AWS::GlobalAccelerator::EndpointGroupThe `AWS::GlobalAccelerator::EndpointGroup` resource is a Global Accelerator resource type that contains information about how you create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region .
import { CfnEndpointGroup } from 'aws-cdk-lib/aws-globalaccelerator';Or use the module namespace:
import * as globalaccelerator from 'aws-cdk-lib/aws-globalaccelerator';
// globalaccelerator.CfnEndpointGroupConfiguration passed to the constructor as CfnEndpointGroupProps.
endpointGroupRegionRequiredstringThe AWS Regions where the endpoint group is located.
listenerArnRequiredstring | IListenerRefThe Amazon Resource Name (ARN) of the listener.
endpointConfigurationsOptionalIResolvable | IResolvable | EndpointConfigurationProperty[]The list of endpoint objects.
healthCheckIntervalSecondsOptionalnumberThe time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
Default: - 30
healthCheckPathOptionalstringIf the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
Default: - "/"
healthCheckPortOptionalnumberThe port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
Default: - -1
healthCheckProtocolOptionalstringThe protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
Default: - "TCP"
portOverridesOptionalIResolvable | IResolvable | PortOverrideProperty[]Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.
thresholdCountOptionalnumberThe number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
Default: - 3
trafficDialPercentageOptionalnumberThe percentage of traffic to send to an AWS Regions . Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100.
Default: - 100
This L1 construct maps directly to the following CloudFormation resource type.
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to Newsletteraws-globalacceleratorAWS::GlobalAccelerator::EndpointGroup