DBInstance

• Implements: ros_cdk_rds.datasource.IDBInstance

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

Initializers

from ros_cdk_rds import datasource
datasource.DBInstance(
  scope: Construct,
  id: str,
  db_instance_id: 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

db_instance_id^Optional

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

Property dbInstanceId: The ID of the instance.

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_rds import datasource
datasource.DBInstance.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_max_quantity^Required

attr_account_max_quantity: typing.Union[str, IResolvable]

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

Attribute AccountMaxQuantity: The maximum number of accounts that can be created on the instance.

attr_advanced_features^Required

attr_advanced_features: typing.Union[str, IResolvable]

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

Attribute AdvancedFeatures: The advanced features that are enabled for the instance.

If multiple advanced features are enabled, the advanced features are separated by commas (,). This parameter is available only to instances that run SQL Server. Valid values: LinkedServer DistributeTransaction

attr_auto_upgrade_minor_version^Required

attr_auto_upgrade_minor_version: typing.Union[str, IResolvable]

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

Attribute AutoUpgradeMinorVersion: The method that is used to update the minor engine version of the instance.

Valid values: Auto: automatic update. Manual: manual update. The minor engine version of the instance is forcefully updated only when the in-use minor engine version is phased out.

attr_availability_value^Required

attr_availability_value: typing.Union[str, IResolvable]

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

Attribute AvailabilityValue: The availability status of the instance in percentage.

attr_babelfish_config^Required

attr_babelfish_config: typing.Union[str, IResolvable]

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

Attribute BabelfishConfig: The configuration of the Babelfish feature for the ApsaraDB RDS for PostgreSQL instance.

attr_category^Required

attr_category: typing.Union[str, IResolvable]

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

Attribute Category: The RDS edition of the instance.

Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server Finance: RDS Enterprise Edition Serverless_basic: RDS Basic Edition for serverless instances

attr_collation^Required

attr_collation: typing.Union[str, IResolvable]

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

Attribute Collation: The character set collation of the instance.

attr_connection_mode^Required

attr_connection_mode: typing.Union[str, IResolvable]

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

Attribute ConnectionMode: The connection mode of the instance.

Valid values: Standard: standard mode Safe: database proxy mode

attr_connection_string^Required

attr_connection_string: typing.Union[str, IResolvable]

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

Attribute ConnectionString: The internal endpoint of the instance.

attr_console_version^Required

attr_console_version: typing.Union[str, IResolvable]

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

Attribute ConsoleVersion: The type of the proxy that is used by the instance.

Valid values: 1: shared proxy 2: dedicated proxy

attr_creation_time^Required

attr_creation_time: typing.Union[str, IResolvable]

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

Attribute CreationTime: The creation time.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

attr_current_kernel_version^Required

attr_current_kernel_version: typing.Union[str, IResolvable]

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

Attribute CurrentKernelVersion: The minor engine version of the instance.

attr_db_cluster_nodes^Required

attr_db_cluster_nodes: typing.Union[str, IResolvable]

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

Attribute DBClusterNodes: The information about the node in the cluster.

attr_db_instance_class^Required

attr_db_instance_class: typing.Union[str, IResolvable]

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

Attribute DBInstanceClass: The instance type of the instance.

attr_db_instance_class_type^Required

attr_db_instance_class_type: typing.Union[str, IResolvable]

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

Attribute DBInstanceClassType: The instance family to which the instance belongs.

Valid values: s: shared instance family x: general-purpose instance family d: dedicated instance family h: dedicated host instance family

attr_db_instance_cpu^Required

attr_db_instance_cpu: typing.Union[str, IResolvable]

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

Attribute DBInstanceCPU: The number of CPU cores.

attr_db_instance_description^Required

attr_db_instance_description: typing.Union[str, IResolvable]

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

Attribute DBInstanceDescription: The description of the instance.

attr_db_instance_disk_used^Required

attr_db_instance_disk_used: typing.Union[str, IResolvable]

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

Attribute DBInstanceDiskUsed: The disk usage of the instance.

attr_db_instance_id^Required

attr_db_instance_id: typing.Union[str, IResolvable]

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

Attribute DBInstanceId: The instance ID.

attr_db_instance_memory^Required

attr_db_instance_memory: typing.Union[str, IResolvable]

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

Attribute DBInstanceMemory: The memory capacity of the instance.

Unit: MB.

attr_db_instance_net_type^Required

attr_db_instance_net_type: typing.Union[str, IResolvable]

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

Attribute DBInstanceNetType: The type of the network over which the instance is connected.

Valid values: Internet: Internet Intranet: internal network

attr_db_instance_status^Required

attr_db_instance_status: typing.Union[str, IResolvable]

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

Attribute DBInstanceStatus: The status of the instance.

attr_db_instance_storage^Required

attr_db_instance_storage: typing.Union[str, IResolvable]

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

Attribute DBInstanceStorage: The storage capacity of the instance.

Unit: GB.

attr_db_instance_storage_type^Required

attr_db_instance_storage_type: typing.Union[str, IResolvable]

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

Attribute DBInstanceStorageType: The storage type of the instance.

Valid values: local_ssd and ephemeral_ssd: local SSD cloud_ssd: standard SSD cloud_essd: enhanced SSD (ESSD)

attr_db_instance_type^Required

attr_db_instance_type: typing.Union[str, IResolvable]

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

Attribute DBInstanceType: The type of the instance.

Valid values: Primary: primary instance Readonly: read-only instance Guard: disaster recovery instance Temp: temporary instance

attr_db_max_quantity^Required

attr_db_max_quantity: typing.Union[str, IResolvable]

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

Attribute DBMaxQuantity: The maximum number of databases that can be created on the instance.

attr_dedicated_host_group_id^Required

attr_dedicated_host_group_id: typing.Union[str, IResolvable]

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

Attribute DedicatedHostGroupId: The ID of the dedicated cluster.

attr_deletion_protection^Required

attr_deletion_protection: typing.Union[str, IResolvable]

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

Attribute DeletionProtection: Indicates whether the release protection feature is enabled.

Valid values: true false

attr_engine^Required

attr_engine: typing.Union[str, IResolvable]

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

Attribute Engine: The database engine of the instance.

Valid values: MySQL PostgreSQL SQLServer MariaDB

attr_engine_version^Required

attr_engine_version: typing.Union[str, IResolvable]

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

Attribute EngineVersion: The database engine version.

attr_expire_time^Required

attr_expire_time: typing.Union[str, IResolvable]

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

Attribute ExpireTime: The expiration time.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note: Pay-as-you-go instances never expire.

attr_extra^Required

attr_extra: typing.Union[str, IResolvable]

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

Attribute Extra: The extended information of the instance.

attr_general_group_name^Required

attr_general_group_name: typing.Union[str, IResolvable]

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

Attribute GeneralGroupName: The name of the dedicated cluster to which the instance belongs.

This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.

attr_guard_db_instance_id^Required

attr_guard_db_instance_id: typing.Union[str, IResolvable]

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

Attribute GuardDBInstanceId: The ID of the disaster recovery instance that is attached to the instance.

attr_increment_source_db_instance_id^Required

attr_increment_source_db_instance_id: typing.Union[str, IResolvable]

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

Attribute IncrementSourceDBInstanceId: The ID of the instance from which incremental data comes.

The incremental data of a disaster recovery instance or read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.

attr_instance_network_type^Required

attr_instance_network_type: typing.Union[str, IResolvable]

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

Attribute InstanceNetworkType: The network type of the instance.

Valid values: Classic VPC

attr_instruction_set_arch^Required

attr_instruction_set_arch: typing.Union[str, IResolvable]

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

Attribute InstructionSetArch: The architecture type of the instance.

Valid values: x86 arm

attr_ip_type^Required

attr_ip_type: typing.Union[str, IResolvable]

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

Attribute IPType: The type of the IP address.

Only IPv4 addresses are supported.

attr_latest_kernel_version^Required

attr_latest_kernel_version: typing.Union[str, IResolvable]

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

Attribute LatestKernelVersion: The latest minor engine version that is supported by the instance.

attr_lock_mode^Required

attr_lock_mode: typing.Union[str, IResolvable]

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

Attribute LockMode: The lock mode of the instance.

Valid values: Unlock: The instance is not locked. ManualLock: The instance is manually locked. LockByExpiration: The instance is automatically locked due to instance expiration. LockByRestoration: The instance is automatically locked due to instance restoration. LockByDiskQuota: The instance is automatically locked due to exhausted storage space. LockReadInstanceByDiskQuota: The instance is a read-only instance and is automatically locked due to exhausted storage.

attr_lock_reason^Required

attr_lock_reason: typing.Union[str, IResolvable]

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

Attribute LockReason: The reason why the instance was locked.

attr_maintain_time^Required

attr_maintain_time: typing.Union[str, IResolvable]

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

Attribute MaintainTime: The maintenance window of the instance.

The time is displayed in UTC. Take note that the maintenance window displayed in the ApsaraDB RDS console is equal to the value of this parameter plus 8 hours.

attr_master_instance_id^Required

attr_master_instance_id: typing.Union[str, IResolvable]

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

Attribute MasterInstanceId: The ID of the primary instance.

Note: If this parameter is not returned, the instance is the primary instance.

attr_master_zone^Required

attr_master_zone: typing.Union[str, IResolvable]

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

Attribute MasterZone: The zone ID of the primary instance.

attr_max_connections^Required

attr_max_connections: typing.Union[str, IResolvable]

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

Attribute MaxConnections: The maximum number of concurrent connections.

attr_max_iombps^Required

attr_max_iombps: typing.Union[str, IResolvable]

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

Attribute MaxIOMBPS: The maximum I/O throughput.

Unit: MB/s.

attr_max_iops^Required

attr_max_iops: typing.Union[str, IResolvable]

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

Attribute MaxIOPS: The maximum number of I/O requests per second.

attr_pay_type^Required

attr_pay_type: typing.Union[str, IResolvable]

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

Attribute PayType: The billing method of the instance.

Valid values: Postpaid: pay-as-you-go Prepaid: subscription

attr_pg_bouncer_enabled^Required

attr_pg_bouncer_enabled: typing.Union[str, IResolvable]

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

Attribute PGBouncerEnabled: Indicates whether PgBouncer is enabled.

attr_port^Required

attr_port: typing.Union[str, IResolvable]

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

Attribute Port: The port that is used to connect to the instance over an internal network.

attr_proxy_type^Required

attr_proxy_type: typing.Union[str, IResolvable]

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

Attribute ProxyType: The type of the proxy that is supported by the instance.

Valid values: 0: The instance does not support database proxies. 1: The instance supports shared proxies, with which the instance runs in multi-tenant mode. 2: The instance supports dedicated proxies, with which the instance runs in single-tenant mode.

attr_read_only_db_instance_ids^Required

attr_read_only_db_instance_ids: typing.Union[str, IResolvable]

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

Attribute ReadOnlyDBInstanceIds: The IDs of the read-only instances that are attached to the primary instance.

attr_readonly_instance_sql_delayed_time^Required

attr_readonly_instance_sql_delayed_time: typing.Union[str, IResolvable]

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

Attribute ReadonlyInstanceSQLDelayedTime: The latency at which the system replicates data to read-only instances.

The system replicates data from the primary instance to the read-only instances at the latency that is specified by the ReadonlyInstanceSQLDelayedTime parameter. Unit: seconds.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The resource group ID.

attr_security_ip_list^Required

attr_security_ip_list: typing.Union[str, IResolvable]

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

Attribute SecurityIPList: The IP addresses in the IP address whitelist.

attr_security_ip_mode^Required

attr_security_ip_mode: typing.Union[str, IResolvable]

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

Attribute SecurityIPMode: The whitelist mode of the instance.

Valid values: normal: standard whitelist mode safety: enhanced whitelist mode

attr_serverless_config^Required

attr_serverless_config: typing.Union[str, IResolvable]

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

Attribute ServerlessConfig: The settings of the serverless instance.

attr_slave_zones^Required

attr_slave_zones: typing.Union[str, IResolvable]

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

Attribute SlaveZones: The information about the zone of the secondary instance.

attr_super_permission_mode^Required

attr_super_permission_mode: typing.Union[str, IResolvable]

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

Attribute SuperPermissionMode: Indicates whether the instance supports superuser accounts, such as the system administrator (SA) account, the Active Directory (AD) account, and the host account.

Enable Disabled

attr_temp_db_instance_id^Required

attr_temp_db_instance_id: typing.Union[str, IResolvable]

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

Attribute TempDBInstanceId: The ID of the temporary instance that is attached to the instance.

attr_time_zone^Required

attr_time_zone: typing.Union[str, IResolvable]

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

Attribute TimeZone: The time zone of the instance.

attr_tips^Required

attr_tips: typing.Union[str, IResolvable]

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

Attribute Tips: The information about the exception that is detected on the instance.

This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.

attr_tips_level^Required

attr_tips_level: typing.Union[str, IResolvable]

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

Attribute TipsLevel: The severity level of the exception that is detected on the instance.

This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values: 1: The instance is normal. 2: The specifications of the read-only instances do not match the specifications of the primary instance. You must adjust the specifications of these instances based on your business requirements.

attr_vpc_cloud_instance_id^Required

attr_vpc_cloud_instance_id: typing.Union[str, IResolvable]

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

Attribute VpcCloudInstanceId: The VPC ID.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: The virtual private cloud (VPC) ID of the instance.

attr_v_switch_id^Required

attr_v_switch_id: typing.Union[str, IResolvable]

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

Attribute VSwitchId: The vSwitch ID.

attr_zone_id^Required

attr_zone_id: typing.Union[str, IResolvable]

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

Attribute ZoneId: The zone ID.

props^Required

props: DBInstanceProps

• Type: DBInstanceProps