AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Information about a target group.

Instance Attribute Summary collapse

Instance Attribute Details

#health_check_enabledBoolean

Indicates whether health checks are enabled.

Returns:

  • (Boolean)

    Indicates whether health checks are enabled.

#health_check_interval_secondsInteger

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

Returns:

  • (Integer)

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

#health_check_pathString

The destination for health checks on the targets.

Returns:

  • (String)

    The destination for health checks on the targets.

#health_check_portString

The port to use to connect with the target.

Returns:

  • (String)

    The port to use to connect with the target.

#health_check_protocolString

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

Possible values:

  • HTTP
  • HTTPS
  • TCP
  • TLS
  • UDP
  • TCP_UDP
  • GENEVE

Returns:

  • (String)

    The protocol to use to connect with the target.

#health_check_timeout_secondsInteger

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

Returns:

  • (Integer)

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

#healthy_threshold_countInteger

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

Returns:

  • (Integer)

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

#load_balancer_arnsArray<String>

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

Returns:

  • (Array<String>)

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

#matcherTypes::Matcher

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

Returns:

  • (Types::Matcher)

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

#portInteger

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

Returns:

  • (Integer)

    The port on which the targets are listening.

#protocolString

The protocol to use for routing traffic to the targets.

Possible values:

  • HTTP
  • HTTPS
  • TCP
  • TLS
  • UDP
  • TCP_UDP
  • GENEVE

Returns:

  • (String)

    The protocol to use for routing traffic to the targets.

#protocol_versionString

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

Returns:

  • (String)

    [HTTP/HTTPS protocol] The protocol version.

#target_group_arnString

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

Returns:

  • (String)

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

#target_group_nameString

The name of the target group.

Returns:

  • (String)

    The name of the target group.

#target_typeString

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), or lambda (register a single Lambda function as a target).

Possible values:

  • instance
  • ip
  • lambda

Returns:

  • (String)

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

#unhealthy_threshold_countInteger

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

Returns:

  • (Integer)

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

#vpc_idString

The ID of the VPC for the targets.

Returns:

  • (String)

    The ID of the VPC for the targets.