Stage

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

Example Usage

Basic

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ApiGatewayV2.Stage("example", new()
    {
        ApiId = aws_apigatewayv2_api.Example.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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(aws_apigatewayv2_api.Example.Id),
		})
		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(aws_apigatewayv2_api.example().id())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.Stage("example", api_id=aws_apigatewayv2_api["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.apigatewayv2.Stage("example", {apiId: aws_apigatewayv2_api.example.id});
resources:
  example:
    type: aws:apigatewayv2:Stage
    properties:
      apiId: ${aws_apigatewayv2_api.example.id}

Create Stage Resource

new Stage(name: string, args: StageArgs, opts?: CustomResourceOptions);
@overload
def Stage(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          access_log_settings: Optional[StageAccessLogSettingsArgs] = None,
          api_id: Optional[str] = None,
          auto_deploy: Optional[bool] = None,
          client_certificate_id: Optional[str] = None,
          default_route_settings: Optional[StageDefaultRouteSettingsArgs] = None,
          deployment_id: Optional[str] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          route_settings: Optional[Sequence[StageRouteSettingArgs]] = None,
          stage_variables: Optional[Mapping[str, str]] = None,
          tags: Optional[Mapping[str, str]] = None)
@overload
def Stage(resource_name: str,
          args: StageArgs,
          opts: Optional[ResourceOptions] = None)
func NewStage(ctx *Context, name string, args StageArgs, opts ...ResourceOption) (*Stage, error)
public Stage(string name, StageArgs args, CustomResourceOptions? opts = null)
public Stage(String name, StageArgs args)
public Stage(String name, StageArgs args, CustomResourceOptions options)
type: aws:apigatewayv2:Stage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args StageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args StageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args StageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args StageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args StageArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Stage Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Stage resource accepts the following input properties:

ApiId string

API identifier.

AccessLogSettings StageAccessLogSettingsArgs

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

AutoDeploy bool

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

ClientCertificateId 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 StageDefaultRouteSettingsArgs

Default route settings for the stage.

DeploymentId string

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

Description string

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

Name string

Name of the stage. Must be between 1 and 128 characters in length.

RouteSettings List<StageRouteSettingArgs>

Route settings for the stage.

StageVariables Dictionary<string, string>

Map that defines the stage variables for the stage.

Tags Dictionary<string, string>

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.

ApiId string

API identifier.

AccessLogSettings StageAccessLogSettingsArgs

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

AutoDeploy bool

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

ClientCertificateId 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 StageDefaultRouteSettingsArgs

Default route settings for the stage.

DeploymentId string

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

Description string

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

Name string

Name of the stage. Must be between 1 and 128 characters in length.

RouteSettings []StageRouteSettingArgs

Route settings for the stage.

StageVariables map[string]string

Map that defines the stage variables for the stage.

Tags map[string]string

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.

apiId String

API identifier.

accessLogSettings StageAccessLogSettingsArgs

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

autoDeploy Boolean

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

clientCertificateId 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 StageDefaultRouteSettingsArgs

Default route settings for the stage.

deploymentId String

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

description String

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

name String

Name of the stage. Must be between 1 and 128 characters in length.

routeSettings List<StageRouteSettingArgs>

Route settings for the stage.

stageVariables Map<String,String>

Map that defines the stage variables for the stage.

tags Map<String,String>

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.

apiId string

API identifier.

accessLogSettings StageAccessLogSettingsArgs

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

autoDeploy boolean

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

clientCertificateId 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 StageDefaultRouteSettingsArgs

Default route settings for the stage.

deploymentId string

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

description string

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

name string

Name of the stage. Must be between 1 and 128 characters in length.

routeSettings StageRouteSettingArgs[]

Route settings for the stage.

stageVariables {[key: string]: string}

Map that defines the stage variables for the stage.

tags {[key: string]: string}

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.

api_id str

API identifier.

access_log_settings StageAccessLogSettingsArgs

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

auto_deploy bool

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

client_certificate_id str

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

default_route_settings StageDefaultRouteSettingsArgs

Default route settings for the stage.

deployment_id str

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

description str

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

name str

Name of the stage. Must be between 1 and 128 characters in length.

route_settings Sequence[StageRouteSettingArgs]

Route settings for the stage.

stage_variables Mapping[str, str]

Map that defines the stage variables for the stage.

tags Mapping[str, str]

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.

apiId String

API identifier.

accessLogSettings Property Map

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

autoDeploy Boolean

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

clientCertificateId 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 Property Map

Default route settings for the stage.

deploymentId String

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

description String

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

name String

Name of the stage. Must be between 1 and 128 characters in length.

routeSettings List<Property Map>

Route settings for the stage.

stageVariables Map<String>

Map that defines the stage variables for the stage.

tags Map<String>

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Stage resource produces the following output properties:

Arn string

ARN of the stage.

ExecutionArn 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.

Id string

The provider-assigned unique ID for this managed resource.

InvokeUrl 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/

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

ARN of the stage.

ExecutionArn 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.

Id string

The provider-assigned unique ID for this managed resource.

InvokeUrl 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/

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the stage.

executionArn 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.

id String

The provider-assigned unique ID for this managed resource.

invokeUrl 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/

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

ARN of the stage.

executionArn 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.

id string

The provider-assigned unique ID for this managed resource.

invokeUrl 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/

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

ARN of the stage.

execution_arn str

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.

id str

The provider-assigned unique ID for this managed resource.

invoke_url str

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/

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the stage.

executionArn 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.

id String

The provider-assigned unique ID for this managed resource.

invokeUrl 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/

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing Stage Resource

Get an existing Stage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: StageState, opts?: CustomResourceOptions): Stage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_log_settings: Optional[StageAccessLogSettingsArgs] = None,
        api_id: Optional[str] = None,
        arn: Optional[str] = None,
        auto_deploy: Optional[bool] = None,
        client_certificate_id: Optional[str] = None,
        default_route_settings: Optional[StageDefaultRouteSettingsArgs] = None,
        deployment_id: Optional[str] = None,
        description: Optional[str] = None,
        execution_arn: Optional[str] = None,
        invoke_url: Optional[str] = None,
        name: Optional[str] = None,
        route_settings: Optional[Sequence[StageRouteSettingArgs]] = None,
        stage_variables: Optional[Mapping[str, str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Stage
func GetStage(ctx *Context, name string, id IDInput, state *StageState, opts ...ResourceOption) (*Stage, error)
public static Stage Get(string name, Input<string> id, StageState? state, CustomResourceOptions? opts = null)
public static Stage get(String name, Output<String> id, StageState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccessLogSettings StageAccessLogSettingsArgs

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

ApiId string

API identifier.

Arn string

ARN of the stage.

AutoDeploy bool

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

ClientCertificateId 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 StageDefaultRouteSettingsArgs

Default route settings for the stage.

DeploymentId string

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

Description string

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

ExecutionArn 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.

InvokeUrl 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 string

Name of the stage. Must be between 1 and 128 characters in length.

RouteSettings List<StageRouteSettingArgs>

Route settings for the stage.

StageVariables Dictionary<string, string>

Map that defines the stage variables for the stage.

Tags Dictionary<string, string>

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.

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

AccessLogSettings StageAccessLogSettingsArgs

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

ApiId string

API identifier.

Arn string

ARN of the stage.

AutoDeploy bool

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

ClientCertificateId 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 StageDefaultRouteSettingsArgs

Default route settings for the stage.

DeploymentId string

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

Description string

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

ExecutionArn 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.

InvokeUrl 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 string

Name of the stage. Must be between 1 and 128 characters in length.

RouteSettings []StageRouteSettingArgs

Route settings for the stage.

StageVariables map[string]string

Map that defines the stage variables for the stage.

Tags map[string]string

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.

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

accessLogSettings StageAccessLogSettingsArgs

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

apiId String

API identifier.

arn String

ARN of the stage.

autoDeploy Boolean

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

clientCertificateId 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 StageDefaultRouteSettingsArgs

Default route settings for the stage.

deploymentId String

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

description String

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

executionArn 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.

invokeUrl 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 String

Name of the stage. Must be between 1 and 128 characters in length.

routeSettings List<StageRouteSettingArgs>

Route settings for the stage.

stageVariables Map<String,String>

Map that defines the stage variables for the stage.

tags Map<String,String>

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.

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

accessLogSettings StageAccessLogSettingsArgs

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

apiId string

API identifier.

arn string

ARN of the stage.

autoDeploy boolean

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

clientCertificateId 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 StageDefaultRouteSettingsArgs

Default route settings for the stage.

deploymentId string

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

description string

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

executionArn 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.

invokeUrl 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 string

Name of the stage. Must be between 1 and 128 characters in length.

routeSettings StageRouteSettingArgs[]

Route settings for the stage.

stageVariables {[key: string]: string}

Map that defines the stage variables for the stage.

tags {[key: string]: string}

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.

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

access_log_settings StageAccessLogSettingsArgs

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

api_id str

API identifier.

arn str

ARN of the stage.

auto_deploy bool

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

client_certificate_id str

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

default_route_settings StageDefaultRouteSettingsArgs

Default route settings for the stage.

deployment_id str

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

description str

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

execution_arn str

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.

invoke_url str

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 str

Name of the stage. Must be between 1 and 128 characters in length.

route_settings Sequence[StageRouteSettingArgs]

Route settings for the stage.

stage_variables Mapping[str, str]

Map that defines the stage variables for the stage.

tags Mapping[str, str]

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.

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

accessLogSettings Property Map

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

apiId String

API identifier.

arn String

ARN of the stage.

autoDeploy Boolean

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

clientCertificateId 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 Property Map

Default route settings for the stage.

deploymentId String

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

description String

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

executionArn 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.

invokeUrl 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 String

Name of the stage. Must be between 1 and 128 characters in length.

routeSettings List<Property Map>

Route settings for the stage.

stageVariables Map<String>

Map that defines the stage variables for the stage.

tags Map<String>

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.

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Supporting Types

StageAccessLogSettings

DestinationArn string

ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.

Format string

Single line format of the access logs of data, as specified by selected $context variables.

DestinationArn string

ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.

Format string

Single line format of the access logs of data, as specified by selected $context variables.

destinationArn String

ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.

format String

Single line format of the access logs of data, as specified by selected $context variables.

destinationArn string

ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.

format string

Single line format of the access logs of data, as specified by selected $context variables.

destination_arn str

ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.

format str

Single line format of the access logs of data, as specified by selected $context variables.

destinationArn String

ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.

format String

Single line format of the access logs of data, as specified by selected $context variables.

StageDefaultRouteSettings

DataTraceEnabled bool

Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

DetailedMetricsEnabled bool

Whether detailed metrics are enabled for the default route. Defaults to false.

LoggingLevel string

Logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

ThrottlingBurstLimit int

Throttling burst limit for the default route.

ThrottlingRateLimit double

Throttling rate limit for the default route.

DataTraceEnabled bool

Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

DetailedMetricsEnabled bool

Whether detailed metrics are enabled for the default route. Defaults to false.

LoggingLevel string

Logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

ThrottlingBurstLimit int

Throttling burst limit for the default route.

ThrottlingRateLimit float64

Throttling rate limit for the default route.

dataTraceEnabled Boolean

Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

detailedMetricsEnabled Boolean

Whether detailed metrics are enabled for the default route. Defaults to false.

loggingLevel String

Logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

throttlingBurstLimit Integer

Throttling burst limit for the default route.

throttlingRateLimit Double

Throttling rate limit for the default route.

dataTraceEnabled boolean

Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

detailedMetricsEnabled boolean

Whether detailed metrics are enabled for the default route. Defaults to false.

loggingLevel string

Logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

throttlingBurstLimit number

Throttling burst limit for the default route.

throttlingRateLimit number

Throttling rate limit for the default route.

data_trace_enabled bool

Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

detailed_metrics_enabled bool

Whether detailed metrics are enabled for the default route. Defaults to false.

logging_level str

Logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

throttling_burst_limit int

Throttling burst limit for the default route.

throttling_rate_limit float

Throttling rate limit for the default route.

dataTraceEnabled Boolean

Whether data trace logging is enabled for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

detailedMetricsEnabled Boolean

Whether detailed metrics are enabled for the default route. Defaults to false.

loggingLevel String

Logging level for the default route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

throttlingBurstLimit Number

Throttling burst limit for the default route.

throttlingRateLimit Number

Throttling rate limit for the default route.

StageRouteSetting

RouteKey string

Route key.

DataTraceEnabled bool

Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

DetailedMetricsEnabled bool

Whether detailed metrics are enabled for the route. Defaults to false.

LoggingLevel string

Logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

ThrottlingBurstLimit int

Throttling burst limit for the route.

ThrottlingRateLimit double

Throttling rate limit for the route.

RouteKey string

Route key.

DataTraceEnabled bool

Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

DetailedMetricsEnabled bool

Whether detailed metrics are enabled for the route. Defaults to false.

LoggingLevel string

Logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

ThrottlingBurstLimit int

Throttling burst limit for the route.

ThrottlingRateLimit float64

Throttling rate limit for the route.

routeKey String

Route key.

dataTraceEnabled Boolean

Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

detailedMetricsEnabled Boolean

Whether detailed metrics are enabled for the route. Defaults to false.

loggingLevel String

Logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

throttlingBurstLimit Integer

Throttling burst limit for the route.

throttlingRateLimit Double

Throttling rate limit for the route.

routeKey string

Route key.

dataTraceEnabled boolean

Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

detailedMetricsEnabled boolean

Whether detailed metrics are enabled for the route. Defaults to false.

loggingLevel string

Logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

throttlingBurstLimit number

Throttling burst limit for the route.

throttlingRateLimit number

Throttling rate limit for the route.

route_key str

Route key.

data_trace_enabled bool

Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

detailed_metrics_enabled bool

Whether detailed metrics are enabled for the route. Defaults to false.

logging_level str

Logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

throttling_burst_limit int

Throttling burst limit for the route.

throttling_rate_limit float

Throttling rate limit for the route.

routeKey String

Route key.

dataTraceEnabled Boolean

Whether data trace logging is enabled for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Defaults to false. Supported only for WebSocket APIs.

detailedMetricsEnabled Boolean

Whether detailed metrics are enabled for the route. Defaults to false.

loggingLevel String

Logging level for the route. Affects the log entries pushed to Amazon CloudWatch Logs. Valid values: ERROR, INFO, OFF. Defaults to OFF. Supported only for WebSocket APIs. This provider will only perform drift detection of its value when present in a configuration.

throttlingBurstLimit Number

Throttling burst limit for the route.

throttlingRateLimit Number

Throttling rate limit for the route.

Import

aws_apigatewayv2_stage can be imported by using the API identifier and stage name, e.g.,

 $ pulumi import aws:apigatewayv2/stage:Stage example aabbccddee/example-stage

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.