interface EndpointGroupOptions

Language	Type name
.NET	Amazon.CDK.AWS.GlobalAccelerator.EndpointGroupOptions
Java	software.amazon.awscdk.services.globalaccelerator.EndpointGroupOptions
Python	aws_cdk.aws_globalaccelerator.EndpointGroupOptions
TypeScript (source)	@aws-cdk/aws-globalaccelerator » EndpointGroupOptions

Basic options for creating a new EndpointGroup.

Example

declare const alb: elbv2.ApplicationLoadBalancer;
declare const listener: globalaccelerator.Listener;

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

Properties

Name	Type	Description
endpointGroupName?	string	Name of the endpoint group.
endpoints?	IEndpoint[]	Initial list of endpoints for this group.
healthCheckInterval?	Duration	The time between health checks for each endpoint.
healthCheckPath?	string	The ping path for health checks (if the protocol is HTTP(S)).
healthCheckPort?	number	The port used to perform health checks.
healthCheckProtocol?	HealthCheckProtocol	The protocol used to perform health checks.
healthCheckThreshold?	number	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.
portOverrides?	PortOverride[]	Override the destination ports used to route traffic to an endpoint.
region?	string	The AWS Region where the endpoint group is located.
trafficDialPercentage?	number	The percentage of traffic to send to this AWS Region.

---

endpointGroupName?

Type: string (optional, default: logical ID of the resource)

Name of the endpoint group.

---

endpoints?

Type: IEndpoint[] (optional, default: Group is initially empty)

Initial list of endpoints for this group.

---

healthCheckInterval?

Type: Duration (optional, default: Duration.seconds(30))

The time between health checks for each endpoint.

Must be either 10 or 30 seconds.

---

healthCheckPath?

Type: string (optional, default: '/')

The ping path for health checks (if the protocol is HTTP(S)).

---

healthCheckPort?

Type: number (optional, default: The listener's port)

The port used to perform health checks.

---

healthCheckProtocol?

Type: HealthCheckProtocol (optional, default: HealthCheckProtocol.TCP)

The protocol used to perform health checks.

---

healthCheckThreshold?

Type: number (optional, default: 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.

---

portOverrides?

Type: PortOverride[] (optional, default: No overrides)

Override the destination ports used to route traffic to an endpoint.

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

---

region?

Type: string (optional, default: region of the first endpoint in this group, or the stack region if that region can't be determined)

The AWS Region where the endpoint group is located.

---

trafficDialPercentage?

Type: number (optional, default: 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.