# EndpointGroupProps

Property of the EndpointGroup.

Extends: EndpointGroupProps
Extends: EndpointGroupOptions
Used as props by: EndpointGroup

- Source: [`aws-globalaccelerator/lib/endpoint-group.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-globalaccelerator/lib/endpoint-group.ts#L149)
- Type last changed: v2.234.0 · 8 Jan 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_globalaccelerator as globalaccelerator } from 'aws-cdk-lib';
import { aws_globalaccelerator as interfaces_globalaccelerator } from 'aws-cdk-lib/interfaces';

declare const endpoint: globalaccelerator.IEndpoint;
declare const listenerRef: interfaces_globalaccelerator.IListenerRef;
const endpointGroupProps: globalaccelerator.EndpointGroupProps = {
  listener: listenerRef,

  // the properties below are optional
  endpointGroupName: 'endpointGroupName',
  endpoints: [endpoint],
  healthCheckInterval: cdk.Duration.minutes(30),
  healthCheckPath: 'healthCheckPath',
  healthCheckPort: 123,
  healthCheckProtocol: globalaccelerator.HealthCheckProtocol.TCP,
  healthCheckThreshold: 123,
  portOverrides: [{
    endpointPort: 123,
    listenerPort: 123,
  }],
  region: 'region',
  trafficDialPercentage: 123,
};
```

## Properties

- `endpointGroupName`: string — Name of the endpoint group.

  **Default:** logical ID of the resource

- `endpoints`: [IEndpoint](/cdk/api/v2/docs/aws-cdk-lib.aws_globalaccelerator.IEndpoint.html)[] — Initial list of endpoints for this group.

  **Default:** Group is initially empty

- `healthCheckInterval`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = Duration.seconds(30) — The time between health checks for each endpoint.

  Must be either 10 or 30 seconds.

- `healthCheckPath`: string = '/' — The ping path for health checks (if the protocol is HTTP(S)).

- `healthCheckPort`: number — The port used to perform health checks.

  **Default:** The listener's port

- `healthCheckProtocol`: [HealthCheckProtocol](/cdk/api/v2/docs/aws-cdk-lib.aws_globalaccelerator.HealthCheckProtocol.html) = HealthCheckProtocol.TCP — The protocol used to perform health checks.

- `healthCheckThreshold`: number = 3 — The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.

- `listener`: [IListenerRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_globalaccelerator.IListenerRef.html) (required) — The Amazon Resource Name (ARN) of the listener.

- `portOverrides`: [PortOverride](/cdk/api/v2/docs/aws-cdk-lib.aws_globalaccelerator.PortOverride.html)[] — Override the destination ports used to route traffic to an endpoint.

  **Default:** No overrides

  Unless overridden, the port used to hit the endpoint will be the same as the port
  that traffic arrives on at the listener.

- `region`: string — The AWS Region where the endpoint group is located.

  **Default:** region of the first endpoint in this group, or the stack region if that region can't be determined

- `trafficDialPercentage`: number = 100 — The percentage of traffic to send to this AWS Region.

  The percentage is applied to the traffic that would otherwise have been
  routed to the Region based on optimal routing. Additional traffic is
  distributed to other endpoint groups for this listener.