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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#health_check_enabledBoolean

Indicates whether health checks are enabled.

Returns:

  • (Boolean)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_secondsInteger

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

Returns:

  • (Integer)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_pathString

The destination for health checks on the targets.

Returns:

  • (String)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_portString

The port to use to connect with the target.

Returns:

  • (String)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_protocolString

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)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_secondsInteger

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

Returns:

  • (Integer)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_countInteger

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

Returns:

  • (Integer)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_typeString

The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

Returns:

  • (String)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_arnsArray<String>

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

Returns:

  • (Array<String>)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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

#matcherTypes::Matcher

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

Returns:



4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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

#portInteger

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

Returns:

  • (Integer)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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

#protocolString

The protocol to use for routing traffic to the targets.

Returns:

  • (String)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_versionString

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

Returns:

  • (String)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_arnString

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

Returns:

  • (String)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_nameString

The name of the target group.

Returns:

  • (String)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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

Returns:

  • (String)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_countInteger

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

Returns:

  • (Integer)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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_idString

The ID of the VPC for the targets.

Returns:

  • (String)


4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 4089

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