Package software.amazon.awssdk.services.globalaccelerator.model

Class DenyCustomRoutingTrafficRequest

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.DenyCustomRoutingTrafficRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DenyCustomRoutingTrafficRequest.Builder,DenyCustomRoutingTrafficRequest>
@Generated("software.amazon.awssdk:codegen") public final class DenyCustomRoutingTrafficRequest extends GlobalAcceleratorRequest implements ToCopyableBuilder<DenyCustomRoutingTrafficRequest.Builder,DenyCustomRoutingTrafficRequest>

  • Method Details

    • 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 the isEmpty() 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 prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group.

      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 prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group.

    • 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 the isEmpty() 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) in a subnet endpoint that you want to prevent from receiving 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) in a subnet endpoint that you want to prevent from receiving traffic.

    • denyAllTrafficToEndpoint

      public final Boolean denyAllTrafficToEndpoint()

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

      When set to TRUE, no 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 cannot 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 cannot receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

      When set to TRUE, no 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 cannot 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 DenyCustomRoutingTrafficRequest.Builder 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 interface ToCopyableBuilder<DenyCustomRoutingTrafficRequest.Builder,DenyCustomRoutingTrafficRequest>
      Specified by:
      toBuilder in class GlobalAcceleratorRequest
      Returns:
      a builder for type T

    • builder

      public static DenyCustomRoutingTrafficRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DenyCustomRoutingTrafficRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.