class Deployment (construct)
A Deployment of a REST API.
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
Normally, you don't need to define deployments manually. The RestApi
construct manages a Deployment resource that represents the latest model. It
can be accessed through
deploy: false is
set when defining the
If you manually define this resource, you will need to know that since deployments are immutable, as long as the resource's logical ID doesn't change, the deployment will represent the snapshot in time in which the resource was created. This means that if you modify the RestApi model (i.e. add methods or resources), these changes will not be reflected unless a new deployment resource is created.
To achieve this behavior, the method
addToLogicalId(data) can be used to
augment the logical ID generated for the deployment resource such that it
will include arbitrary data. This is done automatically for the
Furthermore, since a deployment does not reference any of the REST API
resources and methods, CloudFormation will likely provision it before these
resources are created, which means that it will represent a "half-baked"
model. Use the
node.addDependency(dep) method to circumvent that. This is done
automatically for the
new Deployment(scope: Construct, id: string, props: DeploymentProps)
|api||The Rest API to deploy.|
|description?||A description of the purpose of the API Gateway deployment.|
|retain||When an API Gateway model is updated, a new deployment will automatically be created.|
The Rest API to deploy.
(optional, default: No description.)
A description of the purpose of the API Gateway deployment.
(optional, default: false)
When an API Gateway model is updated, a new deployment will automatically be created.
If this is true, the old API Gateway Deployment resource will not be deleted. This will allow manually reverting back to a previous deployment in case for example
|env||The environment this resource belongs to.|
|node||The construct tree node associated with this construct.|
|stack||The stack in which this resource is defined.|
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
The construct tree node associated with this construct.
The stack in which this resource is defined.
|add||Adds a component to the hash that determines this Deployment resource's logical ID.|
|to||Returns a string representation of this construct.|
To Logical Id(data)
public addToLogicalId(data: any): void
Adds a component to the hash that determines this Deployment resource's logical ID.
This should be called by constructs of the API Gateway model that want to invalidate the deployment when their settings change. The component will be resolve()ed during synthesis so tokens are welcome.
public toString(): string
Returns a string representation of this construct.