Interface DeploymentProps

stable

Synopsis

Properties

api	The Rest API to deploy.
description	A description of the purpose of the API Gateway deployment.
retainDeployments	When an API Gateway model is updated, a new deployment will automatically be created.

Properties

api

The Rest API to deploy.

stable

Declaration

readonly api: IRestApi;

Property Value

IRestApi

description

A description of the purpose of the API Gateway deployment.

• No description. stable

Declaration

readonly description?: string;

Property Value

string

retainDeployments

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

false stable

Declaration

readonly retainDeployments?: boolean;

Property Value

boolean