software.amazon.awssdk.services.globalaccelerator.model

Class AllowCustomRoutingTrafficRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.globalaccelerator.model.GlobalAcceleratorRequest

software.amazon.awssdk.services.globalaccelerator.model.AllowCustomRoutingTrafficRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AllowCustomRoutingTrafficRequest.Builder,AllowCustomRoutingTrafficRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class AllowCustomRoutingTrafficRequest
extends GlobalAcceleratorRequest
implements ToCopyableBuilder<AllowCustomRoutingTrafficRequest.Builder,AllowCustomRoutingTrafficRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AllowCustomRoutingTrafficRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowAllTrafficToEndpoint() Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator.
static AllowCustomRoutingTrafficRequest.Builder	builder()
List<String>	destinationAddresses() A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic.
List<Integer>	destinationPorts() A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.
String	endpointGroupArn() The Amazon Resource Name (ARN) of the endpoint group.
String	endpointId() An ID for the endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestinationAddresses() Returns true if the DestinationAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasDestinationPorts() Returns true if the DestinationPorts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AllowCustomRoutingTrafficRequest.Builder>	serializableBuilderClass()
AllowCustomRoutingTrafficRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

endpointGroupArn

public final String endpointGroupArn()

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

Returns:

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

endpointId

public final String endpointId()

An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

Returns:

An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

hasDestinationAddresses

public final boolean hasDestinationAddresses()

Returns true if the DestinationAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

destinationAddresses

public final List<String> destinationAddresses()

A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.

DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDestinationAddresses() to see if a value was sent in this field.

Returns:

A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.

DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.

hasDestinationPorts

public final boolean hasDestinationPorts()

Returns true if the DestinationPorts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

destinationPorts

public final List<Integer> destinationPorts()

A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDestinationPorts() to see if a value was sent in this field.

Returns:

A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.

allowAllTrafficToEndpoint

public final Boolean allowAllTrafficToEndpoint()

Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

The default value is FALSE.

Returns:

Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

The default value is FALSE.

toBuilder

public AllowCustomRoutingTrafficRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AllowCustomRoutingTrafficRequest.Builder,AllowCustomRoutingTrafficRequest>

Specified by:

toBuilder in class GlobalAcceleratorRequest

builder

public static AllowCustomRoutingTrafficRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AllowCustomRoutingTrafficRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo