Package software.amazon.awscdk.cfnpropertymixins.services.codedeploy

Class CfnDeploymentConfigPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.codedeploy.CfnDeploymentConfigPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeploymentConfigPropsMixin>

Enclosing class:

CfnDeploymentConfigPropsMixin

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

A fluent builder for CfnDeploymentConfigPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDeploymentConfigPropsMixin	build()
CfnDeploymentConfigPropsMixin.Builder	computePlatform(String computePlatform)	The destination platform type for the deployment ( Lambda , Server , or ECS ).
static CfnDeploymentConfigPropsMixin.Builder	create()
static CfnDeploymentConfigPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDeploymentConfigPropsMixin.Builder	deploymentConfigName(String deploymentConfigName)	A name for the deployment configuration.
CfnDeploymentConfigPropsMixin.Builder	minimumHealthyHosts(CfnDeploymentConfigPropsMixin.MinimumHealthyHostsProperty minimumHealthyHosts)	The minimum number of healthy instances that should be available at any time during the deployment.
CfnDeploymentConfigPropsMixin.Builder	minimumHealthyHosts(IResolvable minimumHealthyHosts)	The minimum number of healthy instances that should be available at any time during the deployment.
CfnDeploymentConfigPropsMixin.Builder	trafficRoutingConfig(CfnDeploymentConfigPropsMixin.TrafficRoutingConfigProperty trafficRoutingConfig)	The configuration that specifies how the deployment traffic is routed.
CfnDeploymentConfigPropsMixin.Builder	trafficRoutingConfig(IResolvable trafficRoutingConfig)	The configuration that specifies how the deployment traffic is routed.
CfnDeploymentConfigPropsMixin.Builder	zonalConfig(CfnDeploymentConfigPropsMixin.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.
CfnDeploymentConfigPropsMixin.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.

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 CfnDeploymentConfigPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDeploymentConfigPropsMixin.Builder.

create

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

Returns:

a new instance of CfnDeploymentConfigPropsMixin.Builder.

computePlatform

@Stability(Stable)
public CfnDeploymentConfigPropsMixin.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 CfnDeploymentConfigPropsMixin.Builder deploymentConfigName(String deploymentConfigName)

A name for the deployment configuration.

If you don't specify a name, 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 CfnDeploymentConfigPropsMixin.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 CfnDeploymentConfigPropsMixin.Builder minimumHealthyHosts(CfnDeploymentConfigPropsMixin.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 CfnDeploymentConfigPropsMixin.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 CfnDeploymentConfigPropsMixin.Builder trafficRoutingConfig(CfnDeploymentConfigPropsMixin.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 CfnDeploymentConfigPropsMixin.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 CfnDeploymentConfigPropsMixin.Builder zonalConfig(CfnDeploymentConfigPropsMixin.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 CfnDeploymentConfigPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnDeploymentConfigPropsMixin.