Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. apigatewayv2
  5. Stage
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.apigatewayv2.Stage

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

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",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.Stage("example",
    api_id=example_aws_apigatewayv2_api["id"],
    name="example-stage")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

    }
}
Copy
resources:
  example:
    type: aws:apigatewayv2:Stage
    properties:
      apiId: ${exampleAwsApigatewayv2Api.id}
      name: example-stage
Copy

Create Stage Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Stage(name: string, args: StageArgs, opts?: CustomResourceOptions);
@overload
def Stage(resource_name: str,
          args: StageArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Stage(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          api_id: Optional[str] = None,
          access_log_settings: Optional[StageAccessLogSettingsArgs] = 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)
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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. StageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StageArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var awsStageResource = new Aws.ApiGatewayV2.Stage("awsStageResource", new()
{
    ApiId = "string",
    AccessLogSettings = new Aws.ApiGatewayV2.Inputs.StageAccessLogSettingsArgs
    {
        DestinationArn = "string",
        Format = "string",
    },
    AutoDeploy = false,
    ClientCertificateId = "string",
    DefaultRouteSettings = new Aws.ApiGatewayV2.Inputs.StageDefaultRouteSettingsArgs
    {
        DataTraceEnabled = false,
        DetailedMetricsEnabled = false,
        LoggingLevel = "string",
        ThrottlingBurstLimit = 0,
        ThrottlingRateLimit = 0,
    },
    DeploymentId = "string",
    Description = "string",
    Name = "string",
    RouteSettings = new[]
    {
        new Aws.ApiGatewayV2.Inputs.StageRouteSettingArgs
        {
            RouteKey = "string",
            DataTraceEnabled = false,
            DetailedMetricsEnabled = false,
            LoggingLevel = "string",
            ThrottlingBurstLimit = 0,
            ThrottlingRateLimit = 0,
        },
    },
    StageVariables = 
    {
        { "string", "string" },
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := apigatewayv2.NewStage(ctx, "awsStageResource", &apigatewayv2.StageArgs{
	ApiId: pulumi.String("string"),
	AccessLogSettings: &apigatewayv2.StageAccessLogSettingsArgs{
		DestinationArn: pulumi.String("string"),
		Format:         pulumi.String("string"),
	},
	AutoDeploy:          pulumi.Bool(false),
	ClientCertificateId: pulumi.String("string"),
	DefaultRouteSettings: &apigatewayv2.StageDefaultRouteSettingsArgs{
		DataTraceEnabled:       pulumi.Bool(false),
		DetailedMetricsEnabled: pulumi.Bool(false),
		LoggingLevel:           pulumi.String("string"),
		ThrottlingBurstLimit:   pulumi.Int(0),
		ThrottlingRateLimit:    pulumi.Float64(0),
	},
	DeploymentId: pulumi.String("string"),
	Description:  pulumi.String("string"),
	Name:         pulumi.String("string"),
	RouteSettings: apigatewayv2.StageRouteSettingArray{
		&apigatewayv2.StageRouteSettingArgs{
			RouteKey:               pulumi.String("string"),
			DataTraceEnabled:       pulumi.Bool(false),
			DetailedMetricsEnabled: pulumi.Bool(false),
			LoggingLevel:           pulumi.String("string"),
			ThrottlingBurstLimit:   pulumi.Int(0),
			ThrottlingRateLimit:    pulumi.Float64(0),
		},
	},
	StageVariables: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var awsStageResource = new Stage("awsStageResource", StageArgs.builder()
    .apiId("string")
    .accessLogSettings(StageAccessLogSettingsArgs.builder()
        .destinationArn("string")
        .format("string")
        .build())
    .autoDeploy(false)
    .clientCertificateId("string")
    .defaultRouteSettings(StageDefaultRouteSettingsArgs.builder()
        .dataTraceEnabled(false)
        .detailedMetricsEnabled(false)
        .loggingLevel("string")
        .throttlingBurstLimit(0)
        .throttlingRateLimit(0)
        .build())
    .deploymentId("string")
    .description("string")
    .name("string")
    .routeSettings(StageRouteSettingArgs.builder()
        .routeKey("string")
        .dataTraceEnabled(false)
        .detailedMetricsEnabled(false)
        .loggingLevel("string")
        .throttlingBurstLimit(0)
        .throttlingRateLimit(0)
        .build())
    .stageVariables(Map.of("string", "string"))
    .tags(Map.of("string", "string"))
    .build());
Copy
aws_stage_resource = aws.apigatewayv2.Stage("awsStageResource",
    api_id="string",
    access_log_settings={
        "destination_arn": "string",
        "format": "string",
    },
    auto_deploy=False,
    client_certificate_id="string",
    default_route_settings={
        "data_trace_enabled": False,
        "detailed_metrics_enabled": False,
        "logging_level": "string",
        "throttling_burst_limit": 0,
        "throttling_rate_limit": 0,
    },
    deployment_id="string",
    description="string",
    name="string",
    route_settings=[{
        "route_key": "string",
        "data_trace_enabled": False,
        "detailed_metrics_enabled": False,
        "logging_level": "string",
        "throttling_burst_limit": 0,
        "throttling_rate_limit": 0,
    }],
    stage_variables={
        "string": "string",
    },
    tags={
        "string": "string",
    })
Copy
const awsStageResource = new aws.apigatewayv2.Stage("awsStageResource", {
    apiId: "string",
    accessLogSettings: {
        destinationArn: "string",
        format: "string",
    },
    autoDeploy: false,
    clientCertificateId: "string",
    defaultRouteSettings: {
        dataTraceEnabled: false,
        detailedMetricsEnabled: false,
        loggingLevel: "string",
        throttlingBurstLimit: 0,
        throttlingRateLimit: 0,
    },
    deploymentId: "string",
    description: "string",
    name: "string",
    routeSettings: [{
        routeKey: "string",
        dataTraceEnabled: false,
        detailedMetricsEnabled: false,
        loggingLevel: "string",
        throttlingBurstLimit: 0,
        throttlingRateLimit: 0,
    }],
    stageVariables: {
        string: "string",
    },
    tags: {
        string: "string",
    },
});
Copy
type: aws:apigatewayv2:Stage
properties:
    accessLogSettings:
        destinationArn: string
        format: string
    apiId: string
    autoDeploy: false
    clientCertificateId: string
    defaultRouteSettings:
        dataTraceEnabled: false
        detailedMetricsEnabled: false
        loggingLevel: string
        throttlingBurstLimit: 0
        throttlingRateLimit: 0
    deploymentId: string
    description: string
    name: string
    routeSettings:
        - dataTraceEnabled: false
          detailedMetricsEnabled: false
          loggingLevel: string
          routeKey: string
          throttlingBurstLimit: 0
          throttlingRateLimit: 0
    stageVariables:
        string: string
    tags:
        string: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Stage resource accepts the following input properties:

ApiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier.
AccessLogSettings StageAccessLogSettings
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 StageDefaultRouteSettings
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 Changes to this property will trigger replacement. string

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

The following arguments are optional:

RouteSettings List<StageRouteSetting>
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
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. string

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

The following arguments are optional:

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
This property is required.
Changes to this property will trigger replacement.
String
API identifier.
accessLogSettings StageAccessLogSettings
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 StageDefaultRouteSettings
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 Changes to this property will trigger replacement. String

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

The following arguments are optional:

routeSettings List<StageRouteSetting>
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
This property is required.
Changes to this property will trigger replacement.
string
API identifier.
accessLogSettings StageAccessLogSettings
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 StageDefaultRouteSettings
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 Changes to this property will trigger replacement. string

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

The following arguments are optional:

routeSettings StageRouteSetting[]
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
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. str

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

The following arguments are optional:

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
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. String

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

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.

Deprecated: Please use tags instead.

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.

Deprecated: Please use tags instead.

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.

Deprecated: Please use tags instead.

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.

Deprecated: Please use tags instead.

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.

Deprecated: Please use tags instead.

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)
resources:  _:    type: aws:apigatewayv2:Stage    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 StageAccessLogSettings
Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.
ApiId Changes to this property will trigger replacement. 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 StageDefaultRouteSettings
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 Changes to this property will trigger replacement. string

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

The following arguments are optional:

RouteSettings List<StageRouteSetting>
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.

Deprecated: Please use tags instead.

AccessLogSettings StageAccessLogSettingsArgs
Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.
ApiId Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

accessLogSettings StageAccessLogSettings
Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.
apiId Changes to this property will trigger replacement. 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 StageDefaultRouteSettings
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 Changes to this property will trigger replacement. String

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

The following arguments are optional:

routeSettings List<StageRouteSetting>
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.

Deprecated: Please use tags instead.

accessLogSettings StageAccessLogSettings
Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.
apiId Changes to this property will trigger replacement. 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 StageDefaultRouteSettings
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 Changes to this property will trigger replacement. string

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

The following arguments are optional:

routeSettings StageRouteSetting[]
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.

Deprecated: Please use tags instead.

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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

accessLogSettings Property Map
Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.
apiId Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

Supporting Types

StageAccessLogSettings
, StageAccessLogSettingsArgs

DestinationArn This property is required. string
ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.
Format This property is required. string
Single line format of the access logs of data. Refer to log settings for HTTP or Websocket.
DestinationArn This property is required. string
ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.
Format This property is required. string
Single line format of the access logs of data. Refer to log settings for HTTP or Websocket.
destinationArn This property is required. String
ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.
format This property is required. String
Single line format of the access logs of data. Refer to log settings for HTTP or Websocket.
destinationArn This property is required. string
ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.
format This property is required. string
Single line format of the access logs of data. Refer to log settings for HTTP or Websocket.
destination_arn This property is required. str
ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.
format This property is required. str
Single line format of the access logs of data. Refer to log settings for HTTP or Websocket.
destinationArn This property is required. String
ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN.
format This property is required. String
Single line format of the access logs of data. Refer to log settings for HTTP or Websocket.

StageDefaultRouteSettings
, StageDefaultRouteSettingsArgs

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
, StageRouteSettingArgs

RouteKey This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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

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
Copy

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws