Class AssociatedPermission

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

An object that describes a managed permission associated with a resource share.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the associated managed permission.

      Returns:
      The Amazon Resource Name (ARN) of the associated managed permission.

    • permissionVersion

      public final String permissionVersion()

      The version of the permission currently associated with the resource share.

      Returns:
      The version of the permission currently associated with the resource share.

    • defaultVersion

      public final Boolean defaultVersion()

      Indicates whether the associated resource share is using the default version of the permission.

      Returns:
      Indicates whether the associated resource share is using the default version of the permission.

    • resourceType

      public final String resourceType()

      The resource type to which this permission applies.

      Returns:
      The resource type to which this permission applies.

    • status

      public final String status()

      The current status of the association between the permission and the resource share. The following are the possible values:

      • ATTACHABLE – This permission or version can be associated with resource shares.

      • UNATTACHABLE – This permission or version can't currently be associated with resource shares.

      • DELETING – This permission or version is in the process of being deleted.

      • DELETED – This permission or version is deleted.

      Returns:
      The current status of the association between the permission and the resource share. The following are the possible values:

      • ATTACHABLE – This permission or version can be associated with resource shares.

      • UNATTACHABLE – This permission or version can't currently be associated with resource shares.

      • DELETING – This permission or version is in the process of being deleted.

      • DELETED – This permission or version is deleted.

    • featureSet

      public final PermissionFeatureSet 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 PermissionFeatureSet.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 PermissionFeatureSet.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:

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

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

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

    • resourceShareArn

      public final String resourceShareArn()

      The Amazon Resource Name (ARN) of a resource share associated with this permission.

      Returns:
      The Amazon Resource Name (ARN) of a resource share associated with this permission.

    • toBuilder

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

    • builder

      public static AssociatedPermission.Builder builder()

    • serializableBuilderClass

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