ResourceSharePermissionSummary - AWS RAM

ResourceSharePermissionSummary

Information about an AWS RAM permission.

Contents

Note

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

arn

The Amazon Resource Name (ARN) of the permission you want information about.

Type: String

Required: No

creationTime

The date and time when the permission was created.

Type: Timestamp

Required: No

defaultVersion

Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.

Type: Boolean

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

isResourceTypeDefault

Specifies whether the managed permission associated with this resource share is the default managed permission for all resources of this resource type.

Type: Boolean

Required: No

lastUpdatedTime

The date and time when the permission was last updated.

Type: Timestamp

Required: No

name

The name of this managed permission.

Type: String

Required: No

permissionType

The type of managed permission. This can be one of the following values:

  • AWS_MANAGED – AWS created and manages this managed permission. You can associate it with your resource shares, but you can't modify it.

  • CUSTOMER_MANAGED – You, or another principal in your account created this managed permission. You can associate it with your resource shares and create new versions that have different permissions.

Type: String

Valid Values: CUSTOMER_MANAGED | AWS_MANAGED

Required: No

resourceType

The type of resource to which this permission applies. This takes the form of: service-code:resource-code, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string ec2:subnet.

Type: String

Required: No

status

The current status of the permission.

Type: String

Required: No

tags

A list of the tag key value pairs currently attached to the permission.

Type: Array of Tag objects

Required: No

version

The version of the permission associated with this resource share.

Type: String

Required: No

See Also

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