TargetGroup

Describes a target group

Amazon Web ServicesHigh AvailabilityLoad BalancingNetworkingScalability

Properties

Name	Type	Description
targetGroupArn	string	The Amazon Resource Name (ARN) of the target group
targetGroupName	string	The name of the target group
protocol	string	The protocol to use for routing traffic to the targets
port	integer	The port on which the targets are listening
vpcId	string	The ID of the VPC for the targets
healthCheckProtocol	string	The protocol to use for health checks
healthCheckPort	string	The port to use for health checks
healthCheckEnabled	boolean	Whether health checks are enabled
healthCheckIntervalSeconds	integer	The approximate interval between health checks
healthCheckTimeoutSeconds	integer	The amount of time to wait for a health check response
healthyThresholdCount	integer	The number of consecutive health checks required to consider a target healthy
unhealthyThresholdCount	integer	The number of consecutive health check failures required to consider a target unhealthy
healthCheckPath	string	The destination for health checks on the targets
targetType	string	The type of target
loadBalancerArns	array	The ARNs of the load balancers that route traffic to this target group

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-elastic-load-balancing/refs/heads/main/json-schema/amazon-elastic-load-balancing-target-group-schema.json",
  "title": "TargetGroup",
  "description": "Describes a target group",
  "type": "object",
  "properties": {
    "targetGroupArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the target group"
    },
    "targetGroupName": {
      "type": "string",
      "description": "The name of the target group"
    },
    "protocol": {
      "type": "string",
      "description": "The protocol to use for routing traffic to the targets",
      "enum": [
        "HTTP",
        "HTTPS",
        "TCP",
        "TLS",
        "UDP",
        "TCP_UDP",
        "GENEVE"
      ]
    },
    "port": {
      "type": "integer",
      "description": "The port on which the targets are listening"
    },
    "vpcId": {
      "type": "string",
      "description": "The ID of the VPC for the targets"
    },
    "healthCheckProtocol": {
      "type": "string",
      "description": "The protocol to use for health checks"
    },
    "healthCheckPort": {
      "type": "string",
      "description": "The port to use for health checks"
    },
    "healthCheckEnabled": {
      "type": "boolean",
      "description": "Whether health checks are enabled"
    },
    "healthCheckIntervalSeconds": {
      "type": "integer",
      "description": "The approximate interval between health checks"
    },
    "healthCheckTimeoutSeconds": {
      "type": "integer",
      "description": "The amount of time to wait for a health check response"
    },
    "healthyThresholdCount": {
      "type": "integer",
      "description": "The number of consecutive health checks required to consider a target healthy"
    },
    "unhealthyThresholdCount": {
      "type": "integer",
      "description": "The number of consecutive health check failures required to consider a target unhealthy"
    },
    "healthCheckPath": {
      "type": "string",
      "description": "The destination for health checks on the targets"
    },
    "targetType": {
      "type": "string",
      "description": "The type of target",
      "enum": [
        "instance",
        "ip",
        "lambda",
        "alb"
      ]
    },
    "loadBalancerArns": {
      "type": "array",
      "description": "The ARNs of the load balancers that route traffic to this target group",
      "items": {
        "type": "string"
      }
    }
  }
}