Package software.amazon.awssdk.services.ec2.model

Class ByoipCidr

java.lang.Object
software.amazon.awssdk.services.ec2.model.ByoipCidr
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ByoipCidr.Builder,ByoipCidr>
@Generated("software.amazon.awssdk:codegen") public final class ByoipCidr extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ByoipCidr.Builder,ByoipCidr>

Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

See Also:

  • Method Details

    • cidr

      public final String cidr()

      The address range, in CIDR notation.

      Returns:
      The address range, in CIDR notation.

    • description

      public final String description()

      The description of the address range.

      Returns:
      The description of the address range.

    • hasAsnAssociations

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

    • asnAssociations

      public final List<AsnAssociation> asnAssociations()

      The BYOIP CIDR associations with ASNs.

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

      Returns:
      The BYOIP CIDR associations with ASNs.

    • statusMessage

      public final String statusMessage()

      Upon success, contains the ID of the address pool. Otherwise, contains an error message.

      Returns:
      Upon success, contains the ID of the address pool. Otherwise, contains an error message.

    • state

      public final ByoipCidrState state()

      The state of the address range.

      • advertised: The address range is being advertised to the internet by Amazon Web Services.

      • deprovisioned: The address range is deprovisioned.

      • failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

      • failed-provision: The request to provision the address range was unsuccessful.

      • pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.

      • pending-provision: You’ve submitted a request to provision an address range and it's pending.

      • provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

      • provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

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

      Returns:
      The state of the address range.

      • advertised: The address range is being advertised to the internet by Amazon Web Services.

      • deprovisioned: The address range is deprovisioned.

      • failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

      • failed-provision: The request to provision the address range was unsuccessful.

      • pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.

      • pending-provision: You’ve submitted a request to provision an address range and it's pending.

      • provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

      • provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the address range.

      • advertised: The address range is being advertised to the internet by Amazon Web Services.

      • deprovisioned: The address range is deprovisioned.

      • failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

      • failed-provision: The request to provision the address range was unsuccessful.

      • pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.

      • pending-provision: You’ve submitted a request to provision an address range and it's pending.

      • provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

      • provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

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

      Returns:
      The state of the address range.

      • advertised: The address range is being advertised to the internet by Amazon Web Services.

      • deprovisioned: The address range is deprovisioned.

      • failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

      • failed-provision: The request to provision the address range was unsuccessful.

      • pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.

      • pending-provision: You’ve submitted a request to provision an address range and it's pending.

      • provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

      • provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

      See Also:

    • networkBorderGroup

      public final String networkBorderGroup()

      If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

      You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

      • us-east-1-dfw-2

      • us-west-2-lax-1

      • us-west-2-phx-2

      You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

      Returns:
      If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

      You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

      • us-east-1-dfw-2

      • us-west-2-lax-1

      • us-west-2-phx-2

      You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

    • toBuilder

      public ByoipCidr.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<ByoipCidr.Builder,ByoipCidr>
      Returns:
      a builder for type T

    • builder

      public static ByoipCidr.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

    • 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.