StackInstance

• Implements: ros_cdk_ros.datasource.IStackInstance

This class encapsulates and extends the ROS resource type DATASOURCE::ROS::StackInstance.

Initializers

from ros_cdk_ros import datasource
datasource.StackInstance(
  scope: Construct,
  id: str,
  stack_group_name: typing.Union[str, IResolvable],
  stack_instance_account_id: typing.Union[str, IResolvable],
  stack_instance_region_id: typing.Union[str, IResolvable],
  output_option: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

stack_group_name^Required

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

Property stackGroupName: Resource stack group name.

Names are unique within a single region. The length must not exceed 255 characters, must start with a number or an English letter, and can contain numbers, English letters, dashes (-) and underscores (_)

stack_instance_account_id^Required

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

Property stackInstanceAccountId: The target account ID to which the resource stack belongs.

In the self-service management permission mode, the account is an Alibaba Cloud account. In service management permission mode, this account is a member account of the resource directory.

stack_instance_region_id^Required

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

Property stackInstanceRegionId: The region to which the resource stack belongs.

output_option^Optional

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

Property outputOption: Whether to return the Outputs parameter resource stack output list.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

enable_resource_property_constraint^Optional

• Type: bool

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

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

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

from ros_cdk_ros import datasource
datasource.StackInstance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

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

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_account_id^Required

attr_account_id: typing.Union[str, IResolvable]

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

Attribute AccountId: The account id of the stack.

attr_drift_detection_time^Required

attr_drift_detection_time: typing.Union[str, IResolvable]

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

Attribute DriftDetectionTime: The time when the resource stack group last successfully completed deviation detection.

attr_outputs^Required

attr_outputs: typing.Union[str, IResolvable]

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

Attribute Outputs: The outputs of the stack instance.

attr_parameter_overrides^Required

attr_parameter_overrides: typing.Union[str, IResolvable]

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

Attribute ParameterOverrides: Override parameter list.

attr_rd_folder_id^Required

attr_rd_folder_id: typing.Union[str, IResolvable]

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

Attribute RdFolderId: The resource folder ID of the resource directory.

attr_region_id^Required

attr_region_id: typing.Union[str, IResolvable]

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

Attribute RegionId: The region id of the stack.

attr_stack_drift_status^Required

attr_stack_drift_status: typing.Union[str, IResolvable]

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

Attribute StackDriftStatus: The status of the last successful deviation detection of the resource stack group.

attr_stack_group_id^Required

attr_stack_group_id: typing.Union[str, IResolvable]

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

Attribute StackGroupId: The resource stack group ID.

attr_stack_group_name^Required

attr_stack_group_name: typing.Union[str, IResolvable]

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

Attribute StackGroupName: The resource stack group name.

attr_stack_id^Required

attr_stack_id: typing.Union[str, IResolvable]

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

Attribute StackId: The stack id of stack instance.

attr_status^Required

attr_status: typing.Union[str, IResolvable]

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

Attribute Status: Resource stack status.

attr_status_reason^Required

attr_status_reason: typing.Union[str, IResolvable]

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

Attribute StatusReason: Status reason description.

props^Required

props: StackInstanceProps

• Type: StackInstanceProps