AWS::ApiGateway::Deployment

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

{
  "Type" : "AWS::ApiGateway::Deployment",
  "Properties" : {
    "DeploymentCanarySettings" : DeploymentCanarySettings,
    "Description" : String,
    "RestApiId" : String,
    "StageDescription" : StageDescription,
    "StageName" : String
  }
}

Type: AWS::ApiGateway::Deployment
Properties:
  DeploymentCanarySettings: DeploymentCanarySettings
  Description: String
  RestApiId: String
  StageDescription: StageDescription
  StageName: String

Properties

Return Value

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the deployment ID, such as 123abc.

For more information about using the Ref function, see Ref.

Examples

The following sections provide examples for declaring API Gateway deployments.

Deployment with an Empty Embedded Stage

The following example deploys the MyApi API to a stage named DummyStage.

"Deployment": {
  "Type": "AWS::ApiGateway::Deployment",
  "Properties": {
    "RestApiId": { "Ref": "MyApi" },
    "Description": "My deployment",
    "StageName": "DummyStage"
  }
}

Deployment: 
  Type: AWS::ApiGateway::Deployment
  Properties: 
    RestApiId: 
      Ref: "MyApi"
    Description: "My deployment"
    StageName: "DummyStage"

AWS::ApiGateway::Method Dependency

If you create a AWS::ApiGateway::RestApi resource and its methods (using AWS::ApiGateway::Method) in the same template as your deployment, the deployment must depend on the RestApi's methods. To create a dependency, add a DependsOn attribute to the deployment. If you don't, AWS CloudFormation creates the deployment right after it creates the RestApi resource that doesn't contain any methods, and AWS CloudFormation encounters the following error: The REST API doesn't contain any methods.

"Deployment": {
  "DependsOn": "MyMethod",
  "Type": "AWS::ApiGateway::Deployment",
  "Properties": {
    "RestApiId": { "Ref": "MyApi" },
    "Description": "My deployment",
    "StageName": "DummyStage"
  }
}

Deployment: 
  DependsOn: "MyMethod"
  Type: AWS::ApiGateway::Deployment
  Properties: 
    RestApiId: 
      Ref: "MyApi"
    Description: "My deployment"
    StageName: "DummyStage"

On this page:

• Syntax
• Properties
• Return Value
• Examples