Package software.amazon.awscdk.services.appconfig

Class CfnDeploymentStrategy.Builder

java.lang.Object

software.amazon.awscdk.services.appconfig.CfnDeploymentStrategy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeploymentStrategy>

Enclosing class:

CfnDeploymentStrategy

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

A fluent builder for CfnDeploymentStrategy.

Method Summary

Modifier and Type	Method	Description
CfnDeploymentStrategy	build()
static CfnDeploymentStrategy.Builder	create(software.constructs.Construct scope, String id)
CfnDeploymentStrategy.Builder	deploymentDurationInMinutes(Number deploymentDurationInMinutes)	Total amount of time for a deployment to last.
CfnDeploymentStrategy.Builder	description(String description)	A description of the deployment strategy.
CfnDeploymentStrategy.Builder	finalBakeTimeInMinutes(Number finalBakeTimeInMinutes)	Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete.
CfnDeploymentStrategy.Builder	growthFactor(Number growthFactor)	The percentage of targets to receive a deployed configuration during each interval.
CfnDeploymentStrategy.Builder	growthType(String growthType)	The algorithm used to define how percentage grows over time.
CfnDeploymentStrategy.Builder	name(String name)	A name for the deployment strategy.
CfnDeploymentStrategy.Builder	replicateTo(String replicateTo)	Save the deployment strategy to a Systems Manager (SSM) document.
CfnDeploymentStrategy.Builder	tags(List<? extends CfnTag> tags)	Assigns metadata to an AWS AppConfig resource.

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

deploymentDurationInMinutes

@Stability(Stable)
public CfnDeploymentStrategy.Builder deploymentDurationInMinutes(Number deploymentDurationInMinutes)

Total amount of time for a deployment to last.

Parameters:

deploymentDurationInMinutes - Total amount of time for a deployment to last. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-deploymentdurationinminutes

growthFactor

@Stability(Stable)
public CfnDeploymentStrategy.Builder growthFactor(Number growthFactor)

The percentage of targets to receive a deployed configuration during each interval.

Parameters:

growthFactor - The percentage of targets to receive a deployed configuration during each interval. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-growthfactor

name

@Stability(Stable)
public CfnDeploymentStrategy.Builder name(String name)

A name for the deployment strategy.

Parameters:

name - A name for the deployment strategy. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-name

replicateTo

@Stability(Stable)
public CfnDeploymentStrategy.Builder replicateTo(String replicateTo)

Save the deployment strategy to a Systems Manager (SSM) document.

Parameters:

replicateTo - Save the deployment strategy to a Systems Manager (SSM) document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-replicateto

description

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

A description of the deployment strategy.

Parameters:

description - A description of the deployment strategy. This parameter is required.

Returns:

this

See Also:

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

finalBakeTimeInMinutes

@Stability(Stable)
public CfnDeploymentStrategy.Builder finalBakeTimeInMinutes(Number finalBakeTimeInMinutes)

Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete.

If an alarm is triggered during this time, AWS AppConfig rolls back the deployment. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AWS AppConfig User Guide .

Parameters:

finalBakeTimeInMinutes - Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-finalbaketimeinminutes

growthType

@Stability(Stable)
public CfnDeploymentStrategy.Builder growthType(String growthType)

The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:.

Linear : For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage . For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

Exponential : For this type, AWS AppConfig processes the deployment exponentially using the following formula: G*(2^N) . In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

Parameters:

growthType - The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-growthtype

tags

@Stability(Stable)
public CfnDeploymentStrategy.Builder tags(List<? extends CfnTag> tags)

Assigns metadata to an AWS AppConfig resource.

Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.

Parameters:

tags - Assigns metadata to an AWS AppConfig resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deploymentstrategy.html#cfn-appconfig-deploymentstrategy-tags

build

@Stability(Stable)
public CfnDeploymentStrategy build()

Specified by:

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

Returns:

a newly built instance of CfnDeploymentStrategy.