Class ResourceShareAssociation

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

Describes an association between a resource share and either a principal or a resource.

See Also:

  • Method Details

    • resourceShareArn

      public final String resourceShareArn()

      The Amazon Resource Name (ARN) of the resource share.

      Returns:
      The Amazon Resource Name (ARN) of the resource share.

    • resourceShareName

      public final String resourceShareName()

      The name of the resource share.

      Returns:
      The name of the resource share.

    • associatedEntity

      public final String associatedEntity()

      The associated entity. This can be either of the following:

      • For a resource association, this is the Amazon Resource Name (ARN) of the resource.

      • For principal associations, this is one of the following:

        • The ID of an Amazon Web Services account

        • The Amazon Resource Name (ARN) of an organization in Organizations

        • The ARN of an organizational unit (OU) in Organizations

        • The ARN of an IAM role

        • The ARN of an IAM user

      Returns:
      The associated entity. This can be either of the following:

      • For a resource association, this is the Amazon Resource Name (ARN) of the resource.

      • For principal associations, this is one of the following:

        • The ID of an Amazon Web Services account

        • The Amazon Resource Name (ARN) of an organization in Organizations

        • The ARN of an organizational unit (OU) in Organizations

        • The ARN of an IAM role

        • The ARN of an IAM user

    • associationType

      public final ResourceShareAssociationType associationType()

      The type of entity included in this association.

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

      Returns:
      The type of entity included in this association.
      See Also:

    • associationTypeAsString

      public final String associationTypeAsString()

      The type of entity included in this association.

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

      Returns:
      The type of entity included in this association.
      See Also:

    • status

      public final ResourceShareAssociationStatus status()

      The current status of the association.

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

      Returns:
      The current status of the association.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the association.

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

      Returns:
      The current status of the association.
      See Also:

    • statusMessage

      public final String statusMessage()

      A message about the status of the association.

      Returns:
      A message about the status of the association.

    • creationTime

      public final Instant creationTime()

      The date and time when the association was created.

      Returns:
      The date and time when the association was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The date and time when the association was last updated.

      Returns:
      The date and time when the association was last updated.

    • external

      public final Boolean external()

      Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.

      Returns:
      Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.

    • toBuilder

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

    • builder

      public static ResourceShareAssociation.Builder builder()

    • serializableBuilderClass

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