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

Class CreateCustomRoutingAcceleratorRequest

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

  • Method Details

    • name

      public final String name()

      The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

      Returns:
      The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

    • ipAddressType

      public final IpAddressType ipAddressType()

      The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
      See Also:

    • hasIpAddresses

      public final boolean hasIpAddresses()
      For responses, this returns true if the service returned a value for the IpAddresses 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.

    • ipAddresses

      public final List<String> ipAddresses()

      Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

      After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

      You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

      Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

      For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

      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 hasIpAddresses() method.

      Returns:
      Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

      After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

      You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

      Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

      For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    • enabled

      public final Boolean enabled()

      Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

      If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

      Returns:
      Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

      If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

    • idempotencyToken

      public final String idempotencyToken()

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

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      Create tags for an accelerator.

      For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

      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 hasTags() method.

      Returns:
      Create tags for an accelerator.

      For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

    • toBuilder

      public CreateCustomRoutingAcceleratorRequest.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<CreateCustomRoutingAcceleratorRequest.Builder,CreateCustomRoutingAcceleratorRequest>
      Specified by:
      toBuilder in class GlobalAcceleratorRequest
      Returns:
      a builder for type T

    • builder

      public static CreateCustomRoutingAcceleratorRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateCustomRoutingAcceleratorRequest.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.