Package software.amazon.awscdk.services.appconfig

Interface CfnDeploymentStrategyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentStrategyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:23.304Z")
@Stability(Stable)
public interface CfnDeploymentStrategyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDeploymentStrategy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appconfig.*;
 CfnDeploymentStrategyProps cfnDeploymentStrategyProps = CfnDeploymentStrategyProps.builder()
         .deploymentDurationInMinutes(123)
         .growthFactor(123)
         .name("name")
         .replicateTo("replicateTo")
         // the properties below are optional
         .description("description")
         .finalBakeTimeInMinutes(123)
         .growthType("growthType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeploymentStrategyProps.Builder	A builder for CfnDeploymentStrategyProps
static final class	CfnDeploymentStrategyProps.Jsii$Proxy	An implementation for CfnDeploymentStrategyProps

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentStrategyProps.Builder	builder()
Number	getDeploymentDurationInMinutes()	Total amount of time for a deployment to last.
default String	getDescription()	A description of the deployment strategy.
default Number	getFinalBakeTimeInMinutes()	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.
Number	getGrowthFactor()	The percentage of targets to receive a deployed configuration during each interval.
default String	getGrowthType()	The algorithm used to define how percentage grows over time.
String	getName()	A name for the deployment strategy.
String	getReplicateTo()	Save the deployment strategy to a Systems Manager (SSM) document.
default List<CfnTag>	getTags()	Assigns metadata to an AWS AppConfig resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeploymentDurationInMinutes

@Stability(Stable)
@NotNull
Number getDeploymentDurationInMinutes()

Total amount of time for a deployment to last.

See Also:

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

getGrowthFactor

@Stability(Stable)
@NotNull
Number getGrowthFactor()

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

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

A name for the deployment strategy.

See Also:

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

getReplicateTo

@Stability(Stable)
@NotNull
String getReplicateTo()

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

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the deployment strategy.

See Also:

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

getFinalBakeTimeInMinutes

@Stability(Stable)
@Nullable
default Number getFinalBakeTimeInMinutes()

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 .

See Also:

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

getGrowthType

@Stability(Stable)
@Nullable
default String getGrowthType()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

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

builder

@Stability(Stable)
static CfnDeploymentStrategyProps.Builder builder()

Returns:

a CfnDeploymentStrategyProps.Builder of CfnDeploymentStrategyProps