Class IpamPrefixListResolver

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

Describes an IPAM prefix list resolver.

An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups.

See Also:

  • Method Details

    • ownerId

      public final String ownerId()

      The ID of the Amazon Web Services account that owns the IPAM prefix list resolver.

      Returns:
      The ID of the Amazon Web Services account that owns the IPAM prefix list resolver.

    • ipamPrefixListResolverId

      public final String ipamPrefixListResolverId()

      The ID of the IPAM prefix list resolver.

      Returns:
      The ID of the IPAM prefix list resolver.

    • ipamPrefixListResolverArn

      public final String ipamPrefixListResolverArn()

      The Amazon Resource Name (ARN) of the IPAM prefix list resolver.

      Returns:
      The Amazon Resource Name (ARN) of the IPAM prefix list resolver.

    • ipamArn

      public final String ipamArn()

      The Amazon Resource Name (ARN) of the IPAM associated with this resolver.

      Returns:
      The Amazon Resource Name (ARN) of the IPAM associated with this resolver.

    • ipamRegion

      public final String ipamRegion()

      The Amazon Web Services Region where the associated IPAM is located.

      Returns:
      The Amazon Web Services Region where the associated IPAM is located.

    • description

      public final String description()

      The description of the IPAM prefix list resolver.

      Returns:
      The description of the IPAM prefix list resolver.

    • addressFamily

      public final AddressFamily addressFamily()

      The address family (IPv4 or IPv6) for the IPAM prefix list resolver.

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

      Returns:
      The address family (IPv4 or IPv6) for the IPAM prefix list resolver.
      See Also:

    • addressFamilyAsString

      public final String addressFamilyAsString()

      The address family (IPv4 or IPv6) for the IPAM prefix list resolver.

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

      Returns:
      The address family (IPv4 or IPv6) for the IPAM prefix list resolver.
      See Also:

    • state

      public final IpamPrefixListResolverState state()

      The current state of the IPAM prefix list resolver. Valid values include create-in-progress, create-complete, create-failed, modify-in-progress, modify-complete, modify-failed, delete-in-progress, delete-complete, and delete-failed.

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

      Returns:
      The current state of the IPAM prefix list resolver. Valid values include create-in-progress, create-complete, create-failed, modify-in-progress, modify-complete, modify-failed, delete-in-progress, delete-complete, and delete-failed.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the IPAM prefix list resolver. Valid values include create-in-progress, create-complete, create-failed, modify-in-progress, modify-complete, modify-failed, delete-in-progress, delete-complete, and delete-failed.

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

      Returns:
      The current state of the IPAM prefix list resolver. Valid values include create-in-progress, create-complete, create-failed, modify-in-progress, modify-complete, modify-failed, delete-in-progress, delete-complete, and delete-failed.
      See Also:

    • 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 prefix list resolver.

      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 prefix list resolver.

    • lastVersionCreationStatus

      public final IpamPrefixListResolverVersionCreationStatus lastVersionCreationStatus()

      The status for the last time a version was created.

      Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

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

      Returns:
      The status for the last time a version was created.

      Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

      See Also:

    • lastVersionCreationStatusAsString

      public final String lastVersionCreationStatusAsString()

      The status for the last time a version was created.

      Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

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

      Returns:
      The status for the last time a version was created.

      Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

      See Also:

    • lastVersionCreationStatusMessage

      public final String lastVersionCreationStatusMessage()

      The status message for the last time a version was created.

      Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

      Returns:
      The status message for the last time a version was created.

      Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

    • toBuilder

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

    • builder

      public static IpamPrefixListResolver.Builder builder()

    • serializableBuilderClass

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