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

Class 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:
    Serialized Form

    • Method Detail

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

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

      • hashCode

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

      • equals

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

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