Package software.amazon.awscdk.services.codedeploy

Class CfnDeploymentConfig.Builder

java.lang.Object

software.amazon.awscdk.services.codedeploy.CfnDeploymentConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeploymentConfig>

Enclosing class:

CfnDeploymentConfig

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

A fluent builder for CfnDeploymentConfig.

Method Summary

Modifier and Type	Method	Description
CfnDeploymentConfig	build()
CfnDeploymentConfig.Builder	computePlatform(String computePlatform)	The destination platform type for the deployment ( Lambda , Server , or ECS ).
static CfnDeploymentConfig.Builder	create(software.constructs.Construct scope, String id)
CfnDeploymentConfig.Builder	deploymentConfigName(String deploymentConfigName)	A name for the deployment configuration.
CfnDeploymentConfig.Builder	minimumHealthyHosts(IResolvable minimumHealthyHosts)	The minimum number of healthy instances that should be available at any time during the deployment.
CfnDeploymentConfig.Builder	minimumHealthyHosts(CfnDeploymentConfig.MinimumHealthyHostsProperty minimumHealthyHosts)	The minimum number of healthy instances that should be available at any time during the deployment.
CfnDeploymentConfig.Builder	trafficRoutingConfig(IResolvable trafficRoutingConfig)	The configuration that specifies how the deployment traffic is routed.
CfnDeploymentConfig.Builder	trafficRoutingConfig(CfnDeploymentConfig.TrafficRoutingConfigProperty trafficRoutingConfig)	The configuration that specifies how the deployment traffic is routed.
CfnDeploymentConfig.Builder	zonalConfig(IResolvable zonalConfig)	Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.
CfnDeploymentConfig.Builder	zonalConfig(CfnDeploymentConfig.ZonalConfigProperty zonalConfig)	Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.

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 CfnDeploymentConfig.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 CfnDeploymentConfig.Builder.

computePlatform

@Stability(Stable)
public CfnDeploymentConfig.Builder computePlatform(String computePlatform)

The destination platform type for the deployment ( Lambda , Server , or ECS ).

Parameters:

computePlatform - The destination platform type for the deployment ( Lambda , Server , or ECS ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-computeplatform

deploymentConfigName

@Stability(Stable)
public CfnDeploymentConfig.Builder deploymentConfigName(String deploymentConfigName)

A name for the deployment configuration.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

deploymentConfigName - A name for the deployment configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-deploymentconfigname

minimumHealthyHosts

@Stability(Stable)
public CfnDeploymentConfig.Builder minimumHealthyHosts(IResolvable minimumHealthyHosts)

The minimum number of healthy instances that should be available at any time during the deployment.

There are two parameters expected in the input: type and value.

The type parameter takes either of the following values:

• HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
• FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.

The value parameter takes an integer.

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.

For more information about instance health, see CodeDeploy Instance Health in the AWS CodeDeploy User Guide.

Parameters:

minimumHealthyHosts - The minimum number of healthy instances that should be available at any time during the deployment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts

minimumHealthyHosts

@Stability(Stable)
public CfnDeploymentConfig.Builder minimumHealthyHosts(CfnDeploymentConfig.MinimumHealthyHostsProperty minimumHealthyHosts)

The minimum number of healthy instances that should be available at any time during the deployment.

There are two parameters expected in the input: type and value.

The type parameter takes either of the following values:

• HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
• FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.

The value parameter takes an integer.

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.

For more information about instance health, see CodeDeploy Instance Health in the AWS CodeDeploy User Guide.

Parameters:

minimumHealthyHosts - The minimum number of healthy instances that should be available at any time during the deployment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts

trafficRoutingConfig

@Stability(Stable)
public CfnDeploymentConfig.Builder trafficRoutingConfig(IResolvable trafficRoutingConfig)

The configuration that specifies how the deployment traffic is routed.

Parameters:

trafficRoutingConfig - The configuration that specifies how the deployment traffic is routed. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-trafficroutingconfig

trafficRoutingConfig

@Stability(Stable)
public CfnDeploymentConfig.Builder trafficRoutingConfig(CfnDeploymentConfig.TrafficRoutingConfigProperty trafficRoutingConfig)

The configuration that specifies how the deployment traffic is routed.

Parameters:

trafficRoutingConfig - The configuration that specifies how the deployment traffic is routed. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-trafficroutingconfig

zonalConfig

@Stability(Stable)
public CfnDeploymentConfig.Builder zonalConfig(IResolvable zonalConfig)

Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide .

Parameters:

zonalConfig - Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-zonalconfig

zonalConfig

@Stability(Stable)
public CfnDeploymentConfig.Builder zonalConfig(CfnDeploymentConfig.ZonalConfigProperty zonalConfig)

Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide .

Parameters:

zonalConfig - Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-zonalconfig

build

@Stability(Stable)
public CfnDeploymentConfig build()

Specified by:

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

Returns:

a newly built instance of CfnDeploymentConfig.