Skip to content

Create Resource Share

ram_create_resource_share R Documentation

Creates a resource share

Description

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, the permissions to grant those principals, and optionally source constraints to enhance security for service principal sharing.

Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

Usage

ram_create_resource_share(name, resourceArns, principals, tags,
  allowExternalPrincipals, clientToken, permissionArns, sources,
  resourceShareConfiguration)

Arguments

name

[required] Specifies the name of the resource share.
resourceArns

Specifies a list of one or more ARNs of the resources to associate with the resource share.
principals

Specifies a list of one or more principals to associate with the resource share.

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⁠

  • A service principal name, for example: service-id.amazonaws.com

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.
tags

Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.
allowExternalPrincipals

Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of true lets you share with individual Amazon Web Services accounts that are not in your organization. A value of false only has meaning if your account is a member of an Amazon Web Services Organization. The default value is true.
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 an IdempotentParameterMismatch error.
permissionArns

Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.
sources

Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) that limit when service principals can access resources in this resource share. When a service principal attempts to access a shared resource, validation is performed to ensure the request originates from one of the specified sources. This helps prevent confused deputy attacks by applying constraints on where service principals can access resources from.
resourceShareConfiguration

Specifies the configuration of this resource share.

Value

A list with the following syntax:

list(
  resourceShare = list(
    resourceShareArn = "string",
    name = "string",
    owningAccountId = "string",
    allowExternalPrincipals = TRUE|FALSE,
    status = "PENDING"|"ACTIVE"|"FAILED"|"DELETING"|"DELETED",
    statusMessage = "string",
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    creationTime = as.POSIXct(
      "2015-01-01"
    ),
    lastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    featureSet = "CREATED_FROM_POLICY"|"PROMOTING_TO_STANDARD"|"STANDARD",
    resourceShareConfiguration = list(
      retainSharingOnAccountLeaveOrganization = TRUE|FALSE
    )
  ),
  clientToken = "string"
)

Request syntax

svc$create_resource_share(
  name = "string",
  resourceArns = list(
    "string"
  ),
  principals = list(
    "string"
  ),
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  allowExternalPrincipals = TRUE|FALSE,
  clientToken = "string",
  permissionArns = list(
    "string"
  ),
  sources = list(
    "string"
  ),
  resourceShareConfiguration = list(
    retainSharingOnAccountLeaveOrganization = TRUE|FALSE
  )
)