Interface UpdateEndpointGroupRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateEndpointGroupRequest.Builder,
,UpdateEndpointGroupRequest> GlobalAcceleratorRequest.Builder
,SdkBuilder<UpdateEndpointGroupRequest.Builder,
,UpdateEndpointGroupRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateEndpointGroupRequest
-
Method Summary
Modifier and TypeMethodDescriptionendpointConfigurations
(Collection<EndpointConfiguration> endpointConfigurations) The list of endpoint objects.endpointConfigurations
(Consumer<EndpointConfiguration.Builder>... endpointConfigurations) The list of endpoint objects.endpointConfigurations
(EndpointConfiguration... endpointConfigurations) The list of endpoint objects.endpointGroupArn
(String endpointGroupArn) The Amazon Resource Name (ARN) of the endpoint group.healthCheckIntervalSeconds
(Integer healthCheckIntervalSeconds) The time—10 seconds or 30 seconds—between each health check for an endpoint.healthCheckPath
(String healthCheckPath) If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets.healthCheckPort
(Integer healthCheckPort) The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group.healthCheckProtocol
(String healthCheckProtocol) The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group.healthCheckProtocol
(HealthCheckProtocol healthCheckProtocol) The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.portOverrides
(Collection<PortOverride> portOverrides) Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.portOverrides
(Consumer<PortOverride.Builder>... portOverrides) Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.portOverrides
(PortOverride... portOverrides) Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.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.trafficDialPercentage
(Float trafficDialPercentage) The percentage of traffic to send to an Amazon Web Services Region.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.globalaccelerator.model.GlobalAcceleratorRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
endpointConfigurations
UpdateEndpointGroupRequest.Builder endpointConfigurations(Collection<EndpointConfiguration> endpointConfigurations) The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
- Parameters:
endpointConfigurations
- The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointConfigurations
UpdateEndpointGroupRequest.Builder endpointConfigurations(EndpointConfiguration... endpointConfigurations) The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
- Parameters:
endpointConfigurations
- The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointConfigurations
UpdateEndpointGroupRequest.Builder endpointConfigurations(Consumer<EndpointConfiguration.Builder>... endpointConfigurations) The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
This is a convenience method that creates an instance of theEndpointConfiguration.Builder
avoiding the need to create one manually viaEndpointConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toendpointConfigurations(List<EndpointConfiguration>)
.- Parameters:
endpointConfigurations
- a consumer that will call methods onEndpointConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.
- Parameters:
healthCheckPort
- The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheckProtocol
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
- Parameters:
healthCheckProtocol
- The protocol that Global Accelerator uses to check the health of 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
The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
- Parameters:
healthCheckProtocol
- The protocol that Global Accelerator uses to check the health of 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:
-
healthCheckPath
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
- Parameters:
healthCheckPath
- If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
- Parameters:
healthCheckIntervalSeconds
- The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
- Parameters:
portOverrides
- Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
portOverrides
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
- Parameters:
portOverrides
- Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
portOverrides
Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Overriding listener ports in the Global Accelerator Developer Guide.
This is a convenience method that creates an instance of thePortOverride.Builder
avoiding the need to create one manually viaPortOverride.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toportOverrides(List<PortOverride>)
.- Parameters:
portOverrides
- a consumer that will call methods onPortOverride.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateEndpointGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateEndpointGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-