Class: AWSCDK::AppConfig::CfnDeploymentStrategyProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_config/cfn_deployment_strategy_props.rb

Overview

Properties for defining a CfnDeploymentStrategy.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(deployment_duration_in_minutes:, growth_factor:, name:, replicate_to:, description: nil, final_bake_time_in_minutes: nil, growth_type: nil, tags: nil) ⇒ CfnDeploymentStrategyProps

Returns a new instance of CfnDeploymentStrategyProps.

Parameters:

  • deployment_duration_in_minutes (Numeric) —

    Total amount of time for a deployment to last.

  • growth_factor (Numeric) —

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

  • name (String) —

    A name for the deployment strategy.

  • replicate_to (String) —

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

  • description (String, nil) (defaults to: nil) —

    A description of the deployment strategy.

  • final_bake_time_in_minutes (Numeric, nil) (defaults to: nil) —

    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.

  • growth_type (String, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Assigns metadata to an AWS AppConfig resource.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 17

def initialize(deployment_duration_in_minutes:, growth_factor:, name:, replicate_to:, description: nil, final_bake_time_in_minutes: nil, growth_type: nil, tags: nil)
  @deployment_duration_in_minutes = deployment_duration_in_minutes
  Jsii::Type.check_type(@deployment_duration_in_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "deploymentDurationInMinutes")
  @growth_factor = growth_factor
  Jsii::Type.check_type(@growth_factor, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "growthFactor")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @replicate_to = replicate_to
  Jsii::Type.check_type(@replicate_to, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicateTo")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @final_bake_time_in_minutes = final_bake_time_in_minutes
  Jsii::Type.check_type(@final_bake_time_in_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "finalBakeTimeInMinutes") unless @final_bake_time_in_minutes.nil?
  @growth_type = growth_type
  Jsii::Type.check_type(@growth_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "growthType") unless @growth_type.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#deployment_duration_in_minutes ⇒ Numeric (readonly)

Total amount of time for a deployment to last.

Returns:

  • (Numeric)

See Also:



40
41
42
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 40

def deployment_duration_in_minutes
  @deployment_duration_in_minutes
end

#description ⇒ String? (readonly)

A description of the deployment strategy.

Returns:

  • (String, nil)

See Also:



60
61
62
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 60

def description
  @description
end

#final_bake_time_in_minutes ⇒ Numeric? (readonly)

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:

  • (Numeric, nil)

See Also:



67
68
69
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 67

def final_bake_time_in_minutes
  @final_bake_time_in_minutes
end

#growth_factor ⇒ Numeric (readonly)

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

Returns:

  • (Numeric)

See Also:



45
46
47
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 45

def growth_factor
  @growth_factor
end

#growth_type ⇒ String? (readonly)

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:

  • (String, nil)

See Also:



84
85
86
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 84

def growth_type
  @growth_type
end

#name ⇒ String (readonly)

A name for the deployment strategy.

Returns:

  • (String)

See Also:



50
51
52
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 50

def name
  @name
end

#replicate_to ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



55
56
57
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 55

def replicate_to
  @replicate_to
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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:

See Also:



91
92
93
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 91

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 93

def self.jsii_properties
  {
    :deployment_duration_in_minutes => "deploymentDurationInMinutes",
    :growth_factor => "growthFactor",
    :name => "name",
    :replicate_to => "replicateTo",
    :description => "description",
    :final_bake_time_in_minutes => "finalBakeTimeInMinutes",
    :growth_type => "growthType",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'app_config/cfn_deployment_strategy_props.rb', line 106

def to_jsii
  result = {}
  result.merge!({
    "deploymentDurationInMinutes" => @deployment_duration_in_minutes,
    "growthFactor" => @growth_factor,
    "name" => @name,
    "replicateTo" => @replicate_to,
    "description" => @description,
    "finalBakeTimeInMinutes" => @final_bake_time_in_minutes,
    "growthType" => @growth_type,
    "tags" => @tags,
  })
  result.compact
end