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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.330Z")
 @Stability(value=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"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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)](https://docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share.
default List<String>	getPrincipals() Specifies a list of one or more 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<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 Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

Specifies the name of the resource share.

getAllowExternalPrincipals

@Stability(value=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 .

getPermissionArns

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

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.

getPrincipals

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

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 .

getResourceArns

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

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

getTags

@Stability(value=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.

builder

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

Returns:

a CfnResourceShareProps.Builder of CfnResourceShareProps