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

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.

HealthCheckIntervalSeconds

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.

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

Type: String

Valid Values: HTTP | HTTPS | TCP

Required: No

HealthCheckTimeoutSeconds

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.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 60.

Required: No

HealthyThresholdCount

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.

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: Yes

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 protocol is TCP.

Type: String

Valid Values: HTTP | HTTPS | TCP

Required: Yes

TargetType

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.

Type: String

Valid Values: instance | ip

Required: No

UnhealthyThresholdCount

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.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 10.

Required: No

VpcId

The identifier of the virtual private cloud (VPC).

Type: String

Required: Yes

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 for an Application Load Balancer

This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target group uses the default health check configuration.

Sample Request

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

Sample Response

Copy
<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 for a Network Load Balancer

This example creates a target group that you can use to route traffic to targets using TCP on port 80. This target group uses the default health check configuration.

Sample Request

Copy
https://elasticloadbalancing.amazonaws.com/?Action=CreateTargetGroup &Name=my-tcp-targets &Protocol=TCP &Port=80 &VpcId=vpc-3ac0fb5f &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: