AWS::ApiGatewayV2::Stage

ApiGatewayV2 Stage

Resource Type definition for AWS::ApiGatewayV2::Stage

Properties

12 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`ApiId`	`string`	RequiredCreate-only
`StageName`	`string`	RequiredCreate-only
`AccessLogSettings`	`AccessLogSettings`
`AccessPolicyId`	`string`
`AutoDeploy`	`boolean`
`ClientCertificateId`	`string`
`DefaultRouteSettings`	`RouteSettings`
`DeploymentId`	`string`
`Description`	`string`
`RouteSettings`	`object`
`StageVariables`	`object`
`Tags`	`object`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Id`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGatewayV2::Stage

Resources:
  MyResource:
    Type: AWS::ApiGatewayV2::Stage
    Properties:
      StageName: "my-stagename"
      ApiId: "my-apiid"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceApiGatewayV2

Properties13

Required2

TaggingNot supported

Primary IDId

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

StageNameApiId

Related Resources

External Links

AWS Documentation