調用ALIYUN::RDS::DBInstance建立RDS資料庫執行個體 - Resource Orchestration Service

ALIYUN::RDS::DBInstance類型用於建立RDS資料庫執行個體。

文法

{
  "Type": "ALIYUN::RDS::DBInstance",
  "Properties": {
    "AutoUpgradeMinorVersion": String,
    "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,
    "BackupPolicyMode": 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,
    "AutoRenew": Boolean,
    "SQLCollectorStatus": String,
    "SSLSetting": String,
    "LogBackupFrequency": String,
    "EnableBackupLog": Boolean,
    "ReleasedKeepPolicy": String,
    "ArchiveBackupRetentionPeriod": Integer,
    "ArchiveBackupKeepPolicy": String,
    "ArchiveBackupKeepCount": Integer,
    "LogBackupRetentionPeriod": Integer,
    "HighSpaceUsageProtection": String,
    "LocalLogRetentionSpace": Integer,
    "BackUpCategory": String,
    "CompressType": Integer,
    "LocalLogRetentionHours": Integer,
    "LogBackupLocalRetentionNumber": Integer,
    "ServerlessConfig": Map,
    "InstanceNetworkType": String,
    "StorageAutoScale": String,
    "StorageUpperBound": Number,
    "StorageThreshold": Number,
    "BurstingEnabled": Boolean,
    "IoAccelerationEnabled": String,
    "SubscriptionDeletionForce": Boolean,
    "ColdDataEnabled": Boolean,
    "DeletionProtection": Boolean
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
ResourceGroupId	String	否	是	資源群組ID。	無
Engine	String	是	否	資料庫類型。	取值： MySQL SQLServer PostgreSQL PPAS MariaDB
DBInstanceStorage	Integer	是	是	資料庫儲存空間。	取值： MySQL：5～1000。 SQLServer：10~1000。 PostgreSQL：5～2000。 PPAS：5~2000。單位：GB。說明每5 GB進行遞增。
EngineVersion	String	是	否	資料庫版本號碼。	取值： MySQL：5.5、5.6、5.7、8.0。 SQLServer：2008 R2、08R2_ent_ha、2012、2012_ent_ha、2012_std_ha、2012_web、2014_std_ha、2016_ent_ha、2016_std_ha、2016_web、2017_std_ha、2017_ent、2019_ent。 PostgreSQL：9.4、10.0、11.0、12.0。 PPAS：9.3、10.0。 MariaDB：10.3。
AutoUpgradeMinorVersion	String	否	是	執行個體升級小版本的方式。	取值： Auto：自動升級小版本。 Manual：不自動升級，僅在目前的版本下線時才強制升級。
Port	Integer	否	是	執行個體連接埠。	無
ConnectionStringPrefix	String	否	是	串連地址的首碼。	串連地址首碼以小寫字母開頭，以小寫字母或數字結尾，可包含小寫字母、數字和連字號（-）。串連地址首碼至少包含8個字元、串連地址總長度（首碼+尾碼）不得超過63個字元。
ConnectionStringType	String	否	是	串連地址的類型。	取值： Inner：內網。 Public：公網。
DBTimeZone	String	否	否	UTC時區。	取值範圍：-12:59~+13:00。說明如果不指定該參數，預設時區為地區預設時區。本地SSD盤執行個體可以命名時區。
DBParamGroupId	String	否	否	參數模板ID。	無
Category	String	否	是	執行個體系列。	取值： Basic：基礎版。 HighAvailability：高可用版。 AlwaysOn：叢集版。 Finance：三節點企業版。說明使用參數查詢功能時，ZoneId，DBInstanceStorageType，Category建議必填，否則會導致校正不完全。
TargetDedicatedHostIdForMaster	String	否	否	在專屬叢集內建立執行個體時，指定主執行個體的主機ID。	無
DBIsIgnoreCase	Integer	否	否	表名是否區分大小寫。	取值： 0：區分大小寫。 1（預設值）：不區分大小寫。
EncryptionKey	String	否	否	同地區內的雲端硬碟加密的密鑰ID。您可以在Key Management Service控制台查看密鑰ID，也可以建立新的密鑰。	傳入該參數表示開啟雲端硬碟加密（開啟後無法關閉），並且需要傳入RoleARN。
MaintainTime	String	否	否	執行個體的可維護時間段。	格式：`HH:mmZ-HH:mmZ`（UTC時間）。
TargetDedicatedHostIdForSlave	String	否	否	在專屬叢集內建立執行個體時，指定備份執行個體的主機ID。	無
DedicatedHostGroupId	String	否	否	在專屬叢集內建立執行個體時，指定專屬叢集ID。	無
DBInstanceStorageType	String	否	是	執行個體儲存類型。	執行個體儲存類型，取值： local_ssd：本地 SSD 盤（推薦）。 cloud_ssd：SSD 雲端硬碟（不推薦，部分地區已經停止售賣）。 cloud_essd：ESSD PL1 雲端硬碟。 cloud_essd2：ESSD PL2 雲端硬碟。 cloud_essd3：ESSD PL3 雲端硬碟。 general_essd：通用雲端硬碟。本參數的預設值根據DBInstanceClass參數中傳入的規格代碼自動判斷：規格代碼為本地碟規格：預設值為local_ssd。規格代碼為雲端硬碟規格：預設值為cloud_essd。說明使用參數查詢功能時，ZoneId，DBInstanceStorageType，Category建議必填，否則會導致校正不完全。 Serverless 執行個體僅支援 ESSD PL1 雲端硬碟和通用雲端硬碟。
RoleARN	String	否	否	角色ARN。RDS通過該角色訪問KMS。	更多資訊，請參見授權RDS訪問KMS。
DBInstanceClass	String	是	是	執行個體規格。	更多資訊，請參見主執行個體規格列表。
SecurityIPList	String	是	是	允許訪問該執行個體下所有資料庫的IP白名單。	多個IP以半形逗號（,）間隔，不可以重複。最多支援1000個。支援格式： IP地址形式，例如：10.23.XX.XX。 CIDR形式，例如：10.23.XX.XX/24（無類域間路由，24表示了地址中首碼的長度，範圍為1~32）。
SecurityGroupId	String	否	是	關聯的安全性群組ID。	最多支援關聯3個安全性群組，多個安全性群組用半形逗號（,）隔開。清空安全性群組請指定Null 字元串。
MultiAZ	Boolean	否	否	該資料庫執行個體是否支援多可用性區域。	取值： true：支援多可用性區域。 false：不支援多可用性區域。說明使用參數查詢功能時，MultiAZ建議設定為 false，否則會導致校正不完全。
VpcId	String	否	否	專用網路ID。	無
DBMappings	List	否	否	執行個體下建立新的資料庫。	更多資訊，請參見DBMappings屬性。
DBInstanceDescription	String	否	是	執行個體的描述或備忘資訊。	長度為2~256個字元。以英文字母或漢字開頭，不能以`http://`或`https://`開頭。可包含漢字、英文字母、數字、底線（_）和短劃線（-）。
SubscriptionDeletionForce	Boolean	否	否	該選項僅適用於訂用帳戶執行個體。對於訂用帳戶執行個體，如果此選項為 true，則在刪除之前會將執行個體轉換為隨用隨付執行個體；如果為 false，則不會執行強制移除。此操作會產生額外費用，請謹慎選擇。	無
ConnectionMode	String	否	否	資料庫的串連模式。	取值： Standard：標準訪問模式。 Safe：高安全訪問模式。如果未指定該參數，則預設由RDS系統分配。說明 SQL Server 2012/2016/2017隻支援標準訪問模式。
MasterUsername	String	否	是	資料庫執行個體的主帳號名稱。	名稱需要全域唯一。長度不超過16個字元。以英文字母開頭，可包含英文字母、數字和底線（_）。
MasterUserPassword	String	否	是	資料庫執行個體的主帳號密碼。	長度為8~32個字元。可包含英文字母、數字和底線（_）。
ZoneId	String	否	否	可用性區域ID。	說明使用參數查詢功能時，ZoneId，DBInstanceStorageType，Category建議必填，否則會導致校正不完全。
DBInstanceNetType	String	否	否	資料庫執行個體的網路類型。	取值 Internet：公網訪問。 Intranet（預設值）：私網訪問。
VSwitchId	String	否	否	交換器ID。	多個值用半形逗號（,）隔開。如果資料庫類型為MariaDB，該參數必須指定。
BackupPolicyMode	String	否	是	備份類型。	取值： DataBackupPolicy：資料備份。 LogBackupPolicy：記錄備份。
AllocatePublicConnection	Boolean	否	否	是否申請執行個體的外網串連串。	取值： true：申請執行個體的外網串連串。 false：不申請執行個體的外網串連串。
PreferredBackupTime	String	否	是	備份時間。	格式：`HH:mmZ- HH:mmZ`。取值：00:00Z-01:00Z、01:00Z-02:00Z、02:00Z-03:00Z、03:00Z-04:00Z、04:00Z-05:00Z、05:00Z-06:00Z、06:00Z-07:00Z、07:00Z-08:00Z、08:00Z-09:00Z、09:00Z-10:00Z、10:00Z-11:00Z、11:00Z-12:00Z、12:00Z-13:00Z、13:00Z-14:00Z、14:00Z-15:00Z、15:00Z-16:00Z、16:00Z-17:00Z、17:00Z-18:00Z、18:00Z-19:00Z、19:00Z-20:00Z、20:00Z-21:00Z、21:00Z-22:00Z、22:00Z-23:00Z、23:00Z-24:00Z。
BackupRetentionPeriod	Number	否	是	備份保留天數。	取值範圍：7~30。單位：天。預設值：7。
PrivateIpAddress	String	否	否	VSwitchId下的私網IP。	如果不指定該參數，系統將自動分配私網IP。
PreferredBackupPeriod	List	否	是	備份周期。	取值： Monday Tuesday Wednesday Thursday Friday Saturday Sunday
MasterUserType	String	否	否	主帳號類型。	取值： Normal（預設值）：普通帳號。 Super：高許可權帳號。 Sysadmin：管理員帳號。說明管理員帳號只支援SQLServer資料庫。
Tags	Map	否	是	Tag列表，包括TagKey和TagValue。	TagKey不可為空，TagValue可以為空白。格式樣本：`{"key1":"value1","key2":""}`。
PeriodType	String	否	否	周期類型。	取值： Month（預設值） Year
PayType	String	否	否	執行個體的付費類型。	取值： Postpaid：後付費（隨用隨付） Prepaid：預付費（訂用帳戶） Serverless：Serverless 付費類型，不支援 MariaDB 執行個體。更多資訊，請參見RDS MySQL Serverless執行個體、RDS SQL Server Serverless執行個體簡介、PostgreSQL Serverless執行個體簡介。說明當取值為Serverless時必傳ServerlessConfig，請參見ServerlessConfig屬性。系統會自動產生訂單並自動完成支付，無需手動確認支付。
Period	Integer	否	否	預付費時間長度。	取值：當參數PeriodType取值為Year時：1~3。當參數PeriodType取值為Month：1～9。
TargetDedicatedHostIdForLog	String	否	否	在專屬叢集內建立執行個體時，指定日誌執行個體的主機ID。	無
SlaveZoneIds	List	否	否	高可用版或三節點企業版的備可用性區域。	最多指定兩個備可用性區域，例如： `["zone-b"]`或`["zone-b", "zone-c"]`。為每個主可用性區域或者備可用性區域指定一個交換器，例如：ZoneId=`"zone-a"`並且SlaveZoneIds=`["zone-c", "zone-b"]`，VSwitchID取值為 `"vsw-zone-a,vsw-zone-c,vsw-zone-b"`
SQLCollectorStatus	String	否	是	是否開啟SQL洞察（SQL審計）。	取值： Enable：開啟SQL洞察。 Disabled：關閉SQL洞察。
SSLSetting	String	否	否	執行個體的安全套接層（SSL）連結設定。	取值： Disabled（預設值）：禁用SSL。 EnabledForPublicConnection：公網串連地址將受SSL認證保護。說明該參數取值為EnabledForPublicConnection時，AllocatePublicConnection取值必須為true。 EnabledForInnerConnection：私網串連地址將受SSL認證保護。
AutoRenew	Boolean	否	是	是否自動續約。	僅在建立訂用帳戶執行個體時傳入。取值： true：自動續約。 false：不自動續約。說明按月購買，則自動續約周期為1個月。按年購買，則自動續約周期為1年。
LogBackupFrequency	String	否	是	記錄備份頻率。	取值：LogInterval，表示每30分鐘備份一次。 LogBackupFrequency的預設值與資料備份周期PreferredBackupPeriod相同。說明參數LogBackupFrequency僅適用於SQL Server。
EnableBackupLog	Boolean	否	是	是否啟用記錄備份功能。	取值： true：啟用記錄備份功能。 false：關閉記錄備份功能說明當BackupPolicyMode參數設定為LogBackupPolicy時，必須指定該參數。
ReleasedKeepPolicy	String	否	是	執行個體釋放後的歸檔備份保留原則。	取值： None：不保留 Lastest：保留最後一個 All：全部保留說明僅在 BackupPolicyMode 參數為 DataBackupPolicy 時生效。 2024 年 02 月 01 日及之後新購的 RDS MySQL 雲端硬碟執行個體 ReleasedKeepPolicy 預設值為 Lastest；本地碟執行個體預設值為 None。功能詳情，請參見設定執行個體釋放後備份保留原則。
ArchiveBackupRetentionPeriod	Integer	否	是	歸檔備份的保留天數。	取值範圍：30~1095。單位：天。
ArchiveBackupKeepPolicy	String	否	是	歸檔備份的保留周期。	取值： ByMonth ByWeek KeepAll
ArchiveBackupKeepCount	Integer	否	是	歸檔備份的保留個數。	取值：當ArchiveBackupKeepPolicy取值為ByMonth時：1~31。當ArchiveBackupKeepPolicy取值為ByWeek時：1~7。當ArchiveBackupKeepPolicy取值為KeepAll時：無需指定該參數。預設值：1。
LogBackupRetentionPeriod	Integer	否	是	記錄備份保留天數。	取值範圍：7～730。記錄備份保留期不能長於資料備份保留期。說明如果啟用了記錄備份功能，您可以指定記錄備份的保留期限。
HighSpaceUsageProtection	String	否	是	指定當磁碟空間不足（執行個體超過80％或剩餘空間少於5 GB）時是否強制移除記錄備份檔案。	取值： Enable Disable 當BackupPolicyMode取值為LogBackupPolicy時，必須指定該參數。
LocalLogRetentionSpace	Integer	否	是	執行個體上允許儲存記錄備份檔案的最大空間百分比。	取值範圍：0~50。如果記錄備份檔案的空間使用率超過該百分比，系統會提前刪除記錄備份檔案，直到空間使用率降至此百分比以下。說明當BackupPolicyMode取值為LogBackupPolicy時，必須指定該參數。
BackUpCategory	String	否	是	是否開啟秒級備份。	取值： Flash：開啟。 Standard：關閉。
CompressType	Integer	否	是	備份壓縮方式。	取值： 1：使用zlib工具將備份壓縮到.tar.gz檔案中。 4：使用QuickLZ工具將備份壓縮到.xb.gz檔案中。僅當執行個體運行MySQL 5.6或5.7時，才支援此壓縮格式。它可用於還原單個資料庫和表。 8：使用QuickLZ工具將備份壓縮為.xb.gz檔案。僅當執行個體運行MySQL 8.0時，才支援此壓縮格式。它不能用於還原單個資料庫或表。
LocalLogRetentionHours	Integer	否	是	本地記錄備份保留小時數。	取值範圍：0～168。單位：小時。 0表示不在執行個體上保留記錄備份檔案。說明當BackupPolicyMode取值為LogBackupPolicy時，必須指定該參數。
LogBackupLocalRetentionNumber	Integer	否	是	執行個體上可以保留的記錄備份檔案數。	取值範圍：6~100。預設值：60。
ServerlessConfig	Map	否	否	RDS Serverless執行個體的相關設定。	更多資訊，請參見ServerlessConfig屬性。
InstanceNetworkType	String	否	否	執行個體的網路類型。	取值： VPC：專用網路。 Classic：傳統網路。說明 MySQL雲端硬碟執行個體只支援專用網路，此參數必須配置為VPC。 PostgreSQL和MariaDB執行個體只支援專用網路，此參數必須配置為VPC。 SQL Server單機版和Web版執行個體支援傳統網路和專用網路。其餘執行個體只支援專用網路，此參數必須配置為VPC。
StorageAutoScale	String	否	否	儲存空間自動擴容開關。	僅MySQL和PostgreSQL支援，取值： Enable：開啟。 Disable：關閉（預設）。說明您也可以在執行個體建立完成之後，調用ModifyDasInstanceConfig進行調整。更多資訊，請參見設定儲存空間自動擴容。
StorageUpperBound	Number	否	否	儲存空間自動擴容的總儲存空間限制值。	自動擴容不會導致執行個體總儲存空間超過該值。單位：GB。說明取值需大於等於 0。 StorageAutoScale為Enable時必填。
StorageThreshold	Number	否	否	儲存空間自動擴容觸發閾值（百分比）。	取值： 10 20 30 40 50 說明 StorageAutoScale為Enable時該參數必填。
BurstingEnabled	Boolean	否	否	通用雲端硬碟 IO 突發功能開關。	取值： true：開啟 IO 突發功能。 false：關閉 IO 突發功能。說明瞭解通用雲端硬碟的 IO 突發功能的更多資訊，請參見什麼是高效能雲端硬碟。
IoAccelerationEnabled	String	否	否	是否開啟通用雲端硬碟 IO 加速功能。	取值： 1：開啟 0：不開啟說明通用雲端硬碟的 IO 加速功能的更多資訊，請參見Buffer Pool Extension（BPE）功能。
ColdDataEnabled	Boolean	否	否	通用雲端硬碟資料歸檔功能開關。	取值： true：開啟。 false：關閉。通用雲端硬碟的資料歸檔功能資訊，請參見資料歸檔功能。
DeletionProtection	Boolean	否	是	是否已開啟釋放保護功能。	取值： true：已開啟 false：未開啟

ServerlessConfig文法

"ServerlessConfig": {
    "SwitchForce": Boolean,
    "MaxCapacity": Number,
    "MinCapacity": Number,
    "AutoPause": Boolean
  }

ServerlessConfig屬性

屬性名稱	類型	必須	允許更新	描述	約束
SwitchForce	Boolean	否	否	是否開啟Serverless執行個體的強制彈性擴容和縮容。	取值： true：開啟。 false（預設）：不開啟。說明開啟該參數後，執行個體進行強制擴容和縮容時會有1分鐘以內的閃斷，請您根據實際情況謹慎使用。執行個體RCU的彈性擴容和縮容通常會立刻生效，但在某些特殊情況下（例如：大事務執行中）無法即刻完成擴容和縮容，此時可開啟本參數進行強制擴容和縮容。
MaxCapacity	Number	是	否	執行個體RCU（RDS Capacity Unit）自動擴容和縮容範圍的最大值。	取值：0.5~8。說明該參數的值必須大於等於MinCapacity參數。
MinCapacity	Number	是	否	執行個體RCU自動擴容和縮容範圍的最小值。	取值：0.5~8。說明該參數的值必須小於等於MaxCapacity參數。
AutoPause	Boolean	否	否	是否開啟Serverless執行個體的智能暫停和啟動。	取值： true：開啟。 false（預設）：不開啟。說明如果10分鐘無任何串連將進入暫停狀態，當串連進入時會自動喚醒。

DBMappings文法

"DBMappings": [
  {
    "DBDescription": String,
    "CharacterSetName": String,
    "DBName": String
  }
]

DBMappings屬性

屬性名稱	類型	必須	允許更新	描述	約束
CharacterSetName	String	是	否	字元集。	取值： MySQL類型： utf8 gbk latin1 utf8mb4（適用於5.5版和5.6版） SQLServer類型： Chinese_PRC_CI_AS Chinese_PRC_CS_AS SQL_Latin1_General_CP1_CI_AS SQL_Latin1_General_CP1_CS_AS Chinese_PRC_BIN
DBName	String	是	否	資料庫名稱。	名稱需要全域唯一。長度不超過64個字元。以英文字母開頭，可包含英文字母、數字和底線（_）。
DBDescription	String	否	否	資料庫描述。	長度為2~256個字元。以英文字母或漢字開頭，不能以`http://`或`https://`開頭。可包含漢字、英文字母、數字、底線（_）和短劃線（-）。

傳回值

Fn::GetAtt

DBInstanceId：資料庫執行個體ID。
InnerPort：資料庫執行個體的內網連接埠。
InnerIPAddress：內網IP。
InnerConnectionString：內網串連地址。
PublicPort：資料庫執行個體公網連接埠。
PublicConnectionString：公網串連地址。
PublicIPAddress：公網IP。

樣本

情境 1 ：建立一台隨用隨付的RDS PostgreSQL基礎版執行個體。

快速建立

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: Create a pay-as-you-go (subscription-based) RDS PostgreSQL Basic Edition instance with an annual/monthly billing cycle.
Parameters:
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description:
      en: Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud
      zh-cn: 現有Virtual Private Cloud絡的執行個體ID
    Label:
      en: VPC ID
      zh-cn: Virtual Private Cloud執行個體ID
  ZoneId:
    Type: String
    Label:
      en: Zone ID
      zh-cn: 可用性區域ID
    Description:
      en: Zone ID.
      zh-cn: 可用性區域ID
    Required: true
    AssociationProperty: ZoneId
    AssociationPropertyMetadata:
      AutoSelectFirst: true
  VSwitchId:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    Type: String
    Description:
      en: Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query
      zh-cn: 現有業務網路交換器的執行個體ID
    Label:
      en: VSwitch ID
      zh-cn: 交換器執行個體ID
  DBInstanceClass:
    Type: String
    Label:
      en: Instance Class
      zh-cn: 執行個體規格
    Required: true
    AssociationProperty: ALIYUN::RDS::Instance::InstanceType
    AssociationPropertyMetadata:
      InstanceChargeType: Postpaid
      ZoneId: ${ZoneId}
      EngineVersion: '17.0'
      Engine: PostgreSQL
      Category: Basic
      DBInstanceStorageType: cloud_essd
Resources:
  RDSInstance:
    Type: ALIYUN::RDS::DBInstance
    Properties:
      ZoneId:
        Ref: ZoneId
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
      DBInstanceClass:
        Ref: DBInstanceClass
      DBInstanceStorage: 50
      Engine: PostgreSQL
      EngineVersion: '17.0'
      Category: Basic
      DBInstanceStorageType: cloud_essd
      AllocatePublicConnection: true
      PayType: Postpaid
      SecurityIPList: 0.0.0.0/0
Outputs:
  InnerConnectionString:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - InnerConnectionString
  InnerIPAddress:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - InnerIPAddress
  PublicConnectionString:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - PublicConnectionString
  PublicIPAddress:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - PublicIPAddress

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Create a pay-as-you-go (subscription-based) RDS PostgreSQL Basic Edition instance with an annual/monthly billing cycle.",
  "Parameters": {
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "en": "Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud",
        "zh-cn": "現有Virtual Private Cloud絡的執行個體ID"
      },
      "Label": {
        "en": "VPC ID",
        "zh-cn": "Virtual Private Cloud執行個體ID"
      }
    },
    "ZoneId": {
      "Type": "String",
      "Label": {
        "en": "Zone ID",
        "zh-cn": "可用性區域ID"
      },
      "Description": {
        "en": "Zone ID.",
        "zh-cn": "可用性區域ID"
      },
      "Required": true,
      "AssociationProperty": "ZoneId",
      "AssociationPropertyMetadata": {
        "AutoSelectFirst": true
      }
    },
    "VSwitchId": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "Type": "String",
      "Description": {
        "en": "Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query",
        "zh-cn": "現有業務網路交換器的執行個體ID"
      },
      "Label": {
        "en": "VSwitch ID",
        "zh-cn": "交換器執行個體ID"
      }
    },
    "DBInstanceClass": {
      "Type": "String",
      "Label": {
        "en": "Instance Class",
        "zh-cn": "執行個體規格"
      },
      "Required": true,
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceType",
      "AssociationPropertyMetadata": {
        "InstanceChargeType": "Postpaid",
        "ZoneId": "${ZoneId}",
        "EngineVersion": "17.0",
        "Engine": "PostgreSQL",
        "Category": "Basic",
        "DBInstanceStorageType": "cloud_essd"
      }
    }

  },
  "Resources": {
    "RDSInstance": {
      "Type": "ALIYUN::RDS::DBInstance",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "DBInstanceClass": {
          "Ref": "DBInstanceClass"
        },
        "DBInstanceStorage": 50,
        "Engine": "PostgreSQL",
        "EngineVersion": "17.0",
        "Category": "Basic",
        "DBInstanceStorageType": "cloud_essd",
        "AllocatePublicConnection": true,
        "PayType": "Postpaid",
        "SecurityIPList": "0.0.0.0/0"
      }
    }
  },
  "Outputs": {
    "InnerConnectionString": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "InnerConnectionString"
        ]
      }
    },
    "InnerIPAddress": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "InnerIPAddress"
        ]
      }
    },
    "PublicConnectionString": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "PublicConnectionString"
        ]
      }
    },
    "PublicIPAddress": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "PublicIPAddress"
        ]
      }
    }
  }
}

情境 2 ：建立一台訂用帳戶的多可用性區域RDS MySQL高可用版執行個體。

快速建立

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description:
  zh-cn: 建立一台訂用帳戶的多可用性區域RDS MySQL高可用版執行個體。
  en: Create a multi-AZ RDS MySQL High-Availability edition instance with a prepaid subscription.
Parameters:
  VSwitch2:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId2}
    Type: String
    Description:
      zh-cn: 現有業務網路交換器的執行個體ID
      en: Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query
    Label:
      zh-cn: 交換器2執行個體ID
      en: VSwitch2 ID
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description:
      zh-cn: 現有Virtual Private Cloud絡的執行個體ID
      en: Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud
    Label:
      zh-cn: Virtual Private Cloud執行個體ID
      en: VPC ID
  ZoneId1:
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    AssociationPropertyMetadata:
      ExclusiveTo:
        - ZoneId2
    Type: String
    Label:
      zh-cn: 主可用性區域
      en: Primary Availability Zone
  ZoneId2:
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    AssociationPropertyMetadata:
      ExclusiveTo:
        - ZoneId1
    Type: String
    Label:
      zh-cn: 備可用性區域
      en: Standby Availability Zone
  VSwitch1:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId1}
    Type: String
    Description:
      zh-cn: 現有業務網路交換器的執行個體ID
      en: Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query
    Label:
      zh-cn: 交換器1執行個體ID
      en: VSwitch1 ID
  DBInstanceClass:
    AssociationProperty: ALIYUN::RDS::Instance::InstanceType
    AssociationPropertyMetadata:
      Engine: MySQL
      Category: HighAvailability
      EngineVersion: '8.0'
      InstanceChargeType: Prepaid
      DBInstanceStorageType: cloud_essd
    Type: String
    Label:
      zh-cn: 執行個體規格
      en: Instance Class
Outputs:
  InnerIPAddress:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - InnerIPAddress
  InnerConnectionString:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - InnerConnectionString
  PublicConnectionString:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - PublicConnectionString
  PublicIPAddress:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - PublicIPAddress
Resources:
  RDSInstance:
    Type: ALIYUN::RDS::DBInstance
    Properties:
      Category: HighAvailability
      Engine: MySQL
      PayType: Prepaid
      SlaveZoneIds:
        - Ref: ZoneId2
      DBInstanceStorage: 20
      PeriodType: Month
      DBInstanceStorageType: cloud_essd
      Period: 1
      ZoneId:
        Ref: ZoneId1
      VpcId:
        Ref: VpcId
      VSwitchId:
        Fn::Join:
          - ','
          - - Ref: VSwitch1
            - Ref: VSwitch2
      EngineVersion: '8.0'
      DBInstanceClass:
        Ref: DBInstanceClass
      SecurityIPList: 0.0.0.0/0
Metadata:
  ALIYUN::ROS::Interface:
    ParameterGroups:
      - Parameters:
          - VpcId
          - ZoneId1
          - ZoneId2
          - VSwitch1
          - VSwitch2
        Label:
          default:
            zh-cn: 網路設定
            en: Network Configuration
      - Parameters:
          - DBInstanceClass
        Label:
          default:
            zh-cn: RDS配置
            en: RDS Configuration

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
    "zh-cn": "建立一台訂用帳戶的多可用性區域RDS MySQL高可用版執行個體。",
    "en": "Create a multi-AZ RDS MySQL High-Availability edition instance with a prepaid subscription."
  },
  "Parameters": {
    "VSwitch2": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId2}"
      },
      "Type": "String",
      "Description": {
        "zh-cn": "現有業務網路交換器的執行個體ID",
        "en": "Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query"
      },
      "Label": {
        "zh-cn": "交換器2執行個體ID",
        "en": "VSwitch2 ID"
      }
    },
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "zh-cn": "現有Virtual Private Cloud絡的執行個體ID",
        "en": "Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud"
      },
      "Label": {
        "zh-cn": "Virtual Private Cloud執行個體ID",
        "en": "VPC ID"
      }
    },
    "ZoneId1": {
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "AssociationPropertyMetadata": {
        "ExclusiveTo": [
          "ZoneId2"
        ]
      },
      "Type": "String",
      "Label": {
        "zh-cn": "主可用性區域",
        "en": "Primary Availability Zone"
      }
    },
    "ZoneId2": {
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "AssociationPropertyMetadata": {
        "ExclusiveTo": [
          "ZoneId1"
        ]
      },
      "Type": "String",
      "Label": {
        "zh-cn": "備可用性區域",
        "en": "Standby Availability Zone"
      }
    },
    "VSwitch1": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId1}"
      },
      "Type": "String",
      "Description": {
        "zh-cn": "現有業務網路交換器的執行個體ID",
        "en": "Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query"
      },
      "Label": {
        "zh-cn": "交換器1執行個體ID",
        "en": "VSwitch1 ID"
      }
    },
    "DBInstanceClass": {
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceType",
      "AssociationPropertyMetadata": {
        "Engine": "MySQL",
        "Category": "HighAvailability",
        "EngineVersion": "8.0",
        "InstanceChargeType": "Prepaid",
        "DBInstanceStorageType": "cloud_essd"
      },
      "Type": "String",
      "Label": {
        "zh-cn": "執行個體規格",
        "en": "Instance Class"
      }
    }
  },
  "Outputs": {
    "InnerIPAddress": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "InnerIPAddress"
        ]
      }
    },
    "InnerConnectionString": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "InnerConnectionString"
        ]
      }
    },
    "PublicConnectionString": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "PublicConnectionString"
        ]
      }
    },
    "PublicIPAddress": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "PublicIPAddress"
        ]
      }
    }
  },
  "Resources": {
    "RDSInstance": {
      "Type": "ALIYUN::RDS::DBInstance",
      "Properties": {
        "Category": "HighAvailability",
        "Engine": "MySQL",
        "PayType": "Prepaid",
        "SlaveZoneIds": [
          {
            "Ref": "ZoneId2"
          }
        ],
        "DBInstanceStorage": 20,
        "PeriodType": "Month",
        "DBInstanceStorageType": "cloud_essd",
        "Period": 1,
        "ZoneId": {
          "Ref": "ZoneId1"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Fn::Join": [
            ",",
            [
              {
                "Ref": "VSwitch1"
              },
              {
                "Ref": "VSwitch2"
              }
            ]
          ]
        },
        "EngineVersion": "8.0",
        "DBInstanceClass": {
          "Ref": "DBInstanceClass"
        },
        "SecurityIPList": "0.0.0.0/0"
      }
    }
  },
  "Metadata": {
    "ALIYUN::ROS::Interface": {
      "ParameterGroups": [
        {
          "Parameters": [
            "VpcId",
            "ZoneId1",
            "ZoneId2",
            "VSwitch1",
            "VSwitch2"
          ],
          "Label": {
            "default": {
              "zh-cn": "網路設定",
              "en": "Network Configuration"
            }
          }
        },
        {
          "Parameters": [
            "DBInstanceClass"
          ],
          "Label": {
            "default": {
              "zh-cn": "RDS配置",
              "en": "RDS Configuration"
            }
          }
        }
      ]
    }
  }
}

情境 3 ：建立一台隨用隨付的RDS Serverless MySQL執行個體並綁定資料庫和資料庫帳號。

快速建立

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description:
  zh-cn: 建立一台隨用隨付的RDS Serverless MySQL執行個體並綁定資料庫和資料庫帳號。
  en: Create a pay-as-you-go RDS Serverless MySQL instance and bind it to a database and a database user.
Parameters:
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description:
      zh-cn: 現有Virtual Private Cloud絡的執行個體ID
      en: Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud
    Label:
      zh-cn: Virtual Private Cloud執行個體ID
      en: VPC ID
  RdsAccountName:
    Default: db_root
    Type: String
    Description:
      zh-cn: MySQL 管理使用者名稱
      en: Account Name
    Label:
      zh-cn: 使用者名稱稱
      en: Account Name
  ZoneId:
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    Type: String
    Label:
      zh-cn: 主可用性區域
      en: Primary Availability Zone
  VSwitch:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    Type: String
    Description:
      zh-cn: 現有業務網路交換器的執行個體ID
      en: Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query
    Label:
      zh-cn: 交換器執行個體ID
      en: VSwitch ID
  DBInstanceClass:
    Default: mysql.n2.serverless.1c
    AssociationProperty: ALIYUN::RDS::Instance::InstanceType
    AssociationPropertyMetadata:
      Engine: MySQL
      EngineVersion: '8.0'
      InstanceChargeType: Serverless
      DBInstanceStorageType: cloud_essd
      ZoneId: ${ZoneId}
    Type: String
    Label:
      zh-cn: 執行個體規格
      en: Instance Class
  RdsAccountPassword:
    Type: String
    NoEcho: true
    Description:
      zh-cn: |-
        長度為8~32個字元。由大寫英文字母、小寫英文字母、數字、特殊字元中的任意三種組成。支援的特殊字元如下：
        !@#$&amp;%^*()_+-= 。
      en: |-
        The length is 8 ~ 32 characters. It is composed of uppercase English letters, lowercase English letters, numbers and special characters. The special characters supported are as follows:
        !@#$& amp;%^* ()_+-=  .
    Label:
      zh-cn: 使用者密碼
      en: DB Account Password
Outputs:
  PublicConnectionString:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - PublicConnectionString
  InnerIPAddress:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - InnerIPAddress
  AccountName:
    Value:
      Fn::GetAtt:
        - RdsAccount
        - AccountName
  PublicIPAddress:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - PublicIPAddress
  DBName:
    Value:
      Fn::GetAtt:
        - Database
        - DBName
  InnerConnectionString:
    Value:
      Fn::GetAtt:
        - RDSInstance
        - InnerConnectionString
Resources:
  RDSInstance:
    Type: ALIYUN::RDS::DBInstance
    Properties:
      Category: serverless_basic
      Engine: MySQL
      DBInstanceStorage: 20
      ServerlessConfig:
        MinCapacity: 0.5
        AutoPause: false
        MaxCapacity: 8
        SwitchForce: false
      DBInstanceStorageType: cloud_essd
      PayType: Serverless
      ZoneId:
        Ref: ZoneId
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitch
      EngineVersion: '8.0'
      DBInstanceClass:
        Ref: DBInstanceClass
      SecurityIPList: 0.0.0.0/0
  RdsAccount:
    Type: ALIYUN::RDS::Account
    Properties:
      DBInstanceId:
        Ref: RDSInstance
      AccountPassword:
        Ref: RdsAccountPassword
      AccountType: Super
      AccountName:
        Ref: RdsAccountName
  Database:
    Type: ALIYUN::RDS::Database
    Properties:
      CharacterSetName: UTF8
      DBInstanceId:
        Ref: RDSInstance
      DBName: springboot_demo
Metadata:
  ALIYUN::ROS::Interface:
    ParameterGroups:
      - Parameters:
          - VpcId
          - ZoneId
          - VSwitch
        Label:
          default:
            zh-cn: 網路設定
            en: Network Configuration
      - Parameters:
          - DBInstanceClass
          - RdsAccountName
          - RdsAccountPassword
        Label:
          default:
            zh-cn: RDS配置
            en: RDS Configuration

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
    "zh-cn": "建立一台隨用隨付的RDS Serverless MySQL執行個體並綁定資料庫和資料庫帳號。",
    "en": "Create a pay-as-you-go RDS Serverless MySQL instance and bind it to a database and a database user."
  },
  "Parameters": {
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "zh-cn": "現有Virtual Private Cloud絡的執行個體ID",
        "en": "Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud"
      },
      "Label": {
        "zh-cn": "Virtual Private Cloud執行個體ID",
        "en": "VPC ID"
      }
    },
    "RdsAccountName": {
      "Default": "db_root",
      "Type": "String",
      "Description": {
        "zh-cn": "MySQL 管理使用者名稱",
        "en": "Account Name"
      },
      "Label": {
        "zh-cn": "使用者名稱稱",
        "en": "Account Name"
      }
    },
    "ZoneId": {
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "Type": "String",
      "Label": {
        "zh-cn": "主可用性區域",
        "en": "Primary Availability Zone"
      }
    },
    "VSwitch": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "Type": "String",
      "Description": {
        "zh-cn": "現有業務網路交換器的執行個體ID",
        "en": "Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query"
      },
      "Label": {
        "zh-cn": "交換器執行個體ID",
        "en": "VSwitch ID"
      }
    },
    "DBInstanceClass": {
      "Default": "mysql.n2.serverless.1c",
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceType",
      "AssociationPropertyMetadata": {
        "Engine": "MySQL",
        "EngineVersion": "8.0",
        "InstanceChargeType": "Serverless",
        "DBInstanceStorageType": "cloud_essd",
        "ZoneId": "${ZoneId}"
      },
      "Type": "String",
      "Label": {
        "zh-cn": "執行個體規格",
        "en": "Instance Class"
      }
    },
    "RdsAccountPassword": {
      "Type": "String",
      "NoEcho": true,
      "Description": {
        "zh-cn": "長度為8~32個字元。由大寫英文字母、小寫英文字母、數字、特殊字元中的任意三種組成。支援的特殊字元如下：\n!@#$&amp;%^*()_+-= 。",
        "en": "The length is 8 ~ 32 characters. It is composed of uppercase English letters, lowercase English letters, numbers and special characters. The special characters supported are as follows:\n!@#$& amp;%^* ()_+-=  ."
      },
      "Label": {
        "zh-cn": "使用者密碼",
        "en": "DB Account Password"
      }
    }
  },
  "Outputs": {
    "PublicConnectionString": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "PublicConnectionString"
        ]
      }
    },
    "InnerIPAddress": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "InnerIPAddress"
        ]
      }
    },
    "AccountName": {
      "Value": {
        "Fn::GetAtt": [
          "RdsAccount",
          "AccountName"
        ]
      }
    },
    "PublicIPAddress": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "PublicIPAddress"
        ]
      }
    },
    "DBName": {
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "DBName"
        ]
      }
    },
    "InnerConnectionString": {
      "Value": {
        "Fn::GetAtt": [
          "RDSInstance",
          "InnerConnectionString"
        ]
      }
    }
  },
  "Resources": {
    "RDSInstance": {
      "Type": "ALIYUN::RDS::DBInstance",
      "Properties": {
        "Category": "serverless_basic",
        "Engine": "MySQL",
        "DBInstanceStorage": 20,
        "ServerlessConfig": {
          "MinCapacity": 0.5,
          "AutoPause": false,
          "MaxCapacity": 8,
          "SwitchForce": false
        },
        "DBInstanceStorageType": "cloud_essd",
        "PayType": "Serverless",
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitch"
        },
        "EngineVersion": "8.0",
        "DBInstanceClass": {
          "Ref": "DBInstanceClass"
        },
        "SecurityIPList": "0.0.0.0/0"
      }
    },
    "RdsAccount": {
      "Type": "ALIYUN::RDS::Account",
      "Properties": {
        "DBInstanceId": {
          "Ref": "RDSInstance"
        },
        "AccountPassword": {
          "Ref": "RdsAccountPassword"
        },
        "AccountType": "Super",
        "AccountName": {
          "Ref": "RdsAccountName"
        }
      }
    },
    "Database": {
      "Type": "ALIYUN::RDS::Database",
      "Properties": {
        "CharacterSetName": "UTF8",
        "DBInstanceId": {
          "Ref": "RDSInstance"
        },
        "DBName": "springboot_demo"
      }
    }
  },
  "Metadata": {
    "ALIYUN::ROS::Interface": {
      "ParameterGroups": [
        {
          "Parameters": [
            "VpcId",
            "ZoneId",
            "VSwitch"
          ],
          "Label": {
            "default": {
              "zh-cn": "網路設定",
              "en": "Network Configuration"
            }
          }
        },
        {
          "Parameters": [
            "DBInstanceClass",
            "RdsAccountName",
            "RdsAccountPassword"
          ],
          "Label": {
            "default": {
              "zh-cn": "RDS配置",
              "en": "RDS Configuration"
            }
          }
        }
      ]
    }
  }
}

更多樣本，請參考包含此資源的公用模板。