Class ResourceShare

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

Describes a resource share in RAM.

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

    • name

      public final String name()

      The name of the resource share.

      Returns:
      The name of the resource share.

    • owningAccountId

      public final String owningAccountId()

      The ID of the Amazon Web Services account that owns the resource share.

      Returns:
      The ID of the Amazon Web Services account that owns the resource share.

    • allowExternalPrincipals

      public final Boolean allowExternalPrincipals()

      Indicates whether principals outside your organization in Organizations can be associated with a resource share.

      • True – the resource share can be shared with any Amazon Web Services account.

      • False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.

      Returns:
      Indicates whether principals outside your organization in Organizations can be associated with a resource share.

      • True – the resource share can be shared with any Amazon Web Services account.

      • False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.

    • status

      public final ResourceShareStatus status()

      The current status of the resource share.

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

      Returns:
      The current status of the resource share.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the resource share.

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

      Returns:
      The current status of the resource share.
      See Also:

    • statusMessage

      public final String statusMessage()

      A message about the status of the resource share.

      Returns:
      A message about the status of the resource share.

    • 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 tag key and value pairs attached to the resource share.

      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 tag key and value pairs attached to the resource share.

    • creationTime

      public final Instant creationTime()

      The date and time when the resource share was created.

      Returns:
      The date and time when the resource share was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The date and time when the resource share was last updated.

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

    • featureSet

      public final ResourceShareFeatureSet featureSet()

      Indicates what features are available for this resource share. This parameter can have one of the following values:

      • STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.

      • CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

      • PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.

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

      Returns:
      Indicates what features are available for this resource share. This parameter can have one of the following values:

      • STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.

      • CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

      • PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.

      See Also:

    • featureSetAsString

      public final String featureSetAsString()

      Indicates what features are available for this resource share. This parameter can have one of the following values:

      • STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.

      • CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

      • PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.

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

      Returns:
      Indicates what features are available for this resource share. This parameter can have one of the following values:

      • STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.

      • CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

      • PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.

      See Also:

    • toBuilder

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

    • builder

      public static ResourceShare.Builder builder()

    • serializableBuilderClass

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