Interface ICfnPermissionProps

Properties for defining a CfnPermission.

Namespace: Amazon.CDK.AWS.RAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnPermissionProps

Syntax (vb)

Public Interface ICfnPermissionProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-permission.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 policyTemplate;

             var cfnPermissionProps = new CfnPermissionProps {
                 Name = "name",
                 PolicyTemplate = policyTemplate,
                 ResourceType = "resourceType",

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

Synopsis

Properties

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	Specifies a list of one or more tag key and value pairs to attach to the permission.

Properties

Name

Specifies the name of the customer managed permission.

string Name { get; }

Property Value

string

Remarks

The name must be unique within the AWS Region .

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

PolicyTemplate

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

object PolicyTemplate { get; }

Property Value

object

Remarks

This template can't include either the Resource or Principal elements. Those are both filled in by AWS RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.

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

ResourceType

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

string ResourceType { get; }

Property Value

string

Remarks

The format is <service-code> : <resource-type> and is not case sensitive. For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet . To see the list of valid values for this parameter, query the ListResourceTypes operation.

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