software.amazon.awssdk.services.globalaccelerator.model

Interface EndpointGroup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EndpointGroup.Builder,EndpointGroup>, SdkBuilder<EndpointGroup.Builder,EndpointGroup>, SdkPojo

Enclosing class:

EndpointGroup

public static interface EndpointGroup.Builder
extends SdkPojo, CopyableBuilder<EndpointGroup.Builder,EndpointGroup>

Method Summary

Modifier and Type	Method and Description
EndpointGroup.Builder	endpointDescriptions(Collection<EndpointDescription> endpointDescriptions) The list of endpoint objects.
EndpointGroup.Builder	endpointDescriptions(Consumer<EndpointDescription.Builder>... endpointDescriptions) The list of endpoint objects.
EndpointGroup.Builder	endpointDescriptions(EndpointDescription... endpointDescriptions) The list of endpoint objects.
EndpointGroup.Builder	endpointGroupArn(String endpointGroupArn) The Amazon Resource Name (ARN) of the endpoint group.
EndpointGroup.Builder	endpointGroupRegion(String endpointGroupRegion) The Amazon Web Services Region where the endpoint group is located.
EndpointGroup.Builder	healthCheckIntervalSeconds(Integer healthCheckIntervalSeconds) The time—10 seconds or 30 seconds—between health checks for each endpoint.
EndpointGroup.Builder	healthCheckPath(String healthCheckPath) If 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.
EndpointGroup.Builder	healthCheckPort(Integer healthCheckPort) The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
EndpointGroup.Builder	healthCheckProtocol(HealthCheckProtocol healthCheckProtocol) The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
EndpointGroup.Builder	healthCheckProtocol(String healthCheckProtocol) The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
EndpointGroup.Builder	portOverrides(Collection<PortOverride> portOverrides) Allows you to override the destination ports used to route traffic to an endpoint.
EndpointGroup.Builder	portOverrides(Consumer<PortOverride.Builder>... portOverrides) Allows you to override the destination ports used to route traffic to an endpoint.
EndpointGroup.Builder	portOverrides(PortOverride... portOverrides) Allows you to override the destination ports used to route traffic to an endpoint.
EndpointGroup.Builder	thresholdCount(Integer thresholdCount) 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.
EndpointGroup.Builder	trafficDialPercentage(Float trafficDialPercentage) The percentage of traffic to send to an Amazon Web Services Region.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

endpointGroupArn

EndpointGroup.Builder endpointGroupArn(String endpointGroupArn)

The Amazon Resource Name (ARN) of the endpoint group.

Parameters:

endpointGroupArn - The Amazon Resource Name (ARN) of the endpoint group.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointGroupRegion

EndpointGroup.Builder endpointGroupRegion(String endpointGroupRegion)

The Amazon Web Services Region where the endpoint group is located.

Parameters:

endpointGroupRegion - The Amazon Web Services Region where the endpoint group is located.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointDescriptions

EndpointGroup.Builder endpointDescriptions(Collection<EndpointDescription> endpointDescriptions)

The list of endpoint objects.

Parameters:

endpointDescriptions - The list of endpoint objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointDescriptions

EndpointGroup.Builder endpointDescriptions(EndpointDescription... endpointDescriptions)

The list of endpoint objects.

Parameters:

endpointDescriptions - The list of endpoint objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointDescriptions

EndpointGroup.Builder endpointDescriptions(Consumer<EndpointDescription.Builder>... endpointDescriptions)

The list of endpoint objects.

This is a convenience method that creates an instance of the EndpointDescription.Builder avoiding the need to create one manually via EndpointDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #endpointDescriptions(List).

Parameters:

endpointDescriptions - a consumer that will call methods on EndpointDescription.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#endpointDescriptions(java.util.Collection)

trafficDialPercentage

EndpointGroup.Builder trafficDialPercentage(Float trafficDialPercentage)

The percentage of traffic to send to an Amazon Web Services Region. 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.

Parameters:

trafficDialPercentage - The percentage of traffic to send to an Amazon Web Services Region. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

healthCheckPort

EndpointGroup.Builder healthCheckPort(Integer healthCheckPort)

The 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.

Parameters:

healthCheckPort - The 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

healthCheckProtocol

EndpointGroup.Builder healthCheckProtocol(String healthCheckProtocol)

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

Parameters:

healthCheckProtocol - The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HealthCheckProtocol, HealthCheckProtocol

healthCheckProtocol

EndpointGroup.Builder healthCheckProtocol(HealthCheckProtocol healthCheckProtocol)

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

Parameters:

healthCheckProtocol - The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HealthCheckProtocol, HealthCheckProtocol

healthCheckPath

EndpointGroup.Builder healthCheckPath(String healthCheckPath)

If 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 (/).

Parameters:

healthCheckPath - If 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 (/).

Returns:

Returns a reference to this object so that method calls can be chained together.

healthCheckIntervalSeconds

EndpointGroup.Builder healthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)

The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

Parameters:

healthCheckIntervalSeconds - The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

Returns:

Returns a reference to this object so that method calls can be chained together.

thresholdCount

EndpointGroup.Builder thresholdCount(Integer thresholdCount)

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. The default value is 3.

Parameters:

thresholdCount - 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. The default value is 3.

Returns:

Returns a reference to this object so that method calls can be chained together.

portOverrides

EndpointGroup.Builder portOverrides(Collection<PortOverride> portOverrides)

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.

Parameters:

portOverrides - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

portOverrides

EndpointGroup.Builder portOverrides(PortOverride... portOverrides)

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.

Parameters:

portOverrides - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

portOverrides

EndpointGroup.Builder portOverrides(Consumer<PortOverride.Builder>... portOverrides)

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.

This is a convenience method that creates an instance of the PortOverride.Builder avoiding the need to create one manually via PortOverride.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #portOverrides(List).

Parameters:

portOverrides - a consumer that will call methods on PortOverride.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#portOverrides(java.util.Collection)