Skip to content

ReadOnlyDBInstanceProps

Properties for defining a ReadOnlyDBInstance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-rds-readonlydbinstance

Initializer 

import { ReadOnlyDBInstanceProps } from '@alicloud/ros-cdk-rds'
const readOnlyDBInstanceProps: ReadOnlyDBInstanceProps = { ... }

Properties

Name Type Description
dbInstanceClass string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceClass: The type of the instance.
dbInstanceId string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceId: The ID of the master instance.
dbInstanceStorage number | @alicloud/ros-cdk-core.IResolvable Property dbInstanceStorage: The storage space of the instance.
engineVersion string | @alicloud/ros-cdk-core.IResolvable Property engineVersion: The version of the database.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The ID of the zone.
autoRenew boolean | @alicloud/ros-cdk-core.IResolvable Property autoRenew: Specifies whether to enable auto-renewal.
category string | @alicloud/ros-cdk-core.IResolvable Property category: The RDS edition of the read-only instance.
dbInstanceDescription string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceDescription: Description of created database instance.
dbInstanceStorageType string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceStorageType: The type of storage media that is used by the instance.
dedicatedHostGroupId string | @alicloud/ros-cdk-core.IResolvable Property dedicatedHostGroupId: The ID of the dedicated cluster to which the read-only instance belongs.
deletionProtection boolean | @alicloud/ros-cdk-core.IResolvable Property deletionProtection: Specifies whether to enable the release protection feature for the read-only instance.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The billing method.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The subscription duration.
periodType string | @alicloud/ros-cdk-core.IResolvable Property periodType: Charge period for created instances.
privateIpAddress string | @alicloud/ros-cdk-core.IResolvable Property privateIpAddress: The private IP address of the read-only instance.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
tags {[ key: string ]: any} Property tags: The tags of an instance.
targetDedicatedHostIdForMaster string | @alicloud/ros-cdk-core.IResolvable Property targetDedicatedHostIdForMaster: The ID of the host on which the primary instance resides.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the VSwitch.

dbInstanceClassRequired 

public readonly dbInstanceClass: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceClass: The type of the instance.

For more information, see Instance type list. The type of the read-only instance must be no less than that of the master instance. Otherwise, the read-only instance incurs high latency and high load.

dbInstanceIdRequired 

public readonly dbInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceId: The ID of the master instance.

dbInstanceStorageRequired 

public readonly dbInstanceStorage: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceStorage: The storage space of the instance.

Value range: 5 to 3000. The value must be a multiple of 5. Unit: GB.

engineVersionRequired 

public readonly engineVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property engineVersion: The version of the database.

The database and the master instance must have the same database version. Valid values: 5.6, 5.7, 8.0, 2017_ent, 2019_ent

zoneIdRequired 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The ID of the zone.

You can call the DescribeRegions API operation to view the latest zones.

autoRenewOptional 

public readonly autoRenew: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoRenew: Specifies whether to enable auto-renewal.

Valid values: true and false. Note :Monthly subscription: The auto-renewal cycle is one month. Annual subscription: The auto-renewal cycle is one year.

categoryOptional 

public readonly category: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property category: The RDS edition of the read-only instance.

Valid values: Basic: Basic Edition. HighAvailability: High-availability Edition. This is the default value. AlwaysOn: Cluster Edition. Finance: Enterprise Edition. This edition is available only on the China site (aliyun.com).

dbInstanceDescriptionOptional 

public readonly dbInstanceDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceDescription: Description of created database instance.

dbInstanceStorageTypeOptional 

public readonly dbInstanceStorageType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceStorageType: The type of storage media that is used by the instance.

Valid values: local_ssd: local SSDs cloud_ssd: standard SSDs cloud_essd: ESSDs of performance level 1 (PL1) cloud_essd2: ESSDs of PL2 cloud_essd3: ESSDs of PL3

dedicatedHostGroupIdOptional 

public readonly dedicatedHostGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dedicatedHostGroupId: The ID of the dedicated cluster to which the read-only instance belongs.

This parameter is valid when you create the read-only instance in a dedicated cluster.

deletionProtectionOptional 

public readonly deletionProtection: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deletionProtection: Specifies whether to enable the release protection feature for the read-only instance.

Valid values:- true: enables the feature.- false (default): disables the feature.

payTypeOptional 

public readonly payType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: The billing method.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The subscription duration.

Valid values: When PeriodType is Month, it could be from 1 to 12, 24, 36, 48, 60. When PeriodType is Year, it could be from 1 to 5.

periodTypeOptional 

public readonly periodType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property periodType: Charge period for created instances.

privateIpAddressOptional 

public readonly privateIpAddress: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property privateIpAddress: The private IP address of the read-only instance.

It must be within the IP address range provided by the switch. The system automatically assigns an IP address based on the VPCId and VSwitchId by default.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

tagsOptional 

public readonly tags: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

Property tags: The tags of an instance.

You should input the information of the tag with the format of the Key-Value, such as {"key1":"value1","key2":"value2", ... "key5":"value5"}. At most 5 tags can be specified. Key It can be up to 64 characters in length. Cannot begin with aliyun. Cannot begin with http:\/\/ or https:\/\/. Cannot be a null string. Value It can be up to 128 characters in length. Cannot begin with aliyun. Cannot begin with http:\/\/ or https:\/\/. Can be a null string.

targetDedicatedHostIdForMasterOptional 

public readonly targetDedicatedHostIdForMaster: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property targetDedicatedHostIdForMaster: The ID of the host on which the primary instance resides.

This parameter is valid when you create the read-only instance in a dedicated cluster.

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The ID of the VPC.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the VSwitch.