Show / Hide Table of Contents

Class CfnPermission

Creates a customer managed permission for a specified resource type that you can attach to resource shares.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnPermission
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(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.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 CfnPermission : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnPermission Inherits CfnResource Implements IInspectable, ITaggable
Remarks

It is created in the AWS Region in which you call the operation.

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

CloudformationResource: AWS::RAM::Permission

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 policyTemplate;

             var cfnPermission = new CfnPermission(this, "MyCfnPermission", new CfnPermissionProps {
                 Name = "name",
                 PolicyTemplate = policyTemplate,
                 ResourceType = "resourceType",

                 // the properties below are optional
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnPermission(Construct, string, ICfnPermissionProps)

Creates a customer managed permission for a specified resource type that you can attach to resource shares.

Properties

AttrArn

The Amazon Resource Name (ARN) of the new permission.

AttrIsResourceTypeDefault

Specifies whether this permission is the default for new resource shares that include resources of the associated resource type.

AttrPermissionType

The type of managed permission. This can be one of the following values:.

AttrVersion

The version number for this version of the permission.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties

Creates a customer managed permission for a specified resource type that you can attach to resource shares.

Name

Specifies the name of the customer managed permission.

PolicyTemplate

A string in JSON format string that contains the following elements of a resource-based policy:.

ResourceType

Specifies the name of the resource type that this customer managed permission applies to.

Tags

Tag Manager which manages the tags for this resource.

TagsRaw

Specifies a list of one or more tag key and value pairs to attach to the permission.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<string, object>)

Creates a customer managed permission for a specified resource type that you can attach to resource shares.

Constructors

CfnPermission(Construct, string, ICfnPermissionProps)

Creates a customer managed permission for a specified resource type that you can attach to resource shares.

public CfnPermission(Construct scope, string id, ICfnPermissionProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnPermissionProps

Resource properties.

Remarks

It is created in the AWS Region in which you call the operation.

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

CloudformationResource: AWS::RAM::Permission

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the new permission.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrIsResourceTypeDefault

Specifies whether this permission is the default for new resource shares that include resources of the associated resource type.

public virtual IResolvable AttrIsResourceTypeDefault { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: IsResourceTypeDefault

AttrPermissionType

The type of managed permission. This can be one of the following values:.

public virtual string AttrPermissionType { get; }
Property Value

string

Remarks

    CloudformationAttribute: PermissionType

    AttrVersion

    The version number for this version of the permission.

    public virtual string AttrVersion { get; }
    Property Value

    string

    Remarks

    CloudformationAttribute: Version

    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

    It is created in the AWS Region in which you call the operation.

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

    CloudformationResource: AWS::RAM::Permission

    ExampleMetadata: fixture=_generated

    CfnProperties

    Creates a customer managed permission for a specified resource type that you can attach to resource shares.

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

    IDictionary<string, object>

    Overrides
    CfnResource.CfnProperties
    Remarks

    It is created in the AWS Region in which you call the operation.

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

    CloudformationResource: AWS::RAM::Permission

    ExampleMetadata: fixture=_generated

    Name

    Specifies the name of the customer managed permission.

    public virtual string Name { get; set; }
    Property Value

    string

    Remarks

    It is created in the AWS Region in which you call the operation.

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

    CloudformationResource: AWS::RAM::Permission

    ExampleMetadata: fixture=_generated

    PolicyTemplate

    A string in JSON format string that contains the following elements of a resource-based policy:.

    public virtual object PolicyTemplate { get; set; }
    Property Value

    object

    Remarks

    It is created in the AWS Region in which you call the operation.

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

    CloudformationResource: AWS::RAM::Permission

    ExampleMetadata: fixture=_generated

    ResourceType

    Specifies the name of the resource type that this customer managed permission applies to.

    public virtual string ResourceType { get; set; }
    Property Value

    string

    Remarks

    It is created in the AWS Region in which you call the operation.

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

    CloudformationResource: AWS::RAM::Permission

    ExampleMetadata: fixture=_generated

    Tags

    Tag Manager which manages the tags for this resource.

    public virtual TagManager Tags { get; }
    Property Value

    TagManager

    Remarks

    It is created in the AWS Region in which you call the operation.

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

    CloudformationResource: AWS::RAM::Permission

    ExampleMetadata: fixture=_generated

    TagsRaw

    Specifies a list of one or more tag key and value pairs to attach to the permission.

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

    ICfnTag[]

    Remarks

    It is created in the AWS Region in which you call the operation.

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

    CloudformationResource: AWS::RAM::Permission

    ExampleMetadata: fixture=_generated

    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.

    Remarks

    It is created in the AWS Region in which you call the operation.

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

    CloudformationResource: AWS::RAM::Permission

    ExampleMetadata: fixture=_generated

    RenderProperties(IDictionary<string, object>)

    Creates a customer managed permission for a specified resource type that you can attach to resource shares.

    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

    It is created in the AWS Region in which you call the operation.

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

    CloudformationResource: AWS::RAM::Permission

    ExampleMetadata: fixture=_generated

    Implements

    IInspectable
    ITaggable
    Back to top Generated by DocFX