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.

For more information, see Target Groups for Your Application Load Balancers in the Application 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. The default is 30 seconds.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 300.

Required: No

HealthCheckPath

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 indicates 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 default is the HTTP protocol.

Type: String

Valid Values: HTTP | HTTPS

Required: No

HealthCheckTimeoutSeconds

The amount of time, in seconds, during which no response from a target means a failed health check. The default is 5 seconds.

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. The default is 5.

Type: Integer

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

Required: No

Matcher

The HTTP codes to use when checking for a successful response from a target. The default is 200.

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.

Type: String

Valid Values: HTTP | HTTPS

Required: Yes

UnhealthyThresholdCount

The number of consecutive health check failures required before considering a target unhealthy. 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).

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

TooManyTargetGroups

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

HTTP Status Code: 400

Example

Create a target group

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>

See Also

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