Package software.amazon.awscdk.services.ram

Interface CfnResourceShareProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourceShareProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-27T16:51:03.883Z")
@Stability(Stable)
public interface CfnResourceShareProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnResourceShare.

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.*;
 CfnResourceShareProps cfnResourceShareProps = CfnResourceShareProps.builder()
         .name("name")
         // the properties below are optional
         .allowExternalPrincipals(false)
         .permissionArns(List.of("permissionArns"))
         .principals(List.of("principals"))
         .resourceArns(List.of("resourceArns"))
         .sources(List.of("sources"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnResourceShareProps.Builder	builder()
default Object	getAllowExternalPrincipals()	Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
String	getName()	Specifies the name of the resource share.
default List<String>	getPermissionArns()	Specifies the Amazon Resource Names (ARNs) of the AWS RAM permission to associate with the resource share.
default List<String>	getPrincipals()	Specifies the principals to associate with the resource share.
default List<String>	getResourceArns()	Specifies a list of one or more ARNs of the resources to associate with the resource share.
default List<String>	getSources()
default List<CfnTag>	getTags()	Specifies one or more tags to attach to the resource share itself.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

Specifies the name of the resource share.

See Also:

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

getAllowExternalPrincipals

@Stability(Stable)
@Nullable
default Object getAllowExternalPrincipals()

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 .

See Also:

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

getPermissionArns

@Stability(Stable)
@Nullable
default List<String> getPermissionArns()

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.

See Also:

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

getPrincipals

@Stability(Stable)
@Nullable
default List<String> getPrincipals()

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 .

See Also:

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

getResourceArns

@Stability(Stable)
@Nullable
default List<String> getResourceArns()

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

See Also:

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

getSources

@Stability(Stable)
@Nullable
default List<String> getSources()

See Also:

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

getTags

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

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.

See Also:

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

builder

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

Returns:

a CfnResourceShareProps.Builder of CfnResourceShareProps