create-resource-share¶

Description¶

Creates a resource share. You must provide a list of the Amazon Resource Names (ARNs) for the resources you want to share. You must also specify who you want to share the resources with, and the permissions that you grant them.

Note

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.

Synopsis¶

  create-resource-share
--name <value>
[--resource-arns <value>]
[--principals <value>]
[--tags <value>]
[--allow-external-principals | --no-allow-external-principals]
[--client-token <value>]
[--permission-arns <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--name (string)

The name of the resource share.

--resource-arns (list)

The ARNs of the resources to associate with the resource share.

(string)

Syntax:

"string" "string" ...

--principals (list)

The principals to associate with the resource share. The possible values are:

An Amazon Web Services account ID

An Amazon Resource Name (ARN) of an organization in Organizations

An ARN of an organizational unit (OU) in Organizations

An ARN of an IAM role

An ARN of an IAM user

Note

Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide .

(string)

Syntax:

"string" "string" ...

--tags (list)

One or more tags.

(structure)

Information about a tag.

key -> (string)

The key of the tag.

value -> (string)

The value of the tag.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--allow-external-principals | --no-allow-external-principals (boolean)

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

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--permission-arns (list)

The Amazon Resource Names (ARNs) of the permissions 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. Only one permission can be associated with each resource type in a resource share.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Example 1: To create a resource share

The following create-resource-share example creates a resource share with the specified name.

aws ram create-resource-share \
    --name my-resource-share

Output:

{
    "resourceShare": {
        "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
        "name": "my-resource-share",
        "owningAccountId": "123456789012",
        "allowExternalPrincipals": true,
        "status": "ACTIVE",
        "creationTime": 1565295733.282,
        "lastUpdatedTime": 1565295733.282
    }
}

Example 2: To create a resource share with AWS accounts as principals

The following create-resource-share example creates a resource share and adds the specified principals.

aws ram create-resource-share \
    --name my-resource-share \
    --principals 0abcdef1234567890

EXAMPLE 3: To create a resource share restricted to your organization in AWS Organizations

The following create-resource-share example creates a resource share that is restricted to your organization and adds the specified OU as a principal.

aws ram create-resource-share \
    --name my-resource-share \
    --no-allow-external-principals \
    --principals arn:aws:organizations::123456789012:ou/o-gx7EXAMPLE/ou-29c5-zEXAMPLE

Output:

{
    "resourceShare": {
        "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/3ab63985-99d9-1cd2-7d24-75e93EXAMPLE",
        "name": "my-resource-share",
        "owningAccountId": "123456789012",
        "allowExternalPrincipals": false,
        "status": "ACTIVE",
        "creationTime": 1565295733.282,
        "lastUpdatedTime": 1565295733.282
    }
}

Output¶

resourceShare -> (structure)

Information about the resource share.

resourceShareArn -> (string)

The Amazon Resource Name (ARN) of the resource share.

name -> (string)

The name of the resource share.

owningAccountId -> (string)

The ID of the Amazon Web Services account that owns the resource share.

allowExternalPrincipals -> (boolean)

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

status -> (string)

The status of the resource share.

statusMessage -> (string)

A message about the status of the resource share.

tags -> (list)

The tags for the resource share.

(structure)

Information about a tag.

key -> (string)

The key of the tag.

value -> (string)

The value of the tag.

creationTime -> (timestamp)

The time when the resource share was created.

lastUpdatedTime -> (timestamp)

The time when the resource share was last updated.

featureSet -> (string)

Indicates how the resource share was created. Possible values include:

CREATED_FROM_POLICY - Indicates that the resource share was created from an Amazon Web Services Identity and Access Management (Amazon Web Services IAM) policy attached to a resource. These resource shares are visible only to the Amazon Web Services account that created it. They cannot be modified in RAM.

PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy .

STANDARD - Indicates that the resource share was created in RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in RAM.

clientToken -> (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Table of Contents

Feedback

User Guide