Describes the configuration of a target group.
For more information, see Target groups in the Amazon VPC Lattice User Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"HealthCheck" : HealthCheckConfig
,
"IpAddressType" : String
,
"LambdaEventStructureVersion" : String
,
"Port" : Integer
,
"Protocol" : String
,
"ProtocolVersion" : String
,
"VpcIdentifier" : String
}
YAML
HealthCheck:
HealthCheckConfig
IpAddressType: String
LambdaEventStructureVersion: String
Port: Integer
Protocol: String
ProtocolVersion: String
VpcIdentifier: String
Properties
HealthCheck
-
The health check configuration. Not supported if the target group type is
LAMBDA
orALB
.Required: No
Type: HealthCheckConfig
Update requires: No interruption
IpAddressType
-
The type of IP address used for the target group. Supported only if the target group type is
IP
. The default isIPV4
.Required: No
Type: String
Allowed values:
IPV4 | IPV6
Update requires: Replacement
LambdaEventStructureVersion
-
The version of the event structure that your Lambda function receives. Supported only if the target group type is
LAMBDA
. The default isV1
.Required: No
Type: String
Allowed values:
V1 | V2
Update requires: Replacement
Port
-
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
.Required: No
Type: Integer
Minimum:
1
Maximum:
65535
Update requires: Replacement
Protocol
-
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
.Required: No
Type: String
Allowed values:
HTTP | HTTPS | TCP
Update requires: Replacement
ProtocolVersion
-
The protocol version. The default is
HTTP1
. Not supported if the target group type isLAMBDA
.Required: No
Type: String
Allowed values:
HTTP1 | HTTP2 | GRPC
Update requires: Replacement
VpcIdentifier
-
The ID of the VPC. Not supported if the target group type is
LAMBDA
.Required: No
Type: String
Pattern:
^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$
Minimum:
5
Maximum:
2048
Update requires: Replacement