software.amazon.awscdk.services.apigateway

Class CfnDeployment.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDeployment.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeployment>

Enclosing class:

CfnDeployment

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

A fluent builder for CfnDeployment.

Method Summary

Modifier and Type	Method and Description
CfnDeployment	build()
static CfnDeployment.Builder	create(software.constructs.Construct scope, String id)
CfnDeployment.Builder	deploymentCanarySettings(CfnDeployment.DeploymentCanarySettingsProperty deploymentCanarySettings) Specifies settings for the canary deployment.
CfnDeployment.Builder	deploymentCanarySettings(IResolvable deploymentCanarySettings) Specifies settings for the canary deployment.
CfnDeployment.Builder	description(String description) A description of the purpose of the API Gateway deployment.
CfnDeployment.Builder	restApiId(String restApiId) The ID of the `RestApi` resource to deploy.
CfnDeployment.Builder	stageDescription(CfnDeployment.StageDescriptionProperty stageDescription) Configures the stage that API Gateway creates with this deployment.
CfnDeployment.Builder	stageDescription(IResolvable stageDescription) Configures the stage that API Gateway creates with this deployment.
CfnDeployment.Builder	stageName(String stageName) A name for the stage that API Gateway creates with this deployment.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnDeployment.AccessLogSettingProperty.Builder.

restApiId

@Stability(value=Stable)
public CfnDeployment.Builder restApiId(String restApiId)

The ID of the `RestApi` resource to deploy.

Parameters:

restApiId - The ID of the `RestApi` resource to deploy. This parameter is required.

Returns:

this

deploymentCanarySettings

@Stability(value=Stable)
public CfnDeployment.Builder deploymentCanarySettings(CfnDeployment.DeploymentCanarySettingsProperty deploymentCanarySettings)

Specifies settings for the canary deployment.

Parameters:

deploymentCanarySettings - Specifies settings for the canary deployment. This parameter is required.

Returns:

this

deploymentCanarySettings

@Stability(value=Stable)
public CfnDeployment.Builder deploymentCanarySettings(IResolvable deploymentCanarySettings)

Specifies settings for the canary deployment.

Parameters:

deploymentCanarySettings - Specifies settings for the canary deployment. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnDeployment.Builder description(String description)

A description of the purpose of the API Gateway deployment.

Parameters:

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

Returns:

this

stageDescription

@Stability(value=Stable)
public CfnDeployment.Builder stageDescription(CfnDeployment.StageDescriptionProperty stageDescription)

Configures the stage that API Gateway creates with this deployment.

Parameters:

stageDescription - Configures the stage that API Gateway creates with this deployment. This parameter is required.

Returns:

this

stageDescription

@Stability(value=Stable)
public CfnDeployment.Builder stageDescription(IResolvable stageDescription)

Configures the stage that API Gateway creates with this deployment.

Parameters:

stageDescription - Configures the stage that API Gateway creates with this deployment. This parameter is required.

Returns:

this

stageName

@Stability(value=Stable)
public CfnDeployment.Builder stageName(String stageName)

A name for the stage that API Gateway creates with this deployment.

Use only alphanumeric characters.

Parameters:

stageName - A name for the stage that API Gateway creates with this deployment. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnDeployment build()

Specified by:

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