software.amazon.awscdk.services.appconfig

Class CfnDeploymentStrategy

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.appconfig.CfnDeploymentStrategy

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:56.410Z")
public class CfnDeploymentStrategy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppConfig::DeploymentStrategy`.

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:

• Create an application
• Create an environment
• Create a configuration profile
• Create a deployment strategy
• Deploy the configuration

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();
 

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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)

Method Summary

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() 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.
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) 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.
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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDeploymentStrategy

protected CfnDeploymentStrategy(software.amazon.jsii.JsiiObjectRef objRef)

CfnDeploymentStrategy

protected CfnDeploymentStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDeploymentStrategy

public CfnDeploymentStrategy(Construct scope,
                             java.lang.String id,
                             CfnDeploymentStrategyProps props)

Create a new `AWS::AppConfig::DeploymentStrategy`.

Parameters:

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.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDeploymentDurationInMinutes

public java.lang.Number getDeploymentDurationInMinutes()

Total amount of time for a deployment to last.

setDeploymentDurationInMinutes

public void setDeploymentDurationInMinutes(java.lang.Number value)

Total amount of time for a deployment to last.

getGrowthFactor

public java.lang.Number getGrowthFactor()

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

setGrowthFactor

public void setGrowthFactor(java.lang.Number value)

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

getName

public java.lang.String getName()

A name for the deployment strategy.

setName

public void setName(java.lang.String value)

A name for the deployment strategy.

getReplicateTo

public java.lang.String getReplicateTo()

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

setReplicateTo

public void setReplicateTo(java.lang.String value)

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

getDescription

public java.lang.String getDescription()

A description of the deployment strategy.

setDescription

public void setDescription(java.lang.String value)

A description of the deployment strategy.

getFinalBakeTimeInMinutes

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

setFinalBakeTimeInMinutes

public void setFinalBakeTimeInMinutes(java.lang.Number value)

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 .

getGrowthType

public 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.

setGrowthType

public void setGrowthType(java.lang.String value)

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

public 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.

setTags

public void setTags(java.util.List<CfnDeploymentStrategy.TagsProperty> value)

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.