TargetSummary - Amazon VPC Lattice

TargetSummary

Summary information about a target.

Contents

id

The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target type is ALB, this is the ARN of an Application Load Balancer.

Type: String

Required: No

port

The port on which the target is listening.

Type: Integer

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

Required: No

reasonCode

The code for why the target status is what it is.

Type: String

Required: No

status

The status of the target.

  • DRAINING: The target is being deregistered. No new connections are sent to this target while current connections are being drained. The default draining time is 5 minutes.

  • UNAVAILABLE: Health checks are unavailable for the target group.

  • HEALTHY: The target is healthy.

  • UNHEALTHY: The target is unhealthy.

  • INITIAL: Initial health checks on the target are being performed.

  • UNUSED: Target group is not used in a service.

Type: String

Valid Values: DRAINING | UNAVAILABLE | HEALTHY | UNHEALTHY | INITIAL | UNUSED

Required: No

See Also

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