Package software.amazon.awscdk.services.globalaccelerator

Interface EndpointGroupOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
EndpointGroupProps
All Known Implementing Classes:
EndpointGroupOptions.Jsii$Proxy, EndpointGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:44.026Z") @Stability(Stable) public interface EndpointGroupOptions extends software.amazon.jsii.JsiiSerializable
Basic options for creating a new EndpointGroup.

Example: 

 ApplicationLoadBalancer alb;
 Listener listener;
 listener.addEndpointGroup("Group", EndpointGroupOptions.builder()
         .endpoints(List.of(
             ApplicationLoadBalancerEndpoint.Builder.create(alb)
                     .weight(128)
                     .preserveClientIp(true)
                     .build()))
         .build());

  • Method Details

    • getEndpointGroupName

      @Stability(Stable) @Nullable default String getEndpointGroupName()
      Name of the endpoint group.

      Default: - logical ID of the resource

    • getEndpoints

      @Stability(Stable) @Nullable default List<IEndpoint> getEndpoints()
      Initial list of endpoints for this group.

      Default: - Group is initially empty

    • getHealthCheckInterval

      @Stability(Stable) @Nullable default Duration getHealthCheckInterval()
      The time between health checks for each endpoint.

      Must be either 10 or 30 seconds.

      Default: Duration.seconds(30)

    • getHealthCheckPath

      @Stability(Stable) @Nullable default String getHealthCheckPath()
      The ping path for health checks (if the protocol is HTTP(S)).

      Default: '/'

    • getHealthCheckPort

      @Stability(Stable) @Nullable default Number getHealthCheckPort()
      The port used to perform health checks.

      Default: - The listener's port

    • getHealthCheckProtocol

      @Stability(Stable) @Nullable default HealthCheckProtocol getHealthCheckProtocol()
      The protocol used to perform health checks.

      Default: HealthCheckProtocol.TCP

    • getHealthCheckThreshold

      @Stability(Stable) @Nullable default Number getHealthCheckThreshold()
      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.

      Default: 3

    • getPortOverrides

      @Stability(Stable) @Nullable default List<PortOverride> getPortOverrides()
      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

    • getRegion

      @Stability(Stable) @Nullable default String getRegion()
      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

    • getTrafficDialPercentage

      @Stability(Stable) @Nullable default Number getTrafficDialPercentage()
      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.

      Default: 100

    • builder

      @Stability(Stable) static EndpointGroupOptions.Builder builder()
      Returns:
      a EndpointGroupOptions.Builder of EndpointGroupOptions