public static final class Deployment.Builder
extends java.lang.Object
Deployment
.Modifier and Type | Method and Description |
---|---|
Deployment.Builder |
api(IRestApi api)
The Rest API to deploy.
|
Deployment |
build() |
static Deployment.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
Deployment.Builder |
description(java.lang.String description)
A description of the purpose of the API Gateway deployment.
|
Deployment.Builder |
retainDeployments(java.lang.Boolean retainDeployments)
When an API Gateway model is updated, a new deployment will automatically be created.
|
public static Deployment.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.Deployment.Builder
.public Deployment.Builder api(IRestApi api)
api
- The Rest API to deploy. This parameter is required.this
public Deployment.Builder description(java.lang.String description)
Default: - No description.
description
- A description of the purpose of the API Gateway deployment. This parameter is required.this
public Deployment.Builder retainDeployments(java.lang.Boolean retainDeployments)
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
retainDeployments
- When an API Gateway model is updated, a new deployment will automatically be created. This parameter is required.this
public Deployment build()