software.amazon.awscdk.services.ram

Class CfnResourceShare

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ram.CfnResourceShare

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:52.470Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResourceShare(Construct scope, java.lang.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
java.lang.Object	getAllowExternalPrincipals() Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the resource share.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() Specifies the name of the resource share.
java.util.List<java.lang.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.
java.util.List<java.lang.String>	getPrincipals() Specifies a list of one or more principals to associate with the resource share.
java.util.List<java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAllowExternalPrincipals(java.lang.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(java.lang.String value) Specifies the name of the resource share.
void	setPermissionArns(java.util.List<java.lang.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(java.util.List<java.lang.String> value) Specifies a list of one or more principals to associate with the resource share.
void	setResourceArns(java.util.List<java.lang.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnResourceShare(Construct scope,
                        java.lang.String id,
                        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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

public java.lang.String getName()

Specifies the name of the resource share.

setName

public void setName(java.lang.String value)

Specifies the name of the resource share.

getAllowExternalPrincipals

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

public void setAllowExternalPrincipals(java.lang.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

public void setAllowExternalPrincipals(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

public java.util.List<java.lang.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

public void setPermissionArns(java.util.List<java.lang.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

public java.util.List<java.lang.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

public void setPrincipals(java.util.List<java.lang.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

public java.util.List<java.lang.String> getResourceArns()

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

setResourceArns

public void setResourceArns(java.util.List<java.lang.String> value)

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