Class CfnDeploymentStrategy
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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 ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDeploymentStrategy
.static interface
Metadata to assign to the deployment strategy.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnDeploymentStrategy
(Construct scope, String id, CfnDeploymentStrategyProps props) Create a newAWS::AppConfig::DeploymentStrategy
.protected
CfnDeploymentStrategy
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDeploymentStrategy
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionTotal amount of time for a deployment to last.A description of the deployment strategy.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.The percentage of targets to receive a deployed configuration during each interval.The algorithm used to define how percentage grows over time.getName()
A name for the deployment strategy.Save the deployment strategy to a Systems Manager (SSM) document.getTags()
Assigns metadata to an AWS AppConfig resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Total amount of time for a deployment to last.void
setDescription
(String value) A description of the deployment strategy.void
setFinalBakeTimeInMinutes
(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
(Number value) The percentage of targets to receive a deployed configuration during each interval.void
setGrowthType
(String value) The algorithm used to define how percentage grows over time.void
A name for the deployment strategy.void
setReplicateTo
(String value) Save the deployment strategy to a Systems Manager (SSM) document.void
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 software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDeploymentStrategy
protected CfnDeploymentStrategy(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDeploymentStrategy
protected CfnDeploymentStrategy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDeploymentStrategy
@Stability(Stable) public CfnDeploymentStrategy(@NotNull Construct scope, @NotNull String id, @NotNull CfnDeploymentStrategyProps props) Create a newAWS::AppConfig::DeploymentStrategy
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDeploymentDurationInMinutes
Total amount of time for a deployment to last. -
setDeploymentDurationInMinutes
Total amount of time for a deployment to last. -
getGrowthFactor
The percentage of targets to receive a deployed configuration during each interval. -
setGrowthFactor
The percentage of targets to receive a deployed configuration during each interval. -
getName
A name for the deployment strategy. -
setName
A name for the deployment strategy. -
getReplicateTo
Save the deployment strategy to a Systems Manager (SSM) document. -
setReplicateTo
Save the deployment strategy to a Systems Manager (SSM) document. -
getDescription
A description of the deployment strategy. -
setDescription
A description of the deployment strategy. -
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
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
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 aStep 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 andN
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
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 aStep 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 andN
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
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
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.
-