Package software.amazon.awscdk.services.appconfig

Class CfnDeploymentStrategy

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.459Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDeploymentDurationInMinutes

      @Stability(Stable) @NotNull public Number getDeploymentDurationInMinutes()
      Total amount of time for a deployment to last.

    • setDeploymentDurationInMinutes

      @Stability(Stable) public void setDeploymentDurationInMinutes(@NotNull Number value)
      Total amount of time for a deployment to last.

    • getGrowthFactor

      @Stability(Stable) @NotNull public Number getGrowthFactor()
      The percentage of targets to receive a deployed configuration during each interval.

    • setGrowthFactor

      @Stability(Stable) public void setGrowthFactor(@NotNull Number value)
      The percentage of targets to receive a deployed configuration during each interval.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A name for the deployment strategy.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A name for the deployment strategy.

    • getReplicateTo

      @Stability(Stable) @NotNull public String getReplicateTo()
      Save the deployment strategy to a Systems Manager (SSM) document.

    • setReplicateTo

      @Stability(Stable) public void setReplicateTo(@NotNull String value)
      Save the deployment strategy to a Systems Manager (SSM) document.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the deployment strategy.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the deployment strategy.

    • getFinalBakeTimeInMinutes

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setFinalBakeTimeInMinutes(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setGrowthType(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setTags(@Nullable 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.