ALIYUN::RDS::DBInstance is used to create an ApsaraDB RDS instance.
Syntax
{
"Type": "ALIYUN::RDS::DBInstance",
"Properties": {
"PeriodType": String,
"Category": String,
"PrivateIpAddress": String,
"ResourceGroupId": String,
"TargetDedicatedHostIdForSlave": String,
"DBInstanceNetType": String,
"DBTimeZone": String,
"DedicatedHostGroupId": String,
"EncryptionKey": String,
"PreferredBackupPeriod": List,
"SecurityIPList": String,
"SecurityGroupId": String,
"DBIsIgnoreCase": Integer,
"DBInstanceStorage": Integer,
"DBMappings": List,
"Port": Integer,
"ConnectionStringPrefix": String,
"ConnectionStringType": String,
"MultiAZ": Boolean,
"MaintainTime": String,
"Engine": String,
"DBParamGroupId": String,
"DBInstanceDescription": String,
"Tags": Map,
"TargetDedicatedHostIdForMaster": String,
"EngineVersion": String,
"ZoneId": String,
"DBInstanceClass": String,
"AllocatePublicConnection": Boolean,
"PreferredBackupTime": String,
"VSwitchId": String,
"Period": Integer,
"PayType": String,
"DBInstanceStorageType": String,
"RoleARN": String,
"MasterUserPassword": String,
"MasterUserType": String,
"VpcId": String,
"MasterUsername": String,
"ConnectionMode": String,
"BackupRetentionPeriod": Number,
"TargetDedicatedHostIdForLog": String,
"SlaveZoneIds": List,
"SQLCollectorStatus": String,
"SSLSetting": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
ResourceGroupId | String | No | No | The ID of the resource group. | None |
Engine | String | Yes | No | The database engine that the instance runs. | Valid values:
|
DBInstanceStorage | Integer | Yes | Yes | The storage capacity of the instance. |
Note This value must be in 5 GB increments.
|
EngineVersion | String | Yes | No | The version of the database engine. |
|
Port | Integer | No | Yes | The port that is used to connect to the instance. | None |
ConnectionStringPrefix | String | No | Yes | The prefix of the endpoint. | The prefix must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). |
ConnectionStringType | String | No | Yes | The type of the endpoint. | Valid values:
|
DBTimeZone | String | No | No | The UTC time zone of the instance. | Valid values: -12:59 to +13:00.
Note
|
DBParamGroupId | String | No | No | The ID of the parameter template to be used by the instance. | None |
Category | String | No | No | The edition of the instance. | Valid values:
|
TargetDedicatedHostIdForMaster | String | No | No | The ID of the host on which to create a primary instance within a dedicated cluster. | None |
DBIsIgnoreCase | Integer | No | No | Specifies whether table names are case-sensitive. | Default value: 1. Valid values:
|
EncryptionKey | String | No | No | The ID of the encryption key that is used to encrypt data on SSDs in the region. You can view the ID of an existing encryption key or create an encryption key in the KMS console. | If this parameter is specified, disk encryption is enabled and you must also specify the RoleARN parameter. Disk encryption cannot be disabled after it is enabled. |
MaintainTime | String | No | No | The maintenance window of the instance. | Specify the maintenance window in the HH:mmZ-HH:mmZ format. The time must be in UTC.
|
TargetDedicatedHostIdForSlave | String | No | No | The ID of the host on which to create a secondary instance within a dedicated cluster. | None |
DedicatedHostGroupId | String | No | No | The ID of the dedicated cluster in which to create instances. | None |
DBInstanceStorageType | String | No | No | The storage type of the instance. | Valid values:
|
RoleARN | String | No | No | The Alibaba Cloud Resource Name (ARN) that is provided to the service account of the instance by your Alibaba Cloud account. This ARN is used to connect to Key Management Service (KMS). | For more information, see Authorize an ApsaraDB RDS for MySQL instance to access KMS. |
DBInstanceClass | String | Yes | Yes | The instance type. | For more information, see Primary instance types. |
SecurityIPList | String | Yes | Yes | The whitelist of IP addresses that are allowed to access all databases in the instance. |
Separate multiple IP addresses with commas (,). Each IP address in the whitelist must be unique. A maximum of 1,000 IP addresses can be specified. Supported formats:
|
SecurityGroupId | String | No | Yes | The ID of the associated security group. | Each ApsaraDB RDS instance can be associated with up to three security groups. Separate multiple security groups with commas (,). To delete all security groups, set this parameter to an empty string. |
MultiAZ | Boolean | No | No | Specifies whether the instance can be deployed across multiple zones. | Valid values:
|
VpcId | String | No | No | The ID of the VPC. | None |
DBMappings | List | No | No | The list of one or more databases to be created in the instance. | For more information, see DBMappings properties. |
DBInstanceDescription | String | No | No | The description of the instance. | The description must be 2 to 256 characters in length and can contain letters, digits,
underscores (_), and hyphens (-). It must start with a letter and cannot start with
http:// or https:// .
|
ConnectionMode | String | No | No | The connection mode of the instance. | Valid values:
Note If you create an instance that runs SQL Server 2012, SQL Server 2016, or SQL Server
2017, you can set this parameter only to Standard.
|
MasterUsername | String | No | No | The name of the database account. | The name must be globally unique. The name can be up to 16 characters in length and can contain letters, digits, and underscores (_). It must start with a letter. |
MasterUserPassword | String | No | No | The password of the database account. | The password must be 8 to 32 characters in length and can contain letters, digits, and underscores (_). |
ZoneId | String | No | No | The zone ID of the instance. | None |
DBInstanceNetType | String | No | No | The network type of the instance. | Default value: Intranet. Valid values:
|
VSwitchId | String | No | No | The ID of the vSwitch. | Separate multiple vSwitch IDs with commas (,). This parameter must be specified if the Engine parameter is set to MariaDB. |
AllocatePublicConnection | Boolean | No | No | Specifies whether to apply for a public endpoint for the instance. | Valid values:
|
PreferredBackupTime | String | No | No | The backup window. |
|
BackupRetentionPeriod | Number | No | No | The number of days for which backup files can be retained. | Valid values: 7 to 30.
Unit: days. Default value: 7. |
PrivateIpAddress | String | No | No | The private IP address within the CIDR block of the vSwitch. | If you do not specify this parameter, the system allocates a private IP address. |
PreferredBackupPeriod | List | No | No | The backup cycle. | Valid values:
|
MasterUserType | String | No | No | The type of the database account. | Default value: Normal. Valid values:
|
Tags | Map | No | Yes | The list of one or more tags. Each tag consists of a tag key and a tag value. | The tag key is required and the tag value is optional.
Format example: |
PeriodType | String | No | No | The unit of the subscription period. | Default value: Month. Valid values:
|
PayType | String | No | No | The billing method of the instance. | Valid values:
|
Period | Integer | No | No | The subscription period of the instance. |
|
TargetDedicatedHostIdForLog | String | No | No | The ID of the host on which to create a logger instance within a dedicated cluster. | None |
SlaveZoneIds | List | No | No | The list of one or more secondary zone IDs that you need to specify when you create a High-availability or Enterprise Edition instance. | A maximum of two secondary zones can be specified. For example, you can set this parameter
to ["zone-b"] or ["zone-b", "zone-c"] .
You must specify a vSwitch in each primary or secondary zone. For example, If ZoneId
is set to
"zone-a" and SlaveZoneIds is set to ["zone-c", "zone-b"] , you must set the VSwitchID value in the following format:
If you want the system to automatically select a secondary zone, set this parameter
to |
SQLCollectorStatus | String | No | Yes | Specifies whether SQL Explorer is enabled or disabled. | Valid values:
|
SSLSetting | String | No | No | The settings of the Secure Sockets Layer (SSL) connection for the instance. | Default value: Disabled. Valid values:
|
DBMappings syntax
"DBMappings": [
{
"DBDescription": String,
"CharacterSetName": String,
"DBName": String
}
]
DBMappings properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
CharacterSetName | String | Yes | No | The character set. |
|
DBName | String | Yes | No | The name of the database. | The name must be globally unique.
It can be up to 64 characters in length and can contain letters, digits, and underscores (_). It must start with a letter. |
DBDescription | String | No | No | The description of the database. | The description must be 2 to 256 characters in length and can contain letters, digits,
underscores (_), and hyphens (-). It must start with a letter and cannot start with
http:// or https:// .
|
Response parameters
Fn::GetAtt
- DBInstanceId: the ID of the instance.
- InnerPort: the internal port of the instance.
- InnerIPAddress: the internal IP address of the instance.
- InnerConnectionString: the internal endpoint of the instance.
- PublicPort: the public port of the instance.
- PublicConnectionString: the public endpoint of the instance.
- PublicIPAddress: the public IP address of the instance.
Examples
JSON
format
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"PeriodType": {
"Type": "String",
"Description": "Charge period for created instances.",
"AllowedValues": [
"Month",
"Year"
],
"Default": "Month"
},
"Category": {
"Type": "String",
"Description": "The edition of the instance. Valid values:\nBasic: specifies to use the Basic Edition.\nHighAvailability: specifies to use the High-availability Edition.\nAlwaysOn: specifies to use the Cluster Edition.\nFinance: specifies to use the Enterprise Edition.",
"AllowedValues": [
"Basic",
"HighAvailability",
"AlwaysOn",
"Finance"
]
},
"PrivateIpAddress": {
"Type": "String",
"Description": "The private ip for created instance."
},
"ResourceGroupId": {
"Type": "String",
"Description": "Resource group id."
},
"TargetDedicatedHostIdForSlave": {
"Type": "String",
"Description": "The ID of the host to which the instance belongs if you create a secondary instance in a host group."
},
"DBInstanceNetType": {
"Type": "String",
"Description": "Database instance net type, default is Intranet.Internet for public access, Intranet for private access.",
"AllowedValues": [
"Internet",
"Intranet"
],
"Default": "Intranet"
},
"DBTimeZone": {
"Type": "String",
"Description": "The UTC time zone of the instance. Valid values: -12:00 to +12:00. The time zone must be an integer value such as +08:00. Values such as +08:30 are not allowed."
},
"DedicatedHostGroupId": {
"Type": "String",
"Description": "The ID of the host group to which the instance belongs if you create an instance in a host group."
},
"Port": {
"Type": "Number",
"Description": "The port of the database service.",
"MinValue": 1,
"MaxValue": 65535
},
"EncryptionKey": {
"Type": "String",
"Description": "The ID of the encryption key that is used to encrypt data on SSDs in the region. You can view the encryption key ID in the Key Management Service (KMS) console. You can also create an encryption key."
},
"PreferredBackupPeriod": {
"Type": "CommaDelimitedList",
"Description": "The backup period. Separate multiple values with commas (,). The default value is the original value. Valid values:Monday Tuesday Wednesday Thursday Friday Saturday Sunday Note When the BackupPolicyMode parameter is set to DataBackupPolicy, this parameter is required."
},
"SlaveZoneIds": {
"Type": "Json",
"Description": "List of slave zone ids can specify slave zone ids when creating the high-availability or enterprise edition instance. Meanwhile, VSwitchId needs to pass in the corresponding vswitch id to the slave zone by order. For example, ZoneId = \"zone-a\" and SlaveZoneIds = [\"zone-c\", \"zone-b\"], then the VSwitchId must be \"vsw-zone-a,vsw-zone-c,vsw-zone-b\". Of course, you can also choose automatic allocation, for example, ZoneId = \"zone-a\" and SlaveZoneIds = [\"Auto\", \"Auto\"], then the VSwitchId must be \"vsw-zone-a,Auto,Auto\". The list contains up to 2 slave zone ids, separated by commas.",
"MaxLength": 2
},
"SecurityIPList": {
"Type": "String",
"Description": "Security ip to access the database instance, combine with comma, 0.0.0.0/0 means no limitation."
},
"DBIsIgnoreCase": {
"Type": "Number",
"Description": "Specifies whether table names are case-sensitive. Valid values:\n1: Table names are not case-sensitive. This is the default value.\n0: Table names are case-sensitive."
},
"DBInstanceStorage": {
"Type": "Number",
"Description": "Database instance storage size. mysql is [5,1000]. sql server 2008r2 is [10,1000], sql server 2012/2012_web/2016-web is [20,1000]. PostgreSQL and PPAS is [5,2000]. Increased every 5 GB, Unit in GB"
},
"DBMappings": {
"Type": "Json",
"Description": "Database mappings to attach to db instance."
},
"ConnectionStringPrefix": {
"Type": "String",
"Description": "The prefix of the endpoint. \nOnly the prefix of the CurrentConnectionString parameter value can be modified.\nThe prefix must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). ",
"AllowedPattern": "[a-zA-Z0-9-]{8,64}"
},
"MultiAZ": {
"Type": "Boolean",
"Description": "Specifies if the database instance is a multiple Availability Zone deployment. ",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": false
},
"MaintainTime": {
"Type": "String",
"Description": "The period during which the maintenance performs. The format is HH:mmZ-HH:mmZ."
},
"Engine": {
"Type": "String",
"Description": "Database instance engine type. Support MySQL/SQLServer/PostgreSQL/PPAS/MariaDB now.",
"AllowedValues": [
"MySQL",
"SQLServer",
"PostgreSQL",
"PPAS",
"MariaDB"
]
},
"Tags": {
"Type": "Json",
"Description": "The tags of an instance.\nYou should input the information of the tag with the format of the Key-Value, such as {\"key1\":\"value1\",\"key2\":\"value2\", ... \"key5\":\"value5\"}.\nAt most 5 tags can be specified.\nKey\nIt can be up to 64 characters in length.\nCannot begin with aliyun.\nCannot begin with http:// or https://.\nCannot be a null string.\nValue\nIt can be up to 128 characters in length.\nCannot begin with aliyun.\nCannot begin with http:// or https://.\nCan be a null string."
},
"DBParamGroupId": {
"Type": "String",
"Description": "The ID of the parameter template used by the instance."
},
"DBInstanceDescription": {
"Type": "String",
"Description": "Description of created database instance."
},
"TargetDedicatedHostIdForMaster": {
"Type": "String",
"Description": "The ID of the host to which the instance belongs if you create a primary instance in a host group."
},
"EngineVersion": {
"Type": "String",
"Description": "Database instance version of the relative engine type.Support MySQL: 5.5/5.6/5.7/8.0;\nSQLServer: 2008r2/2012/2012_ent_ha/2012_std_ha/2012_web/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent;\nPostgreSQL: 9.4/10.0/11.0/12.0;\nPPAS: 9.3/10.0;\nMariaDB: 10.3."
},
"ZoneId": {
"Type": "String",
"Description": "selected zone to create database instance. You cannot set the ZoneId parameter if the MultiAZ parameter is set to true."
},
"TargetDedicatedHostIdForLog": {
"Type": "String",
"Description": "The ID of the host to which the instance belongs if you create a log instance in a host group."
},
"DBInstanceClass": {
"Type": "String",
"Description": "Database instance type. Refer the RDS database instance type reference, such as 'rds.mys2.large', 'rds.mss1.large', 'rds.pg.s1.small' etc"
},
"AllocatePublicConnection": {
"Type": "Boolean",
"Description": "If true, allocate public connection automate.",
"AllowedValues": [
"True",
"true",
"False",
"false"
]
},
"PreferredBackupTime": {
"Type": "String",
"Description": "The time when the backup task is performed. Format: yyyy-MM-ddZ-HH:mm:ssZ.Note When the BackupPolicyMode parameter is set to DataBackupPolicy, this parameter is required."
},
"VSwitchId": {
"Type": "String",
"Description": "The vSwitch id of created instance. For VPC network, the property is required."
},
"SecurityGroupId": {
"Type": "String",
"Description": "The ID of the ECS security groups. \nEach RDS instance can be associated with up to three ECS security groups. \nYou must separate them with commas (,). \nTo delete an ECS Security group, leave this parameter empty. \n"
},
"Period": {
"Type": "Number",
"Description": "Prepaid time period. While choose by pay by month, it could be from 1 to 9. While choose pay by year, it could be from 1 to 3.",
"MinValue": 1,
"MaxValue": 9,
"Default": 1
},
"PayType": {
"Type": "String",
"Description": "The charge type of created instance.",
"AllowedValues": [
"Prepaid",
"Postpaid"
],
"Default": "Postpaid"
},
"DBInstanceStorageType": {
"Type": "String",
"Description": "The storage type of the instance. Valid values:\nlocal_ssd: specifies to use local SSDs. This is the recommended storage type.\ncloud_ssd: specifies to use standard SSDs.\ncloud_essd: specifies to use enhanced SSDs."
},
"RoleARN": {
"Type": "String",
"Description": "The Alibaba Cloud Resource Name (ARN) provided to the service account of the instance by your Alibaba Cloud account to connect to KMS. You can copy the ARN from the RAM console."
},
"ConnectionStringType": {
"Type": "String",
"Description": "The endpoint type of the instance, allow values: Inner, Public",
"AllowedValues": [
"Inner",
"Public"
],
"Default": "Inner"
},
"MasterUserPassword": {
"Type": "String",
"Description": "The master password for the database instance. ",
"MinLength": 8,
"MaxLength": 32
},
"MasterUserType": {
"Type": "String",
"Description": "Privilege type of account.\n Normal: Common privilege. \n Super: High privilege. \nSysadmin: Super privileges (SA) (only supported by SQL Server)\nThe default value is Normal.",
"AllowedValues": [
"Normal",
"Super",
"Sysadmin"
],
"Default": "Normal"
},
"VpcId": {
"Type": "String",
"Description": "The VPC id of created database instance. For VPC network, the property is required."
},
"SSLSetting": {
"Type": "String",
"Description": "Secure Sockets Layer (SSL) link setting of the instance. Valid values:\nDisabled: Disable SSL\nEnabledForPublicConnection: Public connection address will be protected by the SSL certificate. It requires AllocatePublicConnection is true.\nEnabledForInnerConnection: Private connection address will be protected by the SSL certificate.\nDefault value is Disabled.",
"AllowedValues": [
"Disabled",
"EnabledForPublicConnection",
"EnabledForInnerConnection"
],
"Default": "Disabled"
},
"MasterUsername": {
"Type": "String",
"Description": "The master user name for the database instance. "
},
"ConnectionMode": {
"Type": "String",
"Description": "Connection Mode for database instance,support 'Standard' and 'Safe' mode. Default is RDS system assigns. "
},
"SQLCollectorStatus": {
"Type": "String",
"Description": "Specifies whether to enable or disable the SQL Explorer (SQL audit) feature. \nValid values:Enable | Disabled.",
"AllowedValues": [
"Enable",
"Disabled"
]
},
"BackupRetentionPeriod": {
"Type": "Number",
"Description": "The retention period of the data backup. Value range: 7 to 730. The default value is the original value. Note When the BackupPolicyMode parameter is set to LogBackupPolicy, this parameter is required.",
"Default": 7
}
},
"Resources": {
"DBInstance": {
"Type": "ALIYUN::RDS::DBInstance",
"Properties": {
"PeriodType": {
"Ref": "PeriodType"
},
"Category": {
"Ref": "Category"
},
"PrivateIpAddress": {
"Ref": "PrivateIpAddress"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
},
"TargetDedicatedHostIdForSlave": {
"Ref": "TargetDedicatedHostIdForSlave"
},
"DBInstanceNetType": {
"Ref": "DBInstanceNetType"
},
"DBTimeZone": {
"Ref": "DBTimeZone"
},
"DedicatedHostGroupId": {
"Ref": "DedicatedHostGroupId"
},
"Port": {
"Ref": "Port"
},
"EncryptionKey": {
"Ref": "EncryptionKey"
},
"PreferredBackupPeriod": {
"Ref": "PreferredBackupPeriod"
},
"SlaveZoneIds": {
"Ref": "SlaveZoneIds"
},
"SecurityIPList": {
"Ref": "SecurityIPList"
},
"DBIsIgnoreCase": {
"Ref": "DBIsIgnoreCase"
},
"DBInstanceStorage": {
"Ref": "DBInstanceStorage"
},
"DBMappings": {
"Ref": "DBMappings"
},
"ConnectionStringPrefix": {
"Ref": "ConnectionStringPrefix"
},
"MultiAZ": {
"Ref": "MultiAZ"
},
"MaintainTime": {
"Ref": "MaintainTime"
},
"Engine": {
"Ref": "Engine"
},
"Tags": {
"Ref": "Tags"
},
"DBParamGroupId": {
"Ref": "DBParamGroupId"
},
"DBInstanceDescription": {
"Ref": "DBInstanceDescription"
},
"TargetDedicatedHostIdForMaster": {
"Ref": "TargetDedicatedHostIdForMaster"
},
"EngineVersion": {
"Ref": "EngineVersion"
},
"ZoneId": {
"Ref": "ZoneId"
},
"TargetDedicatedHostIdForLog": {
"Ref": "TargetDedicatedHostIdForLog"
},
"DBInstanceClass": {
"Ref": "DBInstanceClass"
},
"AllocatePublicConnection": {
"Ref": "AllocatePublicConnection"
},
"PreferredBackupTime": {
"Ref": "PreferredBackupTime"
},
"VSwitchId": {
"Ref": "VSwitchId"
},
"SecurityGroupId": {
"Ref": "SecurityGroupId"
},
"Period": {
"Ref": "Period"
},
"PayType": {
"Ref": "PayType"
},
"DBInstanceStorageType": {
"Ref": "DBInstanceStorageType"
},
"RoleARN": {
"Ref": "RoleARN"
},
"ConnectionStringType": {
"Ref": "ConnectionStringType"
},
"MasterUserPassword": {
"Ref": "MasterUserPassword"
},
"MasterUserType": {
"Ref": "MasterUserType"
},
"VpcId": {
"Ref": "VpcId"
},
"SSLSetting": {
"Ref": "SSLSetting"
},
"MasterUsername": {
"Ref": "MasterUsername"
},
"ConnectionMode": {
"Ref": "ConnectionMode"
},
"SQLCollectorStatus": {
"Ref": "SQLCollectorStatus"
},
"BackupRetentionPeriod": {
"Ref": "BackupRetentionPeriod"
}
}
}
},
"Outputs": {
"InnerConnectionString": {
"Description": "DB instance connection url by Intranet.",
"Value": {
"Fn::GetAtt": [
"DBInstance",
"InnerConnectionString"
]
}
},
"DBInstanceId": {
"Description": "The instance id of created database instance.",
"Value": {
"Fn::GetAtt": [
"DBInstance",
"DBInstanceId"
]
}
},
"InnerIPAddress": {
"Description": "IP Address for created DB instance of Intranet.",
"Value": {
"Fn::GetAtt": [
"DBInstance",
"InnerIPAddress"
]
}
},
"PublicConnectionString": {
"Description": "DB instance connection url by Internet.",
"Value": {
"Fn::GetAtt": [
"DBInstance",
"PublicConnectionString"
]
}
},
"PublicIPAddress": {
"Description": "IP Address for created DB instance of Internet.",
"Value": {
"Fn::GetAtt": [
"DBInstance",
"PublicIPAddress"
]
}
},
"PublicPort": {
"Description": "Internet port of created DB instance.",
"Value": {
"Fn::GetAtt": [
"DBInstance",
"PublicPort"
]
}
},
"InnerPort": {
"Description": "Intranet port of created DB instance.",
"Value": {
"Fn::GetAtt": [
"DBInstance",
"InnerPort"
]
}
}
}
}
YAML
format
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
PeriodType:
Type: String
Description: Charge period for created instances.
AllowedValues:
- Month
- Year
Default: Month
Category:
Type: String
Description: |-
The edition of the instance. Valid values:
Basic: specifies to use the Basic Edition.
HighAvailability: specifies to use the High-availability Edition.
AlwaysOn: specifies to use the Cluster Edition.
Finance: specifies to use the Enterprise Edition.
AllowedValues:
- Basic
- HighAvailability
- AlwaysOn
- Finance
PrivateIpAddress:
Type: String
Description: The private ip for created instance.
ResourceGroupId:
Type: String
Description: Resource group id.
TargetDedicatedHostIdForSlave:
Type: String
Description: >-
The ID of the host to which the instance belongs if you create a secondary
instance in a host group.
DBInstanceNetType:
Type: String
Description: >-
Database instance net type, default is Intranet.Internet for public
access, Intranet for private access.
AllowedValues:
- Internet
- Intranet
Default: Intranet
DBTimeZone:
Type: String
Description: >-
The UTC time zone of the instance. Valid values: -12:00 to +12:00. The
time zone must be an integer value such as +08:00. Values such as +08:30
are not allowed.
DedicatedHostGroupId:
Type: String
Description: >-
The ID of the host group to which the instance belongs if you create an
instance in a host group.
Port:
Type: Number
Description: The port of the database service.
MinValue: 1
MaxValue: 65535
EncryptionKey:
Type: String
Description: >-
The ID of the encryption key that is used to encrypt data on SSDs in the
region. You can view the encryption key ID in the Key Management Service
(KMS) console. You can also create an encryption key.
PreferredBackupPeriod:
Type: CommaDelimitedList
Description: >-
The backup period. Separate multiple values with commas (,). The default
value is the original value. Valid values:Monday Tuesday Wednesday
Thursday Friday Saturday Sunday Note When the BackupPolicyMode parameter
is set to DataBackupPolicy, this parameter is required.
SlaveZoneIds:
Type: Json
Description: >-
List of slave zone ids can specify slave zone ids when creating the
high-availability or enterprise edition instance. Meanwhile, VSwitchId
needs to pass in the corresponding vswitch id to the slave zone by order.
For example, ZoneId = "zone-a" and SlaveZoneIds = ["zone-c", "zone-b"],
then the VSwitchId must be "vsw-zone-a,vsw-zone-c,vsw-zone-b". Of course,
you can also choose automatic allocation, for example, ZoneId = "zone-a"
and SlaveZoneIds = ["Auto", "Auto"], then the VSwitchId must be
"vsw-zone-a,Auto,Auto". The list contains up to 2 slave zone ids,
separated by commas.
MaxLength: 2
SecurityIPList:
Type: String
Description: >-
Security ip to access the database instance, combine with comma, 0.0.0.0/0
means no limitation.
DBIsIgnoreCase:
Type: Number
Description: |-
Specifies whether table names are case-sensitive. Valid values:
1: Table names are not case-sensitive. This is the default value.
0: Table names are case-sensitive.
DBInstanceStorage:
Type: Number
Description: >-
Database instance storage size. mysql is [5,1000]. sql server 2008r2 is
[10,1000], sql server 2012/2012_web/2016-web is [20,1000]. PostgreSQL and
PPAS is [5,2000]. Increased every 5 GB, Unit in GB
DBMappings:
Type: Json
Description: Database mappings to attach to db instance.
ConnectionStringPrefix:
Type: String
Description: >-
The prefix of the endpoint.
Only the prefix of the CurrentConnectionString parameter value can be
modified.
The prefix must be 8 to 64 characters in length and can contain letters,
digits, and hyphens (-).
AllowedPattern: '[a-zA-Z0-9-]{8,64}'
MultiAZ:
Type: Boolean
Description: >-
Specifies if the database instance is a multiple Availability Zone
deployment.
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
MaintainTime:
Type: String
Description: >-
The period during which the maintenance performs. The format is
HH:mmZ-HH:mmZ.
Engine:
Type: String
Description: >-
Database instance engine type. Support
MySQL/SQLServer/PostgreSQL/PPAS/MariaDB now.
AllowedValues:
- MySQL
- SQLServer
- PostgreSQL
- PPAS
- MariaDB
Tags:
Type: Json
Description: >-
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.
DBParamGroupId:
Type: String
Description: The ID of the parameter template used by the instance.
DBInstanceDescription:
Type: String
Description: Description of created database instance.
TargetDedicatedHostIdForMaster:
Type: String
Description: >-
The ID of the host to which the instance belongs if you create a primary
instance in a host group.
EngineVersion:
Type: String
Description: >-
Database instance version of the relative engine type.Support MySQL:
5.5/5.6/5.7/8.0;
SQLServer:
2008r2/2012/2012_ent_ha/2012_std_ha/2012_web/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent;
PostgreSQL: 9.4/10.0/11.0/12.0;
PPAS: 9.3/10.0;
MariaDB: 10.3.
ZoneId:
Type: String
Description: >-
selected zone to create database instance. You cannot set the ZoneId
parameter if the MultiAZ parameter is set to true.
TargetDedicatedHostIdForLog:
Type: String
Description: >-
The ID of the host to which the instance belongs if you create a log
instance in a host group.
DBInstanceClass:
Type: String
Description: >-
Database instance type. Refer the RDS database instance type reference,
such as 'rds.mys2.large', 'rds.mss1.large', 'rds.pg.s1.small' etc
AllocatePublicConnection:
Type: Boolean
Description: 'If true, allocate public connection automate.'
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
PreferredBackupTime:
Type: String
Description: >-
The time when the backup task is performed. Format:
yyyy-MM-ddZ-HH:mm:ssZ.Note When the BackupPolicyMode parameter is set to
DataBackupPolicy, this parameter is required.
VSwitchId:
Type: String
Description: >-
The vSwitch id of created instance. For VPC network, the property is
required.
SecurityGroupId:
Type: String
Description: |
The ID of the ECS security groups.
Each RDS instance can be associated with up to three ECS security groups.
You must separate them with commas (,).
To delete an ECS Security group, leave this parameter empty.
Period:
Type: Number
Description: >-
Prepaid time period. While choose by pay by month, it could be from 1 to
9. While choose pay by year, it could be from 1 to 3.
MinValue: 1
MaxValue: 9
Default: 1
PayType:
Type: String
Description: The charge type of created instance.
AllowedValues:
- Prepaid
- Postpaid
Default: Postpaid
DBInstanceStorageType:
Type: String
Description: >-
The storage type of the instance. Valid values:
local_ssd: specifies to use local SSDs. This is the recommended storage
type.
cloud_ssd: specifies to use standard SSDs.
cloud_essd: specifies to use enhanced SSDs.
RoleARN:
Type: String
Description: >-
The Alibaba Cloud Resource Name (ARN) provided to the service account of
the instance by your Alibaba Cloud account to connect to KMS. You can copy
the ARN from the RAM console.
ConnectionStringType:
Type: String
Description: 'The endpoint type of the instance, allow values: Inner, Public'
AllowedValues:
- Inner
- Public
Default: Inner
MasterUserPassword:
Type: String
Description: 'The master password for the database instance. '
MinLength: 8
MaxLength: 32
MasterUserType:
Type: String
Description: |-
Privilege type of account.
Normal: Common privilege.
Super: High privilege.
Sysadmin: Super privileges (SA) (only supported by SQL Server)
The default value is Normal.
AllowedValues:
- Normal
- Super
- Sysadmin
Default: Normal
VpcId:
Type: String
Description: >-
The VPC id of created database instance. For VPC network, the property is
required.
SSLSetting:
Type: String
Description: >-
Secure Sockets Layer (SSL) link setting of the instance. Valid values:
Disabled: Disable SSL
EnabledForPublicConnection: Public connection address will be protected by
the SSL certificate. It requires AllocatePublicConnection is true.
EnabledForInnerConnection: Private connection address will be protected by
the SSL certificate.
Default value is Disabled.
AllowedValues:
- Disabled
- EnabledForPublicConnection
- EnabledForInnerConnection
Default: Disabled
MasterUsername:
Type: String
Description: 'The master user name for the database instance. '
ConnectionMode:
Type: String
Description: >-
Connection Mode for database instance,support 'Standard' and 'Safe' mode.
Default is RDS system assigns.
SQLCollectorStatus:
Type: String
Description: >-
Specifies whether to enable or disable the SQL Explorer (SQL audit)
feature.
Valid values:Enable | Disabled.
AllowedValues:
- Enable
- Disabled
BackupRetentionPeriod:
Type: Number
Description: >-
The retention period of the data backup. Value range: 7 to 730. The
default value is the original value. Note When the BackupPolicyMode
parameter is set to LogBackupPolicy, this parameter is required.
Default: 7
Resources:
DBInstance:
Type: 'ALIYUN::RDS::DBInstance'
Properties:
PeriodType:
Ref: PeriodType
Category:
Ref: Category
PrivateIpAddress:
Ref: PrivateIpAddress
ResourceGroupId:
Ref: ResourceGroupId
TargetDedicatedHostIdForSlave:
Ref: TargetDedicatedHostIdForSlave
DBInstanceNetType:
Ref: DBInstanceNetType
DBTimeZone:
Ref: DBTimeZone
DedicatedHostGroupId:
Ref: DedicatedHostGroupId
Port:
Ref: Port
EncryptionKey:
Ref: EncryptionKey
PreferredBackupPeriod:
Ref: PreferredBackupPeriod
SlaveZoneIds:
Ref: SlaveZoneIds
SecurityIPList:
Ref: SecurityIPList
DBIsIgnoreCase:
Ref: DBIsIgnoreCase
DBInstanceStorage:
Ref: DBInstanceStorage
DBMappings:
Ref: DBMappings
ConnectionStringPrefix:
Ref: ConnectionStringPrefix
MultiAZ:
Ref: MultiAZ
MaintainTime:
Ref: MaintainTime
Engine:
Ref: Engine
Tags:
Ref: Tags
DBParamGroupId:
Ref: DBParamGroupId
DBInstanceDescription:
Ref: DBInstanceDescription
TargetDedicatedHostIdForMaster:
Ref: TargetDedicatedHostIdForMaster
EngineVersion:
Ref: EngineVersion
ZoneId:
Ref: ZoneId
TargetDedicatedHostIdForLog:
Ref: TargetDedicatedHostIdForLog
DBInstanceClass:
Ref: DBInstanceClass
AllocatePublicConnection:
Ref: AllocatePublicConnection
PreferredBackupTime:
Ref: PreferredBackupTime
VSwitchId:
Ref: VSwitchId
SecurityGroupId:
Ref: SecurityGroupId
Period:
Ref: Period
PayType:
Ref: PayType
DBInstanceStorageType:
Ref: DBInstanceStorageType
RoleARN:
Ref: RoleARN
ConnectionStringType:
Ref: ConnectionStringType
MasterUserPassword:
Ref: MasterUserPassword
MasterUserType:
Ref: MasterUserType
VpcId:
Ref: VpcId
SSLSetting:
Ref: SSLSetting
MasterUsername:
Ref: MasterUsername
ConnectionMode:
Ref: ConnectionMode
SQLCollectorStatus:
Ref: SQLCollectorStatus
BackupRetentionPeriod:
Ref: BackupRetentionPeriod
Outputs:
InnerConnectionString:
Description: DB instance connection url by Intranet.
Value:
'Fn::GetAtt':
- DBInstance
- InnerConnectionString
DBInstanceId:
Description: The instance id of created database instance.
Value:
'Fn::GetAtt':
- DBInstance
- DBInstanceId
InnerIPAddress:
Description: IP Address for created DB instance of Intranet.
Value:
'Fn::GetAtt':
- DBInstance
- InnerIPAddress
PublicConnectionString:
Description: DB instance connection url by Internet.
Value:
'Fn::GetAtt':
- DBInstance
- PublicConnectionString
PublicIPAddress:
Description: IP Address for created DB instance of Internet.
Value:
'Fn::GetAtt':
- DBInstance
- PublicIPAddress
PublicPort:
Description: Internet port of created DB instance.
Value:
'Fn::GetAtt':
- DBInstance
- PublicPort
InnerPort:
Description: Intranet port of created DB instance.
Value:
'Fn::GetAtt':
- DBInstance
- InnerPort