Interface CreateEndpointGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateEndpointGroupRequest.Builder,CreateEndpointGroupRequest>, GlobalAcceleratorRequest.Builder, SdkBuilder<CreateEndpointGroupRequest.Builder,CreateEndpointGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateEndpointGroupRequest
public static interface CreateEndpointGroupRequest.Builder extends GlobalAcceleratorRequest.Builder, SdkPojo, CopyableBuilder<CreateEndpointGroupRequest.Builder,CreateEndpointGroupRequest>

  • Method Details

    • listenerArn

      CreateEndpointGroupRequest.Builder listenerArn(String listenerArn)

      The Amazon Resource Name (ARN) of the listener.

      Parameters:
      listenerArn - The Amazon Resource Name (ARN) of the listener.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointGroupRegion

      CreateEndpointGroupRequest.Builder endpointGroupRegion(String endpointGroupRegion)

      The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

      Parameters:
      endpointGroupRegion - The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointConfigurations

      CreateEndpointGroupRequest.Builder endpointConfigurations(Collection<EndpointConfiguration> endpointConfigurations)

      The list of endpoint objects.

      Parameters:
      endpointConfigurations - The list of endpoint objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointConfigurations

      CreateEndpointGroupRequest.Builder endpointConfigurations(EndpointConfiguration... endpointConfigurations)

      The list of endpoint objects.

      Parameters:
      endpointConfigurations - The list of endpoint objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointConfigurations

      CreateEndpointGroupRequest.Builder endpointConfigurations(Consumer<EndpointConfiguration.Builder>... endpointConfigurations)

      The list of endpoint objects.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpointConfigurations(List<EndpointConfiguration>).

      Parameters:
      endpointConfigurations - a consumer that will call methods on EndpointConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trafficDialPercentage

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

      CreateEndpointGroupRequest.Builder healthCheckPort(Integer 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 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 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

      CreateEndpointGroupRequest.Builder healthCheckProtocol(String 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

      CreateEndpointGroupRequest.Builder healthCheckProtocol(HealthCheckProtocol 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

      CreateEndpointGroupRequest.Builder healthCheckPath(String 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

      CreateEndpointGroupRequest.Builder healthCheckIntervalSeconds(Integer 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

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

    • idempotencyToken

      CreateEndpointGroupRequest.Builder idempotencyToken(String idempotencyToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

      Parameters:
      idempotencyToken - A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • portOverrides

      CreateEndpointGroupRequest.Builder portOverrides(Collection<PortOverride> 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

      CreateEndpointGroupRequest.Builder portOverrides(PortOverride... 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

      CreateEndpointGroupRequest.Builder portOverrides(Consumer<PortOverride.Builder>... 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 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<PortOverride>).

      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:

    • overrideConfiguration

      CreateEndpointGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateEndpointGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.