Class CfnResourceShare

Creates a resource share.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnResourceShare

Implements

IInspectable

IResourceShareRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.RAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnResourceShare : CfnResource, IInspectable, IResourceShareRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnResourceShare Inherits CfnResource Implements IInspectable, IResourceShareRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RAM;

             var cfnResourceShare = new CfnResourceShare(this, "MyCfnResourceShare", new CfnResourceShareProps {
                 Name = "name",

                 // the properties below are optional
                 AllowExternalPrincipals = false,
                 PermissionArns = new [] { "permissionArns" },
                 Principals = new [] { "principals" },
                 ResourceArns = new [] { "resourceArns" },
                 Sources = new [] { "sources" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnResourceShare(Construct, string, ICfnResourceShareProps)

Create a new AWS::RAM::ResourceShare.

Properties

AllowExternalPrincipals	Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
AttrArn	The Amazon Resource Name (ARN) of the resource share.
AttrCreationTime	The date and time when the resource share was created.
AttrFeatureSet	Indicates what features are available for this resource share. This parameter can have one of the following values:.
AttrLastUpdatedTime	The date and time when the resource share was last updated.
AttrOwningAccountId	The ID of the AWS account that owns the resource share.
AttrStatus	The current status of the resource share.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a resource share.
Name	Specifies the name of the resource share.
PermissionArns	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	Specifies the principals to associate with the resource share.
ResourceArns	Specifies a list of one or more ARNs of the resources to associate with the resource share.
ResourceShareRef	A reference to a ResourceShare resource.
Sources	Specifies from which source accounts the service principal has access to the resources in this resource share.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Specifies one or more tags to attach to the resource share itself.

Methods

ArnForResourceShare(IResourceShareRef)	Creates a resource share.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnResourceShare(object)	Checks whether the given object is a CfnResourceShare.
RenderProperties(IDictionary<string, object>)	Creates a resource share.

Constructors

CfnResourceShare(Construct, string, ICfnResourceShareProps)

Create a new AWS::RAM::ResourceShare.

public CfnResourceShare(Construct scope, string id, ICfnResourceShareProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnResourceShareProps

Resource properties.

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

Properties

AllowExternalPrincipals

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

public virtual object? AllowExternalPrincipals { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

AttrArn

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

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreationTime

The date and time when the resource share was created.

public virtual string AttrCreationTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreationTime

AttrFeatureSet

Indicates what features are available for this resource share. This parameter can have one of the following values:.

public virtual string AttrFeatureSet { get; }

Property Value

string

Remarks

CloudformationAttribute: FeatureSet

AttrLastUpdatedTime

The date and time when the resource share was last updated.

public virtual string AttrLastUpdatedTime { get; }

Property Value

string

Remarks

CloudformationAttribute: LastUpdatedTime

AttrOwningAccountId

The ID of the AWS account that owns the resource share.

public virtual string AttrOwningAccountId { get; }

Property Value

string

Remarks

CloudformationAttribute: OwningAccountId

AttrStatus

The current status of the resource share.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

CloudformationAttribute: Status

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

CfnProperties

Creates a resource share.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

Name

Specifies the name of the resource share.

public virtual string Name { get; set; }

Property Value

string

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

PermissionArns

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.

public virtual string[]? PermissionArns { get; set; }

Property Value

string[]

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

Principals

Specifies the principals to associate with the resource share.

public virtual string[]? Principals { get; set; }

Property Value

string[]

Remarks

The possible values are:.

ResourceArns

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

public virtual string[]? ResourceArns { get; set; }

Property Value

string[]

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

ResourceShareRef

A reference to a ResourceShare resource.

public virtual IResourceShareReference ResourceShareRef { get; }

Property Value

IResourceShareReference

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

Sources

Specifies from which source accounts the service principal has access to the resources in this resource share.

public virtual string[]? Sources { get; set; }

Property Value

string[]

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

TagsRaw

Specifies one or more tags to attach to the resource share itself.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

Methods

ArnForResourceShare(IResourceShareRef)

Creates a resource share.

public static string ArnForResourceShare(IResourceShareRef resource)

Parameters

resource IResourceShareRef

Returns

string

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RAM;

             var cfnResourceShare = new CfnResourceShare(this, "MyCfnResourceShare", new CfnResourceShareProps {
                 Name = "name",

                 // the properties below are optional
                 AllowExternalPrincipals = false,
                 PermissionArns = new [] { "permissionArns" },
                 Principals = new [] { "principals" },
                 ResourceArns = new [] { "resourceArns" },
                 Sources = new [] { "sources" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

IsCfnResourceShare(object)

Checks whether the given object is a CfnResourceShare.

public static bool IsCfnResourceShare(object x)

Parameters

x object

Returns

bool

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a resource share.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

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

CloudformationResource: AWS::RAM::ResourceShare

ExampleMetadata: fixture=_generated

Implements

IInspectable

IResourceShareRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable