--- title: "POST /targetgroups" method: POST path: "/targetgroups" --- # POST /targetgroups `POST /targetgroups` Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service. For more information, see [Target groups](https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-groups.html) in the _Amazon VPC Lattice User Guide_. ## Request body - object - `name` string, required — The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. - `type` 'IP' | 'LAMBDA' | 'INSTANCE' | 'ALB', required — The type of target group. - `config` object —

Describes the configuration of a target group.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

- `port` integer — The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA. - `protocol` 'HTTP' | 'HTTPS' | 'TCP' — The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA. - `protocolVersion` 'HTTP1' | 'HTTP2' | 'GRPC' — The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA. - `ipAddressType` 'IPV4' | 'IPV6' — The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4. - `vpcIdentifier` string — The ID of the VPC. Not supported if the target group type is LAMBDA. - `healthCheck` object — The health check configuration. Not supported if the target group type is LAMBDA or ALB. - `enabled` boolean — Indicates whether health checking is enabled. - `protocol` 'HTTP' | 'HTTPS' | 'TCP' — The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP. - `protocolVersion` 'HTTP1' | 'HTTP2' — The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2. - `port` integer — The port used when performing health checks on targets. The default setting is the port that a target receives traffic on. - `path` string — The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI. - `healthCheckIntervalSeconds` integer — The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds. - `healthCheckTimeoutSeconds` integer — The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds. - `healthyThresholdCount` integer — The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5. - `unhealthyThresholdCount` integer — The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2. - `matcher` object — The codes to use when checking for a successful response from a target. - `httpCode` string — The HTTP code to use when checking for a successful response from a target. - `lambdaEventStructureVersion` 'V1' | 'V2' — The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1. - `clientToken` string — A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. - `tags` object — The tags for the target group. ## Response `201` Success - CreateTargetGroupResponse - `id` string — The ID of the target group. - `arn` string — The Amazon Resource Name (ARN) of the target group. - `name` string — The name of the target group. - `type` 'IP' | 'LAMBDA' | 'INSTANCE' | 'ALB' — The type of target group. - `config` object — The target group configuration. - `port` integer — The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA. - `protocol` 'HTTP' | 'HTTPS' | 'TCP' — The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA. - `protocolVersion` 'HTTP1' | 'HTTP2' | 'GRPC' — The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA. - `ipAddressType` 'IPV4' | 'IPV6' — The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4. - `vpcIdentifier` string — The ID of the VPC. Not supported if the target group type is LAMBDA. - `healthCheck` object — The health check configuration. Not supported if the target group type is LAMBDA or ALB. - `enabled` boolean — Indicates whether health checking is enabled. - `protocol` 'HTTP' | 'HTTPS' | 'TCP' — The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP. - `protocolVersion` 'HTTP1' | 'HTTP2' — The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2. - `port` integer — The port used when performing health checks on targets. The default setting is the port that a target receives traffic on. - `path` string — The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI. - `healthCheckIntervalSeconds` integer — The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds. - `healthCheckTimeoutSeconds` integer — The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds. - `healthyThresholdCount` integer — The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5. - `unhealthyThresholdCount` integer — The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2. - `matcher` object — The codes to use when checking for a successful response from a target. - `httpCode` string — The HTTP code to use when checking for a successful response from a target. - `lambdaEventStructureVersion` 'V1' | 'V2' — The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1. - `status` 'CREATE_IN_PROGRESS' | 'ACTIVE' | 'DELETE_IN_PROGRESS' | 'CREATE_FAILED' | 'DELETE_FAILED' — The status. You can retry the operation if the status is CREATE_FAILED. However, if you retry it while the status is CREATE_IN_PROGRESS, there is no change in the status. ## Other responses - `480` — ValidationException - `481` — AccessDeniedException - `482` — ConflictException - `483` — ResourceNotFoundException - `484` — ThrottlingException - `485` — ServiceQuotaExceededException - `486` — InternalServerException --- [API](https://skmtc.net/aws/apis/vpc-lattice.md) · [All operations](https://skmtc.net/aws/apis/vpc-lattice/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/vpc-lattice/versions/bbec5439e0f7/schema)