class RolloutStrategy
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppConfig.RolloutStrategy |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#RolloutStrategy |
Java | software.amazon.awscdk.services.appconfig.RolloutStrategy |
Python | aws_cdk.aws_appconfig.RolloutStrategy |
TypeScript (source) | aws-cdk-lib » aws_appconfig » RolloutStrategy |
Defines the rollout strategy for a deployment strategy and includes the growth factor, deployment duration, growth type, and optionally final bake time.
Example
new appconfig.DeploymentStrategy(this, 'MyDeploymentStrategy', {
rolloutStrategy: appconfig.RolloutStrategy.linear({
growthFactor: 20,
deploymentDuration: Duration.minutes(30),
finalBakeTime: Duration.minutes(30),
}),
});
Initializer
new RolloutStrategy()
Properties
Name | Type | Description |
---|---|---|
deployment | Duration | The deployment duration of the rollout strategy. |
growth | number | The growth factor of the rollout strategy. |
final | Duration | The final bake time of the deployment strategy. |
growth | Growth | The growth type of the rollout strategy. |
static ALL_AT_ONCE | Rollout | Quick. |
static CANARY_10_PERCENT_20_MINUTES | Rollout | AWS Recommended. |
static LINEAR_20_PERCENT_EVERY_6_MINUTES | Rollout | AWS Recommended. |
static LINEAR_50_PERCENT_EVERY_30_SECONDS | Rollout | Testing/Demonstration. |
deploymentDuration
Type:
Duration
The deployment duration of the rollout strategy.
growthFactor
Type:
number
The growth factor of the rollout strategy.
finalBakeTime?
Type:
Duration
(optional)
The final bake time of the deployment strategy.
growthType?
Type:
Growth
(optional)
The growth type of the rollout strategy.
static ALL_AT_ONCE
Type:
Rollout
Quick.
This strategy deploys the configuration to all targets immediately.
static CANARY_10_PERCENT_20_MINUTES
Type:
Rollout
AWS Recommended.
This strategy processes the deployment exponentially using a 10% growth factor over 20 minutes. AWS AppConfig recommends using this strategy for production deployments because it aligns with AWS best practices for configuration deployments.
static LINEAR_20_PERCENT_EVERY_6_MINUTES
Type:
Rollout
AWS Recommended.
This strategy deploys the configuration to 20% of all targets every six minutes for a 30 minute deployment. AWS AppConfig recommends using this strategy for production deployments because it aligns with AWS best practices for configuration deployments.
static LINEAR_50_PERCENT_EVERY_30_SECONDS
Type:
Rollout
Testing/Demonstration.
This strategy deploys the configuration to half of all targets every 30 seconds for a one-minute deployment. AWS AppConfig recommends using this strategy only for testing or demonstration purposes because it has a short duration and bake time.
Methods
Name | Description |
---|---|
static exponential(props) | Build your own exponential rollout strategy. |
static linear(props) | Build your own linear rollout strategy. |
static exponential(props)
public static exponential(props: RolloutStrategyProps): RolloutStrategy
Parameters
- props
Rollout
Strategy Props
Returns
Build your own exponential rollout strategy.
static linear(props)
public static linear(props: RolloutStrategyProps): RolloutStrategy
Parameters
- props
Rollout
Strategy Props
Returns
Build your own linear rollout strategy.