Resource

• Implements: IResource

A construct which represents a resource.

Initializers

import ros_cdk_core
ros_cdk_core.Resource(
  scope: Construct,
  id: str,
  account: str = None,
  environment_from_arn: typing.Union[str, IResolvable] = None,
  physical_name: str = None,
  region: str = None
)

scope^Required

• Type: Construct

id^Required

• Type: str

account^Optional

• Type: str
• Default: the resource is in the same account as the stack it belongs to

The Alibaba Cloud account ID this resource belongs to.

environment_from_arn^Optional

• Type: typing.Union[str, IResolvable]
• Default: take environment from account, region parameters, or use Stack environment.

ARN to deduce region and account from.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

physical_name^Optional

• Type: str
• Default: The physical name will be allocated at deployment time

The value passed in by users to the physical name prop of the resource.

• undefined implies that a physical name will be allocated during deployment.
• a concrete value implies a specific physical name
• PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated.

region^Optional

• Type: str
• Default: the resource is in the same region as the stack it belongs to

The Alibaba Cloud region this resource belongs to.

Methods

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.

session^Required

• Type: ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_core
ros_cdk_core.Resource.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: RosResource