ALIYUN::RDS::ReadOnlyDBInstance -

ALIYUN::RDS::ReadOnlyDBInstance類型用於為關係型資料庫RDS（Relational Database Service）執行個體建立一個唯讀執行個體。

文法

{
  "Type": "ALIYUN::RDS::ReadOnlyDBInstance",
  "Properties": {
    "Category": String,
    "VPCId": String,
    "DBInstanceDescription": String,
    "Tags": Map,
    "EngineVersion": String,
    "DBInstanceId": String,
    "PayType": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "DBInstanceStorage": Integer,
    "VSwitchId": String,
    "DBInstanceStorageType": String,
    "DBInstanceClass": String,
    "PrivateIpAddress": String,
    "PeriodType": String,
    "Period": Integer,
    "AutoRenew": Boolean,
    "TargetDedicatedHostIdForMaster": String,
    "DeletionProtection": Boolean,
    "DedicatedHostGroupId": String
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
Category	String	否	否	執行個體系列。	取值： Basic：基礎版。 HighAvailability（預設值）：高可用版。 AlwaysOn：叢集版。
VPCId	String	否	否	唯讀執行個體的專用網路ID。	無
DBInstanceDescription	String	否	否	執行個體描述。	長度為2~256個字元。以漢字、英文字母開頭，不能以`http://`或`https://`開頭。可包含數字、漢字、英文字母、底線（_）和短劃線（-）。
Tags	Map	否	是	執行個體標籤。	執行個體標籤是索引值對形式，例如： `{"key1": "value1","key2": "value2", ... "key5": "value5"}` 最多設定5個索引值對。其中，key最大長度為64個字元，不能以`http://`或`https://`開頭；value最大長度為128個字元，不能以`aliyun`、`http://`或`https://`開頭。
EngineVersion	String	是	否	資料庫版本號碼。	EngineVersion必須與主執行個體的版本保持一致。取值： MySQL資料庫： 5.6 5.7 8.0 SQL Server資料庫：2017_ent
DBInstanceId	String	是	否	主執行個體ID。	無
PayType	String	否	否	付費類型。	僅支援隨用隨付。取值：Postpaid。
ZoneId	String	是	否	可用性區域ID。	可以通過介面DescribeRegions查看可用性區域列表。
ResourceGroupId	String	否	否	資源群組ID。	無
DBInstanceStorage	Integer	是	是	儲存空間。	單位：GB。取值範圍：5~3000，步長為5 GB。不同版本執行個體，支援的取值範圍不同。更多資訊，請參見主執行個體規格列表。
VSwitchId	String	否	否	唯讀執行個體的交換器ID。	無
DBInstanceStorageType	String	否	否	執行個體儲存類型。	取值： local_ssd或ephemeral_ssd：本地SSD盤。 cloud_ssd：SSD雲端硬碟。 cloud_essd：ESSD雲端硬碟。說明 MySQL僅支援本地碟儲存類型，SQL Server僅支援雲端硬碟儲存類型。
DBInstanceClass	String	是	是	執行個體規格。	更多資訊，請參見主執行個體規格列表。建議唯讀執行個體規格不小於主執行個體規格，否則容易出現唯讀執行個體延遲高、負載高等現象。
PrivateIpAddress	String	否	否	唯讀執行個體的內網IP。	需要在指定交換器的IP位址範圍內，設定唯讀執行個體的內網IP。系統預設通過VPCId和VSwitchId自動分配。
PeriodType	String	否	否	預付費執行個體類型。	取值： Year：包年。 Month：包月。
Period	Integer	否	否	購買時間長度。	取值範圍：當參數PeriodType為Year時：1~3。當參數PeriodType為Month時：1~9。
AutoRenew	Boolean	否	否	執行個體是否自動續約。	僅在建立訂用帳戶執行個體時生效。取值： true：自動續約。 false（預設值）：不自動續約。說明按月購買，則自動續約周期為1個月。按年購買，則自動續約周期為1年。
TargetDedicatedHostIdForMaster	String	否	否	在專屬叢集內建立唯讀執行個體時，指定主執行個體的主機ID。	無
DeletionProtection	Boolean	否	否	是否開啟RDS釋放保護功能。	取值： true：開啟。 false（預設值）：關閉。說明僅計費方式為隨用隨付時支援開啟。
DedicatedHostGroupId	String	否	否	在專屬叢集內建立唯讀執行個體時指定專屬叢集ID。	無

傳回值

Fn::GetAtt

ConnectionString：建立的唯讀執行個體內網資料庫連接地址。
DBInstanceId：建立的唯讀執行個體ID。
Port：建立的唯讀執行個體內網資料庫連接連接埠。

樣本

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: The ID of the master instance.
  ZoneId:
    Type: String
    Description: Create an Availability Zone for an instance to ensure that the Availability Zone supports the creation of rds resource specifications.
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    Label: Zone ID
  VPC:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description: Please search the ID starts with (vpc-xxx)from console-Virtual Private Cloud
    Label: Existing VPC Instance ID
  VSwitch:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Description: Please search the business VSwitch ID starts with(vsw-xxx)from console-Virtual Private Cloud-VSwitches
    Label: Existing VSwitch ID
    AssociationPropertyMetadata:
      VpcId: VPC
      ZoneId: ZoneId
  EngineVersion:
    Type: String
    Description: 'MySQL: 5.5、5.6、5.7、5.8，SQLServer：2008r2，PostgreSQL：9.4'
    Default: '5.6'
  DBInstanceClass:
    Type: String
    Description: Instance Class
    Default: rds.mysql.s2.large
  DBInstanceStorage:
    Type: Number
    Description: MySQL：5-1000，SQLServer：10-1000，others：5-2000
    Default: 40
Resources:
  ReadOnlyDBInstance:
    Type: ALIYUN::RDS::ReadOnlyDBInstance
    DependsOn: RDSInstance
    Properties:
      VPCId:
        Ref: VPC
      DBInstanceId:
        Ref: DBInstanceId
      ZoneId:
        Ref: ZoneId
      DBInstanceStorage:
        Ref: DBInstanceStorage
      VSwitchId:
        Ref: VSwitch
      EngineVersion:
        Ref: EngineVersion
      DBInstanceClass:
        Ref: DBInstanceClass
Outputs:
  DBInstanceId:
    Description: The instance id of created database instance.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - DBInstanceId
  Port:
    Description: Intranet port of created DB instance.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - Port
  ConnectionString:
    Description: DB instance connection url by Intranet.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - ConnectionString

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "The ID of the master instance."
    },
    "ZoneId": {
      "Type": "String",
      "Description": "Create an Availability Zone for an instance to ensure that the Availability Zone supports the creation of rds resource specifications.",
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "Label": "Zone ID"
    },
    "VPC": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": "Please search the ID starts with (vpc-xxx)from console-Virtual Private Cloud",
      "Label": "Existing VPC Instance ID"
    },
    "VSwitch": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Description": "Please search the business VSwitch ID starts with(vsw-xxx)from console-Virtual Private Cloud-VSwitches",
      "Label": "Existing VSwitch ID",
      "AssociationPropertyMetadata": {
        "VpcId": "VPC",
        "ZoneId": "ZoneId"
      }
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "MySQL: 5.5、5.6、5.7、5.8，SQLServer：2008r2，PostgreSQL：9.4",
      "Default": "5.6"
    },
    "DBInstanceClass": {
      "Type": "String",
      "Description": "Instance Class",
      "Default": "rds.mysql.s2.large"
    },
    "DBInstanceStorage": {
      "Type": "Number",
      "Description": "MySQL：5-1000，SQLServer：10-1000，others：5-2000",
      "Default": 40
    }
  },
  "Resources": {
    "ReadOnlyDBInstance": {
      "Type": "ALIYUN::RDS::ReadOnlyDBInstance",
      "DependsOn": "RDSInstance",
      "Properties": {
        "VPCId": {
          "Ref": "VPC"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "DBInstanceStorage": {
          "Ref": "DBInstanceStorage"
        },
        "VSwitchId": {
          "Ref": "VSwitch"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "DBInstanceClass": {
          "Ref": "DBInstanceClass"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceId": {
      "Description": "The instance id of created database instance.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "DBInstanceId"
        ]
      }
    },
    "Port": {
      "Description": "Intranet port of created DB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "Port"
        ]
      }
    },
    "ConnectionString": {
      "Description": "DB instance connection url by Intranet.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "ConnectionString"
        ]
      }
    }
  }
}