CfnResourceShareProps

class aws_cdk.aws_ram.CfnResourceShareProps(*, name, allow_external_principals=None, permission_arns=None, principals=None, resource_arns=None, sources=None, tags=None)

Bases: object

Properties for defining a CfnResourceShare.

Parameters:

  • name (str) – Specifies the name of the resource share.

  • allow_external_principals (Union[bool, IResolvable, None]) – Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of true lets you share with individual AWS accounts that are not in your organization. A value of false only has meaning if your account is a member of an AWS Organization. The default value is true .

  • permission_arns (Optional[Sequence[str]]) – Specifies the Amazon Resource Names (ARNs) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS 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 (Optional[Sequence[str]]) – Specifies the principals to associate with the resource share. The possible values are:. - An AWS account ID - An Amazon Resource Name (ARN) of an organization in AWS Organizations - An ARN of an organizational unit (OU) in AWS Organizations - An ARN of an IAM role - An ARN of an IAM user .. epigraph:: Not all resource types can be shared with IAM roles and users. For more information, see the column Can share with IAM roles and users in the tables on Shareable AWS resources in the AWS Resource Access Manager User Guide .

  • resource_arns (Optional[Sequence[str]]) – Specifies a list of one or more ARNs of the resources to associate with the resource share.

  • sources (Optional[Sequence[str]]) –

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ram as ram

cfn_resource_share_props = ram.CfnResourceShareProps(
    name="name",

    # the properties below are optional
    allow_external_principals=False,
    permission_arns=["permissionArns"],
    principals=["principals"],
    resource_arns=["resourceArns"],
    sources=["sources"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

allow_external_principals

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

A value of true lets you share with individual AWS accounts that are not in your organization. A value of false only has meaning if your account is a member of an AWS Organization. The default value is true .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-allowexternalprincipals

name

Specifies the name of the resource share.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-name

permission_arns

//docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html>`_ of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-permissionarns

Type:

Specifies the `Amazon Resource Names (ARNs) <https

principals

.

  • An AWS account ID

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

  • An ARN of an organizational unit (OU) in AWS Organizations

  • An ARN of an IAM role

  • An ARN of an IAM user

Not all resource types can be shared with IAM roles and users. For more information, see the column Can share with IAM roles and users in the tables on Shareable AWS resources in the AWS Resource Access Manager User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-principals

Type:

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

resource_arns

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-resourcearns

sources

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-sources

Type:

see

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html#cfn-ram-resourceshare-tags