ALIYUN::PolarDBX::Database を使用したデータベース作成 - ROS

ALIYUN::PolarDBX::Database は、データベースを作成するために使用されます。

構文

{
  "Type": "ALIYUN::PolarDBX::Database",
  "Properties": {
    "CharacterSetName": String, // 文字セット
    "DBInstanceId": String, // PolarDB-X インスタンス ID
    "Mode": String, // データベース作成モード
    "DatabaseName": String, // データベース名
    "DatabaseDescription": String, // データベースの説明
    "Accounts": List // アカウントリスト
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
CharacterSetName	String	はい	いいえ	データベースがサポートする文字セット。	有効な値: utf8 gbk latin1 utf8mb4
DBInstanceId	String	はい	いいえ	PolarDB-X インスタンスの ID。	なし。
Mode	String	いいえ	いいえ	データベースを作成する方法。	有効な値: auto: AUTO モードのデータベースは自動パーティショニングをサポートします。テーブルを作成するときにパーティションキーを指定する必要はありません。 drds: DRDS モードのデータベースは自動パーティショニングをサポートしていません。テーブルを作成するときに、PolarDB-X 専用のシャーディング構文でデータベースシャードキーとテーブルシャードキーを指定する必要があります。
DatabaseName	String	はい	いいえ	データベースの名前。	なし。
DatabaseDescription	String	いいえ	はい	データベースの説明。	なし。
Accounts	List	はい	はい	データベースへのアクセスに使用するアカウント。	詳細については、アカウントのプロパティをご参照ください。

アカウントの構文

"Accounts": [
  {
    "AccountPrivilege": String, // アカウント権限
    "AccountName": String // アカウント名
  }
]

アカウントのプロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

AccountPrivilege

String

はい

アカウントに付与するデータベースの権限。

有効な値:

ReadWrite
ReadOnly
DMLOnly
DDLOnly

AccountName

String

はい

データベースへのアクセスに使用するアカウントのユーザー名。

なし。

戻り値

Fn::GetAtt

CharacterSetName: データベースがサポートする文字セット。
DBInstanceId: PolarDB-X インスタンスの ID。
DatabaseName: データベースの名前。
DatabaseDescription: データベースの説明。
Accounts: データベースへのアクセスに使用するアカウント。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CharacterSetName:
    Type: String
    Description: |-
      文字セット。以下の文字セットをサポートします。
      - **utf8**
      - **gbk**
      - **latin1**
      - **utf8mb4**.
    AllowedValues:
      - utf8
      - gbk
      - latin1
      - utf8mb4
    Default: utf8
  DBInstanceId:
    Type: String
    Description: インスタンス ID。
    Default: drdshh****
  DatabaseName:
    Type: String
    Description: データベースの名前。
    Default: test1
  Accounts:
    Type: Json
    Description: アカウントのリスト。
    Default:
      - AccountPrivilege: ReadWrite
        AccountName: test1
Resources:
  ExtensionResource:
    Type: ALIYUN::PolarDBX::Database
    Properties:
      CharacterSetName:
        Ref: CharacterSetName
      DBInstanceId:
        Ref: DBInstanceId
      DatabaseName:
        Ref: DatabaseName
      Accounts:
        Ref: Accounts
Outputs:
  CharacterSetName:
    Description: 文字セット。以下の文字セットをサポートします。.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CharacterSetName
  DBInstanceId:
    Description: インスタンス ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DBInstanceId
  DatabaseName:
    Description: データベースの名前。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DatabaseName
  DatabaseDescription:
    Description: データベースの説明情報。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DatabaseDescription
  Accounts:
    Description: アカウントのリスト。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Accounts

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CharacterSetName": {
      "Type": "String",
      "Description": "文字セット。以下の文字セットをサポートします。\n- **utf8**\n- **gbk**\n- **latin1**\n- **utf8mb4**。",
      "AllowedValues": [
        "utf8",
        "gbk",
        "latin1",
        "utf8mb4"
      ],
      "Default": "utf8"
    },
    "DBInstanceId": {
      "Type": "String",
      "Description": "インスタンス ID。",
      "Default": "drdshh****"
    },
    "DatabaseName": {
      "Type": "String",
      "Description": "データベースの名前。",
      "Default": "test1"
    },
    "Accounts": {
      "Type": "Json",
      "Description": "アカウントのリスト。",
      "Default": [
        {
          "AccountPrivilege": "ReadWrite",
          "AccountName": "test1"
        }]
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::PolarDBX::Database",
      "Properties": {
        "CharacterSetName": {
          "Ref": "CharacterSetName"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "DatabaseName": {
          "Ref": "DatabaseName"
        },
        "Accounts": {
          "Ref": "Accounts"
        }
      }
    }
  },
  "Outputs": {
    "CharacterSetName": {
      "Description": "文字セット。以下の文字セットをサポートします。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CharacterSetName"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "インスタンス ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DBInstanceId"
        ]
      }
    },
    "DatabaseName": {
      "Description": "データベースの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DatabaseName"
        ]
      }
    },
    "DatabaseDescription": {
      "Description": "データベースの説明情報。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DatabaseDescription"
        ]
      }
    },
    "Accounts": {
      "Description": "アカウントのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Accounts"
        ]
      }
    }
  }
}