Class IpamPrefixListResolverTarget

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

Describes an IPAM prefix list resolver target.

An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in Amazon Web Services resources.

See Also:

  • Method Details

    • ipamPrefixListResolverTargetId

      public final String ipamPrefixListResolverTargetId()

      The ID of the IPAM prefix list resolver target.

      Returns:
      The ID of the IPAM prefix list resolver target.

    • ipamPrefixListResolverTargetArn

      public final String ipamPrefixListResolverTargetArn()

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

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

    • ipamPrefixListResolverId

      public final String ipamPrefixListResolverId()

      The ID of the IPAM prefix list resolver associated with this target.

      Returns:
      The ID of the IPAM prefix list resolver associated with this target.

    • ownerId

      public final String ownerId()

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

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

    • prefixListId

      public final String prefixListId()

      The ID of the managed prefix list associated with this target.

      Returns:
      The ID of the managed prefix list associated with this target.

    • prefixListRegion

      public final String prefixListRegion()

      The Amazon Web Services Region where the prefix list associated with this target is located.

      Returns:
      The Amazon Web Services Region where the prefix list associated with this target is located.

    • desiredVersion

      public final Long desiredVersion()

      The desired version of the prefix list that this target should synchronize with.

      Returns:
      The desired version of the prefix list that this target should synchronize with.

    • lastSyncedVersion

      public final Long lastSyncedVersion()

      The version of the prefix list that was last successfully synchronized by this target.

      Returns:
      The version of the prefix list that was last successfully synchronized by this target.

    • trackLatestVersion

      public final Boolean trackLatestVersion()

      Indicates whether this target automatically tracks the latest version of the prefix list.

      Returns:
      Indicates whether this target automatically tracks the latest version of the prefix list.

    • stateMessage

      public final String stateMessage()

      A message describing the current state of the IPAM prefix list resolver target, including any error information.

      Returns:
      A message describing the current state of the IPAM prefix list resolver target, including any error information.

    • state

      public final IpamPrefixListResolverTargetState state()

      The current state of the IPAM prefix list resolver target. 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 IpamPrefixListResolverTargetState.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 target. 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 target. 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 IpamPrefixListResolverTargetState.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 target. 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 target.

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

    • toBuilder

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

    • builder

      public static IpamPrefixListResolverTarget.Builder builder()

    • serializableBuilderClass

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