ALIYUN::DMS::Instance - DMS データベースインスタンスの登録 - Resource Orchestration Service

ALIYUN::DMS::Instance は、企業向けにデータベースインスタンスを登録します。

構文

{
  "Type": "ALIYUN::DMS::Instance",
  "Properties": {
    "InstanceSource": String,
    "DatabasePassword": String,
    "Port": Integer,
    "Host": String,
    "ExportTimeout": Integer,
    "SafeRule": String,
    "DdlOnline": Integer,
    "EnvType": String,
    "Tid": Integer,
    "UseDsql": Integer,
    "Sid": String,
    "EcsInstanceId": String,
    "VpcId": String,
    "InstanceAlias": String,
    "DbaUid": Integer,
    "EcsRegion": String,
    "NetworkType": String,
    "DatabaseUser": String,
    "InstanceType": String,
    "DataLinkName": String,
    "QueryTimeout": Integer
  }
}

プロパティ

プロパティ名	タイプ	必須	更新の許可	説明	制約
InstanceSource	String	はい	いいえ	データベースインスタンスのソース。	有効値： PUBLIC_OWN: パブリックネットワーク上のセルフマネージドデータベース RDS: ApsaraDB RDS インスタンス ECS_OWN: ECS インスタンス上のセルフマネージドデータベース VPC_IDC: VPC に接続されたデータセンター内のセルフマネージドデータベース
DatabasePassword	String	はい	はい	データベースインスタンスに接続するためのパスワード。	なし。
Port	Integer	はい	いいえ	データベースインスタンスの接続ポート。	なし。
Host	String	はい	いいえ	データベースインスタンスのエンドポイント。	なし。
ExportTimeout	Integer	はい	はい	データエクスポートのタイムアウト期間。	単位：秒。
SafeRule	String	はい	はい	データベースインスタンスに適用する、企業のセキュリティルールセットの名前。	なし。
DdlOnline	Integer	いいえ	いいえ	オンライン DDL サービスを有効にするかどうかを指定します。	有効値： 0: 無効 1: ネイティブのオンライン DDL を優先 2: DMS のロックフリーのスキーマ変更を優先説明 MySQL と PolarDB でのみサポートされています。
EnvType	String	はい	はい	環境タイプ。	有効値： product: 本番環境 dev: 開発環境 pre: プレリリース環境 test: テスト環境 sit: システム統合テスト (SIT) 環境 uat: ユーザー受け入れテスト (UAT) 環境 pet: ストレステスト環境 stag: ステージング環境
Tid	Integer	いいえ	いいえ	テナント ID。	なし。
UseDsql	Integer	いいえ	いいえ	クロスインスタンスクエリを有効にするかどうかを指定します。	有効値： 0: 無効 1: 有効
Sid	String	いいえ	いいえ	データベースのシステム ID (SID)。	InstanceType が PostgreSQL または Oracle の場合に必須です。
EcsInstanceId	String	いいえ	いいえ	ECS インスタンスの ID。	InstanceSource が ECS_OWN の場合に必須です。
VpcId	String	いいえ	いいえ	VPC ID。	InstanceSource が VPC_IDC の場合に必須です。
InstanceAlias	String	はい	はい	データベースインスタンスのエイリアス。	なし。
DbaUid	Integer	はい	いいえ	データベースインスタンスのデータベース管理者 (DBA) の Alibaba Cloud UID。	なし。
EcsRegion	String	いいえ	いいえ	インスタンスが存在するリージョン。	InstanceSource が RDS、ECS_OWN、または VPC_IDC の場合に必須です。
NetworkType	String	はい	いいえ	ネットワークタイプ。	有効値： CLASSIC: クラシックネットワーク VPC: 仮想プライベートクラウド
DatabaseUser	String	はい	はい	データベースインスタンスに接続するためのユーザー名。	なし。
InstanceType	String	はい	いいえ	データベースインスタンスのタイプ。	有効値： MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis
DataLinkName	String	いいえ	いいえ	クロスデータベースクエリ用のデータリンク名。	なし。
QueryTimeout	Integer	はい	はい	データクエリのタイムアウト期間。	単位：秒。

戻り値

Fn::GetAtt

InstanceId：データベースインスタンスの ID。
Port：データベースインスタンスの接続ポート。
Host：データベースインスタンスのエンドポイント。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceSource:
    Type: String
    Description: >-
      データベースインスタンスのソース。 有効値：
      PUBLIC_OWN: パブリックネットワーク上に構築されたセルフマネージドデータベース
      RDS: ApsaraDB for RDS (RDS) インスタンス。
      ECS_OWN: Elastic Compute Service (ECS) インスタンス上に構築されたセルフマネージドデータベース。
      VPC_IDC: Virtual Private Cloud (VPC) 内のインターネットデータセンター (IDC) に構築されたセルフマネージドデータベース。
  DatabasePassword:
    Type: String
    Description: データベースインスタンスのログオンパスワード。
  Port:
    Type: Number
    Description: データベースインスタンスの接続ポート。
  Host:
    Type: String
    Description: データベースインスタンスのエンドポイント。
  ExportTimeout:
    Type: Number
    Description: 'データエクスポートのタイムアウト期間。 単位：秒。'
  SafeRule:
    Type: String
    Description: >-
      データベースインスタンスのセキュリティルール。 企業向けのセキュリティルールの名前を入力します。
      注：指定したセキュリティルールを照会するには、DMS Enterprise コンソールにログインし、 [System Management] > [Security Rules] を選択します。 セキュリティルールがセキュリティルールリストに表示されます。
  DdlOnline:
    Type: Number
    Description: >-
      [重要] オンラインデータ記述言語 (DDL) サービスを有効にするかどうかを指定します。
      現在、このサービスは MySQL および PolarDB データベースでのみ利用可能です。
      0: サービスは無効です。
      1: ネイティブのオンライン DDL サービスが優先されます。
      2: DMS のロックフリーのスキーマ変更が優先されます。
  EnvType:
    Type: String
    Description: >-
      データベースインスタンスが属する環境のタイプ。 有効値：
      product: 本番環境。
      dev: 開発環境。
  Tid:
    Type: Number
    Description: >-
      テナントの ID。
      注：ID を照会するには、DMS Enterprise コンソールにログインし、 [System Management] > [Instance Management] または [System Management] > [User Management] を選択します。 テナントの ID は、 [Service Specification] セクションに表示されます。
  UseDsql:
    Type: Number
    Description: >-
      データベースインスタンスのクロスデータベースクエリを有効にするかどうかを指定します。 有効値：
      0: 無効
      1: 有効
    AllowedValues:
      - 0
      - 1
  Sid:
    Type: String
    Description: >-
      データベースインスタンスのシステム ID (SID)。
      注：InstanceType パラメーターが PostgreSQL または Oracle に設定されている場合は、このパラメーターを指定する必要があります。
  EcsInstanceId:
    Type: String
    Description: >-
      データベースインスタンスが属する ECS インスタンスの ID。
      注：InstanceSource パラメーターが ECS_OWN に設定されている場合は、このパラメーターを指定する必要があります。
  VpcId:
    Type: String
    Description: >-
      データベースインスタンスが属する VPC の ID。
      注：InstanceSource パラメーターが VPC_IDC に設定されている場合は、このパラメーターを指定する必要があります。
  DbaUid:
    Type: Number
    Description: >-
      データベースインスタンスのデータベース管理者 (DBA) の Alibaba Cloud ユニーク ID (UID)。
      注：UID を照会するには、DMS Enterprise コンソールにログインし、 [System Management] > [User Management] を選択します。
  EcsRegion:
    Type: String
    Description: >-
      データベースインスタンスが存在するリージョン。
      注：InstanceSource パラメーターが RDS、ECS_OWN、または VPC_IDC に設定されている場合は、このパラメーターを指定する必要があります。
  NetworkType:
    Type: String
    Description: |-
      データベースインスタンスのネットワークタイプ。 有効値：
      CLASSIC
      VPC
    AllowedValues:
      - CLASSIC
      - VPC
  InstanceAlias:
    Type: String
    Description: >-
      データベースインスタンスのエイリアス。 エイリアスを使用すると、必要なインスタンスをすばやく見つけることができます。
  DatabaseUser:
    Type: String
    Description: データベースインスタンスのログオンユーザー名。
  InstanceType:
    Type: String
    Description: >-
      データベースインスタンスのタイプ。 有効値：MySQL、SQLServer、PostgreSQL、Oracle、DRDS、OceanBase、Mongo、Redis
    AllowedValues:
      - MySQL
      - SQLServer
      - PostgreSQL
      - Oracle
      - DRDS
      - OceanBase
      - Mongo
      - Redis
  DataLinkName:
    Type: String
    Description: クロスデータベースクエリ用のデータリンクの名前。
  QueryTimeout:
    Type: Number
    Description: 'データクエリのタイムアウト期間。 単位：秒。'
Resources:
  Instance:
    Type: 'ALIYUN::DMS::Instance'
    Properties:
      InstanceSource:
        Ref: InstanceSource
      DatabasePassword:
        Ref: DatabasePassword
      Port:
        Ref: Port
      Host:
        Ref: Host
      ExportTimeout:
        Ref: ExportTimeout
      SafeRule:
        Ref: SafeRule
      DdlOnline:
        Ref: DdlOnline
      EnvType:
        Ref: EnvType
      Tid:
        Ref: Tid
      UseDsql:
        Ref: UseDsql
      Sid:
        Ref: Sid
      EcsInstanceId:
        Ref: EcsInstanceId
      VpcId:
        Ref: VpcId
      DbaUid:
        Ref: DbaUid
      EcsRegion:
        Ref: EcsRegion
      NetworkType:
        Ref: NetworkType
      InstanceAlias:
        Ref: InstanceAlias
      DatabaseUser:
        Ref: DatabaseUser
      InstanceType:
        Ref: InstanceType
      DataLinkName:
        Ref: DataLinkName
      QueryTimeout:
        Ref: QueryTimeout
Outputs:
  InstanceId:
    Description: データベースインスタンスの ID。
    Value:
      'Fn::GetAtt':
        - Instance
        - InstanceId
  Port:
    Description: データベースインスタンスの接続ポート。
    Value:
      'Fn::GetAtt':
        - Instance
        - Port
  Host:
    Description: データベースインスタンスのエンドポイント。
    Value:
      'Fn::GetAtt':
        - Instance
        - Host

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceSource": {
      "Type": "String",
      "Description": "データベースインスタンスのソース。 有効値：\nPUBLIC_OWN: パブリックネットワーク上に構築されたセルフマネージドデータベース。\nRDS: ApsaraDB for RDS (RDS) インスタンス。\nECS_OWN: Elastic Compute Service (ECS) インスタンス上に構築されたセルフマネージドデータベース。\nVPC_IDC: Virtual Private Cloud (VPC) 内のインターネットデータセンター (IDC) に構築されたセルフマネージドデータベース。"
    },
    "DatabasePassword": {
      "Type": "String",
      "Description": "データベースインスタンスのログオンパスワード。"
    },
    "Port": {
      "Type": "Number",
      "Description": "データベースインスタンスの接続ポート。"
    },
    "Host": {
      "Type": "String",
      "Description": "データベースインスタンスのエンドポイント。"
    },
    "ExportTimeout": {
      "Type": "Number",
      "Description": "データエクスポートのタイムアウト期間。 単位：秒。"
    },
    "SafeRule": {
      "Type": "String",
      "Description": "データベースインスタンスのセキュリティルール。 企業向けのセキュリティルールの名前を入力します。\n注：指定したセキュリティルールを照会するには、DMS Enterprise コンソールにログインし、 [System Management] > [Security Rules] を選択します。 セキュリティルールがセキュリティルールリストに表示されます。"
    },
    "DdlOnline": {
      "Type": "Number",
      "Description": "[重要] オンラインデータ記述言語 (DDL) サービスを有効にするかどうかを指定します。\n現在、このサービスは MySQL および PolarDB データベースでのみ利用可能です。\n0: サービスは無効です。\n1: ネイティブのオンライン DDL サービスが優先されます。\n2: DMS のロックフリーのスキーマ変更が優先されます。"
    },
    "EnvType": {
      "Type": "String",
      "Description": "データベースインスタンスが属する環境のタイプ。 有効値：\nproduct: 本番環境。\ndev: 開発環境。"
    },
    "Tid": {
      "Type": "Number",
      "Description": "テナントの ID。\n注：ID を照会するには、DMS Enterprise コンソールにログインし、 [System Management]\n> [Instance Management] または [System Management] > [User Management] を選択します。 テナントの ID は、\n[Service Specification] セクションに表示されます。"
    },
    "UseDsql": {
      "Type": "Number",
      "Description": "データベースインスタンスのクロスデータベースクエリを有効にするかどうかを指定します。 有効値：\n0: 無効\n1: 有効",
      "AllowedValues": [
        0,
        1
      ]
    },
    "Sid": {
      "Type": "String",
      "Description": "データベースインスタンスのシステム ID (SID)。\n注：InstanceType パラメーターが PostgreSQL または Oracle に設定されている場合は、このパラメーターを指定する必要があります。"
    },
    "EcsInstanceId": {
      "Type": "String",
      "Description": "データベースインスタンスが属する ECS インスタンスの ID。\n注：InstanceSource パラメーターが ECS_OWN に設定されている場合は、このパラメーターを指定する必要があります。"
    },
    "VpcId": {
      "Type": "String",
      "Description": "データベースインスタンスが属する VPC の ID。\n注：InstanceSource パラメーターが VPC_IDC に設定されている場合は、このパラメーターを指定する必要があります。"
    },
    "DbaUid": {
      "Type": "Number",
      "Description": "データベースインスタンスのデータベース管理者 (DBA) の Alibaba Cloud ユニーク ID (UID)。\n注：UID を照会するには、DMS Enterprise コンソールにログインし、 [System Management]\n> [User Management] を選択します。"
    },
    "EcsRegion": {
      "Type": "String",
      "Description": "データベースインスタンスが存在するリージョン。\n注：InstanceSource パラメーターが RDS、ECS_OWN、または VPC_IDC に設定されている場合は、このパラメーターを指定する必要があります。"
    },
    "NetworkType": {
      "Type": "String",
      "Description": "データベースインスタンスのネットワークタイプ。 有効値：\nCLASSIC\nVPC",
      "AllowedValues": [
        "CLASSIC",
        "VPC"
      ]
    },
    "InstanceAlias": {
      "Type": "String",
      "Description": "データベースインスタンスのエイリアス。 エイリアスを使用すると、必要なインスタンスをすばやく見つけることができます。"
    },
    "DatabaseUser": {
      "Type": "String",
      "Description": "データベースインスタンスのログオンユーザー名。"
    },
    "InstanceType": {
      "Type": "String",
      "Description": "データベースインスタンスのタイプ。 有効値：MySQL、SQLServer、PostgreSQL、Oracle、DRDS、OceanBase、Mongo、Redis",
      "AllowedValues": [
        "MySQL",
        "SQLServer",
        "PostgreSQL",
        "Oracle",
        "DRDS",
        "OceanBase",
        "Mongo",
        "Redis"
      ]
    },
    "DataLinkName": {
      "Type": "String",
      "Description": "クロスデータベースクエリ用のデータリンクの名前。"
    },
    "QueryTimeout": {
      "Type": "Number",
      "Description": "データクエリのタイムアウト期間。 単位：秒。"
    }
  },
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::DMS::Instance",
      "Properties": {
        "InstanceSource": {
          "Ref": "InstanceSource"
        },
        "DatabasePassword": {
          "Ref": "DatabasePassword"
        },
        "Port": {
          "Ref": "Port"
        },
        "Host": {
          "Ref": "Host"
        },
        "ExportTimeout": {
          "Ref": "ExportTimeout"
        },
        "SafeRule": {
          "Ref": "SafeRule"
        },
        "DdlOnline": {
          "Ref": "DdlOnline"
        },
        "EnvType": {
          "Ref": "EnvType"
        },
        "Tid": {
          "Ref": "Tid"
        },
        "UseDsql": {
          "Ref": "UseDsql"
        },
        "Sid": {
          "Ref": "Sid"
        },
        "EcsInstanceId": {
          "Ref": "EcsInstanceId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "DbaUid": {
          "Ref": "DbaUid"
        },
        "EcsRegion": {
          "Ref": "EcsRegion"
        },
        "NetworkType": {
          "Ref": "NetworkType"
        },
        "InstanceAlias": {
          "Ref": "InstanceAlias"
        },
        "DatabaseUser": {
          "Ref": "DatabaseUser"
        },
        "InstanceType": {
          "Ref": "InstanceType"
        },
        "DataLinkName": {
          "Ref": "DataLinkName"
        },
        "QueryTimeout": {
          "Ref": "QueryTimeout"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "データベースインスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "Port": {
      "Description": "データベースインスタンスの接続ポート。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Port"
        ]
      }
    },
    "Host": {
      "Description": "データベースインスタンスのエンドポイント。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Host"
        ]
      }
    }
  }
}