Class: AWSCDK::ElasticLoadBalancingv2::AddApplicationActionProps

Inherits:
AddRuleProps
  • Object
show all
Defined in:
elastic_load_balancingv2/add_application_action_props.rb

Overview

Properties for adding a new action to a listener.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(conditions: nil, priority: nil, action:, remove_suffix: nil) ⇒ AddApplicationActionProps

Returns a new instance of AddApplicationActionProps.

Parameters:



11
12
13
14
15
16
17
18
19
20
 
# File 'elastic_load_balancingv2/add_application_action_props.rb', line 11

def initialize(conditions: nil, priority: nil, action:, remove_suffix: nil)
  @conditions = conditions
  Jsii::Type.check_type(@conditions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZ3YyLkxpc3RlbmVyQ29uZGl0aW9uIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "conditions") unless @conditions.nil?
  @priority = priority
  Jsii::Type.check_type(@priority, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "priority") unless @priority.nil?
  @action = action
  Jsii::Type.check_type(@action, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5MaXN0ZW5lckFjdGlvbiJ9")), "action")
  @remove_suffix = remove_suffix
  Jsii::Type.check_type(@remove_suffix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "removeSuffix") unless @remove_suffix.nil?
end

Instance Attribute Details

#action ⇒ AWSCDK::ElasticLoadBalancingv2::ListenerAction (readonly)

Action to perform.

Returns:



42
43
44
 
# File 'elastic_load_balancingv2/add_application_action_props.rb', line 42

def action
  @action
end

#conditions ⇒ Array<AWSCDK::ElasticLoadBalancingv2::ListenerCondition>? (readonly)

Note:

Default: - No conditions.

Rule applies if matches the conditions.

Returns:

See Also:



27
28
29
 
# File 'elastic_load_balancingv2/add_application_action_props.rb', line 27

def conditions
  @conditions
end

#priority ⇒ Numeric? (readonly)

Note:

Default: Target groups are used as defaults

Priority of this target group.

The rule with the lowest priority will be used for every request. If priority is not given, these target groups will be added as defaults, and must not have conditions.

Priorities must be unique.

Returns:

  • (Numeric, nil) 


38
39
40
 
# File 'elastic_load_balancingv2/add_application_action_props.rb', line 38

def priority
  @priority
end

#remove_suffix ⇒ Boolean? (readonly)

Note:

Default: - use standard logicalId with the Rule suffix

ListenerRules have a Rule suffix on their logicalId by default. This allows you to remove that suffix.

Legacy behavior of the add_target_groups() convenience method did not include the Rule suffix on the logicalId of the generated ListenerRule. At some point, increasing complexity of requirements can require users to switch from the add_target_groups() method to the add_action() method. When migrating ListenerRules deployed by a legacy version of add_target_groups(), you will need to enable this flag to avoid changing the logicalId of your resource. Otherwise Cfn will attempt to replace the ListenerRule and fail.

Returns:

  • (Boolean, nil) 


54
55
56
 
# File 'elastic_load_balancingv2/add_application_action_props.rb', line 54

def remove_suffix
  @remove_suffix
end

Class Method Details

.jsii_properties ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'elastic_load_balancingv2/add_application_action_props.rb', line 56

def self.jsii_properties
  {
    :conditions => "conditions",
    :priority => "priority",
    :action => "action",
    :remove_suffix => "removeSuffix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'elastic_load_balancingv2/add_application_action_props.rb', line 65

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "conditions" => @conditions,
    "priority" => @priority,
    "action" => @action,
    "removeSuffix" => @remove_suffix,
  })
  result.compact
end