Package software.amazon.awscdk.services.appconfig

Class CfnDeploymentStrategyProps.Builder

java.lang.Object
software.amazon.awscdk.services.appconfig.CfnDeploymentStrategyProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeploymentStrategyProps>
Enclosing interface:
CfnDeploymentStrategyProps
@Stability(Stable) public static final class CfnDeploymentStrategyProps.Builder extends Object implements software.amazon.jsii.Builder<CfnDeploymentStrategyProps>
A builder for CfnDeploymentStrategyProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • deploymentDurationInMinutes

      @Stability(Stable) public CfnDeploymentStrategyProps.Builder deploymentDurationInMinutes(Number deploymentDurationInMinutes)
      Sets the value of CfnDeploymentStrategyProps.getDeploymentDurationInMinutes()
      Parameters:
      deploymentDurationInMinutes - Total amount of time for a deployment to last. This parameter is required.
      Returns:
      this

    • growthFactor

      @Stability(Stable) public CfnDeploymentStrategyProps.Builder growthFactor(Number growthFactor)
      Sets the value of CfnDeploymentStrategyProps.getGrowthFactor()
      Parameters:
      growthFactor - The percentage of targets to receive a deployed configuration during each interval. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnDeploymentStrategyProps.Builder name(String name)
      Sets the value of CfnDeploymentStrategyProps.getName()
      Parameters:
      name - A name for the deployment strategy. This parameter is required.
      Returns:
      this

    • replicateTo

      @Stability(Stable) public CfnDeploymentStrategyProps.Builder replicateTo(String replicateTo)
      Sets the value of CfnDeploymentStrategyProps.getReplicateTo()
      Parameters:
      replicateTo - Save the deployment strategy to a Systems Manager (SSM) document. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnDeploymentStrategyProps.Builder description(String description)
      Sets the value of CfnDeploymentStrategyProps.getDescription()
      Parameters:
      description - A description of the deployment strategy.
      Returns:
      this

    • finalBakeTimeInMinutes

      @Stability(Stable) public CfnDeploymentStrategyProps.Builder finalBakeTimeInMinutes(Number finalBakeTimeInMinutes)
      Sets the value of CfnDeploymentStrategyProps.getFinalBakeTimeInMinutes()
      Parameters:
      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. 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 .
      Returns:
      this

    • growthType

      @Stability(Stable) public CfnDeploymentStrategyProps.Builder growthType(String growthType)
      Sets the value of CfnDeploymentStrategyProps.getGrowthType()
      Parameters:
      growthType - 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.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnDeploymentStrategyProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnDeploymentStrategyProps.getTags()
      Parameters:
      tags - 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.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDeploymentStrategyProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDeploymentStrategyProps>
      Returns:
      a new instance of CfnDeploymentStrategyProps
      Throws:
      NullPointerException - if any required attribute was not provided