ALIYUN::RDS::PrepayDBInstance類型用於建立預付費資料庫執行個體。
文法
{
"Type": "ALIYUN::RDS::PrepayDBInstance",
"Properties": {
"AutoUpgradeMinorVersion": String,
"DBMappings": List,
"CouponCode": String,
"MasterUsername": String,
"PeriodType": String,
"DBInstanceNetType": String,
"MasterUserType": String,
"AutoRenew": Boolean,
"PreferredBackupTime": String,
"PrivateIpAddress": String,
"Engine": String,
"MultiAZ": Boolean,
"VpcId": String,
"ConnectionMode": String,
"ResourceGroupId": String,
"VSwitchId": String,
"BackupRetentionPeriod": Number,
"Quantity": Number,
"CommodityCode": String,
"ZoneId": String,
"AutoPay": Boolean,
"Port": Integer,
"ConnectionStringPrefix": String,
"SubscriptionDeletionForce": Boolean,
"ConnectionStringType": String,
"EngineVersion": String,
"DBInstanceClass": String,
"PreferredBackupPeriod": List,
"DBInstanceStorage": Integer,
"DBInstanceDescription": String,
"Tags": Map,
"Period": Number,
"MasterUserPassword": String,
"AllocatePublicConnection": Boolean,
"SlaveZoneIds": List,
"TargetDedicatedHostIdForMaster": String,
"RoleARN": String,
"DBInstanceStorageType": String,
"Category": String,
"DBParamGroupId": String,
"EncryptionKey": String,
"DBIsIgnoreCase": Integer,
"SecurityGroupId": String,
"TargetDedicatedHostIdForLog": String,
"DBTimeZone": String,
"DedicatedHostGroupId": String,
"TargetDedicatedHostIdForSlave": String,
"MaintainTime": String,
"SQLCollectorStatus": String,
"SSLSetting": String,
"ArchiveBackupRetentionPeriod": Integer,
"LogBackupRetentionPeriod": Integer,
"EnableBackupLog": Boolean,
"LogBackupLocalRetentionNumber": Integer,
"ArchiveBackupKeepPolicy": String,
"LocalLogRetentionHours": Integer,
"HighSpaceUsageProtection": String,
"CompressType": Integer,
"LogBackupFrequency": String,
"BackupPolicyMode": String,
"ArchiveBackupKeepCount": Integer,
"LocalLogRetentionSpace": Integer,
"ReleasedKeepPolicy": String,
"BackUpCategory": String,
"ServerlessConfig": Map,
"InstanceNetworkType": String,
"StorageAutoScale": String,
"StorageUpperBound": Number,
"StorageThreshold": Number,
"IoAccelerationEnabled": String,
"ColdDataEnabled": Boolean,
"BurstingEnabled": Boolean,
"DeletionProtection": Boolean
}
}屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
ResourceGroupId | String | 否 | 是 | 資源群組ID。 | 無 |
DBMappings | List | 否 | 否 | 執行個體下建立的資料庫。 | 更多資訊,請參見DBMappings屬性。 |
CouponCode | String | 否 | 否 | 優惠碼。 | 無 |
MasterUsername | String | 否 | 是 | 資料庫執行個體的資料庫帳號名稱。 | 名稱需要全域唯一。 長度為2~16個字元,以英文字母開頭,以英文字母或數字結尾。可包含英文字母、數字和底線(_)。 |
PeriodType | String | 是 | 否 | 周期類型。 | 取值:
|
AutoUpgradeMinorVersion | String | 否 | 是 | 執行個體升級小版本的方式。 | 取值:
|
DBInstanceNetType | String | 否 | 否 | 資料庫執行個體的網路類型。 | 取值:
|
MasterUserType | String | 否 | 否 | 資料庫帳號的權限類別型。 | 取值:
|
Port | Integer | 否 | 是 | 執行個體連接埠。 | 無 |
ConnectionStringPrefix | String | 否 | 是 | 串連地址的首碼。 | 長度為8~64個字元,可包含英文字母、數字和短劃線(-)。 |
ConnectionStringType | String | 否 | 是 | 串連地址的類型。 | 取值:
|
PreferredBackupTime | String | 否 | 是 | 備份時間。 | 格式:HH:mmZ-HH:mmZ。 取值:00:00Z-01:00Z、01:00Z-02:00Z、02:00Z-03:00Z、03:00Z-04:00至23:00Z-24:00Z。 |
PrivateIpAddress | String | 否 | 否 | 指定交換器下的私網IP地址。 | 如果不指定該參數,則系統自動分配私網IP地址。 |
Engine | String | 是 | 否 | 資料類型。 | 取值:
|
MultiAZ | Boolean | 否 | 否 | 資料庫執行個體是否支援多可用性區域。 | 取值:
|
VpcId | String | 否 | 否 | 專用網路ID。 | 無 |
ConnectionMode | String | 否 | 否 | 資料庫的串連模式。 | 取值:
如果未指定該參數,則預設由RDS系統分配。 |
AutoRenew | Boolean | 否 | 否 | 執行個體是否自動續約。 | 取值:
|
VSwitchId | String | 否 | 否 | 交換器ID。 | 無 |
BackupRetentionPeriod | Number | 否 | 是 | 備份保留天數。 | 無 |
Quantity | Number | 否 | 否 | 建立的執行個體數量。 | 取值範圍:1~99。 預設值:1。 |
CommodityCode | String | 是 | 否 | 商品碼。 | 取值:
|
SubscriptionDeletionForce | Boolean | 否 | 否 | 該選項僅適用於訂用帳戶執行個體。對於訂用帳戶執行個體,如果此選項為 true,則在刪除之前會將執行個體轉換為隨用隨付執行個體;如果為 false,則不會執行強制移除。此操作會產生額外費用,請謹慎選擇。 | 無 |
ZoneId | String | 否 | 否 | 可用性區域ID。 | 無 |
EngineVersion | String | 是 | 否 | 資料庫版本號碼。 | 取值:
|
DBInstanceClass | String | 是 | 是 | 執行個體規格。 | 例如:rds.mys2.large、rds.mss1.large、rds.pg.s1.small。 |
PreferredBackupPeriod | List | 否 | 是 | 備份周期。 | 取值:
|
DBInstanceStorage | Integer | 是 | 是 | 資料庫儲存空間。 | 取值:
單位:GB。 說明 每5 GB進行遞增。 |
DBInstanceDescription | String | 否 | 是 | 執行個體的描述或備忘資訊。 | 長度為2~256個字元。以漢字或英文字母開頭,不能以 |
Tags | Map | 否 | 是 | 標籤。 | 無 |
Period | Number | 是 | 否 | 購買時間長度。 | 取值:
|
MasterUserPassword | String | 否 | 是 | 資料庫執行個體的資料庫帳號密碼。 | 長度為8~32個字元。由大寫英文字母、小寫英文字母、數字和特殊字元中的任意三種組成。支援特殊字元 |
AllocatePublicConnection | Boolean | 否 | 否 | 是否申請執行個體的外網串連地址。 | 取值:
|
AutoPay | Boolean | 否 | 否 | 是否自動付款。 | 取值:
|
SlaveZoneIds | List | 否 | 否 | 高可用版或三節點企業版的備可用性區域。 | 最多指定兩個備可用性區域,例如: 為每個主可用性區域或者備可用性區域指定一個交換器,例如:ZoneId = 如果自動選擇備可用性區域,取值為 |
TargetDedicatedHostIdForMaster | String | 否 | 否 | 在專屬叢集內建立執行個體時,指定主執行個體的主機ID。 | 無 |
RoleARN | String | 否 | 否 | 角色ARN。該角色允許RDS訪問KMS。 | 無 |
DBInstanceStorageType | String | 否 | 是 | 執行個體儲存類型。 | 取值:
|
Category | String | 否 | 是 | 執行個體系列。 | 取值:
|
DBParamGroupId | String | 否 | 否 | 參數模板ID。 | 無 |
EncryptionKey | String | 否 | 否 | 同地區內的雲端硬碟加密的密鑰ID。 | 您可以在Key Management Service控制台查看密鑰ID,也可以建立新的密鑰。 |
DBIsIgnoreCase | Integer | 否 | 否 | 表名是否區分大小寫。 | 取值:
|
SecurityGroupId | String | 否 | 是 | 關聯的安全性群組ID。 | 最多支援關聯3個安全性群組,多個安全性群組用半形逗號(,)隔開。清空安全性群組請指定Null 字元串。 |
TargetDedicatedHostIdForLog | String | 否 | 否 | 在專屬叢集內建立執行個體時,指定日誌執行個體的主機ID。 | 無 |
DBTimeZone | String | 否 | 否 | UTC時區。 | 取值範圍:-12:59 ~ +13:00。 如果不指定該參數,預設時區為地區預設時區。 本地SSD盤執行個體可以命名時區。 |
DedicatedHostGroupId | String | 否 | 否 | 在專屬叢集內建立執行個體時,指定專屬叢集ID。 | 無 |
TargetDedicatedHostIdForSlave | String | 否 | 否 | 在專屬叢集內建立執行個體時,指定備執行個體的主機ID。 | 無 |
MaintainTime | String | 否 | 否 | 執行個體的可維護時間段。 | 格式:HH:mmZ-HH:mmZ。 |
SQLCollectorStatus | String | 否 | 是 | 是否開啟SQL洞察(SQL審計)。 | 取值:
|
SSLSetting | String | 否 | 否 | 執行個體的安全套接層(SSL)連結設定。 | 取值:
|
ArchiveBackupRetentionPeriod | Integer | 否 | 是 | 歸檔備份的保留天數。 | 無 |
LogBackupRetentionPeriod | Integer | 否 | 是 | 記錄備份保留天數。 | 無 |
EnableBackupLog | Boolean | 否 | 是 | 是否開啟記錄備份。 | 取值:
|
LogBackupLocalRetentionNumber | Integer | 否 | 是 | 本地Binlog保留個數。 | 無 |
ArchiveBackupKeepPolicy | String | 否 | 是 | 歸檔備份的保留周期。 | 取值:
歸檔備份的保留周期內能儲存的備份個數由ArchiveBackupKeepCount決定,預設為0。 說明 當BackupPolicyMode參數取值為DataBackupPolicy時,該參數生效。 |
LocalLogRetentionHours | Integer | 否 | 是 | 本地記錄備份保留小時數。 | 無 |
HighSpaceUsageProtection | String | 否 | 是 | 執行個體使用空間大於80%,或者剩餘空間小於5 GB時,是否強制清理Binlog。 | 取值:
|
CompressType | Integer | 否 | 是 | 備份壓縮方式。 | 取值:
|
LogBackupFrequency | String | 否 | 是 | 記錄備份頻率。 | 適用於SQL Server。 取值:LogInterval,表示每30分鐘備份一次。 說明 預設與資料備份周期PreferredBackupPeriod一致。 |
BackupPolicyMode | String | 否 | 是 | 備份類型。 | 取值:
|
ArchiveBackupKeepCount | Integer | 否 | 是 | 歸檔備份的保留個數。 | 無 |
LocalLogRetentionSpace | Integer | 否 | 是 | 本地日誌最大空間使用率。 | 無 |
ReleasedKeepPolicy | String | 否 | 是 | 已刪除執行個體的歸檔備份保留原則。 | 取值:
|
BackUpCategory | String | 否 | 是 | 備份執行個體系列。 | 取值:
|
ServerlessConfig | Map | 否 | 否 | RDS Serverless執行個體的相關設定。 | 更多資訊,請參見ServerlessConfig屬性。 |
InstanceNetworkType | String | 否 | 否 | 執行個體的網路類型。 | 取值:
說明 MySQL雲端硬碟執行個體只支援專用網路,此參數必須配置為VPC。 PostgreSQL和MariaDB執行個體只支援專用網路,此參數必須配置為VPC。 SQL Server單機版和Web版執行個體支援傳統網路和專用網路。其餘執行個體只支援專用網路,此參數必須配置為VPC。 |
StorageAutoScale | String | 否 | 否 | 儲存空間自動擴容開關。 | 僅MySQL和PostgreSQL支援,取值:
說明 您也可以在執行個體建立完成之後,調用ModifyDasInstanceConfig進行調整。更多資訊,請參見設定儲存空間自動擴容。 |
StorageUpperBound | Number | 否 | 否 | 儲存空間自動擴容的總儲存空間限制值。 | 自動擴容不會導致執行個體總儲存空間超過該值。單位:GB。 說明 取值需大於等於0。 StorageAutoScale為Enable時必填。 |
StorageThreshold | Number | 否 | 否 | 儲存空間自動擴容觸發閾值(百分比)。 | 取值:
說明 StorageAutoScale為Enable時該參數必填。 |
IoAccelerationEnabled | String | 否 | 否 | 是否開啟 IO 加速。 | 取值含義如下:
|
ColdDataEnabled | Boolean | 否 | 否 | 預留參數。 | 無 |
BurstingEnabled | Boolean | 否 | 否 | 是否已開啟 IO 突發。 | 取值:
|
DeletionProtection | Boolean | 否 | 是 | 是否已開啟釋放保護功能。 | 取值:
|
ServerlessConfig文法
"ServerlessConfig": {
"SwitchForce": Boolean,
"MaxCapacity": Number,
"MinCapacity": Number,
"AutoPause": Boolean
}ServerlessConfig屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
SwitchForce | Boolean | 否 | 否 | 是否開啟Serverless執行個體的強制彈性擴容和縮容。 | 取值:
說明
|
MaxCapacity | Number | 是 | 否 | 執行個體RCU(RDS Capacity Unit)自動擴容和縮容範圍的最大值。 | 取值:0.5~8。 說明 該參數的值必須大於等於MinCapacity參數。 |
MinCapacity | Number | 是 | 否 | 執行個體RCU自動擴容和縮減範圍的最小值。 | 取值:0.5~8。 說明 該參數的值必須小於等於MaxCapacity參數。 |
AutoPause | Boolean | 否 | 否 | 是否開啟Serverless執行個體的智能暫停和啟動。 | 取值:
說明 如果10分鐘無任何串連將進入暫停狀態,當串連進入時會自動喚醒。 |
DBMappings文法
"DBMappings": [
{
"DBDescription": String,
"CharacterSetName": String,
"DBName": String
}
]DBMappings屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
DBDescription | String | 否 | 否 | 資料庫描述。 | 長度為2~256個字元。以漢字或英文字母開頭,不能以 |
CharacterSetName | String | 是 | 否 | 字元集。 | 取值:
|
DBName | String | 是 | 否 | 資料庫名稱。 | 名稱需要全域唯一。 長度不超過64個字元。以小寫英文字母開頭,可包含小寫英文字母、數字和底線(_)。 |
傳回值
Fn::GetAtt
InnerPort:資料庫執行個體的內網連接埠。
OrderId:訂單ID。
PublicConnectionString:公網串連串。
InnerIPAddress:內網IP地址。
DBInstanceId:資料庫執行個體ID。
PublicIPAddress:公網IP地址。
PublicPort:資料庫執行個體公網連接埠。
InnerConnectionString:內網串連串。
樣本
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
AllocatePublicConnection:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Description: If true, allocate public connection automate.
Type: Boolean
ArchiveBackupKeepCount:
Description: "The number of archived backups that can be retained. Default value:\
\ 1. Valid values: \nThe value of this parameter ranges from 1 to 31 when the\
\ ArchiveBackupKeepPolicy \n parameter is set to ByMonth. \nThe value of this\
\ parameter ranges from 1 to 7 when the ArchiveBackupKeepPolicy \n parameter\
\ is set to ByWeek. \nNote You do not need to specify this parameter when the\
\ ArchiveBackupKeepPolicy \nparameter is set to KeepAll."
MaxValue: 31
MinValue: 1
Type: Number
ArchiveBackupKeepPolicy:
AllowedValues:
- ByMonth
- ByWeek
- KeepAll
Description: "The period for which to retain archived backups. The number of archived\
\ backups that can \n be retained within the specified period is determined\
\ by the ArchiveBackupKeepCount parameter. \n Default value: 0. Valid values:\
\ \nByMonth \n ByWeek \n KeepAll"
Type: String
ArchiveBackupRetentionPeriod:
Description: "The number of days for which to retain archived backups. \n The\
\ default value 0 specifies not to enable the backup archiving function. Valid\
\ values: 30 to 1095."
MaxValue: 1095
MinValue: 30
Type: Number
AutoPay:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: true
Description: Automatic Payment. Default is true.
Type: Boolean
AutoRenew:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
Description: Auto renew the prepay instance. If the period type is by year, it
will renew by year, else it will renew by month.
Type: Boolean
BackUpCategory:
AllowedValues:
- Flash
- Standard
Description: "Specifies whether to enable the second-level backup function. This\
\ function allows a backup \nto be completed within seconds. Valid values: \n\
Flash: specifies to enable the second-level backup function. \n Standard: specifies\
\ to disable the second-level backup function."
Type: String
BackupPolicyMode:
AllowedValues:
- DataBackupPolicy
- LogBackupPolicy
Description: "Backup type, \nDataBackupPolicy: data backup \nLogBackupPolicy:\
\ log backup"
Type: String
BackupRetentionPeriod:
Default: 7
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.'
Type: Number
Category:
AllowedValues:
- Basic
- HighAvailability
- AlwaysOn
- Finance
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.'
Type: String
CommodityCode:
AllowedValues:
- rds
- bards
- rords
Default: rds
Description: The CommodityCode of the order.
Type: String
CompressType:
Description: "The format used to compress backups. Valid values: \n 1: The zlib\
\ tool is used to compress backups into .tar.gz files. \n 4: The QuickLZ tool\
\ is used to compress backups into .xb.gz files. \nThis compression format is\
\ supported only when the instance runs MySQL 5.6 or 5.7. \nIt can be used to\
\ restore individual databases and tables. \n 8: The QuickLZ tool is used to\
\ compress backups into .xb.gz files. \n This compression format is supported\
\ only when the instance runs MySQL 8.0. \nIt cannot be used to restore individual\
\ databases or tables."
Type: Number
ConnectionMode:
Description: 'Connection Mode for database instance,support ''Standard'' and ''Safe''
mode. Default is RDS system assigns. '
Type: String
ConnectionStringPrefix:
AllowedPattern: '[a-zA-Z0-9-]{8,64}'
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 (-). "
Type: String
ConnectionStringType:
AllowedValues:
- Inner
- Public
Default: Inner
Description: 'The endpoint type of the instance, allow values: Inner, Public'
Type: String
CouponCode:
Description: The coupon code of the order.
Type: String
DBInstanceClass:
Description: Database instance type. Refer the RDS database instance type reference,
such as 'rds.mys2.large', 'rds.mss1.large', 'rds.pg.s1.small' etc
Type: String
DBInstanceDescription:
Description: Description of created database instance.
Type: String
DBInstanceNetType:
AllowedValues:
- Internet
- Intranet
Default: Intranet
Description: Database instance net type, default is Intranet.Internet for public
access, Intranet for private access.
Type: String
DBInstanceStorage:
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
Type: Number
DBInstanceStorageType:
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.'
Type: String
DBIsIgnoreCase:
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.'
Type: Number
DBMappings:
Description: Database mappings to attach to db instance.
Type: Json
DBParamGroupId:
Description: The ID of the parameter template used by the instance.
Type: String
DBTimeZone:
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.'
Type: String
DedicatedHostGroupId:
Description: The ID of the host group to which the instance belongs if you create
an instance in a host group.
Type: String
EnableBackupLog:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Description: "Specifies whether to enable the log backup function. Valid values:\
\ \nTrue: specifies to enable the log backup function. \nFalse: specifies to\
\ disable the log backup function. \nNote You must specify this parameter when\
\ the BackupPolicyMode parameter is set to LogBackupPolicy."
Type: Boolean
EncryptionKey:
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.
Type: String
Engine:
AllowedValues:
- MySQL
- SQLServer
- PostgreSQL
- PPAS
- MariaDB
Description: Database instance engine type. Support MySQL/SQLServer/PostgreSQL/PPAS/MariaDB
now.
Type: String
EngineVersion:
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.'
Type: String
HighSpaceUsageProtection:
AllowedValues:
- Enable
- Disable
Description: "Specifies whether to forcibly delete log backup files when the space\
\ usage of the \n instance exceeds 80% or the remaining space is less than 5\
\ GB. Valid values: \n Enable and Disable. You can retain the default value.\
\ Note You must specify \n this parameter when the BackupPolicyMode parameter\
\ is set to LogBackupPolicy."
Type: String
LocalLogRetentionHours:
Description: "The number of hours for which to retain log backup files on the\
\ instance. \nValid values: 0 to 168. The value 0 specifies not to retain log\
\ backup files on the instance. \nYou can retain the default value. Note You\
\ must specify this parameter when the BackupPolicyMode \nparameter is set to\
\ LogBackupPolicy."
MaxValue: 168
MinValue: 0
Type: Number
LocalLogRetentionSpace:
Description: "The maximum percentage of space that is allowed to store log backup\
\ files on the instance. \n If the space usage for log backup files exceeds\
\ this percentage, the system deletes earlier \n log backup files until the\
\ space usage falls below this percentage. Valid values:0 to 50. \n You can\
\ retain the default value. Note You must specify this parameter when the \n\
\ BackupPolicyMode parameter is set to LogBackupPolicy."
MaxValue: 50
MinValue: 0
Type: Number
LogBackupFrequency:
Description: "The frequency at which to back up logs. Valid values: \nThe value\
\ LogInterval specifies to back up logs every 30 minutes. \n The default value\
\ of this parameter is the same as the data backup frequency. \nNote The value\
\ LogInterval is supported only when the instance runs SQL Server."
Type: String
LogBackupLocalRetentionNumber:
Description: "The number of log backup files that can be retained on the instance.\
\ \nDefault value: 60. Valid values: 6 to 100."
MaxValue: 100
MinValue: 6
Type: Number
LogBackupRetentionPeriod:
Description: "The number of days for which to retain log backup files. Valid values:\
\ 7 to 730. The log backup \n retention period cannot be longer than the data\
\ backup retention period.Note If you enable the log \n backup function, you\
\ can specify the log backup retention period. This applies only when the \n\
\ instance runs MySQL, PostgreSQL, or PPAS."
MaxValue: 730
MinValue: 7
Type: Number
MaintainTime:
Description: The period during which the maintenance performs. The format is HH:mmZ-HH:mmZ.
Type: String
MasterUserPassword:
Description: 'The master password for the database instance. '
MaxLength: 32
MinLength: 8
Type: String
MasterUserType:
AllowedValues:
- Normal
- Super
- Sysadmin
Default: Normal
Description: "Privilege type of account.\n Normal: Common privilege. \n Super:\
\ High privilege. \nSysadmin: Super privileges (SA) (only supported by SQL Server)\n\
The default value is Normal."
Type: String
MasterUsername:
Description: 'The master user name for the database instance. '
Type: String
MultiAZ:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
Description: 'Specifies if the database instance is a multiple Availability Zone
deployment. '
Type: Boolean
Period:
Default: 1
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.
MaxValue: 9
MinValue: 1
Type: Number
PeriodType:
AllowedValues:
- Month
- Year
Default: Month
Description: Charge period for created instances.
Type: String
Port:
Description: The port of the database service.
MaxValue: 65535
MinValue: 1
Type: Number
PreferredBackupPeriod:
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.
Type: CommaDelimitedList
PreferredBackupTime:
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.'
Type: String
PrivateIpAddress:
Description: The private ip for created instance.
Type: String
Quantity:
Default: 1
Description: The number of instance to be created, default is 1, max number is
99
MaxValue: 99
MinValue: 1
Type: Number
ReleasedKeepPolicy:
AllowedValues:
- Lastest
- All
Description: "The policy used to retain archived backups if the instance is released.\
\ Default value: None. \n Valid values: \nLastest: Only the last archived backup\
\ is retained. \n All: All of the archived backups are retained."
Type: String
ResourceGroupId:
Description: Resource group id.
Type: String
RoleARN:
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.
Type: String
SQLCollectorStatus:
AllowedValues:
- Enable
- Disabled
Description: "Specifies whether to enable or disable the SQL Explorer (SQL audit)\
\ feature. \nValid values:Enable | Disabled."
Type: String
SSLSetting:
AllowedValues:
- Disabled
- EnabledForPublicConnection
- EnabledForInnerConnection
Default: Disabled
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.'
Type: String
SecurityGroupId:
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"
Type: String
SlaveZoneIds:
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
Type: Json
Tags:
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.'
Type: Json
TargetDedicatedHostIdForLog:
Description: The ID of the host to which the instance belongs if you create a
log instance in a host group.
Type: String
TargetDedicatedHostIdForMaster:
Description: The ID of the host to which the instance belongs if you create a
primary instance in a host group.
Type: String
TargetDedicatedHostIdForSlave:
Description: The ID of the host to which the instance belongs if you create a
secondary instance in a host group.
Type: String
VSwitchId:
Description: The vSwitch id of created instance. For VPC network, the property
is required.
Type: String
VpcId:
Description: The VPC id of created database instance. For VPC network, the property
is required.
Type: String
ZoneId:
Description: selected zone to create database instance. You cannot set the ZoneId
parameter if the MultiAZ parameter is set to true.
Type: String
Resources:
PrepayDBInstance:
Properties:
AllocatePublicConnection:
Ref: AllocatePublicConnection
ArchiveBackupKeepCount:
Ref: ArchiveBackupKeepCount
ArchiveBackupKeepPolicy:
Ref: ArchiveBackupKeepPolicy
ArchiveBackupRetentionPeriod:
Ref: ArchiveBackupRetentionPeriod
AutoPay:
Ref: AutoPay
AutoRenew:
Ref: AutoRenew
BackUpCategory:
Ref: BackUpCategory
BackupPolicyMode:
Ref: BackupPolicyMode
BackupRetentionPeriod:
Ref: BackupRetentionPeriod
Category:
Ref: Category
CommodityCode:
Ref: CommodityCode
CompressType:
Ref: CompressType
ConnectionMode:
Ref: ConnectionMode
ConnectionStringPrefix:
Ref: ConnectionStringPrefix
ConnectionStringType:
Ref: ConnectionStringType
CouponCode:
Ref: CouponCode
DBInstanceClass:
Ref: DBInstanceClass
DBInstanceDescription:
Ref: DBInstanceDescription
DBInstanceNetType:
Ref: DBInstanceNetType
DBInstanceStorage:
Ref: DBInstanceStorage
DBInstanceStorageType:
Ref: DBInstanceStorageType
DBIsIgnoreCase:
Ref: DBIsIgnoreCase
DBMappings:
Ref: DBMappings
DBParamGroupId:
Ref: DBParamGroupId
DBTimeZone:
Ref: DBTimeZone
DedicatedHostGroupId:
Ref: DedicatedHostGroupId
EnableBackupLog:
Ref: EnableBackupLog
EncryptionKey:
Ref: EncryptionKey
Engine:
Ref: Engine
EngineVersion:
Ref: EngineVersion
HighSpaceUsageProtection:
Ref: HighSpaceUsageProtection
LocalLogRetentionHours:
Ref: LocalLogRetentionHours
LocalLogRetentionSpace:
Ref: LocalLogRetentionSpace
LogBackupFrequency:
Ref: LogBackupFrequency
LogBackupLocalRetentionNumber:
Ref: LogBackupLocalRetentionNumber
LogBackupRetentionPeriod:
Ref: LogBackupRetentionPeriod
MaintainTime:
Ref: MaintainTime
MasterUserPassword:
Ref: MasterUserPassword
MasterUserType:
Ref: MasterUserType
MasterUsername:
Ref: MasterUsername
MultiAZ:
Ref: MultiAZ
Period:
Ref: Period
PeriodType:
Ref: PeriodType
Port:
Ref: Port
PreferredBackupPeriod:
Ref: PreferredBackupPeriod
PreferredBackupTime:
Ref: PreferredBackupTime
PrivateIpAddress:
Ref: PrivateIpAddress
Quantity:
Ref: Quantity
ReleasedKeepPolicy:
Ref: ReleasedKeepPolicy
ResourceGroupId:
Ref: ResourceGroupId
RoleARN:
Ref: RoleARN
SQLCollectorStatus:
Ref: SQLCollectorStatus
SSLSetting:
Ref: SSLSetting
SecurityGroupId:
Ref: SecurityGroupId
SlaveZoneIds:
Ref: SlaveZoneIds
Tags:
Ref: Tags
TargetDedicatedHostIdForLog:
Ref: TargetDedicatedHostIdForLog
TargetDedicatedHostIdForMaster:
Ref: TargetDedicatedHostIdForMaster
TargetDedicatedHostIdForSlave:
Ref: TargetDedicatedHostIdForSlave
VSwitchId:
Ref: VSwitchId
VpcId:
Ref: VpcId
ZoneId:
Ref: ZoneId
Type: ALIYUN::RDS::PrepayDBInstance
Outputs:
DBInstanceId:
Description: The instance id of created database instance.
Value:
Fn::GetAtt:
- PrepayDBInstance
- DBInstanceId
InnerConnectionString:
Description: DB instance connection url by Intranet.
Value:
Fn::GetAtt:
- PrepayDBInstance
- InnerConnectionString
InnerIPAddress:
Description: IP Address for created DB instance of Intranet.
Value:
Fn::GetAtt:
- PrepayDBInstance
- InnerIPAddress
InnerPort:
Description: Intranet port of created DB instance.
Value:
Fn::GetAtt:
- PrepayDBInstance
- InnerPort
OrderId:
Description: The order id list of created instance.
Value:
Fn::GetAtt:
- PrepayDBInstance
- OrderId
PublicConnectionString:
Description: DB instance connection url by Internet.
Value:
Fn::GetAtt:
- PrepayDBInstance
- PublicConnectionString
PublicIPAddress:
Description: IP Address for created DB instance of Internet.
Value:
Fn::GetAtt:
- PrepayDBInstance
- PublicIPAddress
PublicPort:
Description: Internet port of created DB instance.
Value:
Fn::GetAtt:
- PrepayDBInstance
- PublicPort{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"PeriodType": {
"Type": "String",
"Description": "Charge period for created instances.",
"AllowedValues": [
"Month",
"Year"
],
"Default": "Month"
},
"ResourceGroupId": {
"Type": "String",
"Description": "Resource group id."
},
"ArchiveBackupRetentionPeriod": {
"Type": "Number",
"Description": "The number of days for which to retain archived backups. \n The default value 0 specifies not to enable the backup archiving function. Valid values: 30 to 1095.",
"MinValue": 30,
"MaxValue": 1095
},
"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."
},
"Port": {
"Type": "Number",
"Description": "The port of the database service.",
"MinValue": 1,
"MaxValue": 65535
},
"ArchiveBackupKeepCount": {
"Type": "Number",
"Description": "The number of archived backups that can be retained. Default value: 1. Valid values: \nThe value of this parameter ranges from 1 to 31 when the ArchiveBackupKeepPolicy \n parameter is set to ByMonth. \nThe value of this parameter ranges from 1 to 7 when the ArchiveBackupKeepPolicy \n parameter is set to ByWeek. \nNote You do not need to specify this parameter when the ArchiveBackupKeepPolicy \nparameter is set to KeepAll.",
"MinValue": 1,
"MaxValue": 31
},
"LogBackupRetentionPeriod": {
"Type": "Number",
"Description": "The number of days for which to retain log backup files. Valid values: 7 to 730. The log backup \n retention period cannot be longer than the data backup retention period.Note If you enable the log \n backup function, you can specify the log backup retention period. This applies only when the \n instance runs MySQL, PostgreSQL, or PPAS.",
"MinValue": 7,
"MaxValue": 730
},
"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
},
"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."
},
"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."
},
"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"
},
"ArchiveBackupKeepPolicy": {
"Type": "String",
"Description": "The period for which to retain archived backups. The number of archived backups that can \n be retained within the specified period is determined by the ArchiveBackupKeepCount parameter. \n Default value: 0. Valid values: \nByMonth \n ByWeek \n KeepAll",
"AllowedValues": [
"ByMonth",
"ByWeek",
"KeepAll"
]
},
"VSwitchId": {
"Type": "String",
"Description": "The vSwitch id of created instance. For VPC network, the property is required."
},
"BackupPolicyMode": {
"Type": "String",
"Description": "Backup type, \nDataBackupPolicy: data backup \nLogBackupPolicy: log backup",
"AllowedValues": [
"DataBackupPolicy",
"LogBackupPolicy"
]
},
"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
},
"LocalLogRetentionHours": {
"Type": "Number",
"Description": "The number of hours for which to retain log backup files on the instance. \nValid values: 0 to 168. The value 0 specifies not to retain log backup files on the instance. \nYou can retain the default value. Note You must specify this parameter when the BackupPolicyMode \nparameter is set to LogBackupPolicy.",
"MinValue": 0,
"MaxValue": 168
},
"HighSpaceUsageProtection": {
"Type": "String",
"Description": "Specifies whether to forcibly delete log backup files when the space usage of the \n instance exceeds 80% or the remaining space is less than 5 GB. Valid values: \n Enable and Disable. You can retain the default value. Note You must specify \n this parameter when the BackupPolicyMode parameter is set to LogBackupPolicy.",
"AllowedValues": [
"Enable",
"Disable"
]
},
"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."
},
"MasterUserPassword": {
"Type": "String",
"Description": "The master password for the database instance. ",
"MinLength": 8,
"MaxLength": 32
},
"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. "
},
"LocalLogRetentionSpace": {
"Type": "Number",
"Description": "The maximum percentage of space that is allowed to store log backup files on the instance. \n If the space usage for log backup files exceeds this percentage, the system deletes earlier \n log backup files until the space usage falls below this percentage. Valid values:0 to 50. \n You can retain the default value. Note You must specify this parameter when the \n BackupPolicyMode parameter is set to LogBackupPolicy.",
"MinValue": 0,
"MaxValue": 50
},
"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."
},
"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"
},
"ReleasedKeepPolicy": {
"Type": "String",
"Description": "The policy used to retain archived backups if the instance is released. Default value: None. \n Valid values: \nLastest: Only the last archived backup is retained. \n All: All of the archived backups are retained.",
"AllowedValues": [
"Lastest",
"All"
]
},
"DedicatedHostGroupId": {
"Type": "String",
"Description": "The ID of the host group to which the instance belongs if you create an instance in a host group."
},
"AutoRenew": {
"Type": "Boolean",
"Description": "Auto renew the prepay instance. If the period type is by year, it will renew by year, else it will renew by month.",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": false
},
"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."
},
"LogBackupLocalRetentionNumber": {
"Type": "Number",
"Description": "The number of log backup files that can be retained on the instance. \nDefault value: 60. Valid values: 6 to 100.",
"MinValue": 6,
"MaxValue": 100
},
"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
},
"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."
},
"CommodityCode": {
"Type": "String",
"Description": "The CommodityCode of the order.",
"AllowedValues": [
"rds",
"bards",
"rords"
],
"Default": "rds"
},
"MaintainTime": {
"Type": "String",
"Description": "The period during which the maintenance performs. The format is HH:mmZ-HH:mmZ."
},
"DBParamGroupId": {
"Type": "String",
"Description": "The ID of the parameter template used by the instance."
},
"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."
},
"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."
},
"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"
},
"Quantity": {
"Type": "Number",
"Description": "The number of instance to be created, default is 1, max number is 99",
"MinValue": 1,
"MaxValue": 99,
"Default": 1
},
"AutoPay": {
"Type": "Boolean",
"Description": "Automatic Payment. Default is false.",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": true
},
"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."
},
"BackUpCategory": {
"Type": "String",
"Description": "Specifies whether to enable the second-level backup function. This function allows a backup \nto be completed within seconds. Valid values: \nFlash: specifies to enable the second-level backup function. \n Standard: specifies to disable the second-level backup function.",
"AllowedValues": [
"Flash",
"Standard"
]
},
"CompressType": {
"Type": "Number",
"Description": "The format used to compress backups. Valid values: \n 1: The zlib tool is used to compress backups into .tar.gz files. \n 4: The QuickLZ tool is used to compress backups into .xb.gz files. \nThis compression format is supported only when the instance runs MySQL 5.6 or 5.7. \nIt can be used to restore individual databases and tables. \n 8: The QuickLZ tool is used to compress backups into .xb.gz files. \n This compression format is supported only when the instance runs MySQL 8.0. \nIt cannot be used to restore individual databases or tables."
},
"LogBackupFrequency": {
"Type": "String",
"Description": "The frequency at which to back up logs. Valid values: \nThe value LogInterval specifies to back up logs every 30 minutes. \n The default value of this parameter is the same as the data backup frequency. \nNote The value LogInterval is supported only when the instance runs SQL Server."
},
"ConnectionStringType": {
"Type": "String",
"Description": "The endpoint type of the instance, allow values: Inner, Public",
"AllowedValues": [
"Inner",
"Public"
],
"Default": "Inner"
},
"CouponCode": {
"Type": "String",
"Description": "The coupon code of the order."
},
"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"
},
"EnableBackupLog": {
"Type": "Boolean",
"Description": "Specifies whether to enable the log backup function. Valid values: \nTrue: specifies to enable the log backup function. \nFalse: specifies to disable the log backup function. \nNote You must specify this parameter when the BackupPolicyMode parameter is set to LogBackupPolicy.",
"AllowedValues": [
"True",
"true",
"False",
"false"
]
},
"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": {
"PrepayDBInstance": {
"Type": "ALIYUN::RDS::PrepayDBInstance",
"Properties": {
"PeriodType": {
"Ref": "PeriodType"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
},
"ArchiveBackupRetentionPeriod": {
"Ref": "ArchiveBackupRetentionPeriod"
},
"DBTimeZone": {
"Ref": "DBTimeZone"
},
"Port": {
"Ref": "Port"
},
"ArchiveBackupKeepCount": {
"Ref": "ArchiveBackupKeepCount"
},
"LogBackupRetentionPeriod": {
"Ref": "LogBackupRetentionPeriod"
},
"DBInstanceStorage": {
"Ref": "DBInstanceStorage"
},
"DBMappings": {
"Ref": "DBMappings"
},
"ConnectionStringPrefix": {
"Ref": "ConnectionStringPrefix"
},
"MultiAZ": {
"Ref": "MultiAZ"
},
"Engine": {
"Ref": "Engine"
},
"Tags": {
"Ref": "Tags"
},
"DBInstanceDescription": {
"Ref": "DBInstanceDescription"
},
"TargetDedicatedHostIdForMaster": {
"Ref": "TargetDedicatedHostIdForMaster"
},
"EngineVersion": {
"Ref": "EngineVersion"
},
"DBInstanceClass": {
"Ref": "DBInstanceClass"
},
"ArchiveBackupKeepPolicy": {
"Ref": "ArchiveBackupKeepPolicy"
},
"VSwitchId": {
"Ref": "VSwitchId"
},
"BackupPolicyMode": {
"Ref": "BackupPolicyMode"
},
"Period": {
"Ref": "Period"
},
"LocalLogRetentionHours": {
"Ref": "LocalLogRetentionHours"
},
"HighSpaceUsageProtection": {
"Ref": "HighSpaceUsageProtection"
},
"RoleARN": {
"Ref": "RoleARN"
},
"MasterUserPassword": {
"Ref": "MasterUserPassword"
},
"VpcId": {
"Ref": "VpcId"
},
"SSLSetting": {
"Ref": "SSLSetting"
},
"MasterUsername": {
"Ref": "MasterUsername"
},
"ConnectionMode": {
"Ref": "ConnectionMode"
},
"LocalLogRetentionSpace": {
"Ref": "LocalLogRetentionSpace"
},
"Category": {
"Ref": "Category"
},
"PrivateIpAddress": {
"Ref": "PrivateIpAddress"
},
"TargetDedicatedHostIdForSlave": {
"Ref": "TargetDedicatedHostIdForSlave"
},
"DBInstanceNetType": {
"Ref": "DBInstanceNetType"
},
"ReleasedKeepPolicy": {
"Ref": "ReleasedKeepPolicy"
},
"DedicatedHostGroupId": {
"Ref": "DedicatedHostGroupId"
},
"AutoRenew": {
"Ref": "AutoRenew"
},
"EncryptionKey": {
"Ref": "EncryptionKey"
},
"PreferredBackupPeriod": {
"Ref": "PreferredBackupPeriod"
},
"LogBackupLocalRetentionNumber": {
"Ref": "LogBackupLocalRetentionNumber"
},
"SlaveZoneIds": {
"Ref": "SlaveZoneIds"
},
"DBIsIgnoreCase": {
"Ref": "DBIsIgnoreCase"
},
"CommodityCode": {
"Ref": "CommodityCode"
},
"MaintainTime": {
"Ref": "MaintainTime"
},
"DBParamGroupId": {
"Ref": "DBParamGroupId"
},
"ZoneId": {
"Ref": "ZoneId"
},
"TargetDedicatedHostIdForLog": {
"Ref": "TargetDedicatedHostIdForLog"
},
"AllocatePublicConnection": {
"Ref": "AllocatePublicConnection"
},
"PreferredBackupTime": {
"Ref": "PreferredBackupTime"
},
"SecurityGroupId": {
"Ref": "SecurityGroupId"
},
"Quantity": {
"Ref": "Quantity"
},
"AutoPay": {
"Ref": "AutoPay"
},
"DBInstanceStorageType": {
"Ref": "DBInstanceStorageType"
},
"BackUpCategory": {
"Ref": "BackUpCategory"
},
"CompressType": {
"Ref": "CompressType"
},
"LogBackupFrequency": {
"Ref": "LogBackupFrequency"
},
"ConnectionStringType": {
"Ref": "ConnectionStringType"
},
"CouponCode": {
"Ref": "CouponCode"
},
"MasterUserType": {
"Ref": "MasterUserType"
},
"EnableBackupLog": {
"Ref": "EnableBackupLog"
},
"SQLCollectorStatus": {
"Ref": "SQLCollectorStatus"
},
"BackupRetentionPeriod": {
"Ref": "BackupRetentionPeriod"
}
}
}
},
"Outputs": {
"InnerConnectionString": {
"Description": "DB instance connection url by Intranet.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"InnerConnectionString"
]
}
},
"DBInstanceId": {
"Description": "The instance id of created database instance.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"DBInstanceId"
]
}
},
"InnerIPAddress": {
"Description": "IP Address for created DB instance of Intranet.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"InnerIPAddress"
]
}
},
"PublicConnectionString": {
"Description": "DB instance connection url by Internet.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"PublicConnectionString"
]
}
},
"PublicIPAddress": {
"Description": "IP Address for created DB instance of Internet.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"PublicIPAddress"
]
}
},
"OrderId": {
"Description": "The order id list of created instance.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"OrderId"
]
}
},
"PublicPort": {
"Description": "Internet port of created DB instance.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"PublicPort"
]
}
},
"InnerPort": {
"Description": "Intranet port of created DB instance.",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"InnerPort"
]
}
}
}
}