Stage Args
data class StageArgs(val accessLogSettings: Output<StageAccessLogSettingsArgs>? = null, val apiId: Output<String>? = null, val autoDeploy: Output<Boolean>? = null, val clientCertificateId: Output<String>? = null, val defaultRouteSettings: Output<StageDefaultRouteSettingsArgs>? = null, val deploymentId: Output<String>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val routeSettings: Output<List<StageRouteSettingArgs>>? = null, val stageVariables: Output<Map<String, String>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<StageArgs>
Manages an Amazon API Gateway Version 2 stage. More information can be found in the Amazon API Gateway Developer Guide.
Example Usage
Basic
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apigatewayv2.Stage("example", {
apiId: exampleAwsApigatewayv2Api.id,
name: "example-stage",
});Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.apigatewayv2.Stage("example",
api_id=example_aws_apigatewayv2_api["id"],
name="example-stage")Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ApiGatewayV2.Stage("example", new()
{
ApiId = exampleAwsApigatewayv2Api.Id,
Name = "example-stage",
});
});Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigatewayv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigatewayv2.NewStage(ctx, "example", &apigatewayv2.StageArgs{
ApiId: pulumi.Any(exampleAwsApigatewayv2Api.Id),
Name: pulumi.String("example-stage"),
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.Stage;
import com.pulumi.aws.apigatewayv2.StageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Stage("example", StageArgs.builder()
.apiId(exampleAwsApigatewayv2Api.id())
.name("example-stage")
.build());
}
}Content copied to clipboard
resources:
example:
type: aws:apigatewayv2:Stage
properties:
apiId: ${exampleAwsApigatewayv2Api.id}
name: example-stageContent copied to clipboard
Import
Using pulumi import, import aws_apigatewayv2_stage using the API identifier and stage name. For example:
$ pulumi import aws:apigatewayv2/stage:Stage example aabbccddee/example-stageContent copied to clipboard
->Note: The API Gateway managed stage created as part of quick_create cannot be imported.
Constructors
Link copied to clipboard
fun StageArgs(accessLogSettings: Output<StageAccessLogSettingsArgs>? = null, apiId: Output<String>? = null, autoDeploy: Output<Boolean>? = null, clientCertificateId: Output<String>? = null, defaultRouteSettings: Output<StageDefaultRouteSettingsArgs>? = null, deploymentId: Output<String>? = null, description: Output<String>? = null, name: Output<String>? = null, routeSettings: Output<List<StageRouteSettingArgs>>? = null, stageVariables: Output<Map<String, String>>? = null, tags: Output<Map<String, String>>? = null)
Functions
Properties
Link copied to clipboard
Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.
Link copied to clipboard