Package 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(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	Description
CfnDeployment	build()
static CfnDeployment.Builder	create(software.constructs.Construct scope, String id)
CfnDeployment.Builder	deploymentCanarySettings(IResolvable deploymentCanarySettings)	The input configuration for a canary deployment.
CfnDeployment.Builder	deploymentCanarySettings(CfnDeployment.DeploymentCanarySettingsProperty deploymentCanarySettings)	The input configuration for a canary deployment.
CfnDeployment.Builder	description(String description)	The description for the Deployment resource to create.
CfnDeployment.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.
CfnDeployment.Builder	stageDescription(IResolvable stageDescription)	The description of the Stage resource for the Deployment resource to create.
CfnDeployment.Builder	stageDescription(CfnDeployment.StageDescriptionProperty stageDescription)	The description of the Stage resource for the Deployment resource to create.
CfnDeployment.Builder	stageName(String stageName)	The name of the Stage resource for the Deployment resource to create.

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 CfnDeployment.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDeployment.Builder.

restApiId

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

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid

deploymentCanarySettings

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

The input configuration for a canary deployment.

Parameters:

deploymentCanarySettings - The input configuration for a canary deployment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings

deploymentCanarySettings

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

The input configuration for a canary deployment.

Parameters:

deploymentCanarySettings - The input configuration for a canary deployment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings

description

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

The description for the Deployment resource to create.

Parameters:

description - The description for the Deployment resource to create. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description

stageDescription

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

The description of the Stage resource for the Deployment resource to create.

To specify a stage description, you must also provide a stage name.

Parameters:

stageDescription - The description of the Stage resource for the Deployment resource to create. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription

stageDescription

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

The description of the Stage resource for the Deployment resource to create.

To specify a stage description, you must also provide a stage name.

Parameters:

stageDescription - The description of the Stage resource for the Deployment resource to create. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription

stageName

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

The name of the Stage resource for the Deployment resource to create.

Parameters:

stageName - The name of the Stage resource for the Deployment resource to create. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename

build

@Stability(Stable)
public CfnDeployment build()

Specified by:

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

Returns:

a newly built instance of CfnDeployment.