EndpointGroup
EndpointGroup construct.
Import
import { EndpointGroup } from 'aws-cdk-lib/aws-globalaccelerator';Or use the module namespace:
import * as globalaccelerator from 'aws-cdk-lib/aws-globalaccelerator';
// globalaccelerator.EndpointGroupProperties
Configuration passed to the constructor as EndpointGroupProps.
listenerRequiredIListenerRefThe Amazon Resource Name (ARN) of the listener.
10 properties inherited from EndpointGroupOptions
endpointGroupNameOptionalinherited from EndpointGroupOptionsstringName of the endpoint group.
Default: - logical ID of the resource
endpointsOptionalinherited from EndpointGroupOptionsIEndpoint[]Initial list of endpoints for this group.
Default: - Group is initially empty
healthCheckIntervalOptionalinherited from EndpointGroupOptionsDurationThe time between health checks for each endpoint. Must be either 10 or 30 seconds.
Default: Duration.seconds(30)
healthCheckPathOptionalinherited from EndpointGroupOptionsstringThe ping path for health checks (if the protocol is HTTP(S)).
Default: '/'
healthCheckPortOptionalinherited from EndpointGroupOptionsnumberThe port used to perform health checks.
Default: - The listener's port
healthCheckProtocolOptionalinherited from EndpointGroupOptionsHealthCheckProtocolThe protocol used to perform health checks.
Default: HealthCheckProtocol.TCP
healthCheckThresholdOptionalinherited from EndpointGroupOptionsnumberThe number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.
Default: 3
portOverridesOptionalinherited from EndpointGroupOptionsPortOverride[]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.
Default: - No overrides
regionOptionalinherited from EndpointGroupOptionsstringThe 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
trafficDialPercentageOptionalinherited from EndpointGroupOptionsnumberThe 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.
Default: 100
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-globalaccelerator