DBNodeClasses
- Implements: ros_cdk_polardb.datasource.IDBNodeClasses
This class encapsulates and extends the ROS resource type DATASOURCE::POLARDB::DBNodeClasses.
Initializers
from ros_cdk_polardb import datasource
datasource.DBNodeClasses(
scope: Construct,
id: str,
pay_type: typing.Union[str, IResolvable],
db_node_class: typing.Union[str, IResolvable] = None,
db_type: typing.Union[str, IResolvable] = None,
db_version: typing.Union[str, IResolvable] = None,
refresh_options: typing.Union[str, IResolvable] = None,
zone_id: 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. |
pay_type | typing.Union[str, ros_cdk_core.IResolvable] | Property payType: The billing method. |
db_node_class | typing.Union[str, ros_cdk_core.IResolvable] | Property dbNodeClass: The node type. |
db_type | typing.Union[str, ros_cdk_core.IResolvable] | Property dbType: The database engine. |
db_version | typing.Union[str, ros_cdk_core.IResolvable] | Property dbVersion: The version number of the database engine Valid values for the MySQL database engine: 5.6 5.7 8 Valid value for the PostgreSQL database engine: 11 Valid value for the Oracle database engine: 11 Note If you specify the DBType parameter, you must specify this parameter. |
refresh_options | typing.Union[str, ros_cdk_core.IResolvable] | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
zone_id | typing.Union[str, ros_cdk_core.IResolvable] | Property zoneId: The ID of the zone where PolarDB resources that you want to query reside. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
pay_typeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property payType: The billing method.
Valid values: Postpaid: the pay-as-you-go billing method Prepaid: the subscription billing method
db_node_classOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbNodeClass: The node type.
For more information, see Specifications of compute nodes.
db_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbType: The database engine.
Valid values: MySQL PostgreSQL Oracle
db_versionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbVersion: The version number of the database engine Valid values for the MySQL database engine: 5.6 5.7 8 Valid value for the PostgreSQL database engine: 11 Valid value for the Oracle database engine: 11 Note If you specify the DBType parameter, you must specify this parameter.
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.
zone_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property zoneId: The ID of the zone where PolarDB resources that you want to query reside.
Note You can call the DescribeRegions operation to query information about zones.
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_polardb import datasource
datasource.DBNodeClasses.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_db_node_classes | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DBNodeClasses: The list of db node classes. |
attr_db_node_class_ids | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DBNodeClassIds: The list of db node class ids. |
props | DBNodeClassesProps | 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_db_node_classesRequired
attr_db_node_classes: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DBNodeClasses: The list of db node classes.
attr_db_node_class_idsRequired
attr_db_node_class_ids: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DBNodeClassIds: The list of db node class ids.
propsRequired
props: DBNodeClassesProps
- Type: DBNodeClassesProps