Class AllowCustomRoutingTrafficRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AllowCustomRoutingTrafficRequest.Builder,
AllowCustomRoutingTrafficRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator.builder()
A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic.A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.final String
The Amazon Resource Name (ARN) of the endpoint group.final String
An ID for the endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DestinationAddresses property.final boolean
For responses, this returns true if the service returned a value for the DestinationPorts property.final int
hashCode()
static Class
<? extends AllowCustomRoutingTrafficRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
- Returns:
- The Amazon Resource Name (ARN) of the endpoint group.
-
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
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 ifAllowAllTrafficToEndpoint
isFALSE
or 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.
DestinationAddresses
is required ifAllowAllTrafficToEndpoint
isFALSE
or 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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AllowCustomRoutingTrafficRequest.Builder,
AllowCustomRoutingTrafficRequest> - Specified by:
toBuilder
in classGlobalAcceleratorRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-