Class CfnResourceShare

Creates a resource share.

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnResourceShare

Implements

IInspectable

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(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<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.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, ITaggable

Syntax (vb)

Public Class CfnResourceShare
    Inherits CfnResource
    Implements IInspectable, 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(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnResourceShare(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnResourceShare(Construct, String, ICfnResourceShareProps)

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.
AttrId
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
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.
Sources
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Specifies one or more tags to attach to the resource share itself.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnResourceShare(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnResourceShare(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnResourceShare(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnResourceShare(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

CfnResourceShare(Construct, String, ICfnResourceShareProps)

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

Parameters

scope Constructs.Construct: Scope in which this resource is defined.
id System.String: Construct identifier for this resource (unique in its scope).
props ICfnResourceShareProps: Resource properties.

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

System.Object

AttrArn

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

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrId

public virtual string AttrId { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

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

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

Name

Specifies the name of the resource share.

public virtual string Name { get; set; }

Property Value

System.String

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

System.String[]

Principals

Specifies the principals to associate with the resource share.

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

Property Value

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

System.String[]

Sources

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

Property Value

System.String[]

TagsRaw

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

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

Property Value

ICfnTag[]

Methods

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.

RenderProperties(IDictionary<String, Object>)

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

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable

ITaggable