CfnResourceShareProps

class aws_cdk.aws_ram.CfnResourceShareProps(*, name, allow_external_principals=None, permission_arns=None, principals=None, resource_arns=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 a list of one or more principals to associate with the resource share. You can include the following values: - An AWS account ID, for example: 123456789012 - An Amazon Resoure Name (ARN) of an organization in AWS Organizations , for example: arn:aws:organizations::123456789012:organization/o-exampleorgid - An ARN of an organizational unit (OU) in AWS Organizations , for example: arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 - An ARN of an IAM role, for example: arn:aws:iam::123456789012:role/rolename - An ARN of an IAM user, for example: arn:aws:iam::123456789012user/username .. epigraph:: Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users 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.

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

Link

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.
import aws_cdk.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"],
    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 .

Link

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

Return type

Union[bool, IResolvable, None]

name

Specifies the name of the resource share.

Link

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

Return type

str

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.

Link

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

Return type

Optional[List[str]]

principals

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

You can include the following values:

  • An AWS account ID, for example: 123456789012

  • An Amazon Resoure Name (ARN) of an organization in AWS Organizations , for example: arn:aws:organizations::123456789012:organization/o-exampleorgid

  • An ARN of an organizational unit (OU) in AWS Organizations , for example: arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

  • An ARN of an IAM role, for example: arn:aws:iam::123456789012:role/rolename

  • An ARN of an IAM user, for example: arn:aws:iam::123456789012user/username

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

Link

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

Return type

Optional[List[str]]

resource_arns

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

Link

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

Return type

Optional[List[str]]

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.

Link

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

Return type

Optional[List[CfnTag]]