AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGateway::Deployment

CfnDeployment

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.

Import

import { CfnDeployment } from 'aws-cdk-lib/aws-apigateway';

Or use the module namespace:

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.CfnDeployment

Properties

Configuration passed to the constructor as CfnDeploymentProps.

restApiIdRequired
string | IRestApiRef

The string identifier of the associated RestApi.

deploymentCanarySettingsOptional
IResolvable | DeploymentCanarySettingsProperty

The input configuration for a canary deployment.

descriptionOptional
string

The description for the Deployment resource to create.

stageDescriptionOptional
IResolvable | StageDescriptionProperty

The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.

stageNameOptional
string

The name of the Stage resource for the Deployment resource to create.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ApiGateway::DeploymentView in CloudFormation Explorer

Get the Amazon API Gateway Cheat Sheet

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

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-apigateway
CFN TypeAWS::ApiGateway::Deployment
Properties5

Related Constructs

Explore This Service

External Links