Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnDeploymentPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDeploymentPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeploymentPropsMixin>

Enclosing class:

CfnDeploymentPropsMixin

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

A fluent builder for CfnDeploymentPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDeploymentPropsMixin	build()
static CfnDeploymentPropsMixin.Builder	create()
static CfnDeploymentPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDeploymentPropsMixin.Builder	deploymentCanarySettings(CfnDeploymentPropsMixin.DeploymentCanarySettingsProperty deploymentCanarySettings)	The input configuration for a canary deployment.
CfnDeploymentPropsMixin.Builder	deploymentCanarySettings(IResolvable deploymentCanarySettings)	The input configuration for a canary deployment.
CfnDeploymentPropsMixin.Builder	description(String description)	The description for the Deployment resource to create.
CfnDeploymentPropsMixin.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.
CfnDeploymentPropsMixin.Builder	restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnDeploymentPropsMixin.Builder	stageDescription(CfnDeploymentPropsMixin.StageDescriptionProperty stageDescription)	The description of the Stage resource for the Deployment resource to create.
CfnDeploymentPropsMixin.Builder	stageDescription(IResolvable stageDescription)	The description of the Stage resource for the Deployment resource to create.
CfnDeploymentPropsMixin.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 CfnDeploymentPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDeploymentPropsMixin.Builder.

create

@Stability(Stable)
public static CfnDeploymentPropsMixin.Builder create()

Returns:

a new instance of CfnDeploymentPropsMixin.Builder.

deploymentCanarySettings

@Stability(Stable)
public CfnDeploymentPropsMixin.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 CfnDeploymentPropsMixin.Builder deploymentCanarySettings(CfnDeploymentPropsMixin.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 CfnDeploymentPropsMixin.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

restApiId

@Stability(Stable)
public CfnDeploymentPropsMixin.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

restApiId

@Stability(Stable)
public CfnDeploymentPropsMixin.Builder restApiId(IRestApiRef 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

stageDescription

@Stability(Stable)
public CfnDeploymentPropsMixin.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 CfnDeploymentPropsMixin.Builder stageDescription(CfnDeploymentPropsMixin.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 CfnDeploymentPropsMixin.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 CfnDeploymentPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnDeploymentPropsMixin.