Package software.amazon.awscdk.services.appconfig

Class CfnDeploymentStrategy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.appconfig.CfnDeploymentStrategy
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:38.241Z") @Stability(Stable) public class CfnDeploymentStrategy extends CfnResource implements IInspectable, ITaggableV2
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
  • Choose a pre-defined deployment strategy or create your own
  • 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(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnDeploymentStrategyProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The deployment strategy ID.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • 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.

    • 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.

    • getGrowthType

      @Stability(Stable) @Nullable public String getGrowthType()
      The algorithm used to define how percentage grows over time.

      AWS AppConfig supports the following growth types:.

    • 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:.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Assigns metadata to an AWS AppConfig resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Assigns metadata to an AWS AppConfig resource.