Interface ICfnDeploymentStrategyProps
Properties for defining a CfnDeploymentStrategy
.
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnDeploymentStrategyProps
Syntax (vb)
Public Interface ICfnDeploymentStrategyProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppConfig;
var cfnDeploymentStrategyProps = new CfnDeploymentStrategyProps {
DeploymentDurationInMinutes = 123,
GrowthFactor = 123,
Name = "name",
ReplicateTo = "replicateTo",
// the properties below are optional
Description = "description",
FinalBakeTimeInMinutes = 123,
GrowthType = "growthType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
Deployment |
Total amount of time for a deployment to last. |
Description | A description of the deployment strategy. |
Final |
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. |
Growth |
The percentage of targets to receive a deployed configuration during each interval. |
Growth |
The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:. |
Name | A name for the deployment strategy. |
Replicate |
Save the deployment strategy to a Systems Manager (SSM) document. |
Tags | Assigns metadata to an AWS AppConfig resource. |
Properties
DeploymentDurationInMinutes
Total amount of time for a deployment to last.
double DeploymentDurationInMinutes { get; }
Property Value
System.
Remarks
Description
A description of the deployment strategy.
virtual string Description { get; }
Property Value
System.
Remarks
FinalBakeTimeInMinutes
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.
virtual Nullable<double> FinalBakeTimeInMinutes { get; }
Property Value
System.
Remarks
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 .
GrowthFactor
The percentage of targets to receive a deployed configuration during each interval.
double GrowthFactor { get; }
Property Value
System.
Remarks
GrowthType
The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:.
virtual string GrowthType { get; }
Property Value
System.
Remarks
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.
Name
A name for the deployment strategy.
string Name { get; }
Property Value
System.
Remarks
ReplicateTo
Save the deployment strategy to a Systems Manager (SSM) document.
string ReplicateTo { get; }
Property Value
System.
Remarks
Tags
Assigns metadata to an AWS AppConfig resource.
virtual ICfnTag[] Tags { get; }
Property Value
ICfn
Remarks
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.