1.204.0

interface CfnDeploymentStrategyProps

LanguageType name
.NETAmazon.CDK.AWS.AppConfig.CfnDeploymentStrategyProps
Javasoftware.amazon.awscdk.services.appconfig.CfnDeploymentStrategyProps
Pythonaws_cdk.aws_appconfig.CfnDeploymentStrategyProps
TypeScript @aws-cdk/aws-appconfig » CfnDeploymentStrategyProps

Properties for defining a CfnDeploymentStrategy.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appconfig from '@aws-cdk/aws-appconfig';
const cfnDeploymentStrategyProps: appconfig.CfnDeploymentStrategyProps = {
  deploymentDurationInMinutes: 123,
  growthFactor: 123,
  name: 'name',
  replicateTo: 'replicateTo',

  // the properties below are optional
  description: 'description',
  finalBakeTimeInMinutes: 123,
  growthType: 'growthType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
deploymentDurationInMinutesnumberTotal amount of time for a deployment to last.
growthFactornumberThe percentage of targets to receive a deployed configuration during each interval.
namestringA name for the deployment strategy.
replicateTostringSave the deployment strategy to a Systems Manager (SSM) document.
description?stringA description of the deployment strategy.
finalBakeTimeInMinutes?numberSpecifies 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.
growthType?stringThe algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:.
tags?TagsProperty[]Assigns metadata to an AWS AppConfig resource.

deploymentDurationInMinutes

Type: number

Total amount of time for a deployment to last.

growthFactor

Type: number

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

name

Type: string

A name for the deployment strategy.

replicateTo

Type: string

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

description?

Type: string (optional)

A description of the deployment strategy.

finalBakeTimeInMinutes?

Type: number (optional)

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 .

growthType?

Type: string (optional)

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.

tags?

Type: TagsProperty[] (optional)

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.

← PreviousNext →