TargetGroupSummary
Summary information about a target group.
For more information, see Target groups in the Amazon VPC Lattice User Guide.
Contents
- arn
-
The ARN (Amazon Resource Name) of the target group.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:targetgroup/tg-[0-9a-z]{17}$
Required: No
- createdAt
-
The date and time that the target group was created, specified in ISO-8601 format.
Type: Timestamp
Required: No
- id
-
The ID of the target group.
Type: String
Length Constraints: Fixed length of 20.
Pattern:
^tg-[0-9a-z]{17}$
Required: No
- ipAddressType
-
The type of IP address used for the target group. The possible values are
IPV4
andIPV6
. This is an optional parameter. If not specified, the default isIPV4
.Type: String
Valid Values:
IPV4 | IPV6
Required: No
- lambdaEventStructureVersion
-
The version of the event structure that your Lambda function receives. Supported only if the target group type is
LAMBDA
.Type: String
Valid Values:
V1 | V2
Required: No
- lastUpdatedAt
-
The date and time that the target group was last updated, specified in ISO-8601 format.
Type: Timestamp
Required: No
- name
-
The name of the target group.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
^(?!tg-)(?![-])(?!.*[-]$)(?!.*[-]{2})[a-z0-9-]+$
Required: No
- port
-
The port of the target group.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: No
- protocol
-
The protocol of the target group.
Type: String
Valid Values:
HTTP | HTTPS | TCP
Required: No
- serviceArns
-
The Amazon Resource Names (ARNs) of the service.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:service/svc-[0-9a-z]{17}$
Required: No
- status
-
The status.
Type: String
Valid Values:
CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
Required: No
- type
-
The target group type.
Type: String
Valid Values:
IP | LAMBDA | INSTANCE | ALB
Required: No
- vpcIdentifier
-
The ID of the VPC of the target group.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 50.
Pattern:
^vpc-(([0-9a-z]{8})|([0-9a-z]{17}))$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: