Associate Resource Share
ram_associate_resource_share | R Documentation |
Adds the specified list of principals and list of resources to a resource share¶
Description¶
Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.
Usage¶
Arguments¶
resourceShareArn
[required] Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.
resourceArns
Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be
null
if you want to add only principals.principals
Specifies a list of principals to whom you want to the resource share. This can be
null
if you want to add only resources.What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See
associate_resource_share_permission
.You can include the following values:
An Amazon Web Services account ID, for example:
123456789012
An Amazon Resource Name (ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
An ARN of an IAM role, for example:
iam::123456789012:role/rolename
An ARN of an IAM user, for example:
iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.sources
Specifies from which source accounts the service principal has access to the resources in this resource share.
Value¶
A list with the following syntax:
list(
resourceShareAssociations = list(
list(
resourceShareArn = "string",
resourceShareName = "string",
associatedEntity = "string",
associationType = "PRINCIPAL"|"RESOURCE",
status = "ASSOCIATING"|"ASSOCIATED"|"FAILED"|"DISASSOCIATING"|"DISASSOCIATED",
statusMessage = "string",
creationTime = as.POSIXct(
"2015-01-01"
),
lastUpdatedTime = as.POSIXct(
"2015-01-01"
),
external = TRUE|FALSE
)
),
clientToken = "string"
)