Package software.amazon.awscdk.services.ram

Interface CfnPermissionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPermissionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:04.559Z")
@Stability(Stable)
public interface CfnPermissionProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ram.*;
 Object policyTemplate;
 CfnPermissionProps cfnPermissionProps = CfnPermissionProps.builder()
         .name("name")
         .policyTemplate(policyTemplate)
         .resourceType("resourceType")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPermissionProps.Builder	A builder for CfnPermissionProps
static final class	CfnPermissionProps.Jsii$Proxy	An implementation for CfnPermissionProps

Method Summary

Modifier and Type	Method	Description
static CfnPermissionProps.Builder	builder()
String	getName()	Specifies the name of the customer managed permission.
Object	getPolicyTemplate()	A string in JSON format string that contains the following elements of a resource-based policy:.
String	getResourceType()	Specifies the name of the resource type that this customer managed permission applies to.
default List<CfnTag>	getTags()	Specifies a list of one or more tag key and value pairs to attach to the permission.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

Specifies the name of the customer managed permission.

The name must be unique within the AWS Region .

See Also:

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

getPolicyTemplate

@Stability(Stable)
@NotNull
Object getPolicyTemplate()

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.

See Also:

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

getResourceType

@Stability(Stable)
@NotNull
String getResourceType()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnPermissionProps.Builder builder()

Returns:

a CfnPermissionProps.Builder of CfnPermissionProps