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.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.298Z")
 @Stability(value=Experimental)
public interface EndpointGroupOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Basic options for creating a new EndpointGroup.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EndpointGroupOptions.Builder A builder for EndpointGroupOptions
static class	EndpointGroupOptions.Jsii$Proxy An implementation for EndpointGroupOptions

Method Summary

Modifier and Type	Method and Description
static EndpointGroupOptions.Builder	builder()
default String	getEndpointGroupName() (experimental) Name of the endpoint group.
default List<IEndpoint>	getEndpoints() (experimental) Initial list of endpoints for this group.
default Duration	getHealthCheckInterval() (experimental) The time between health checks for each endpoint.
default String	getHealthCheckPath() (experimental) The ping path for health checks (if the protocol is HTTP(S)).
default Number	getHealthCheckPort() (experimental) The port used to perform health checks.
default HealthCheckProtocol	getHealthCheckProtocol() (experimental) The protocol used to perform health checks.
default Number	getHealthCheckThreshold() (experimental) 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 List<PortOverride>	getPortOverrides() (experimental) Override the destination ports used to route traffic to an endpoint.
default String	getRegion() (experimental) The AWS Region where the endpoint group is located.
default Number	getTrafficDialPercentage() (experimental) The percentage of traffic to send to this AWS Region.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEndpointGroupName

@Stability(value=Experimental)
 @Nullable
default String getEndpointGroupName()

(experimental) Name of the endpoint group.

Default: - logical ID of the resource

getEndpoints

@Stability(value=Experimental)
 @Nullable
default List<IEndpoint> getEndpoints()

(experimental) Initial list of endpoints for this group.

Default: - Group is initially empty

getHealthCheckInterval

@Stability(value=Experimental)
 @Nullable
default Duration getHealthCheckInterval()

(experimental) The time between health checks for each endpoint.

Must be either 10 or 30 seconds.

Default: Duration.seconds(30)

getHealthCheckPath

@Stability(value=Experimental)
 @Nullable
default String getHealthCheckPath()

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

Default: '/'

getHealthCheckPort

@Stability(value=Experimental)
 @Nullable
default Number getHealthCheckPort()

(experimental) The port used to perform health checks.

Default: - The listener's port

getHealthCheckProtocol

@Stability(value=Experimental)
 @Nullable
default HealthCheckProtocol getHealthCheckProtocol()

(experimental) The protocol used to perform health checks.

Default: HealthCheckProtocol.TCP

getHealthCheckThreshold

@Stability(value=Experimental)
 @Nullable
default Number getHealthCheckThreshold()

(experimental) 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(value=Experimental)
 @Nullable
default List<PortOverride> getPortOverrides()

(experimental) 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(value=Experimental)
 @Nullable
default String getRegion()

(experimental) 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(value=Experimental)
 @Nullable
default Number getTrafficDialPercentage()

(experimental) 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(value=Experimental)
static EndpointGroupOptions.Builder builder()

Returns:

a EndpointGroupOptions.Builder of EndpointGroupOptions