1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. apigatewayv2
  6. Stage

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.62.0
published on Monday, Apr 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.apigatewayv2.Stage

aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.62.0
published on Monday, Apr 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ApiGatewayV2::Stage

    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[StageRouteSettingsArgs] = None,
          deployment_id: Optional[str] = None,
          description: Optional[str] = None,
          route_settings: Optional[Any] = None,
          stage_name: Optional[str] = None,
          stage_variables: Optional[Any] = None,
          tags: Optional[Any] = 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-native:apigatewayv2:Stage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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

    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 string
    The API identifier.
    AccessLogSettings Pulumi.AwsNative.ApiGatewayV2.Inputs.StageAccessLogSettings
    Settings for logging access in this stage.
    AutoDeploy bool
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false .
    ClientCertificateId string
    The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.
    DefaultRouteSettings Pulumi.AwsNative.ApiGatewayV2.Inputs.StageRouteSettings
    The default route settings for the stage.
    DeploymentId string
    The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
    Description string
    The description for the API stage.
    RouteSettings object

    Route settings for the stage.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    StageName string
    The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.
    StageVariables object

    A map that defines the stage variables for a Stage . Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    Tags object

    The collection of tags. Each tag element is associated with a given resource.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    ApiId string
    The API identifier.
    AccessLogSettings StageAccessLogSettingsArgs
    Settings for logging access in this stage.
    AutoDeploy bool
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false .
    ClientCertificateId string
    The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.
    DefaultRouteSettings StageRouteSettingsArgs
    The default route settings for the stage.
    DeploymentId string
    The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
    Description string
    The description for the API stage.
    RouteSettings interface{}

    Route settings for the stage.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    StageName string
    The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.
    StageVariables interface{}

    A map that defines the stage variables for a Stage . Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    Tags interface{}

    The collection of tags. Each tag element is associated with a given resource.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    apiId String
    The API identifier.
    accessLogSettings StageAccessLogSettings
    Settings for logging access in this stage.
    autoDeploy Boolean
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false .
    clientCertificateId String
    The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.
    defaultRouteSettings StageRouteSettings
    The default route settings for the stage.
    deploymentId String
    The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
    description String
    The description for the API stage.
    routeSettings Object

    Route settings for the stage.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    stageName String
    The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.
    stageVariables Object

    A map that defines the stage variables for a Stage . Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    tags Object

    The collection of tags. Each tag element is associated with a given resource.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    apiId string
    The API identifier.
    accessLogSettings StageAccessLogSettings
    Settings for logging access in this stage.
    autoDeploy boolean
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false .
    clientCertificateId string
    The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.
    defaultRouteSettings StageRouteSettings
    The default route settings for the stage.
    deploymentId string
    The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
    description string
    The description for the API stage.
    routeSettings any

    Route settings for the stage.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    stageName string
    The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.
    stageVariables any

    A map that defines the stage variables for a Stage . Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    tags any

    The collection of tags. Each tag element is associated with a given resource.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    api_id str
    The API identifier.
    access_log_settings StageAccessLogSettingsArgs
    Settings for logging access in this stage.
    auto_deploy bool
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false .
    client_certificate_id str
    The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.
    default_route_settings StageRouteSettingsArgs
    The default route settings for the stage.
    deployment_id str
    The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
    description str
    The description for the API stage.
    route_settings Any

    Route settings for the stage.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    stage_name str
    The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.
    stage_variables Any

    A map that defines the stage variables for a Stage . Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    tags Any

    The collection of tags. Each tag element is associated with a given resource.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    apiId String
    The API identifier.
    accessLogSettings Property Map
    Settings for logging access in this stage.
    autoDeploy Boolean
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false .
    clientCertificateId String
    The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.
    defaultRouteSettings Property Map
    The default route settings for the stage.
    deploymentId String
    The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
    description String
    The description for the API stage.
    routeSettings Any

    Route settings for the stage.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    stageName String
    The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.
    stageVariables Any

    A map that defines the stage variables for a Stage . Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    tags Any

    The collection of tags. Each tag element is associated with a given resource.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

    Outputs

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

    AwsId string
    The identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    The identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    The identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    The identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    The identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    The identifier.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    StageAccessLogSettings, StageAccessLogSettingsArgs

    DestinationArn string
    The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
    Format string
    A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.
    DestinationArn string
    The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
    Format string
    A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.
    destinationArn String
    The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
    format String
    A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.
    destinationArn string
    The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
    format string
    A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.
    destination_arn str
    The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
    format str
    A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.
    destinationArn String
    The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
    format String
    A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.

    StageRouteSettings, StageRouteSettingsArgs

    DataTraceEnabled bool
    Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    DetailedMetricsEnabled bool
    Specifies whether detailed metrics are enabled.
    LoggingLevel string
    Specifies the logging level for this route: INFO , ERROR , or OFF . This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    ThrottlingBurstLimit int
    Specifies the throttling burst limit.
    ThrottlingRateLimit double
    Specifies the throttling rate limit.
    DataTraceEnabled bool
    Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    DetailedMetricsEnabled bool
    Specifies whether detailed metrics are enabled.
    LoggingLevel string
    Specifies the logging level for this route: INFO , ERROR , or OFF . This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    ThrottlingBurstLimit int
    Specifies the throttling burst limit.
    ThrottlingRateLimit float64
    Specifies the throttling rate limit.
    dataTraceEnabled Boolean
    Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    detailedMetricsEnabled Boolean
    Specifies whether detailed metrics are enabled.
    loggingLevel String
    Specifies the logging level for this route: INFO , ERROR , or OFF . This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    throttlingBurstLimit Integer
    Specifies the throttling burst limit.
    throttlingRateLimit Double
    Specifies the throttling rate limit.
    dataTraceEnabled boolean
    Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    detailedMetricsEnabled boolean
    Specifies whether detailed metrics are enabled.
    loggingLevel string
    Specifies the logging level for this route: INFO , ERROR , or OFF . This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    throttlingBurstLimit number
    Specifies the throttling burst limit.
    throttlingRateLimit number
    Specifies the throttling rate limit.
    data_trace_enabled bool
    Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    detailed_metrics_enabled bool
    Specifies whether detailed metrics are enabled.
    logging_level str
    Specifies the logging level for this route: INFO , ERROR , or OFF . This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    throttling_burst_limit int
    Specifies the throttling burst limit.
    throttling_rate_limit float
    Specifies the throttling rate limit.
    dataTraceEnabled Boolean
    Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    detailedMetricsEnabled Boolean
    Specifies whether detailed metrics are enabled.
    loggingLevel String
    Specifies the logging level for this route: INFO , ERROR , or OFF . This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    throttlingBurstLimit Number
    Specifies the throttling burst limit.
    throttlingRateLimit Number
    Specifies the throttling rate limit.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.62.0
    published on Monday, Apr 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.