software.amazon.awscdk.services.ram

Class CfnResourceShare.Builder

java.lang.Object

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

Enclosing class:

CfnResourceShare

public static final class CfnResourceShare.Builder
extends java.lang.Object

A fluent builder for CfnResourceShare.

Method Summary

Modifier and Type	Method and Description
CfnResourceShare.Builder	allowExternalPrincipals(java.lang.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(Construct scope, java.lang.String id)
CfnResourceShare.Builder	name(java.lang.String name) Specifies the name of the resource share.
CfnResourceShare.Builder	permissionArns(java.util.List<java.lang.String> permissionArns) Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share.
CfnResourceShare.Builder	principals(java.util.List<java.lang.String> principals) Specifies a list of one or more principals to associate with the resource share.
CfnResourceShare.Builder	resourceArns(java.util.List<java.lang.String> resourceArns) Specifies a list of one or more ARNs of the resources to associate with the resource share.
CfnResourceShare.Builder	tags(java.util.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 Detail

create

public static CfnResourceShare.Builder create(Construct scope,
                                              java.lang.String id)

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnResourceShare.Builder.

name

public CfnResourceShare.Builder name(java.lang.String name)

Specifies the name of the resource share.

Parameters:

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

Returns:

this

allowExternalPrincipals

public CfnResourceShare.Builder allowExternalPrincipals(java.lang.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

allowExternalPrincipals

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

permissionArns

public CfnResourceShare.Builder permissionArns(java.util.List<java.lang.String> permissionArns)

Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) 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)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) 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

principals

public CfnResourceShare.Builder principals(java.util.List<java.lang.String> principals)

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

You can include the following values:

• An AWS account ID, for example: 123456789012
• An Amazon Resoure Name (ARN) of an organization in AWS Organizations , for example: arn:aws:organizations::123456789012:organization/o-exampleorgid
• An ARN of an organizational unit (OU) in AWS Organizations , for example: arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
• An ARN of an IAM role, for example: arn:aws:iam::123456789012:role/rolename
• An ARN of an IAM user, for example: arn:aws:iam::123456789012user/username

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the AWS Resource Access Manager User Guide .

Parameters:

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

Returns:

this

resourceArns

public CfnResourceShare.Builder resourceArns(java.util.List<java.lang.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

tags

public CfnResourceShare.Builder tags(java.util.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

build

public CfnResourceShare build()