Instances
- Implements: ros_cdk_lindorm.datasource.IInstances
This class encapsulates and extends the ROS resource type DATASOURCE::Lindorm::Instances.
Initializers
from ros_cdk_lindorm import datasource
datasource.Instances(
scope: Construct,
id: str,
instance_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
query_str: typing.Union[str, IResolvable] = None,
refresh_options: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
service_type: typing.Union[str, IResolvable] = None,
support_engine: typing.Union[typing.Union[int, float], IResolvable] = None,
tags: typing.List[TagsProperty] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
instance_ids | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property instanceIds: The list of the instance id. |
query_str | typing.Union[str, ros_cdk_core.IResolvable] | Property queryStr: Instance name keyword, which can be used for fuzzy search. |
refresh_options | typing.Union[str, ros_cdk_core.IResolvable] | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: The resource group id of lindorm instance. |
service_type | typing.Union[str, ros_cdk_core.IResolvable] | Property serviceType: The type of lindorm instance. |
support_engine | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property supportEngine: Database engine types supported by the queried instance. |
tags | typing.List[ros_cdk_lindorm.datasource.RosInstances.TagsProperty] | Property tags: Tags of lindorm instance. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
instance_idsOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property instanceIds: The list of the instance id.
query_strOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property queryStr: Instance name keyword, which can be used for fuzzy search.
refresh_optionsOptional
- 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.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The resource group id of lindorm instance.
service_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property serviceType: The type of lindorm instance.
support_engineOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property supportEngine: Database engine types supported by the queried instance.
1: Support search engines. 2: Support timing engine. 4: Support wide table engine. 8: Support file engine. Note For example: the value of SupportEngine is 15, 15=8+4+2+1, which means that the instance supports search engine, timing engine, wide table engine and file engine. The value of SupportEngine is 6, 6=4+2, indicating that the instance supports timing engine and wide table engine.
tagsOptional
- Type: typing.List[ros_cdk_lindorm.datasource.RosInstances.TagsProperty]
Property tags: Tags of lindorm instance.
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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
from ros_cdk_lindorm import datasource
datasource.Instances.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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_instance_ids | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceIds: The list of The instance list. |
attr_instances | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Instances: The detail list of The instance. |
props | InstancesProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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_instance_idsRequired
attr_instance_ids: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceIds: The list of The instance list.
attr_instancesRequired
attr_instances: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Instances: The detail list of The instance.
propsRequired
props: InstancesProps
- Type: InstancesProps