[ aws . ram ]

associate-resource-share

Description

Associates the specified resource share with the specified principals and resources.

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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--resource-share-arn (string)

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

--resource-arns (list)

The Amazon Resource Names (ARNs) of the resources.

(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" ...

--client-token (string)

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

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

To associate a resource with a resource share

The following associate-resource-share example associates the specified subnet with the specified resource share.

aws ram associate-resource-share \
    --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235 \
    --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE

Output:

{
    "resourceShareAssociations": [
        "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
        "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235",
        "associationType": "RESOURCE",
        "status": "ASSOCIATING",
        "external": false
    ]
}

Output

resourceShareAssociations -> (list)

Information about the associations.

(structure)

Describes an association with a resource share.

resourceShareArn -> (string)

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

resourceShareName -> (string)

The name of the resource share.

associatedEntity -> (string)

The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:

• An Amazon Web Services account ID

• An 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

associationType -> (string)

The association type.

status -> (string)

The status of the association.

statusMessage -> (string)

A message about the status of the association.

creationTime -> (timestamp)

The time when the association was created.

lastUpdatedTime -> (timestamp)

The 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)

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