ResourceShare - AWS RAM
ContentsSee Also

ResourceShare

Describes a resource share in AWS RAM.

Contents

Note

In the following list, the required parameters are described first.

allowExternalPrincipals

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

  • True – the resource share can be shared with any AWS account.

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

Type: Boolean

Required: No

creationTime

The date and time when the resource share was created.

Type: Timestamp

Required: No

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 AWS RAM using the console or APIs. This resource share might have been created by AWS 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 AWS 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 AWS account that created it. You can't modify it in AWS 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.

Type: String

Valid Values: CREATED_FROM_POLICY | PROMOTING_TO_STANDARD | STANDARD

Required: No

lastUpdatedTime

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

Type: Timestamp

Required: No

name

The name of the resource share.

Type: String

Required: No

owningAccountId

The ID of the AWS account that owns the resource share.

Type: String

Required: No

resourceShareArn

The Amazon Resource Name (ARN) of the resource share

Type: String

Required: No

status

The current status of the resource share.

Type: String

Valid Values: PENDING | ACTIVE | FAILED | DELETING | DELETED

Required: No

statusMessage

A message about the status of the resource share.

Type: String

Required: No

tags

The tag key and value pairs attached to the resource share.

Type: Array of Tag objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: