Package software.amazon.awscdk.services.ram

Class CfnResourceShare.Builder

java.lang.Object

software.amazon.awscdk.services.ram.CfnResourceShare.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnResourceShare>

Enclosing class:

CfnResourceShare

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

A fluent builder for CfnResourceShare.

Method Summary

Modifier and Type	Method	Description
CfnResourceShare.Builder	allowExternalPrincipals(Boolean allowExternalPrincipals)	Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
CfnResourceShare.Builder	allowExternalPrincipals(IResolvable allowExternalPrincipals)	Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
CfnResourceShare	build()
static CfnResourceShare.Builder	create(software.constructs.Construct scope, String id)
CfnResourceShare.Builder	name(String name)	Specifies the name of the resource share.
CfnResourceShare.Builder	permissionArns(List<String> permissionArns)	Specifies the Amazon Resource Names (ARNs) of the AWS RAM permission to associate with the resource share.
CfnResourceShare.Builder	principals(List<String> principals)	Specifies the principals to associate with the resource share.
CfnResourceShare.Builder	resourceArns(List<String> resourceArns)	Specifies a list of one or more ARNs of the resources to associate with the resource share.
CfnResourceShare.Builder	sources(List<String> sources)
CfnResourceShare.Builder	tags(List<? extends CfnTag> tags)	Specifies one or more tags to attach to the resource share itself.

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 CfnResourceShare.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 CfnResourceShare.Builder.

name

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

Specifies the name of the resource share.

Parameters:

name - Specifies the name of the resource share. This parameter is required.

Returns:

this

See Also:

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

allowExternalPrincipals

@Stability(Stable)
public CfnResourceShare.Builder allowExternalPrincipals(Boolean allowExternalPrincipals)

Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.

A value of true lets you share with individual AWS accounts that are not in your organization. A value of false only has meaning if your account is a member of an AWS Organization. The default value is true .

Parameters:

allowExternalPrincipals - Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. This parameter is required.

Returns:

this

See Also:

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

allowExternalPrincipals

@Stability(Stable)
public CfnResourceShare.Builder allowExternalPrincipals(IResolvable allowExternalPrincipals)

Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.

A value of true lets you share with individual AWS accounts that are not in your organization. A value of false only has meaning if your account is a member of an AWS Organization. The default value is true .

Parameters:

allowExternalPrincipals - Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. This parameter is required.

Returns:

this

See Also:

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

permissionArns

@Stability(Stable)
public CfnResourceShare.Builder permissionArns(List<String> permissionArns)

Specifies the Amazon Resource Names (ARNs) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.

Parameters:

permissionArns - Specifies the Amazon Resource Names (ARNs) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. This parameter is required.

Returns:

this

See Also:

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

principals

@Stability(Stable)
public CfnResourceShare.Builder principals(List<String> principals)

Specifies the principals to associate with the resource share. The possible values are:.

• An AWS account ID
• An Amazon Resource Name (ARN) of an organization in AWS Organizations
• An ARN of an organizational unit (OU) in AWS Organizations
• An ARN of an IAM role
• An ARN of an IAM user

Not all resource types can be shared with IAM roles and users. For more information, see the column Can share with IAM roles and users in the tables on Shareable AWS resources in the AWS Resource Access Manager User Guide .

Parameters:

principals - Specifies the principals to associate with the resource share. The possible values are:. This parameter is required.

Returns:

this

See Also:

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

resourceArns

@Stability(Stable)
public CfnResourceShare.Builder resourceArns(List<String> resourceArns)

Specifies a list of one or more ARNs of the resources to associate with the resource share.

Parameters:

resourceArns - Specifies a list of one or more ARNs of the resources to associate with the resource share. This parameter is required.

Returns:

this

See Also:

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

sources

@Stability(Stable)
public CfnResourceShare.Builder sources(List<String> sources)

Parameters:

sources - This parameter is required.

Returns:

this

See Also:

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

tags

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

Specifies one or more tags to attach to the resource share itself.

It doesn't attach the tags to the resources associated with the resource share.

Parameters:

tags - Specifies one or more tags to attach to the resource share itself. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnResourceShare build()

Specified by:

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

Returns:

a newly built instance of CfnResourceShare.