EndpointGroupProps Struct
Property of the EndpointGroup.
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
endpointGroupNameoptionalstringendpoint_group_nameoptionalstrendpointGroupNameoptionalStringEndpointGroupNameoptionalstringEndpointGroupNameoptional*string#Name of the endpoint group.
Default: logical ID of the resource
endpointsoptionalIEndpoint[]endpointsoptionaltyping.List[IEndpoint]endpointsoptionalList<IEndpoint>EndpointsoptionalIEndpoint[]Endpointsoptional*[]IEndpoint#Initial list of endpoints for this group.
Default: Group is initially empty
healthCheckIntervaloptionalDurationhealth_check_intervaloptionalDurationhealthCheckIntervaloptionalDurationHealthCheckIntervaloptionalDurationHealthCheckIntervaloptionalDuration= Duration.seconds(30)#The time between health checks for each endpoint.
Must be either 10 or 30 seconds.
healthCheckPathoptionalstringhealth_check_pathoptionalstrhealthCheckPathoptionalStringHealthCheckPathoptionalstringHealthCheckPathoptional*string= '/'#The ping path for health checks (if the protocol is HTTP(S)).
healthCheckPortoptionalnumberhealth_check_portoptionalint | floathealthCheckPortoptionalNumberHealthCheckPortoptionaldoubleHealthCheckPortoptional*float64#The port used to perform health checks.
Default: The listener's port
healthCheckProtocoloptionalHealthCheckProtocolhealth_check_protocoloptionalHealthCheckProtocolhealthCheckProtocoloptionalHealthCheckProtocolHealthCheckProtocoloptionalHealthCheckProtocolHealthCheckProtocoloptionalHealthCheckProtocol= HealthCheckProtocol.TCP#The protocol used to perform health checks.
healthCheckThresholdoptionalnumberhealth_check_thresholdoptionalint | floathealthCheckThresholdoptionalNumberHealthCheckThresholdoptionaldoubleHealthCheckThresholdoptional*float64= 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.
listenerIListenerReflistenerIListenerReflistenerIListenerRefListenerIListenerRefListenerIListenerRefrequired#The Amazon Resource Name (ARN) of the listener.
portOverridesoptionalPortOverride[]port_overridesoptionaltyping.List[PortOverride]portOverridesoptionalList<PortOverride>PortOverridesoptionalPortOverride[]PortOverridesoptional*[]PortOverride#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.
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
trafficDialPercentageoptionalnumbertraffic_dial_percentageoptionalint | floattrafficDialPercentageoptionalNumberTrafficDialPercentageoptionaldoubleTrafficDialPercentageoptional*float64= 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.