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

Class: Aws::ElasticLoadBalancingV2::Types::CreateTargetGroupInput

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

Overview

Note:

When making an API call, you may pass CreateTargetGroupInput data as a hash:

{
  name: "TargetGroupName", # required
  protocol: "HTTP", # required, accepts HTTP, HTTPS, TCP
  port: 1, # required
  vpc_id: "VpcId", # required
  health_check_protocol: "HTTP", # accepts HTTP, HTTPS, TCP
  health_check_port: "HealthCheckPort",
  health_check_path: "Path",
  health_check_interval_seconds: 1,
  health_check_timeout_seconds: 1,
  healthy_threshold_count: 1,
  unhealthy_threshold_count: 1,
  matcher: {
    http_code: "HttpCode", # required
  },
  target_type: "instance", # accepts instance, ip
}

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. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. The default is 30 seconds.

Returns:

  • (Integer)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#health_check_pathString

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

Returns:

  • (String)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#health_check_portString

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

Returns:

  • (String)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#health_check_protocolString

The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.

Returns:

  • (String)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#health_check_timeout_secondsInteger

The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2 to 60 seconds and the default is 5 seconds. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.

Returns:

  • (Integer)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#healthy_threshold_countInteger

The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.

Returns:

  • (Integer)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#matcherTypes::Matcher

[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.

Returns:



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#nameString

The name of the target group.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

Returns:

  • (String)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#portInteger

The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target.

Returns:

  • (Integer)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#protocolString

The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.

Returns:

  • (String)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  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 (targets are specified by instance ID) or ip (targets are specified by IP address). The default is instance. Note that you can't specify targets for a target group using both instance IDs and IP addresses.

If the target type is ip, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.

Returns:

  • (String)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#unhealthy_threshold_countInteger

The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count.

Returns:

  • (Integer)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end

#vpc_idString

The identifier of the virtual private cloud (VPC).

Returns:

  • (String)


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 570

class CreateTargetGroupInput < Struct.new(
  :name,
  :protocol,
  :port,
  :vpc_id,
  :health_check_protocol,
  :health_check_port,
  :health_check_path,
  :health_check_interval_seconds,
  :health_check_timeout_seconds,
  :healthy_threshold_count,
  :unhealthy_threshold_count,
  :matcher,
  :target_type)
  include Aws::Structure
end