1.204.0

interface CfnResourceShareProps

LanguageType name
.NETAmazon.CDK.AWS.RAM.CfnResourceShareProps
Javasoftware.amazon.awscdk.services.ram.CfnResourceShareProps
Pythonaws_cdk.aws_ram.CfnResourceShareProps
TypeScript @aws-cdk/aws-ram » CfnResourceShareProps

Properties for defining a CfnResourceShare.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ram from '@aws-cdk/aws-ram';
const cfnResourceShareProps: ram.CfnResourceShareProps = {
  name: 'name',

  // the properties below are optional
  allowExternalPrincipals: false,
  permissionArns: ['permissionArns'],
  principals: ['principals'],
  resourceArns: ['resourceArns'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
namestringSpecifies the name of the resource share.
allowExternalPrincipals?boolean | IResolvableSpecifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
permissionArns?string[]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?string[]Specifies the principals to associate with the resource share. The possible values are:.
resourceArns?string[]Specifies a list of one or more ARNs of the resources to associate with the resource share.
tags?CfnTag[]Specifies one or more tags to attach to the resource share itself.

name

Type: string

Specifies the name of the resource share.

allowExternalPrincipals?

Type: boolean | IResolvable (optional)

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 .

permissionArns?

Type: string[] (optional)

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?

Type: string[] (optional)

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

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 .

resourceArns?

Type: string[] (optional)

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

tags?

Type: CfnTag[] (optional)

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.

← PreviousNext →