This example creates a rule that first authenticates the user and then forwards the request if the user is authenticated.
API Version 2015-12-01 25
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateTargetGroup
Creates a target group.
To register targets with the target group, use RegisterTargets (p. 96). To update the health check settings for the target group, use ModifyTargetGroup (p. 90). To monitor the health of targets in the target group, use DescribeTargetHealth (p. 74).
To route traffic to the targets in a target group, specify the target group in an action using CreateListener (p. 7) or CreateRule (p. 22).
To delete a target group, use DeleteTargetGroup (p. 40).
For more information, see the following:
• Target groups for your Application Load Balancers
• Target groups for your Network Load Balancers
• Target groups for your Gateway Load Balancers
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 168).
HealthCheckEnabled
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, ip, or alb, health checks are always enabled and cannot be disabled.
Type: Boolean Required: No
HealthCheckIntervalSeconds
The approximate amount of time, in seconds, between health checks of an individual target. If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds and 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.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 300.
Required: No HealthCheckPath
[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 /AWS.ALB/healthcheck.
API Version 2015-12-01 27
Request Parameters
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No HealthCheckPort
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.
Type: String Required: No HealthCheckProtocol
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.
Type: String
Valid Values: HTTP | HTTPS | TCP | TLS | UDP | TCP_UDP | GENEVE Required: No
HealthCheckTimeoutSeconds
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.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 120.
Required: No HealthyThresholdCount
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.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10.
Required: No IpAddressType
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.
Type: String
Valid Values: ipv4 | ipv6
Required: No Matcher
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
Type: Matcher (p. 141) object Required: No
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.
Type: String Required: Yes 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No 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.
Type: String
Valid Values: HTTP | HTTPS | TCP | TLS | UDP | TCP_UDP | GENEVE Required: No
ProtocolVersion
[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.
Type: String Required: No Tags.member.N
The tags to assign to the target group.
Type: Array of Tag (p. 154) objects
Array Members: Minimum number of 1 item.
API Version 2015-12-01 29
Response Elements
Required: No TargetType
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.
• alb - Register a single Application Load Balancer as a target.
Type: String
Valid Values: instance | ip | lambda | alb Required: No
UnhealthyThresholdCount
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.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10.
Required: No VpcId
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.
Type: String Required: No
Response Elements
The following element is returned by the service.
TargetGroups.member.N
Information about the target group.
Type: Array of TargetGroup (p. 158) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 170).
DuplicateTargetGroupName
A target group with the specified name already exists.
HTTP Status Code: 400 InvalidConfigurationRequest
The requested configuration is not valid.
HTTP Status Code: 400 TooManyTags
You've reached the limit on the number of tags per load balancer.
HTTP Status Code: 400 TooManyTargetGroups
You've reached the limit on the number of target groups for your AWS account.
HTTP Status Code: 400