Class IpamPolicyDocument

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

Information about an IPAM policy.

See Also:

  • Method Details

    • ipamPolicyId

      public final String ipamPolicyId()

      The ID of the IPAM policy.

      Returns:
      The ID of the IPAM policy.

    • locale

      public final String locale()

      The locale of the IPAM policy document.

      Returns:
      The locale of the IPAM policy document.

    • resourceType

      public final IpamPolicyResourceType resourceType()

      The resource type of the IPAM policy document.

      The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

      • Elastic IP addresses

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

      Returns:
      The resource type of the IPAM policy document.

      The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

      • Elastic IP addresses

      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The resource type of the IPAM policy document.

      The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

      • Elastic IP addresses

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

      Returns:
      The resource type of the IPAM policy document.

      The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

      • Elastic IP addresses

      See Also:

    • hasAllocationRules

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

    • allocationRules

      public final List<IpamPolicyAllocationRule> allocationRules()

      The allocation rules in the IPAM policy document.

      Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

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

      Returns:
      The allocation rules in the IPAM policy document.

      Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

    • toBuilder

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

    • builder

      public static IpamPolicyDocument.Builder builder()

    • serializableBuilderClass

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