AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::Stage

ApiGateway Stage

The AWS::ApiGateway::Stage resource creates a stage for a deployment.

Properties

14 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
RestApiId
string
RequiredCreate-only
AccessLogSetting
AccessLogSetting
CacheClusterEnabled
boolean
CacheClusterSize
string
CanarySetting
CanarySetting
ClientCertificateId
string
DeploymentId
string
Description
string
DocumentationVersion
string
MethodSettings
Array<MethodSetting>
StageName
string
Create-only
Tags
Array<Tag>
TracingEnabled
boolean
Variables
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::ApiGateway::Stage

Resources:
  MyResource:
    Type: AWS::ApiGateway::Stage
    Properties:
      RestApiId: "my-restapiid"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

apigateway:POSTapigateway:PATCHapigateway:GETapigateway:PUT

read

apigateway:GET

update

apigateway:GETapigateway:PATCHapigateway:PUTapigateway:DELETE

delete

apigateway:DELETE

list

apigateway:GET

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway
Properties14
Required1
TaggingSupported
Primary IDRestApiId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

RestApiIdStageName

Related Resources

External Links