Class IpamResourceDiscoveryAssociation

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

An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.

See Also:

  • Method Details

    • ownerId

      public final String ownerId()

      The Amazon Web Services account ID of the resource discovery owner.

      Returns:
      The Amazon Web Services account ID of the resource discovery owner.

    • ipamResourceDiscoveryAssociationId

      public final String ipamResourceDiscoveryAssociationId()

      The resource discovery association ID.

      Returns:
      The resource discovery association ID.

    • ipamResourceDiscoveryAssociationArn

      public final String ipamResourceDiscoveryAssociationArn()

      The resource discovery association Amazon Resource Name (ARN).

      Returns:
      The resource discovery association Amazon Resource Name (ARN).

    • ipamResourceDiscoveryId

      public final String ipamResourceDiscoveryId()

      The resource discovery ID.

      Returns:
      The resource discovery ID.

    • ipamId

      public final String ipamId()

      The IPAM ID.

      Returns:
      The IPAM ID.

    • ipamArn

      public final String ipamArn()

      The IPAM ARN.

      Returns:
      The IPAM ARN.

    • ipamRegion

      public final String ipamRegion()

      The IPAM home Region.

      Returns:
      The IPAM home Region.

    • isDefault

      public final Boolean isDefault()

      Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.

      Returns:
      Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.

    • resourceDiscoveryStatus

      public final IpamAssociatedResourceDiscoveryStatus resourceDiscoveryStatus()

      The resource discovery status.

      • active - Connection or permissions required to read the results of the resource discovery are intact.

      • not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.

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

      Returns:
      The resource discovery status.

      • active - Connection or permissions required to read the results of the resource discovery are intact.

      • not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.

      See Also:

    • resourceDiscoveryStatusAsString

      public final String resourceDiscoveryStatusAsString()

      The resource discovery status.

      • active - Connection or permissions required to read the results of the resource discovery are intact.

      • not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.

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

      Returns:
      The resource discovery status.

      • active - Connection or permissions required to read the results of the resource discovery are intact.

      • not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.

      See Also:

    • state

      public final IpamResourceDiscoveryAssociationState state()

      The lifecycle state of the association when you associate or disassociate a resource discovery.

      • associate-in-progress - Resource discovery is being associated.

      • associate-complete - Resource discovery association is complete.

      • associate-failed - Resource discovery association has failed.

      • disassociate-in-progress - Resource discovery is being disassociated.

      • disassociate-complete - Resource discovery disassociation is complete.

      • disassociate-failed - Resource discovery disassociation has failed.

      • isolate-in-progress - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.

      • isolate-complete - Resource discovery isolation is complete..

      • restore-in-progress - Resource discovery is being restored.

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

      Returns:
      The lifecycle state of the association when you associate or disassociate a resource discovery.

      • associate-in-progress - Resource discovery is being associated.

      • associate-complete - Resource discovery association is complete.

      • associate-failed - Resource discovery association has failed.

      • disassociate-in-progress - Resource discovery is being disassociated.

      • disassociate-complete - Resource discovery disassociation is complete.

      • disassociate-failed - Resource discovery disassociation has failed.

      • isolate-in-progress - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.

      • isolate-complete - Resource discovery isolation is complete..

      • restore-in-progress - Resource discovery is being restored.

      See Also:

    • stateAsString

      public final String stateAsString()

      The lifecycle state of the association when you associate or disassociate a resource discovery.

      • associate-in-progress - Resource discovery is being associated.

      • associate-complete - Resource discovery association is complete.

      • associate-failed - Resource discovery association has failed.

      • disassociate-in-progress - Resource discovery is being disassociated.

      • disassociate-complete - Resource discovery disassociation is complete.

      • disassociate-failed - Resource discovery disassociation has failed.

      • isolate-in-progress - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.

      • isolate-complete - Resource discovery isolation is complete..

      • restore-in-progress - Resource discovery is being restored.

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

      Returns:
      The lifecycle state of the association when you associate or disassociate a resource discovery.

      • associate-in-progress - Resource discovery is being associated.

      • associate-complete - Resource discovery association is complete.

      • associate-failed - Resource discovery association has failed.

      • disassociate-in-progress - Resource discovery is being disassociated.

      • disassociate-complete - Resource discovery disassociation is complete.

      • disassociate-failed - Resource discovery disassociation has failed.

      • isolate-in-progress - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.

      • isolate-complete - Resource discovery isolation is complete..

      • restore-in-progress - Resource discovery is being restored.

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

      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

      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:
      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

    • toBuilder

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

    • builder

      public static IpamResourceDiscoveryAssociation.Builder builder()

    • serializableBuilderClass

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