Class IpamPolicy

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

Information about an IPAM policy.

An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

See Also:

  • Method Details

    • ownerId

      public final String ownerId()

      The account ID that owns the IPAM policy.

      Returns:
      The account ID that owns the IPAM policy.

    • ipamPolicyId

      public final String ipamPolicyId()

      The ID of the IPAM policy.

      Returns:
      The ID of the IPAM policy.

    • ipamPolicyArn

      public final String ipamPolicyArn()

      The Amazon Resource Name (ARN) of the IPAM policy.

      Returns:
      The Amazon Resource Name (ARN) of the IPAM policy.

    • ipamPolicyRegion

      public final String ipamPolicyRegion()

      The Region of the IPAM policy.

      Returns:
      The Region of the IPAM policy.

    • state

      public final IpamPolicyState state()

      The state of the IPAM policy.

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

      Returns:
      The state of the IPAM policy.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the IPAM policy.

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

      Returns:
      The state of the IPAM policy.
      See Also:

    • stateMessage

      public final String stateMessage()

      A message about the state of the IPAM policy.

      Returns:
      A message about the state of the IPAM policy.

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

      The tags assigned to the IPAM policy.

      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:
      The tags assigned to the IPAM policy.

    • ipamId

      public final String ipamId()

      The ID of the IPAM this policy belongs to.

      Returns:
      The ID of the IPAM this policy belongs to.

    • toBuilder

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

    • builder

      public static IpamPolicy.Builder builder()

    • serializableBuilderClass

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