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("software.amazon.awssdk:codegen") public final class AllowCustomRoutingTrafficRequest extends GlobalAcceleratorRequest implements ToCopyableBuilder<AllowCustomRoutingTrafficRequest.Builder,AllowCustomRoutingTrafficRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAllowCustomRoutingTrafficRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanallowAllTrafficToEndpoint()Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator.static AllowCustomRoutingTrafficRequest.Builderbuilder()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.StringendpointGroupArn()The Amazon Resource Name (ARN) of the endpoint group.StringendpointId()An ID for the endpoint.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDestinationAddresses()For responses, this returns true if the service returned a value for the DestinationAddresses property.booleanhasDestinationPorts()For responses, this returns true if the service returned a value for the DestinationPorts property.inthashCode()List<SdkField<?>>sdkFields()static Class<? extends AllowCustomRoutingTrafficRequest.Builder>serializableBuilderClass()AllowCustomRoutingTrafficRequest.BuildertoBuilder()StringtoString()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()
For responses, this returns true if the service returned a value for the DestinationAddresses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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.
DestinationAddressesis required ifAllowAllTrafficToEndpointisFALSEor is not specified.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDestinationAddresses()method.- 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.
DestinationAddressesis required ifAllowAllTrafficToEndpointisFALSEor is not specified.
-
hasDestinationPorts
public final boolean hasDestinationPorts()
For responses, this returns true if the service returned a value for the DestinationPorts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDestinationPorts()method.- 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:
toBuilderin interfaceToCopyableBuilder<AllowCustomRoutingTrafficRequest.Builder,AllowCustomRoutingTrafficRequest>- Specified by:
toBuilderin classGlobalAcceleratorRequest
-
builder
public static AllowCustomRoutingTrafficRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends AllowCustomRoutingTrafficRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-