AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::RAM::Permission

CfnPermission

Creates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the AWS Region in which you call the operation.

Import

import { CfnPermission } from 'aws-cdk-lib/aws-ram';

Or use the module namespace:

import * as ram from 'aws-cdk-lib/aws-ram';
// ram.CfnPermission

Properties

Configuration passed to the constructor as CfnPermissionProps.

nameRequired
string

Specifies the name of the customer managed permission. The name must be unique within the AWS Region .

policyTemplateRequired
any

A string in JSON format string that contains the following elements of a resource-based policy:. - *Effect* : must be set to `ALLOW` . - *Action* : specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see [Actions, resources, and condition keys for AWS services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) in the *AWS Identity and Access Management User Guide* . - *Condition* : (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see [IAM policies: Condition element](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html) in the *AWS Identity and Access Management User Guide* . 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.

resourceTypeRequired
string

Specifies the name of the resource type that this customer managed permission applies to. 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](https://docs.aws.amazon.com/ram/latest/APIReference/API_ListResourceTypes.html) operation.

tagsOptional
CfnTag[]

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter