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

Inherits:

Struct

• Object
• Struct
• Aws::ElasticLoadBalancingV2::Types::TargetGroup

Defined in:

gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Information about a target group.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #health_check_enabled ⇒ Boolean

  Indicates whether health checks are enabled.

• #health_check_interval_seconds ⇒ Integer

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

• #health_check_path ⇒ String

  The destination for health checks on the targets.

• #health_check_port ⇒ String

  The port to use to connect with the target.

• #health_check_protocol ⇒ String

  The protocol to use to connect with the target.

• #health_check_timeout_seconds ⇒ Integer

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

• #healthy_threshold_count ⇒ Integer

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

• #ip_address_type ⇒ String

  The IP address type.

• #load_balancer_arns ⇒ Array<String>

  The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group.

• #matcher ⇒ Types::Matcher

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

• #port ⇒ Integer

  The port on which the targets are listening.

• #protocol ⇒ String

  The protocol to use for routing traffic to the targets.

• #protocol_version ⇒ String

  [HTTP/HTTPS protocol] The protocol version.

• #target_group_arn ⇒ String

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

• #target_group_name ⇒ String

  The name of the target group.

• #target_type ⇒ String

  The type of target that you must specify when registering targets with this target group.

• #unhealthy_threshold_count ⇒ Integer

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

• #vpc_id ⇒ String

  The ID of the VPC for the targets.

Instance Attribute Details

#health_check_enabled ⇒ Boolean

Indicates whether health checks are enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_interval_seconds ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_path ⇒ String

The destination for health checks on the targets.

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_port ⇒ String

The port to use to connect with the target.

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_protocol ⇒ String

The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_timeout_seconds ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#healthy_threshold_count ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ String

The IP address type. The default value is ipv4.

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancer_arns ⇒ Array<String>

The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#matcher ⇒ Types::Matcher

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

Returns:

• (Types::Matcher)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port on which the targets are listening. This parameter is not used if the target is a Lambda function.

Returns:

• (Integer)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

The protocol to use for routing traffic to the targets.

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#protocol_version ⇒ String

[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#target_group_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#target_group_name ⇒ String

The name of the target group.

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#target_type ⇒ String

The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#unhealthy_threshold_count ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The ID of the VPC for the targets.

Returns:

• (String)

# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4142

class TargetGroup < Struct.new(
  :target_group_arn,
  :target_group_name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_enabled,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :health_check_path,
  :matcher,
  :load_balancer_arns,
  :target_type,
  :protocol_version,
  :ip_address_type)
  SENSITIVE = []
  include Aws::Structure
end