Package software.amazon.awscdk.services.apigateway

Class Deployment.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.Deployment.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Deployment>

Enclosing class:

Deployment

@Stability(Stable)
public static final class Deployment.Builder
extends Object
implements software.amazon.jsii.Builder<Deployment>

A fluent builder for Deployment.

Method Summary

Modifier and Type	Method	Description
Deployment.Builder	api(IRestApi api)	The Rest API to deploy.
Deployment	build()
static Deployment.Builder	create(software.constructs.Construct scope, String id)
Deployment.Builder	description(String description)	A description of the purpose of the API Gateway deployment.
Deployment.Builder	retainDeployments(Boolean retainDeployments)	When an API Gateway model is updated, a new deployment will automatically be created.
Deployment.Builder	stageName(String stageName)	The name of the stage the API Gateway deployment deploys to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static Deployment.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Deployment.Builder.

api

@Stability(Stable)
public Deployment.Builder api(IRestApi api)

The Rest API to deploy.

Parameters:

api - The Rest API to deploy. This parameter is required.

Returns:

this

description

@Stability(Stable)
public Deployment.Builder description(String description)

A description of the purpose of the API Gateway deployment.

Default: - No description.

Parameters:

description - A description of the purpose of the API Gateway deployment. This parameter is required.

Returns:

this

retainDeployments

@Stability(Stable)
public Deployment.Builder retainDeployments(Boolean 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

Default: false

Parameters:

retainDeployments - When an API Gateway model is updated, a new deployment will automatically be created. This parameter is required.

Returns:

this

stageName

@Stability(Stable)
public Deployment.Builder stageName(String stageName)

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.

Parameters:

stageName - The name of the stage the API Gateway deployment deploys to. This parameter is required.

Returns:

this

build

@Stability(Stable)
public Deployment build()

Specified by:

build in interface software.amazon.jsii.Builder<Deployment>

Returns:

a newly built instance of Deployment.