Class: AWSCDK::AppConfig::RolloutStrategyProps

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

Overview

Properties for the Rollout Strategy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(deployment_duration:, growth_factor:, final_bake_time: nil) ⇒ RolloutStrategyProps

Returns a new instance of RolloutStrategyProps.

Parameters:

  • deployment_duration (AWSCDK::Duration) —

    The deployment duration of the deployment strategy.

  • growth_factor (Numeric) —

    The growth factor of the deployment strategy.

  • final_bake_time (AWSCDK::Duration, nil) (defaults to: nil) —

    The final bake time of the deployment strategy.



10
11
12
13
14
15
16
17
 
# File 'app_config/rollout_strategy_props.rb', line 10

def initialize(deployment_duration:, growth_factor:, final_bake_time: nil)
  @deployment_duration = deployment_duration
  Jsii::Type.check_type(@deployment_duration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "deploymentDuration")
  @growth_factor = growth_factor
  Jsii::Type.check_type(@growth_factor, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "growthFactor")
  @final_bake_time = final_bake_time
  Jsii::Type.check_type(@final_bake_time, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "finalBakeTime") unless @final_bake_time.nil?
end

Instance Attribute Details

#deployment_duration ⇒ AWSCDK::Duration (readonly)

The deployment duration of the deployment strategy.

This defines the total amount of time for a deployment to last.

Returns:



25
26
27
 
# File 'app_config/rollout_strategy_props.rb', line 25

def deployment_duration
  @deployment_duration
end

#final_bake_time ⇒ AWSCDK::Duration? (readonly)

Note:

Default: Duration.minutes(0)

The final bake time of the deployment strategy.

This setting 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.

Returns:



44
45
46
 
# File 'app_config/rollout_strategy_props.rb', line 44

def final_bake_time
  @final_bake_time
end

#growth_factor ⇒ Numeric (readonly)

The growth factor of the deployment strategy.

This defines the percentage of targets to receive a deployed configuration during each interval.

Returns:

  • (Numeric) 


33
34
35
 
# File 'app_config/rollout_strategy_props.rb', line 33

def growth_factor
  @growth_factor
end

Class Method Details

.jsii_properties ⇒ Object 



46
47
48
49
50
51
52
 
# File 'app_config/rollout_strategy_props.rb', line 46

def self.jsii_properties
  {
    :deployment_duration => "deploymentDuration",
    :growth_factor => "growthFactor",
    :final_bake_time => "finalBakeTime",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'app_config/rollout_strategy_props.rb', line 54

def to_jsii
  result = {}
  result.merge!({
    "deploymentDuration" => @deployment_duration,
    "growthFactor" => @growth_factor,
    "finalBakeTime" => @final_bake_time,
  })
  result.compact
end