DrdsDB
- Implements: IDrdsDB
This class encapsulates and extends the ROS resource type ALIYUN::DRDS::DrdsDB.
Initializers
import ros_cdk_drds
ros_cdk_drds.DrdsDB(
scope: Construct,
id: str,
drds_instance_id: typing.Union[str, IResolvable],
account_name: typing.Union[str, IResolvable] = None,
db_instance_is_creating: typing.Union[bool, IResolvable] = None,
db_inst_type: typing.Union[str, IResolvable] = None,
db_name: typing.Union[str, IResolvable] = None,
encode: typing.Union[str, IResolvable] = None,
inst_db_name: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, InstDbNameProperty]]] = None,
password: typing.Union[str, IResolvable] = None,
rds_instance: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
type: 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. |
drds_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Property drdsInstanceId: DRDS instance ID. |
account_name | typing.Union[str, ros_cdk_core.IResolvable] | Property accountName: In the vertical split scenario, an account name with access rights to the corresponding database on all RDSs. |
db_instance_is_creating | typing.Union[bool, ros_cdk_core.IResolvable] | Property dbInstanceIsCreating: Specifies whether the required ApsaraDB RDS for MySQL instance is being created. |
db_inst_type | typing.Union[str, ros_cdk_core.IResolvable] | Property dbInstType: The type of the storage instances that are used by the PolarDB-X 1.0 database. Set the value to RDS. |
db_name | typing.Union[str, ros_cdk_core.IResolvable] | Property dbName: Database Name. |
encode | typing.Union[str, ros_cdk_core.IResolvable] | Property encode: The encoding method that is used by the database. |
inst_db_name | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstDbNameProperty]]] | Property instDbName: List of databases. |
password | typing.Union[str, ros_cdk_core.IResolvable] | Property password: The logon password of the database instance. |
rds_instance | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property rdsInstance: List of RDS instances. |
type | typing.Union[str, ros_cdk_core.IResolvable] | Property type: Database Sharding method. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
drds_instance_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property drdsInstanceId: DRDS instance ID.
account_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property accountName: In the vertical split scenario, an account name with access rights to the corresponding database on all RDSs.
db_instance_is_creatingOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property dbInstanceIsCreating: Specifies whether the required ApsaraDB RDS for MySQL instance is being created.
db_inst_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbInstType: The type of the storage instances that are used by the PolarDB-X 1.0 database. Set the value to RDS.
db_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbName: Database Name.
encodeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property encode: The encoding method that is used by the database.
inst_db_nameOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstDbNameProperty]]]
Property instDbName: List of databases.
passwordOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property password: The logon password of the database instance.
rds_instanceOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property rdsInstance: List of RDS instances.
typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property type: Database Sharding method.
For more information, see scalability principle. Valid values: HORIZONTAL: indicates HORIZONTAL partitioning, which is commonly known as database and table sharding. VERTICAL: indicates VERTICAL partitioning.
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
import ros_cdk_drds
ros_cdk_drds.DrdsDB.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. |
props | DrdsDBProps | 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
propsRequired
props: DrdsDBProps
- Type: DrdsDBProps