interface CfnPermissionProps

Language	Type name
.NET	`Amazon.CDK.AWS.RAM.CfnPermissionProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsram#CfnPermissionProps`
Java	`software.amazon.awscdk.services.ram.CfnPermissionProps`
Python	`aws_cdk.aws_ram.CfnPermissionProps`
TypeScript	`aws-cdk-lib` » `aws_ram` » `CfnPermissionProps`

Properties for defining a CfnPermission.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ram as ram } from 'aws-cdk-lib';

declare const policyTemplate: any;
const cfnPermissionProps: ram.CfnPermissionProps = {
  name: 'name',
  policyTemplate: policyTemplate,
  resourceType: 'resourceType',

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	Specifies the name of the customer managed permission.
policyTemplate	`any`	A string in JSON format string that contains the following elements of a resource-based policy:.
resourceType	`string`	Specifies the name of the resource type that this customer managed permission applies to.
tags?	`CfnTag[]`	Specifies a list of one or more tag key and value pairs to attach to the permission.

name

Type: string

Specifies the name of the customer managed permission.

The name must be unique within the AWS Region .

policyTemplate

Type: 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 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 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.

resourceType

Type: 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 operation.

tags?

Type: CfnTag[] (optional)

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