DeploymentProps¶

class aws_cdk.aws_apigateway.DeploymentProps(*, api, description=None, retain_deployments=None)¶

Bases: object

__init__(*, api, description=None, retain_deployments=None)¶

Parameters

api (IRestApi) – The Rest API to deploy.
description (Optional[str]) – A description of the purpose of the API Gateway deployment. Default: - No description.
retain_deployments (Optional[bool]) – 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 Default: false

Return type

None

Attributes

api¶

The Rest API to deploy.

Return type: IRestApi

description¶

A description of the purpose of the API Gateway deployment.

default :default: - No description.

Return type: Optional[str]

retain_deployments¶

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

default :default: false

Return type: Optional[bool]