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

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

Overview

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)


573
574
575
576
577
578
579
580
581
582
583
584
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 573

class CreateDeploymentStrategyRequest < Struct.new(
  :name,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type,
  :replicate_to,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the deployment strategy.

Returns:

  • (String)


573
574
575
576
577
578
579
580
581
582
583
584
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 573

class CreateDeploymentStrategyRequest < Struct.new(
  :name,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type,
  :replicate_to,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#final_bake_time_in_minutesInteger

Specifies the amount of time 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, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

Returns:

  • (Integer)


573
574
575
576
577
578
579
580
581
582
583
584
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 573

class CreateDeploymentStrategyRequest < Struct.new(
  :name,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type,
  :replicate_to,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#growth_factorFloat

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

Returns:

  • (Float)


573
574
575
576
577
578
579
580
581
582
583
584
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 573

class CreateDeploymentStrategyRequest < Struct.new(
  :name,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type,
  :replicate_to,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#growth_typeString

The algorithm used to define how percentage grows over time. 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.

Returns:

  • (String)


573
574
575
576
577
578
579
580
581
582
583
584
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 573

class CreateDeploymentStrategyRequest < Struct.new(
  :name,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type,
  :replicate_to,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A name for the deployment strategy.

Returns:

  • (String)


573
574
575
576
577
578
579
580
581
582
583
584
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 573

class CreateDeploymentStrategyRequest < Struct.new(
  :name,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type,
  :replicate_to,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#replicate_toString

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

Returns:

  • (String)


573
574
575
576
577
578
579
580
581
582
583
584
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 573

class CreateDeploymentStrategyRequest < Struct.new(
  :name,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type,
  :replicate_to,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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


573
574
575
576
577
578
579
580
581
582
583
584
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 573

class CreateDeploymentStrategyRequest < Struct.new(
  :name,
  :description,
  :deployment_duration_in_minutes,
  :final_bake_time_in_minutes,
  :growth_factor,
  :growth_type,
  :replicate_to,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end