Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ram ]

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  associate-resource-share
--resource-share-arn <value>
[--resource-arns <value>]
[--principals <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--resource-share-arn (string)

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to add principals or resources to.

--resource-arns (list)

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.

(string)

Syntax:

"string" "string" ...

--principals (list)

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

You can include the following values:

  • An Amazon Web Services account ID, for example: 123456789012
  • An Amazon Resoure 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

Note

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 .

(string)

Syntax:

"string" "string" ...

--client-token (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 associate a resource with a resource share

The following associate-resource-share example adds a license configuration to the specified resource share.

aws ram associate-resource-share \
    --resource-share arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE \
    --resource-arns arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-36be0485f5ae379cc74cf8e92EXAMPLE

Output:

{
    "resourceShareAssociations": [
        {
           "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE",
           "associatedEntity": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-36be0485f5ae379cc74cf8e92EXAMPLE",
           "associationType": "RESOURCE",
           "status": "ASSOCIATING",
           "external": false
        }
    ]
}

Example 2: To associate a principal with a resource share

The following associate-resource-share example grants access for the specified resource share to all accounts in the specified organizational unit.

aws ram associate-resource-share \
    --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE \
    --principals arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE

Output:

{
    "resourceShareAssociations": [
        {
            "status": "ASSOCIATING",
            "associationType": "PRINCIPAL",
            "associatedEntity": "arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE",
            "external": false,
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE"
        }
    ]
}

Output

resourceShareAssociations -> (list)

An array of objects that contain information about the associations.

(structure)

Describes an association with a resource share and either a principal or a resource.

resourceShareArn -> (string)

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

resourceShareName -> (string)

The name of the resource share.

associatedEntity -> (string)

The associated entity. This can be either of the following:

  • For a resource association, this is the Amazon Resoure Name (ARN) of the resource.
  • For principal associations, this is one of the following:
    • The ID of an Amazon Web Services account
    • The Amazon Resoure Name (ARN) of an organization in Organizations
    • The ARN of an organizational unit (OU) in Organizations
    • The ARN of an IAM role
    • The ARN of an IAM user

associationType -> (string)

The type of entity included in this association.

status -> (string)

The current status of the association.

statusMessage -> (string)

A message about the status of the association.

creationTime -> (timestamp)

The date and time when the association was created.

lastUpdatedTime -> (timestamp)

The date and time when the association was last updated.

external -> (boolean)

Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.

clientToken -> (string)

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.