software.amazon.awscdk.services.ram

Class CfnResourceShare

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ram.CfnResourceShare

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.329Z")
 @Stability(value=Stable)
public class CfnResourceShare
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RAM::ResourceShare`.

Specifies a resource share.

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.*;
 CfnResourceShare cfnResourceShare = CfnResourceShare.Builder.create(this, "MyCfnResourceShare")
         .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	Class and Description
static class	CfnResourceShare.Builder A fluent builder for CfnResourceShare.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResourceShare(software.constructs.Construct scope, String id, CfnResourceShareProps props) Create a new `AWS::RAM::ResourceShare`.
protected	CfnResourceShare(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResourceShare(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAllowExternalPrincipals() Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
String	getAttrArn() The Amazon Resource Name (ARN) of the resource share.
protected Map<String,Object>	getCfnProperties()
String	getName() Specifies the name of the resource share.
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.
List<String>	getPrincipals() Specifies a list of one or more principals to associate with the resource share.
List<String>	getResourceArns() Specifies a list of one or more ARNs of the resources to associate with the resource share.
TagManager	getTags() Specifies one or more tags to attach to the resource share itself.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllowExternalPrincipals(Boolean value) Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
void	setAllowExternalPrincipals(IResolvable value) Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
void	setName(String value) Specifies the name of the resource share.
void	setPermissionArns(List<String> value) 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.
void	setPrincipals(List<String> value) Specifies a list of one or more principals to associate with the resource share.
void	setResourceArns(List<String> value) Specifies a list of one or more ARNs of the resources to associate with the resource share.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnResourceShare

protected CfnResourceShare(software.amazon.jsii.JsiiObjectRef objRef)

CfnResourceShare

protected CfnResourceShare(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnResourceShare

@Stability(value=Stable)
public CfnResourceShare(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnResourceShareProps props)

Create a new `AWS::RAM::ResourceShare`.

Parameters:

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

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

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the resource share.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager 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.

getName

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

Specifies the name of the resource share.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

Specifies the name of the resource share.

getAllowExternalPrincipals

@Stability(value=Stable)
 @Nullable
public 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 .

setAllowExternalPrincipals

@Stability(value=Stable)
public void setAllowExternalPrincipals(@Nullable
                                                                Boolean value)

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 .

setAllowExternalPrincipals

@Stability(value=Stable)
public void setAllowExternalPrincipals(@Nullable
                                                                IResolvable value)

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
public 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.

setPermissionArns

@Stability(value=Stable)
public void setPermissionArns(@Nullable
                                                       List<String> value)

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
public 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 .

setPrincipals

@Stability(value=Stable)
public void setPrincipals(@Nullable
                                                   List<String> value)

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
public List<String> getResourceArns()

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

setResourceArns

@Stability(value=Stable)
public void setResourceArns(@Nullable
                                                     List<String> value)

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