Class CfnResourceShare
A CloudFormation AWS::RAM::ResourceShare
.
Inherited Members
Namespace: Amazon.CDK.AWS.RAM
Assembly: Amazon.CDK.AWS.RAM.dll
Syntax (csharp)
public class CfnResourceShare : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnResourceShare
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a resource share. 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.
CloudformationResource: AWS::RAM::ResourceShare
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html
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" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnResourceShare(Construct, String, ICfnResourceShareProps) | Create a new |
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 |
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. |
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. The possible values are:. |
ResourceArns | Specifies a list of one or more ARNs of the resources to associate with the resource share. |
Tags | 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(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 System.String
- scoped id of the resource.
- props ICfnResourceShareProps
- resource properties.
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
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
Remarks
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
.
AttrArn
The Amazon Resource Name (ARN) of the resource share.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
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
Name
Specifies the name of the resource share.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
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[]
Remarks
Principals
Specifies the principals to associate with the resource share. The possible values are:.
public virtual string[] Principals { get; set; }
Property Value
System.String[]
Remarks
Not all resource types can be shared with IAM roles and users. For more information, see the column <em>Can share with IAM roles and users</em> in the tables on <a href="https://docs.aws.amazon.com/ram/latest/userguide/shareable.html">Shareable AWS resources</a> in the <em>AWS Resource Access Manager User Guide</em> .
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[]
Remarks
Tags
Specifies one or more tags to attach to the resource share itself.
public virtual TagManager Tags { get; }
Property Value
Remarks
It doesn't attach the tags to the resources associated with the resource share.
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>