ALIYUN::RDS::DBInstance类型用于创建RDS数据库实例。
语法
{
"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
}
}属性
| 属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
|---|---|---|---|---|---|
| ResourceGroupId | String | 否 | 否 | 资源组ID。 | 无 |
| Engine | String | 是 | 否 | 数据库类型。 | 取值：
|
| DBInstanceStorage | Integer | 是 | 是 | 数据库存储空间。 | 取值：
单位：GB。
说明 每5 GB进行递增。
|
| EngineVersion | String | 是 | 否 | 数据库版本号。 | 取值：
|
| Port | Integer | 否 | 是 | 实例端口。 | 无 |
| ConnectionStringPrefix | String | 否 | 是 | 连接地址的前缀。 | 长度8~64个字符，由英文字母、数字、短划线（-）组成。 |
| ConnectionStringType | String | 否 | 是 | 连接地址的类型。 | 取值：
|
| DBTimeZone | String | 否 | 否 | UTC时区。 | 取值范围：-12:59~+13:00。
说明
|
| DBParamGroupId | String | 否 | 否 | 参数模板ID。 | 无 |
| Category | String | 否 | 否 | 实例系列。 | 取值：
|
| TargetDedicatedHostIdForMaster | String | 否 | 否 | 在专属集群内创建实例时，指定主实例的主机ID。 | 无 |
| DBIsIgnoreCase | Integer | 否 | 否 | 表名是否区分大小写。 | 取值：
|
| EncryptionKey | String | 否 | 否 | 同地域内的云盘加密的密钥ID。您可以在密钥管理服务控制台查看密钥ID，也可以创建新的密钥。 | 传入此参数表示开启云盘加密（开启后无法关闭），并且需要传入RoleARN。 |
| MaintainTime | String | 否 | 否 | 实例的可维护时间段。 | 格式：HH:mmZ-HH:mmZ（UTC时间）。 |
| TargetDedicatedHostIdForSlave | String | 否 | 否 | 在专属集群内创建实例时，指定备实例的主机ID。 | 无 |
| DedicatedHostGroupId | String | 否 | 否 | 在专属集群内创建实例时指定专属集群ID。 | 无 |
| DBInstanceStorageType | String | 否 | 否 | 实例存储类型。 | 取值：
|
| RoleARN | String | 否 | 否 | 角色ARN。RDS通过该角色访问KMS。 | 更多信息，请参见授权RDS访问KMS。 |
| DBInstanceClass | String | 是 | 是 | 实例规格。 | 更多信息，请参见主实例规格列表。 |
| SecurityIPList | String | 是 | 是 | 允许访问该实例下所有数据库的IP白名单。 |
多个IP以英文逗号（,）间隔，不可以重复。最多支持1000个。
支持格式：
|
| SecurityGroupId | String | 否 | 是 | 关联的安全组ID。 | 最多支持关联3个安全组，多个安全组用英文逗号（,）隔开。清空安全组请指定空字符串。 |
| MultiAZ | Boolean | 否 | 否 | 该数据库实例是否支持多可用区。 | 取值：
|
| VpcId | String | 否 | 否 | 专有网络ID。 | 无 |
| DBMappings | List | 否 | 否 | 实例下创建新的数据库。 | 更多信息，请参见DBMappings属性。 |
| DBInstanceDescription | String | 否 | 否 | 实例的描述或备注信息。 | 长度为2~256个字符。以英文字母或汉字开头，不能以http://或https://开头。可包含汉字、英文字母、数字、下划线（_）和短划线（-）。 |
| ConnectionMode | String | 否 | 否 | 数据库的连接模式。 | 取值：
如果未指定该参数，则默认由RDS系统分配。
说明 SQL Server 2012/2016/2017只支持标准访问模式。
|
| MasterUsername | String | 否 | 否 | 数据库实例的主账号名称。 | 名称需要全局唯一。长度不超过16个字符。以英文字母开头，可包含英文字母、数字和下划线（_）。 |
| MasterUserPassword | String | 否 | 否 | 数据库实例的主账号密码。 | 长度为8~32个字符。可包含英文字母、数字和下划线（_）。 |
| ZoneId | String | 否 | 否 | 可用区ID。 | 无 |
| DBInstanceNetType | String | 否 | 否 | 数据库实例的网络类型。 | 取值
|
| VSwitchId | String | 否 | 否 | 交换机ID。 | 多个值用英文逗号（,）隔开。如果数据库类型为MariaDB，该参数必须指定。 |
| AllocatePublicConnection | Boolean | 否 | 否 | 是否申请实例的外网连接串。 | 取值：
|
| PreferredBackupTime | String | 否 | 否 | 备份时间。 |
|
| BackupRetentionPeriod | Number | 否 | 否 | 备份保留天数。 | 取值范围：7~30。
单位：天。 默认值：7。 |
| PrivateIpAddress | String | 否 | 否 | VSwitchId下的私网IP。 | 如果不指定该参数，系统将自动分配私网IP。 |
| PreferredBackupPeriod | List | 否 | 否 | 备份周期。 | 取值：
|
| MasterUserType | String | 否 | 否 | 主账号类型。 | 取值：
|
| Tags | Map | 否 | 是 | Tag列表，包括TagKey和TagValue。 | TagKey不能为空，TagValue可以为空。
格式示例： |
| PeriodType | String | 否 | 否 | 周期类型。 | 取值：
|
| PayType | String | 否 | 否 | 实例的付费类型。 | 取值：
|
| Period | Integer | 否 | 否 | 预付费时长。 | 取值：
|
| TargetDedicatedHostIdForLog | String | 否 | 否 | 在专属集群内创建实例时，指定日志实例的主机ID。 | 无 |
| SlaveZoneIds | List | 否 | 否 | 高可用版或三节点企业版的备可用区。 | 最多指定两个备可用区，例如： ["zone-b"]或["zone-b", "zone-c"]。
为每个主可用区或者备可用区指定一个交换机，例如：ZoneId=
"zone-a"并且SlaveZoneIds=["zone-c", "zone-b"]，VSwitchID取值为
如果自动选择备可用区，取值为 |
| SQLCollectorStatus | String | 否 | 是 | 开启或关闭SQL洞察（SQL审计）。 | 取值：
|
| SSLSetting | String | 否 | 否 | 实例的安全套接层（SSL）链接设置。 | 取值：
|
DBMappings语法
"DBMappings": [
{
"DBDescription": String,
"CharacterSetName": String,
"DBName": String
}
]DBMappings属性
| 属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
|---|---|---|---|---|---|
| CharacterSetName | String | 是 | 否 | 字符集 | 取值：
|
| DBName | String | 是 | 否 | 数据库名称 | 名称需要全局唯一。
长度不超过64个字符。以英文字母开头，可包含英文字母、数字和下划线（_）。 |
| DBDescription | String | 否 | 否 | 数据库描述 | 长度为2~256个字符。以英文字母或汉字开头，不能以http://或https://开头。可包含汉字、英文字母、数字、下划线（_）和短划线（-）。 |
返回值
Fn::GetAtt
- DBInstanceId：数据库实例ID。
- InnerPort：数据库实例的内网端口。
- InnerIPAddress：内网IP。
- InnerConnectionString：内网连接地址。
- PublicPort：数据库实例公网端口。
- PublicConnectionString：公网连接地址。
- PublicIPAddress：公网IP。
示例
JSON格式
{
"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格式
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