# EndpointGroup

EndpointGroup construct.

Extends: Construct › Resource › EndpointGroup
Implements: IResource, IEndpointGroup, IEnvironmentAware, IEndpointGroupRef, IConstruct, IDependable

- CloudFormation: [`AWS::GlobalAccelerator::EndpointGroup`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-globalaccelerator-endpointgroup.html)
- L1 type: [`CfnEndpointGroup`](/cdk/api/v2/docs/aws-cdk-lib.aws_globalaccelerator.CfnEndpointGroup.html)
- 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#L159)
- Type last changed: v2.234.0 · 8 Jan 2026

## Example

```ts
declare const listener: globalaccelerator.Listener;

// Non-open ALB
declare const alb: elbv2.ApplicationLoadBalancer;

const endpointGroup = listener.addEndpointGroup('Group', {
  endpoints: [
    new ga_endpoints.ApplicationLoadBalancerEndpoint(alb, {
      preserveClientIp: true,
    }),
  ],
});

// Remember that there is only one AGA security group per VPC.
declare const vpc: ec2.Vpc;
const agaSg = endpointGroup.connectionsPeer('GlobalAcceleratorSG', vpc);

// Allow connections from the AGA to the ALB
alb.connections.allowFrom(agaSg, ec2.Port.tcp(443));
```

## Initializer

```ts
new EndpointGroup(scope: Construct, id: string, props: EndpointGroupProps)
```

## Construct Props

- `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.

## Properties

- `endpointGroupArn`: string — EndpointGroup ARN.

- `endpointGroupName`: string — The name of the endpoint group.

- `endpointGroupRef`: [EndpointGroupReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_globalaccelerator.EndpointGroupReference.html) — A reference to a EndpointGroup resource.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `addEndpoint(endpoint: IEndpoint): void` — Add an endpoint.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `connectionsPeer(id: string, vpc: IVpc): IPeer` — Return an object that represents the Accelerator's Security Group.

  Uses a Custom Resource to look up the Security Group that Accelerator
  creates at deploy time. Requires your VPC ID to perform the lookup.

  The Security Group will only be created if you enable **Client IP
  Preservation** on any of the endpoints.

  You cannot manipulate the rules inside this security group, but you can
  use this security group as a Peer in Connections rules on other
  constructs.

- `fromEndpointGroupArn(scope: Construct, id: string, endpointGroupArn: string): IEndpointGroup` (static) — import from ARN.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.