AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppConfig::Types::CreateDeploymentStrategyRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDeploymentStrategyRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "Name", # required
  description: "Description",
  deployment_duration_in_minutes: 1, # required
  final_bake_time_in_minutes: 1,
  growth_factor: 1.0, # required
  growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
  replicate_to: "NONE", # required, accepts NONE, SSM_DOCUMENT
  tags: {
    "TagKey" => "TagValue",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_duration_in_minutesInteger

Total amount of time for a deployment to last.

Returns:

  • (Integer)

    Total amount of time for a deployment to last.

#descriptionString

A description of the deployment strategy.

Returns:

  • (String)

    A description of the deployment strategy.

#final_bake_time_in_minutesInteger

The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

Returns:

  • (Integer)

    The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

#growth_factorFloat

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

Returns:

  • (Float)

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

#growth_typeString

The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:

Linear: For this type, 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, 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.

Possible values:

  • LINEAR
  • EXPONENTIAL

Returns:

  • (String)

    The algorithm used to define how percentage grows over time.

#nameString

A name for the deployment strategy.

Returns:

  • (String)

    A name for the deployment strategy.

#replicate_toString

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

Possible values:

  • NONE
  • SSM_DOCUMENT

Returns:

  • (String)

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

#tagsHash<String,String>

Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Returns:

  • (Hash<String,String>)

    Metadata to assign to the deployment strategy.