如何使用PolarDBXALIYUN::PolarDBX::DBInstance類型 -

ALIYUN::PolarDBX::DBInstance類型用於建立PolarDB-X 2.0執行個體。

文法

{
  "Type": "ALIYUN::PolarDBX::DBInstance",
  "Properties": {
    "TopologyType": String,
    "EngineVersion": String,
    "ResourceGroupId": String,
    "VPCId": String,
    "AutoRenew": Boolean,
    "VSwitchId": String,
    "Period": String,
    "PayType": String,
    "DBNodeClass": String,
    "SecondaryZone": String,
    "TertiaryZone": String,
    "DBNodeCount": Integer,
    "PrimaryZone": String,
    "UsedTime": Integer,
    "DBInstanceDescription": String,
    "SecurityIpConfig": Map
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
TopologyType	String	是	否	拓撲類型。	取值： 3azones：三可用性區域。 1azone：單可用性區域。
EngineVersion	String	是	否	資料庫引擎版本。	執行個體付費類型為隨用隨付時支援2.0、5.7。執行個體付費類型為訂用帳戶時支援5.7。
ResourceGroupId	String	否	否	資源群組ID。	無
VPCId	String	是	否	專用網路ID。	無
AutoRenew	Boolean	否	否	是否自動續約。	取值： true：自動續約。 false：不自動續約。
VSwitchId	String	是	否	虛擬交換器ID。	無
Period	String	否	否	收費周期。	當PayType取值為訂用帳戶時，本參數取值為Year或Mouth。當PayType取值為隨用隨付時，本參數取值為Hour。
PayType	String	否	否	執行個體付費類型。	取值：訂用帳戶。您可以通過下列形式定義訂用帳戶類型：Subscription、PrePaid、Prepaid、PrePay、PREPAY、PRE。隨用隨付。您可以通過下列形式定義隨用隨付類型：PayOnDemand、PayAsYouGo、PostPaid、PayOnDemand、Postpaid、PostPay、POSTPAY、POST。
DBNodeClass	String	是	否	節點規格。	取值： polarx.x4.medium.2e：2核8G。 polarx.x4.large.2e：4核16G。 polarx.x8.large.2e：4核32G。 polarx.x4.xlarge.2e：8核32G。 polarx.x8.xlarge.2e：8核64G。 polarx.x4.2xlarge.2e：16核64G。 polarx.x8.2xlarge.2e：16核128G。 polarx.x4.4xlarge.2e：32核128G。 polarx.x8.4xlarge.2e：32核256G。 polarx.st.8xlarge.2e：60核470G。 polarx.st.12xlarge.2e：90核720G。
SecondaryZone	String	否	否	次可用性區域。	無
TertiaryZone	String	否	否	第三可用性區域。	無
DBNodeCount	Integer	是	否	執行個體節點數量。	最小值為2。
PrimaryZone	String	是	否	主可用性區域。	無
UsedTime	Integer	否	否	預付費時間長度。	說明當Period取值為Year時，該參數支援的取值為1、2、3。
DBInstanceDescription	String	否	是	執行個體備忘描述。	無
SecurityIpConfig	Map	否	否	執行個體白名單配置。	更多資訊，請參見SecurityIpConfig屬性。

SecurityIpConfig文法

"SecurityIpConfig": {
  "SecurityIPList": String,
  "ModifyMode": String,
  "GroupName": String
}

SecurityIpConfig屬性

屬性名稱	類型	必須	允許更新	描述	約束
SecurityIPList	String	否	否	白名單組中的IP列表。	多個IP白名單間以“，”分隔。
ModifyMode	String	否	否	白名單修改方式，	取值： 0：覆蓋並修改白名單組。 1：添加白名單組。 2：刪除白名單組。
GroupName	String	否	否	執行個體的白名單組名。	無

傳回值

Fn::GetAtt

OrderId：訂單號。
DBInstanceName：建立的執行個體名稱。
Port：內網串連連接埠。
ConnectionString：內網串連串。

樣本

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TopologyType:
    Type: String
    Description: 'The topology type of the instance. Valid values: 3azones: The instance is deployed in three zones. 1azone: The instance is deployed in only one zone.'
    AllowedValues:
      - 1azone
      - 3azones
  EngineVersion:
    Type: String
    Description: The version of the database engine.
  VPCId:
    Type: String
    Description: The ID of the VPC to which the instance belongs.
  VSwitchId:
    Type: String
    Description: The ID of the vSwitch.
  DBNodeClass:
    Type: String
    Description: The specification of the nodes in the instance you want to create.
  DBNodeCount:
    Type: Number
    Description: The number of nodes in the instance you want to create.
    MinValue: 2
  PrimaryZone:
    Type: String
    Description: The primary zone.
Resources:
  DBInstance:
    Type: ALIYUN::PolarDBX::DBInstance
    Properties:
      TopologyType:
        Ref: TopologyType
      EngineVersion:
        Ref: EngineVersion
      VPCId:
        Ref: VPCId
      VSwitchId:
        Ref: VSwitchId
      DBNodeClass:
        Ref: DBNodeClass
      DBNodeCount:
        Ref: DBNodeCount
      PrimaryZone:
        Ref: PrimaryZone
Outputs:
  OrderId:
    Description: The ID of the order.
    Value:
      Fn::GetAtt:
        - DBInstance
        - OrderId
  DBInstanceName:
    Description: The name of the instance that you create.
    Value:
      Fn::GetAtt:
        - DBInstance
        - DBInstanceName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TopologyType": {
      "Type": "String",
      "Description": "The topology type of the instance. Valid values: 3azones: The instance is deployed in three zones. 1azone: The instance is deployed in only one zone.",
      "AllowedValues": [
        "1azone",
        "3azones"
      ]
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "The version of the database engine."
    },
    "VPCId": {
      "Type": "String",
      "Description": "The ID of the VPC to which the instance belongs."
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "The ID of the vSwitch."
    },
    "DBNodeClass": {
      "Type": "String",
      "Description": "The specification of the nodes in the instance you want to create."
    },
    "DBNodeCount": {
      "Type": "Number",
      "Description": "The number of nodes in the instance you want to create.",
      "MinValue": 2
    },
    "PrimaryZone": {
      "Type": "String",
      "Description": "The primary zone."
    }
  },
  "Resources": {
    "DBInstance": {
      "Type": "ALIYUN::PolarDBX::DBInstance",
      "Properties": {
        "TopologyType": {
          "Ref": "TopologyType"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "VPCId": {
          "Ref": "VPCId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "DBNodeClass": {
          "Ref": "DBNodeClass"
        },
        "DBNodeCount": {
          "Ref": "DBNodeCount"
        },
        "PrimaryZone": {
          "Ref": "PrimaryZone"
        }
      }
    }
  },
  "Outputs": {
    "OrderId": {
      "Description": "The ID of the order.",
      "Value": {
        "Fn::GetAtt": [
          "DBInstance",
          "OrderId"
        ]
      }
    },
    "DBInstanceName": {
      "Description": "The name of the instance that you create.",
      "Value": {
        "Fn::GetAtt": [
          "DBInstance",
          "DBInstanceName"
        ]
      }
    }
  }
}