StageArgs

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",
});
import pulumi
import pulumi_aws as aws
example = aws.apigatewayv2.Stage("example",
api_id=example_aws_apigatewayv2_api["id"],
name="example-stage")
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",
});
});
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
})
}
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());
}
}
resources:
example:
type: aws:apigatewayv2:Stage
properties:
apiId: ${exampleAwsApigatewayv2Api.id}
name: example-stage

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-stage

->Note: The API Gateway managed stage created as part of quick_create cannot be imported.

Constructors

Link copied to clipboard
constructor(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)

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
val apiId: Output<String>? = null

API identifier.

Link copied to clipboard
val autoDeploy: Output<Boolean>? = null

Whether updates to an API automatically trigger a new deployment. Defaults to false. Applicable for HTTP APIs.

Link copied to clipboard
val clientCertificateId: Output<String>? = null

Identifier of a client certificate for the stage. Use the aws.apigateway.ClientCertificate resource to configure a client certificate. Supported only for WebSocket APIs.

Link copied to clipboard

Default route settings for the stage.

Link copied to clipboard
val deploymentId: Output<String>? = null

Deployment identifier of the stage. Use the aws.apigatewayv2.Deployment resource to configure a deployment.

Link copied to clipboard
val description: Output<String>? = null

Description for the stage. Must be less than or equal to 1024 characters in length.

Link copied to clipboard
val name: Output<String>? = null

Name of the stage. Must be between 1 and 128 characters in length. The following arguments are optional:

Link copied to clipboard

Route settings for the stage.

Link copied to clipboard
val stageVariables: Output<Map<String, String>>? = null

Map that defines the stage variables for the stage.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Map of tags to assign to the stage. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Functions

Link copied to clipboard
open override fun toJava(): StageArgs