CreateResourceShareRequest

import type { CreateResourceShareRequest } from "https://aws-api.deno.dev/v0.3/services/ram.ts?docs=full";

interface CreateResourceShareRequest {

allowExternalPrincipals?: boolean | null;

clientToken?: string | null;

name: string;

permissionArns?: string[] | null;

principals?: string[] | null;

resourceArns?: string[] | null;

tags?: Tag[] | null;

}

§Properties

allowExternalPrincipals?: boolean | null

[src]

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?: string | null

[src]

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.

name: string

[src]

Specifies the name of the resource share.

permissionArns?: string[] | null

[src]

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.

principals?: string[] | null

[src]

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

resourceArns?: string[] | null

[src]

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

tags?: Tag[] | null

[src]

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.