Class: Aws::AppConfig::Types::UpdateDeploymentStrategyRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb

Overview

Note:

When making an API call, you may pass UpdateDeploymentStrategyRequest data as a hash:

{
  deployment_strategy_id: "DeploymentStrategyId", # required
  description: "Description",
  deployment_duration_in_minutes: 1,
  final_bake_time_in_minutes: 1,
  growth_factor: 1.0,
  growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_duration_in_minutesInteger

Total amount of time for a deployment to last.

Returns:

  • (Integer)


1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1937

class UpdateDeploymentStrategyRequest < Struct.new(
  :deployment_strategy_id,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_strategy_idString

The deployment strategy ID.

Returns:

  • (String)


1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1937

class UpdateDeploymentStrategyRequest < Struct.new(
  :deployment_strategy_id,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the deployment strategy.

Returns:

  • (String)


1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1937

class UpdateDeploymentStrategyRequest < Struct.new(
  :deployment_strategy_id,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type)
  SENSITIVE = []
  include Aws::Structure
end

#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)


1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1937

class UpdateDeploymentStrategyRequest < Struct.new(
  :deployment_strategy_id,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type)
  SENSITIVE = []
  include Aws::Structure
end

#growth_factorFloat

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

Returns:

  • (Float)


1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1937

class UpdateDeploymentStrategyRequest < Struct.new(
  :deployment_strategy_id,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type)
  SENSITIVE = []
  include Aws::Structure
end

#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 increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed 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.

Returns:

  • (String)


1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1937

class UpdateDeploymentStrategyRequest < Struct.new(
  :deployment_strategy_id,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type)
  SENSITIVE = []
  include Aws::Structure
end