Skip to content

ResourceShare

This class encapsulates and extends the ROS resource type ALIYUN::ResourceManager::ResourceShare, which is used to create a resource share.

Initializers

import com.aliyun.ros.cdk.resourcemanager.ResourceShare;
ResourceShare.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .resourceShareName(java.lang.String)
    .resourceShareName(IResolvable)
//  .allowExternalTargets(java.lang.Boolean)
//  .allowExternalTargets(IResolvable)
//  .permissionNames(IResolvable)
//  .permissionNames(java.util.List<java.lang.String)
//  .permissionNames(IResolvable>)
//  .resources(IResolvable)
//  .resources(java.util.List<IResolvable)
//  .resources(ResourcesProperty>)
//  .targets(IResolvable)
//  .targets(java.util.List<java.lang.String)
//  .targets(IResolvable>)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
resourceShareName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceShareName: The name of the resource share.
allowExternalTargets java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property allowExternalTargets: Whether to allow sharing to accounts outside the resource directory.
permissionNames com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property permissionNames: Sharing permission name.
resources com.aliyun.ros.cdk.core.IResolvable OR java.util.ListResourcesProperty> Property resources:.
targets com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property targets: The shared target.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

resourceShareNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceShareName: The name of the resource share.

The name must be 1 to 50 characters in length. It can contain letters, digits, periods (.), underscores (_), and hyphens (-).


allowExternalTargetsOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property allowExternalTargets: Whether to allow sharing to accounts outside the resource directory.

Value: false (default): Only allow sharing within the resource directory. true: Allow sharing to any account.


permissionNamesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property permissionNames: Sharing permission name.

When empty, the system automatically binds the default permissions associated with the resource type.


resourcesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListResourcesProperty>

Property resources:.


targetsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property targets: The shared target.

A shared target shares the resources of resource owners. You can share your resources only with the member accounts in your resource directory. A shared target is indicated by its account ID. For more information about how to obtain the ID, see View the basic information of a member account.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

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

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.resourcemanager.ResourceShare;
ResourceShare.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrResourceShareId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceShareId: The ID of the resource share.
props ResourceShareProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrResourceShareIdRequired

public java.lang.Object getAttrResourceShareId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceShareId: The ID of the resource share.


propsRequired

public ResourceShareProps getProps();