Class IpamPoolCidr

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

A CIDR provisioned to an IPAM pool.

See Also:

  • Method Details

    • cidr

      public final String cidr()

      The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

      Returns:
      The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

    • state

      public final IpamPoolCidrState state()

      The state of the CIDR.

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

      Returns:
      The state of the CIDR.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the CIDR.

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

      Returns:
      The state of the CIDR.
      See Also:

    • failureReason

      public final IpamPoolCidrFailureReason failureReason()

      Details related to why an IPAM pool CIDR failed to be provisioned.

      Returns:
      Details related to why an IPAM pool CIDR failed to be provisioned.

    • ipamPoolCidrId

      public final String ipamPoolCidrId()

      The IPAM pool CIDR ID.

      Returns:
      The IPAM pool CIDR ID.

    • netmaskLength

      public final Integer netmaskLength()

      The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.

      Returns:
      The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.

    • toBuilder

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

    • builder

      public static IpamPoolCidr.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.