Class: AWSCDK::ElasticLoadBalancingv2::TargetGroupHealth

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
elastic_load_balancingv2/target_group_health.rb

Overview

Properties for configuring a target group health.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dns_minimum_healthy_target_count: nil, dns_minimum_healthy_target_percentage: nil, routing_minimum_healthy_target_count: nil, routing_minimum_healthy_target_percentage: nil) ⇒ TargetGroupHealth

Returns a new instance of TargetGroupHealth.

Parameters:

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

    The minimum number of targets that must be healthy for DNS failover.

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

    The minimum percentage of targets that must be healthy for DNS failover.

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

    The minimum number of targets that must be healthy for unhealthy state routing.

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

    The minimum percentage of targets that must be healthy for unhealthy state routing.



13
14
15
16
17
18
19
20
21
22
 
# File 'elastic_load_balancingv2/target_group_health.rb', line 13

def initialize(dns_minimum_healthy_target_count: nil, dns_minimum_healthy_target_percentage: nil, routing_minimum_healthy_target_count: nil, routing_minimum_healthy_target_percentage: nil)
  @dns_minimum_healthy_target_count = dns_minimum_healthy_target_count
  Jsii::Type.check_type(@dns_minimum_healthy_target_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "dnsMinimumHealthyTargetCount") unless @dns_minimum_healthy_target_count.nil?
  @dns_minimum_healthy_target_percentage = dns_minimum_healthy_target_percentage
  Jsii::Type.check_type(@dns_minimum_healthy_target_percentage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "dnsMinimumHealthyTargetPercentage") unless @dns_minimum_healthy_target_percentage.nil?
  @routing_minimum_healthy_target_count = routing_minimum_healthy_target_count
  Jsii::Type.check_type(@routing_minimum_healthy_target_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "routingMinimumHealthyTargetCount") unless @routing_minimum_healthy_target_count.nil?
  @routing_minimum_healthy_target_percentage = routing_minimum_healthy_target_percentage
  Jsii::Type.check_type(@routing_minimum_healthy_target_percentage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "routingMinimumHealthyTargetPercentage") unless @routing_minimum_healthy_target_percentage.nil?
end

Instance Attribute Details

#dns_minimum_healthy_target_count ⇒ Numeric? (readonly)

Note:

Default: 1

The minimum number of targets that must be healthy for DNS failover.

If below this value, mark the zone as unhealthy in DNS. Use 0 for "off".

Returns:

  • (Numeric, nil) 


31
32
33
 
# File 'elastic_load_balancingv2/target_group_health.rb', line 31

def dns_minimum_healthy_target_count
  @dns_minimum_healthy_target_count
end

#dns_minimum_healthy_target_percentage ⇒ Numeric? (readonly)

Note:

Default: 0

The minimum percentage of targets that must be healthy for DNS failover.

If below this value, mark the zone as unhealthy in DNS. Use 0 for "off".

Returns:

  • (Numeric, nil) 


39
40
41
 
# File 'elastic_load_balancingv2/target_group_health.rb', line 39

def dns_minimum_healthy_target_percentage
  @dns_minimum_healthy_target_percentage
end

#routing_minimum_healthy_target_count ⇒ Numeric? (readonly)

Note:

Default: 1

The minimum number of targets that must be healthy for unhealthy state routing.

If below this value, send traffic to all targets including unhealthy ones.

Returns:

  • (Numeric, nil) 


46
47
48
 
# File 'elastic_load_balancingv2/target_group_health.rb', line 46

def routing_minimum_healthy_target_count
  @routing_minimum_healthy_target_count
end

#routing_minimum_healthy_target_percentage ⇒ Numeric? (readonly)

Note:

Default: 0

The minimum percentage of targets that must be healthy for unhealthy state routing.

If below this value, send traffic to all targets including unhealthy ones. Use 0 for "off".

Returns:

  • (Numeric, nil) 


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

def routing_minimum_healthy_target_percentage
  @routing_minimum_healthy_target_percentage
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :dns_minimum_healthy_target_count => "dnsMinimumHealthyTargetCount",
    :dns_minimum_healthy_target_percentage => "dnsMinimumHealthyTargetPercentage",
    :routing_minimum_healthy_target_count => "routingMinimumHealthyTargetCount",
    :routing_minimum_healthy_target_percentage => "routingMinimumHealthyTargetPercentage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "dnsMinimumHealthyTargetCount" => @dns_minimum_healthy_target_count,
    "dnsMinimumHealthyTargetPercentage" => @dns_minimum_healthy_target_percentage,
    "routingMinimumHealthyTargetCount" => @routing_minimum_healthy_target_count,
    "routingMinimumHealthyTargetPercentage" => @routing_minimum_healthy_target_percentage,
  })
  result.compact
end