AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGatewayV2::Stage

ApiGatewayV2 Stage

Resource Type definition for AWS::ApiGatewayV2::Stage

Properties

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

Filter:
PropertyTypeFlags
ApiId
string
RequiredCreate-only
StageName
string
RequiredCreate-only
AccessLogSettings
AccessLogSettings
AutoDeploy
boolean
ClientCertificateId
string
DefaultRouteSettings
RouteSettings
DeploymentId
string
Description
string
RouteSettings
object
StageVariables
object
Tags
object

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"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

apigateway:GET

create

apigateway:POSTapigateway:TagResource

update

apigateway:PATCHapigateway:POSTapigateway:DELETEapigateway:TagResourceapigateway:UntagResource

list

apigateway:GET

delete

apigateway:DELETE

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
Properties11
Required2
TaggingSupported
Primary IDApiId

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

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

StageNameApiId

Related Resources

External Links