ALIYUN::RDS::ReadOnlyDBInstance is used to create a read-only ApsaraDB RDS instance.
Syntax
{
"Type": "ALIYUN::RDS::ReadOnlyDBInstance",
"Properties": {
"Category": String,
"VPCId": String,
"DBInstanceDescription": String,
"Tags": Map,
"EngineVersion": String,
"DBInstanceId": String,
"PayType": String,
"ZoneId": String,
"ResourceGroupId": String,
"DBInstanceStorage": Integer,
"VSwitchId": String,
"DBInstanceStorageType": String,
"DBInstanceClass": String,
"PrivateIpAddress": String,
"PeriodType": String,
"Period": Integer,
"AutoRenew": Boolean
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
Category | String | No | No | The edition of the read-only instance. | Valid values:
|
VPCId | String | No | No | The virtual private cloud (VPC) ID of the read-only instance. | None. |
DBInstanceDescription | String | No | No | The description of the read-only instance. | The description must be 2 to 256 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The description must start with a letter and cannot start with |
Tags | Map | No | Yes | The tags of the read-only instance. | The tags are in the key-value pair format. Example:
You can specify up to five key-value pairs. A tag key can be up to 64 characters in length and cannot start with |
EngineVersion | String | Yes | No | The database engine version of the read-only instance. | The database engine version of the read-only instance must be the same as the database engine version of the primary instance. Valid values:
|
DBInstanceId | String | Yes | No | The ID of the primary instance. | None. |
PayType | String | No | No | The billing method of the read-only instance. | Only the pay-as-you-go billing method is supported. Set the value to Postpaid. |
ZoneId | String | Yes | No | The zone ID of the read-only instance. | You can call the DescribeRegions operation to query the most recent zone list. |
ResourceGroupId | String | No | No | The ID of the resource group. | None. |
DBInstanceStorage | Integer | Yes | Yes | The storage capacity of the read-only instance. | Unit: GB. Valid values: 5 to 3000. The value must be a multiple of 5. Instances of different versions have different value ranges. For more information, see Primary ApsaraDB RDS instance types. |
VSwitchId | String | No | No | The vSwitch ID of the read-only instance. | None. |
DBInstanceStorageType | String | No | No | The storage type of the read-only instance. | Valid values:
Note You can use only local SSDs for read-only ApsaraDB RDS for MySQL instances, and use only standard SSDs or enhanced SSDs for read-only ApsaraDB RDS for SQL Server instances. |
DBInstanceClass | String | Yes | Yes | The instance type of the read-only instance. | For more information, see Primary ApsaraDB RDS instance types. We recommend that you specify an instance type higher than or equal to the instance type of the primary instance. If the instance type of the read-only instance is lower than that of the primary instance, the read-only instance may encounter issues such as high latency and heavy load. |
PrivateIpAddress | String | No | No | The private IP address of the read-only instance. | The private IP address must be within the IP address range of the vSwitch that you specify. The system automatically assigns a private IP address to the instance based on the values of VPCId and VSwitchId. |
PeriodType | String | No | No | The unit of the subscription duration of the read-only instance. | Valid values:
|
Period | Integer | No | No | The subscription duration of the read-only instance. | Valid values:
|
AutoRenew | Boolean | No | No | Specifies whether to enable auto-renewal for the read-only instance. | This property takes effect only when the read-only instance uses the subscription billing method. Valid values:
Note
|
Return values
Fn::GetAtt
ConnectionString: the internal endpoint of the read-only instance.
DBInstanceId: the ID of the read-only instance.
Port: the internal port of the read-only instance.