@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
date="2022-09-28T18:14:32.233Z")
public class CfnDeploymentStrategy
extends CfnResource
implements IInspectable
The AWS::AppConfig::DeploymentStrategy resource creates an AWS AppConfig deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
AWS AppConfig requires that you create resources and deploy a configuration in the following order:
For more information, see AWS AppConfig in the AWS AppConfig User Guide .
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.*;
CfnDeploymentStrategy cfnDeploymentStrategy = CfnDeploymentStrategy.Builder.create(this, "MyCfnDeploymentStrategy")
.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();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnDeploymentStrategy.Builder
A fluent builder for
CfnDeploymentStrategy. |
static interface |
CfnDeploymentStrategy.TagsProperty
Metadata to assign to the deployment strategy.
|
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnDeploymentStrategy(Construct scope,
java.lang.String id,
CfnDeploymentStrategyProps props)
Create a new `AWS::AppConfig::DeploymentStrategy`.
|
protected |
CfnDeploymentStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDeploymentStrategy(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Number |
getDeploymentDurationInMinutes()
Total amount of time for a deployment to last.
|
java.lang.String |
getDescription()
A description of the deployment strategy.
|
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.
|
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.
|
java.util.List<CfnDeploymentStrategy.TagsProperty> |
getTags()
Assigns metadata to an AWS AppConfig resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDeploymentDurationInMinutes(java.lang.Number value)
Total amount of time for a deployment to last.
|
void |
setDescription(java.lang.String value)
A description of the deployment strategy.
|
void |
setFinalBakeTimeInMinutes(java.lang.Number value)
The amount of time AWS AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
|
void |
setGrowthFactor(java.lang.Number value)
The percentage of targets to receive a deployed configuration during each interval.
|
void |
setGrowthType(java.lang.String value)
The algorithm used to define how percentage grows over time.
|
void |
setName(java.lang.String value)
A name for the deployment strategy.
|
void |
setReplicateTo(java.lang.String value)
Save the deployment strategy to a Systems Manager (SSM) document.
|
void |
setTags(java.util.List<CfnDeploymentStrategy.TagsProperty> value)
Assigns metadata to an AWS AppConfig resource.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDeploymentStrategy(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDeploymentStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDeploymentStrategy(Construct scope, java.lang.String id, CfnDeploymentStrategyProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic java.lang.Number getDeploymentDurationInMinutes()
public void setDeploymentDurationInMinutes(java.lang.Number value)
public java.lang.Number getGrowthFactor()
public void setGrowthFactor(java.lang.Number value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getReplicateTo()
public void setReplicateTo(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Number getFinalBakeTimeInMinutes()
public void setFinalBakeTimeInMinutes(java.lang.Number value)
public java.lang.String getGrowthType()
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.
public void setGrowthType(java.lang.String value)
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.
public java.util.List<CfnDeploymentStrategy.TagsProperty> getTags()
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.
public void setTags(java.util.List<CfnDeploymentStrategy.TagsProperty> value)
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.