You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticLoadBalancingV2::Types::TargetGroup

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Information about a target group.

Instance Attribute Summary collapse

Instance Attribute Details

#health_check_interval_secondsInteger

The approximate amount of time, in seconds, between health checks of an individual target.

Returns:

  • (Integer)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#health_check_pathString

The destination for the health check request.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#health_check_portString

The port to use to connect with the target.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#health_check_protocolString

The protocol to use to connect with the target.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#health_check_timeout_secondsInteger

The amount of time, in seconds, during which no response means a failed health check.

Returns:

  • (Integer)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#healthy_threshold_countInteger

The number of consecutive health checks successes required before considering an unhealthy target healthy.

Returns:

  • (Integer)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#load_balancer_arnsArray<String>

The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.

Returns:

  • (Array<String>)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#matcherTypes::Matcher

The HTTP codes to use when checking for a successful response from a target.

Returns:



2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#portInteger

The port on which the targets are listening.

Returns:

  • (Integer)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#protocolString

The protocol to use for routing traffic to the targets.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#target_group_arnString

The Amazon Resource Name (ARN) of the target group.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#target_group_nameString

The name of the target group.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#unhealthy_threshold_countInteger

The number of consecutive health check failures required before considering the target unhealthy.

Returns:

  • (Integer)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end

#vpc_idString

The ID of the VPC for the targets.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2060

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns)
  include Aws::Structure
end