Class: AWSCDK::AppConfig::DeploymentStrategyProps

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

Overview

Properties for DeploymentStrategy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rollout_strategy:, deployment_strategy_name: nil, description: nil) ⇒ DeploymentStrategyProps

Returns a new instance of DeploymentStrategyProps.

Parameters:

  • rollout_strategy (AWSCDK::AppConfig::RolloutStrategy) —

    The rollout strategy for the deployment strategy.

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

    A name for the deployment strategy.

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

    A description of the deployment strategy.



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

def initialize(rollout_strategy:, deployment_strategy_name: nil, description: nil)
  @rollout_strategy = rollout_strategy
  Jsii::Type.check_type(@rollout_strategy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLlJvbGxvdXRTdHJhdGVneSJ9")), "rolloutStrategy")
  @deployment_strategy_name = deployment_strategy_name
  Jsii::Type.check_type(@deployment_strategy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deploymentStrategyName") unless @deployment_strategy_name.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#deployment_strategy_name ⇒ String? (readonly)

Note:

Default: - A name is generated.

A name for the deployment strategy.

Returns:

  • (String, nil) 


31
32
33
 
# File 'app_config/deployment_strategy_props.rb', line 31

def deployment_strategy_name
  @deployment_strategy_name
end

#description ⇒ String? (readonly)

Note:

Default: - No description.

A description of the deployment strategy.

Returns:

  • (String, nil) 


36
37
38
 
# File 'app_config/deployment_strategy_props.rb', line 36

def description
  @description
end

#rollout_strategy ⇒ AWSCDK::AppConfig::RolloutStrategy (readonly)

The rollout strategy for the deployment strategy.

You can use predefined deployment strategies, such as RolloutStrategy.ALL_AT_ONCE, RolloutStrategy.LINEAR_50_PERCENT_EVERY_30_SECONDS, or RolloutStrategy.CANARY_10_PERCENT_20_MINUTES.

Returns:



26
27
28
 
# File 'app_config/deployment_strategy_props.rb', line 26

def rollout_strategy
  @rollout_strategy
end

Class Method Details

.jsii_properties ⇒ Object 



38
39
40
41
42
43
44
 
# File 'app_config/deployment_strategy_props.rb', line 38

def self.jsii_properties
  {
    :rollout_strategy => "rolloutStrategy",
    :deployment_strategy_name => "deploymentStrategyName",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "rolloutStrategy" => @rollout_strategy,
    "deploymentStrategyName" => @deployment_strategy_name,
    "description" => @description,
  })
  result.compact
end