software.amazon.awscdk.services.appconfig

Interface CfnDeploymentStrategyProps

All Known Implementing Classes:

CfnDeploymentStrategyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:03.454Z")
public interface CfnDeploymentStrategyProps

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(TagsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDeploymentStrategyProps.Builder	builder()
java.lang.Number	getDeploymentDurationInMinutes() Total amount of time for a deployment to last.
default java.lang.String	getDescription() A description of the deployment strategy.
default java.lang.Number	getFinalBakeTimeInMinutes() The amount of time AWS AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
java.lang.Number	getGrowthFactor() The percentage of targets to receive a deployed configuration during each interval.
default java.lang.String	getGrowthType() The algorithm used to define how percentage grows over time.
java.lang.String	getName() A name for the deployment strategy.
java.lang.String	getReplicateTo() Save the deployment strategy to a Systems Manager (SSM) document.
default java.util.List<CfnDeploymentStrategy.TagsProperty>	getTags() Assigns metadata to an AWS AppConfig resource.

Method Detail

getDeploymentDurationInMinutes

java.lang.Number getDeploymentDurationInMinutes()

Total amount of time for a deployment to last.

getGrowthFactor

java.lang.Number getGrowthFactor()

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

getName

java.lang.String getName()

A name for the deployment strategy.

getReplicateTo

java.lang.String getReplicateTo()

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

getDescription

default java.lang.String getDescription()

A description of the deployment strategy.

getFinalBakeTimeInMinutes

default java.lang.Number getFinalBakeTimeInMinutes()

The amount of time AWS AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

getGrowthType

default java.lang.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.

getTags

default java.util.List<CfnDeploymentStrategy.TagsProperty> 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.

builder

static CfnDeploymentStrategyProps.Builder builder()

Returns:

a CfnDeploymentStrategyProps.Builder of CfnDeploymentStrategyProps