Elastic Load Balancing
API Reference (API Version 2015-12-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CreateTargetGroup

Creates a target group.

To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.

To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.

To delete a target group, use DeleteTargetGroup.

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.

For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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 or ip, 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. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 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 ping path that is the destination on the targets for health checks. The default is /.

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. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

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, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Type: String

Valid Values: HTTP | HTTPS | TCP | TLS | UDP | TCP_UDP

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 or HTTPS, 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 or TLS, 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

Matcher

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

Type: Matcher 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.

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. 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

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 - Targets are specified by instance ID. This is the default value. If the target group protocol is UDP or TCP_UDP, the target type must be instance.

  • ip - Targets are specified 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 - The target groups contains a single Lambda function.

Type: String

Valid Values: instance | ip | lambda

Required: No

UnhealthyThresholdCount

The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. 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 objects

Errors

For information about the errors that are common to all actions, see Common Errors.

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

TooManyTargetGroups

You've reached the limit on the number of target groups for your AWS account.

HTTP Status Code: 400

Examples

Create a target group to route traffic to instances registered by instance ID

This example creates a target group for an Application Load Balancer that you can use to route traffic to instances using HTTP on port 80. You register the instances by instance ID. This target group uses the default health check settings.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=CreateTargetGroup &Name=my-targets &Protocol=HTTP &Port=80 &VpcId=vpc-3ac0fb5f &TargetType=instance &Version=2015-12-01 &AUTHPARAMS

Sample Response

<CreateTargetGroupResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/"> <CreateTargetGroupResult> <TargetGroups> <member> <TargetGroupArn>arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067</TargetGroupArn> <HealthCheckTimeoutSeconds>5</HealthCheckTimeoutSeconds> <HealthCheckPort>traffic-port</HealthCheckPort> <Matcher> <HttpCode>200</HttpCode> </Matcher> <TargetGroupName>my-targets</TargetGroupName> <HealthCheckProtocol>HTTP</HealthCheckProtocol> <HealthCheckPath>/</HealthCheckPath> <Protocol>HTTP</Protocol> <Port>80</Port> <VpcId>vpc-3ac0fb5f</VpcId> <HealthyThresholdCount>5</HealthyThresholdCount> <HealthCheckIntervalSeconds>30</HealthCheckIntervalSeconds> <UnhealthyThresholdCount>2</UnhealthyThresholdCount> </member> </TargetGroups> </CreateTargetGroupResult> <ResponseMetadata> <RequestId>b83fe90e-f2d5-11e5-b95d-3b2c1831fc26</RequestId> </ResponseMetadata> </CreateTargetGroupResponse>

Create a target group to route traffic to IP addresses

This example creates a target group for a Network Load Balancer that you can use to route traffic to IP addresses using TCP on port 80. This target group uses the default health check settings.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=CreateTargetGroup &Name=my-ip-targets &Protocol=TCP &Port=80 &VpcId=vpc-3ac0fb5f &TargetType=ip &Version=2015-12-01 &AUTHPARAMS

Create a target group to route traffic to a Lambda function

This example creates a target group for an Application Load Balancer that you can use to route traffic to a Lambda function. This target group uses the default health check settings. For more information, see Lambda Functions as Targets in the Application Load Balancers Guide.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=CreateTargetGroup &Name=my-lambda-target &TargetType=lambda &Version=2015-12-01 &AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: