class Aws::ElasticLoadBalancingV2::Types::CreateTargetGroupInput

@note When making an API call, you may pass CreateTargetGroupInput

data as a hash:

    {
      name: "TargetGroupName", # required
      protocol: "HTTP", # accepts HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE
      protocol_version: "ProtocolVersion",
      port: 1,
      vpc_id: "VpcId",
      health_check_protocol: "HTTP", # accepts HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, GENEVE
      health_check_port: "HealthCheckPort",
      health_check_enabled: false,
      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",
        grpc_code: "GrpcCode",
      },
      target_type: "instance", # accepts instance, ip, lambda
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue",
        },
      ],
    }

@!attribute [rw] name

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.
@return [String]

@!attribute [rw] protocol

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 protocols are TCP,
TLS, UDP, or TCP\_UDP. For Gateway Load Balancers, the supported
protocol is GENEVE. A TCP\_UDP listener must be associated with a
TCP\_UDP target group. If the target is a Lambda function, this
parameter does not apply.
@return [String]

@!attribute [rw] protocol_version

\[HTTP/HTTPS protocol\] The protocol version. Specify `GRPC` to send
requests to targets using gRPC. Specify `HTTP2` to send requests to
targets using HTTP/2. The default is `HTTP1`, which sends requests
to targets using HTTP/1.1.
@return [String]

@!attribute [rw] port

The port on which the targets receive traffic. This port is used
unless you specify a port override when registering the target. If
the target is a Lambda function, this parameter does not apply. If
the protocol is GENEVE, the supported port is 6081.
@return [Integer]

@!attribute [rw] vpc_id

The identifier of the virtual private cloud (VPC). If the target is
a Lambda function, this parameter does not apply. Otherwise, this
parameter is required.
@return [String]

@!attribute [rw] health_check_protocol

The protocol the load balancer uses when performing health checks on
targets. For Application Load Balancers, the default is HTTP. For
Network Load Balancers and Gateway Load Balancers, the default is
TCP. The TCP protocol is not supported for health checks if the
protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP,
and TCP\_UDP protocols are not supported for health checks.
@return [String]

@!attribute [rw] health_check_port

The port the load balancer uses when performing health checks on
targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP\_UDP,
the default is `traffic-port`, which is the port on which each
target receives traffic from the load balancer. If the protocol is
GENEVE, the default is port 80.
@return [String]

@!attribute [rw] health_check_enabled

Indicates whether health checks are enabled. If the target type is
`lambda`, health checks are disabled by default but can be enabled.
If the target type is `instance` or `ip`, health checks are always
enabled and cannot be disabled.
@return [Boolean]

@!attribute [rw] health_check_path

\[HTTP/HTTPS health checks\] The destination for health checks on
the targets.

\[HTTP1 or HTTP2 protocol version\] The ping path. The default is /.

\[GRPC protocol version\] The path of a custom health check method
with the format /package.service/method. The default is /Amazon Web
Services.ALB/healthcheck.
@return [String]

@!attribute [rw] health_check_interval_seconds

The approximate amount of time, in seconds, between health checks of
an individual target. If the target group protocol is TCP, TLS, UDP,
or TCP\_UDP, the supported values are 10 and 30 seconds. If the
target group protocol is HTTP or HTTPS, the default is 30 seconds.
If the target group protocol is GENEVE, the default is 10 seconds.
If the target type is `lambda`, the default is 35 seconds.
@return [Integer]

@!attribute [rw] health_check_timeout_seconds

The amount of time, in seconds, during which no response from a
target means a failed health check. For target groups with a
protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. For
target groups with a protocol of TCP or TLS, this value must be 6
seconds for HTTP health checks and 10 seconds for TCP and HTTPS
health checks. If the target type is `lambda`, the default is 30
seconds.
@return [Integer]

@!attribute [rw] healthy_threshold_count

The number of consecutive health checks successes required before
considering an unhealthy target healthy. For target groups with a
protocol of HTTP or HTTPS, the default is 5. For target groups with
a protocol of TCP, TLS, or GENEVE, the default is 3. If the target
type is `lambda`, the default is 5.
@return [Integer]

@!attribute [rw] unhealthy_threshold_count

The number of consecutive health check failures required before
considering a target unhealthy. If the target group protocol is HTTP
or HTTPS, the default is 2. If the target group protocol is TCP or
TLS, this value must be the same as the healthy threshold count. If
the target group protocol is GENEVE, the default is 3. If the target
type is `lambda`, the default is 2.
@return [Integer]

@!attribute [rw] matcher

\[HTTP/HTTPS health checks\] The HTTP or gRPC codes to use when
checking for a successful response from a target.
@return [Types::Matcher]

@!attribute [rw] target_type

The type of target that you must specify when registering targets
with this target group. You can't specify targets for a target
group using more than one target type.

* `instance` - Register targets by instance ID. This is the default
  value.

* `ip` - Register targets by IP address. You can 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.

* `lambda` - Register a single Lambda function as a target.
@return [String]

@!attribute [rw] tags

The tags to assign to the target group.
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/CreateTargetGroupInput AWS API Documentation

Constants

SENSITIVE