# Deployment

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 `restApi.latestDeployment` (unless `deploy: false` is
set when defining the `RestApi`).

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
`restApi.latestDeployment` deployment.

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 `restApi.latestDeployment` deployment.

Extends: Construct › Resource › Deployment
Implements: IResource, IEnvironmentAware, IConstruct, IDependable

- CloudFormation: [`AWS::ApiGateway::Deployment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-deployment.html)
- L1 type: [`CfnDeployment`](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.CfnDeployment.html)
- Source: [`aws-apigateway/lib/deployment.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-apigateway/lib/deployment.ts#L79)
- Type last changed: v2.196.0 · 16 May 2025

## Example

```ts
// production stage
const prodLogGroup = new logs.LogGroup(this, "PrdLogs");
const api = new apigateway.RestApi(this, 'books', {
  deployOptions: {
    accessLogDestination: new apigateway.LogGroupLogDestination(prodLogGroup),
    accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields(),
  },
});
const deployment = new apigateway.Deployment(this, 'Deployment', {api});

// development stage
const devLogGroup = new logs.LogGroup(this, "DevLogs");
new apigateway.Stage(this, 'dev', {
  deployment,
  accessLogDestination: new apigateway.LogGroupLogDestination(devLogGroup),
  accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields({
    caller: false,
    httpMethod: true,
    ip: true,
    protocol: true,
    requestTime: true,
    resourcePath: true,
    responseLength: true,
    status: true,
    user: true,
  }),
});
```

## Initializer

```ts
new Deployment(scope: Construct, id: string, props: DeploymentProps)
```

## Construct Props

- `api`: [IRestApi](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IRestApi.html) (required) — The Rest API to deploy.

- `description`: string — A description of the purpose of the API Gateway deployment.

  **Default:** No description.

- `retainDeployments`: boolean = 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

- `stageName`: string — The name of the stage the API Gateway deployment deploys to.

  **Default:** No stage name. If the `stageName` property is set but a stage with the corresponding name does not exist, a new stage resource will be created with the provided stage name.

## Properties

- `api`: [IRestApi](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IRestApi.html)

- `deploymentId`: string

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

- `stageName`: string — The stage of the API gateway deployment.

## Methods

- `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 resolved during synthesis so tokens are welcome.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.