Package software.amazon.awscdk.services.ram

Class CfnPermission.Builder

java.lang.Object

software.amazon.awscdk.services.ram.CfnPermission.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPermission>

Enclosing class:

CfnPermission

@Stability(Stable)
public static final class CfnPermission.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPermission>

A fluent builder for CfnPermission.

Method Summary

Modifier and Type	Method	Description
CfnPermission	build()
static CfnPermission.Builder	create(software.constructs.Construct scope, String id)
CfnPermission.Builder	name(String name)	Specifies the name of the customer managed permission.
CfnPermission.Builder	policyTemplate(Object policyTemplate)	A string in JSON format string that contains the following elements of a resource-based policy:.
CfnPermission.Builder	resourceType(String resourceType)	Specifies the name of the resource type that this customer managed permission applies to.
CfnPermission.Builder	tags(List<? extends CfnTag> tags)	Specifies a list of one or more tag key and value pairs to attach to the permission.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnPermission.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnPermission.Builder.

name

@Stability(Stable)
public CfnPermission.Builder name(String name)

Specifies the name of the customer managed permission.

The name must be unique within the AWS Region .

Parameters:

name - Specifies the name of the customer managed permission. This parameter is required.

Returns:

this

See Also:

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

policyTemplate

@Stability(Stable)
public CfnPermission.Builder policyTemplate(Object policyTemplate)

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.

Parameters:

policyTemplate - A string in JSON format string that contains the following elements of a resource-based policy:. This parameter is required.

Returns:

this

See Also:

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

resourceType

@Stability(Stable)
public CfnPermission.Builder resourceType(String resourceType)

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.

Parameters:

resourceType - Specifies the name of the resource type that this customer managed permission applies to. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnPermission.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

tags - Specifies a list of one or more tag key and value pairs to attach to the permission. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPermission build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPermission>

Returns:

a newly built instance of CfnPermission.