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 ros_cdk_resourcemanager
ros_cdk_resourcemanager.ResourceShare(
  scope: Construct,
  id: str,
  resource_share_name: typing.Union[str, IResolvable],
  allow_external_targets: typing.Union[bool, IResolvable] = None,
  permission_names: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  resources: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcesProperty]]] = None,
  targets: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
resource_share_name typing.Union[str, ros_cdk_core.IResolvable] Property resourceShareName: The name of the resource share.
allow_external_targets typing.Union[bool, ros_cdk_core.IResolvable] Property allowExternalTargets: Whether to allow sharing to accounts outside the resource directory.
permission_names typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property permissionNames: Sharing permission name.
resources typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ResourcesProperty]]] Property resources:.
targets typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property targets: The shared target.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

resource_share_nameRequired

  • Type: typing.Union[str, 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 (-).


allow_external_targetsOptional

  • Type: typing.Union[bool, 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.


permission_namesOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property permissionNames: Sharing permission name.

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


resourcesOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ResourcesProperty]]]

Property resources:.


targetsOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

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.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct

import ros_cdk_resourcemanager
ros_cdk_resourcemanager.ResourceShare.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_resource_share_id ros_cdk_core.IResolvable Attribute ResourceShareId: The ID of the resource share.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_resource_share_idRequired

attr_resource_share_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceShareId: The ID of the resource share.