AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::Deployment

ApiGateway Deployment

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

Properties

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

Filter:
PropertyTypeFlags
RestApiId
string
RequiredCreate-only
DeploymentCanarySettings
DeploymentCanarySettings
Create-onlyWrite-only
Description
string
StageDescription
StageDescription
Write-only
StageName
string
Write-only

Return Values

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

AttributeTypeDescription
DeploymentIdstring-

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::Deployment

Resources:
  MyResource:
    Type: AWS::ApiGateway::Deployment
    Properties:
      RestApiId: "my-restapiid"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

read

apigateway:GET

create

apigateway:POSTapigateway:PATCHapigateway:PUTapigateway:GET

update

apigateway:PATCHapigateway:GETapigateway:PUTapigateway:DELETE

list

apigateway:GET

delete

apigateway:GETapigateway:DELETE

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
Properties6
Required1
TaggingNot supported
Primary IDDeploymentId

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

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

DeploymentCanarySettingsRestApiId

Related Resources

External Links