pulumi-aws-kotlin/com.pulumi.aws.apigatewayv2.kotlin/Stage

Stage

class Stage : KotlinCustomResource

Manages an Amazon API Gateway Version 2 stage. More information can be found in the Amazon API Gateway Developer Guide.

Example Usage

Basic

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(aws_apigatewayv2_api.example().id())
            .build());
    }
}

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.

Properties

accessLogSettings

val accessLogSettings: Output<StageAccessLogSettings>?

Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.

apiId

val apiId: Output<String>

API identifier.

arn

val arn: Output<String>

ARN of the stage.

autoDeploy

val autoDeploy: Output<Boolean>?

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

clientCertificateId

val clientCertificateId: Output<String>?

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

defaultRouteSettings

val defaultRouteSettings: Output<StageDefaultRouteSettings>?

Default route settings for the stage.

deploymentId

val deploymentId: Output<String>

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

description

val description: Output<String>?

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

executionArn

val executionArn: Output<String>

ARN prefix to be used in an aws.lambda.Permission's source_arn attribute. For WebSocket APIs this attribute can additionally be used in an aws.iam.Policy to authorize access to the @connections API. See the Amazon API Gateway Developer Guide for details.

val id: Output<String>

invokeUrl

val invokeUrl: Output<String>

URL to invoke the API pointing to the stage, e.g., wss://z4675bid1j.execute-api.eu-west-2.amazonaws.com/example-stage, or https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/

name

val name: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

routeSettings

val routeSettings: Output<List<StageRouteSetting>>?

Route settings for the stage.

stageVariables

val stageVariables: Output<Map<String, String>>?

Map that defines the stage variables for the stage.