ALIYUN::DMS::Instanceを使用して企業のデータベースインスタンスを登録する - Resource Orchestration Service

ALIYUN::DMS::Instanceは、企業のデータベースインスタンスを登録するために使用されます。

構文

{
  "タイプ": "ALIYUN::DMS:: インスタンス" 、
  "Properties": {
    "InstanceSource": 文字列、
    "DatabasePassword": 文字列、
    "ポート": 整数、
    "ホスト": 文字列、
    "ExportTimeout": 整数、
    "SafeRule": 文字列、
    "DdlOnline": 整数、
    "EnvType": 文字列、
    "Tid": 整数、
    "UseDsql": 整数、
    "Sid": ストリング、
    "EcsInstanceId": 文字列、
    "VpcId": String,
    "InstanceAlias": 文字列、
    "DbaUid": 整数、
    "EcsRegion": 文字列、
    "NetworkType": String,
    "DatabaseUser": 文字列、
    "InstanceType": String,
    "DataLinkName": 文字列、
    "QueryTimeout": 整数
  }
}

プロパティ

プロパティ	データ型	必須	編集可能	説明	制約条件
InstanceSource	String	課金されます	課金されません	データベースインスタンスのソース。	有効な値： PUBLIC_OWN: インターネットにデプロイされた自己管理型データベースインスタンス RDS: ApsaraDB RDSインスタンス ECS_OWN: Elastic Compute Service (ECS) インスタンスにデプロイされた自己管理型データベース VPC_IDC: 仮想プライベートクラウド (VPC) を介して接続されたデータセンターにデプロイされた自己管理型データベースインスタンス
DatabasePassword	String	課金されます	課金されます	データベースインスタンスへの接続に使用されるパスワード。	なし。
ポート	Integer	課金されます	課金されません	データベースインスタンスへの接続に使用されるポート番号。	なし。
ホスト	String	課金されます	課金されません	データベースインスタンスへの接続に使用されるホストアドレス。	なし。
ExportTimeout	Integer	課金されます	課金されます	データをエクスポートするためのタイムアウト期間。	単位は秒です。
セーフルール	String	課金されます	課金されます	データベースインスタンスのセキュリティルールの名前。企業に属するセキュリティルールの名前を指定します。	なし。
DdlOnline	Integer	課金されません	課金されません	ロックフリースキーマ変更機能を使用するかどうかを指定します。	有効な値： 0: ロックフリースキーマ変更機能を無効にします。 1: 最初にMySQLのネイティブオンラインDDL操作を使用します。 2: 最初にデータ管理 (DMS) のロックフリースキーマ変更機能を使用します。説明 MySQLおよびPolarDBデータベースのみがサポートされています。
EnvType	String	課金されます	課金されます	環境タイプ。	有効な値：プロダクト: 生产の环境 dev: 開発環境 pre: プレリリース環境テスト: テスト環境 sit: システム統合テスト (SIT) 環境 uat: ユーザー受け入れテスト (UAT) 環境ペット: ストレステスト环境 stag: ステージング環境
ティッド	Integer	課金されません	課金されません	テナントID。	なし。
UseDsql	Integer	課金されません	課金されません	データベースインスタンスのデータベース間クエリ機能を有効にするかどうかを指定します。	有効な値： 0: データベースインスタンスのクロスデータベースクエリ機能を無効にします。 1: データベースインスタンスのクロスデータベースクエリ機能を有効にします。
シド	String	課金されません	課金されません	データベースインスタンスのシステムID (SID) 。	このプロパティは、InstanceTypeがPostgreSQLまたはOracleに設定されている場合に指定する必要があります。
EcsInstanceId	String	課金されません	課金されません	ECSインスタンスのID。	このプロパティは、InstanceSourceがECS_OWNに設定されている場合に指定する必要があります。
VpcId	String	課金されません	課金されません	VPC ID	InstanceSourceがVPC_IDCに設定されている場合、このプロパティを指定する必要があります。
InstanceAlias	String	課金されます	課金されます	データベースインスタンスの名前。	なし。
DbaUid	Integer	課金されます	課金されません	データベースインスタンスが属するAlibaba CloudアカウントのユーザーID。	なし。
EcsRegion	String	課金されません	課金されません	データベースインスタンスのリージョンID。	InstanceSourceがRDS、ECS_OWN、またはVPC_IDCに設定されている場合、このプロパティを指定する必要があります。
NetworkType	String	課金されます	課金されません	ネットワークタイプ。	有効な値： CLASSIC VPC
DatabaseUser	String	課金されます	課金されます	データベースインスタンスへの接続に使用されるアカウント。	なし。
InstanceType	String	課金されます	課金されません	データベースインスタンスのタイプ。	有効な値： MySQL SQL サーバー PostgreSQL Oracle DRDS OceanBase モンゴ Redis
DataLinkName	String	課金されません	課金されません	クロスデータベースクエリのデータベースリンクの名前。	なし。
QueryTimeout	Integer	課金されます	課金されます	データを照会するためのタイムアウト期間。	単位は秒です。

戻り値

Fn::GetAtt

InstanceId: データベースインスタンスのID。
ポート: データベースインスタンスへの接続に使用されるポート番号。
ホスト: データベースインスタンスへの接続に使用されるホストアドレス。

例

YAML形式

ROSTemplateFormatVersion: '2015-09-01'
パラメータ:
  InstanceSource:
    データ型：Strig
    説明: >-
      データベースインスタンスのソース。 有効な値：
      PUBLIC_OWN: パブリックネットワーク上に構築されたオンプレミスデータベース
      RDS: ApsaraDB for RDS (RDS) インスタンス。
      ECS_OWN: Elastic Compute Service (ECS) 上に構築されたオンプレミスデータベース
      instance.
      VPC_IDC: インターネットデータセンター (IDC) に構築されたオンプレミスデータベース
      仮想プライベート
      クラウド (VPC) 。
  DatabasePassword:
    データ型：Strig
    説明: データベースインスタンスのログインパスワード。
  ポート:
    タイプ: 数
    説明: データベースインスタンスの接続ポート。
  ホスト:
    データ型：Strig
    説明: データベースインスタンスのエンドポイント。
  ExportTimeout:
    タイプ: 数
    説明: 'データベースインスタンスをエクスポートするためのタイムアウト期間。 単位: 秒。'
  SafeRule:
    データ型：Strig
    説明: >-
      データベースインスタンスのセキュリティルール。 セキュリティの名前を入力してください
      のルール
      あなたの企業。
      注指定されたセキュリティルールをクエリするには、DMS Enterpriseにログインします。
      コンソールと選択
      システム管理> セキュリティルール。 セキュリティルールは、
      セキュリティルール
      します。
  DdlOnline:
    タイプ: 数
    説明: >-
      [重要] オンラインデータの説明を有効にするかどうかを指定します
      言語 (DDL)

      サービスを作成します。 現在、このサービスはMySQLと
      PolarDBデータベース。
      0: サービスが無効です。
      1: ネイティブオンラインDDLサービスが優先します。
      2: DMSが提供するテーブルロックなしのデータ変更が優勢です。
  EnvType:
    データ型：Strig
    説明: >-
      データベースインスタンスが属する環境のタイプ。 有効
      values:
      プロダクト: 生産の環境。
      dev: テスト環境。
  Tid:
    タイプ: 数
    説明: >-
      テナントのID。
      注IDを照会するには、DMS Enterpriseコンソールにログインし、
      システム管理
      > インスタンス管理またはシステム管理> ユーザー管理。 のIDは、
      テナント
      サービス仕様セクションに表示されます。
  UseDsql:
    タイプ: 数
    説明: >-
      データベースのクロスデータベースクエリを有効にするかどうかを指定します。
      instance. 有効
      values:
      0：無効
      1：有効
    AllowedValues:
      -0
      -1
  シド:
    データ型：Strig
    説明: >-
      データベースインスタンスのシステムID (SID) 。
      注InstanceTypeパラメーターが設定されている場合は、このパラメーターを指定する必要があります。
      PostgreSQLまたはOracleに変換します。
  EcsInstanceId:
    データ型：Strig
    説明: >-
      データベースインスタンスが属するECSインスタンスのID。
      注InstanceSourceパラメーターが
      ECS_OWNに設定します。
  VpcId:
    データ型：Strig
    説明: >-
      データベースインスタンスが属するVPCのID。
      注InstanceSourceパラメーターが
      VPC_IDCに設定します。
  DbaUid:
    タイプ: 数
    説明: >-
      のデータベース管理者 (DBA) のAlibaba Cloud一意ID (UID)
      データベース
      instance.
      注UIDを照会するには、DMS Enterpriseコンソールにログインし、
      システム管理
      > ユーザー管理。
  EcsRegion:
    データ型：Strig
    説明: >-
      データベースインスタンスが存在するリージョン。
      注InstanceSourceパラメーターが
      ECS_OWNまたはVPC_IDCに設定します。
  NetworkType:
    データ型：Strig
    説明: |-
      データベースインスタンスのネットワークタイプ。 有効な値：
      CLASSIC
      VPC
    AllowedValues:
      -クラシック
      -VPC
  InstanceAlias:
    データ型：Strig
    説明: >-
      データベースインスタンスのエイリアス。 エイリアスを使用すると、
      required
      instance.
  DatabaseUser:
    データ型：Strig
    説明: データベースインスタンスのログインユーザー名。
  InstanceType:
    データ型：Strig
    説明: >-
      データベースインスタンスのタイプ。 有効な値: MySQL、SQLServer、
      PostgreSQL、Oracle、DRDS、OceanBase、Mongo、Redis
    AllowedValues:
      -MySQL
      -SQLServer
      -PostgreSQL
      -オラクル
      -DRDS
      -OceanBase
      -モンゴ
      -Redis
  DataLinkName:
    データ型：Strig
    説明: データベース間クエリのデータリンクの名前。
  QueryTimeout:
    タイプ: 数
    説明: 'データベースインスタンスを照会するためのタイムアウト期間。 単位: 秒。'
リソース:
  インスタンス：
    タイプ: 'ALIYUN::DMS::Instance'
    プロパティ:
      InstanceSource:
        参照: InstanceSource
      DatabasePassword:
        参照: DatabasePassword
      ポート:
        参照: ポート
      ホスト:
        参照: ホスト
      ExportTimeout:
        参照: ExportTimeout
      SafeRule:
        参照: SafeRule
      DdlOnline:
        参照: DdlOnline
      EnvType:
        参照: EnvType
      Tid:
        参照: ティッド
      UseDsql:
        参照: UseDsql
      シド:
        参照: シド
      EcsInstanceId:
        参照: EcsInstanceId
      VpcId:
        参照: VpcId
      DbaUid:
        参照: DbaUid
      EcsRegion:
        参照: EcsRegion
      NetworkType:
        参照: NetworkType
      InstanceAlias:
        参照: InstanceAlias
      DatabaseUser:
        参照: DatabaseUser
      InstanceType:
        参照: InstanceType
      DataLinkName:
        参照: DataLinkName
      QueryTimeout:
        参照: QueryTimeout
出力:
  InstanceId:
    説明: データベースインスタンスのID。
    値：
      'Fn::GetAtt':
        -インスタンス
        -InstanceId
  ポート:
    説明: データベースインスタンスの接続ポート。
    値：
      'Fn::GetAtt':
        -インスタンス
        -ポート
  ホスト:
    説明: データベースインスタンスのエンドポイント。
    値：
      'Fn::GetAtt':
        -インスタンス
        -ホスト

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\nCloud (VPC) のインターネットデータセンター (IDC) に構築されたオンプレミスデータベース。"
    },
    "DatabasePassword": {
      "Type": "String",
      "Description": "データベースインスタンスのログインパスワード。
    },
    "ポート": {
      "Type": "Number",
      "Description": "データベースインスタンスの接続ポート。
    },
    "ホスト": {
      "Type": "String",
      "Description": "データベースインスタンスのエンドポイント。
    },
    "ExportTimeout": {
      "Type": "Number",
      "Description": "データベースインスタンスをエクスポートするためのタイムアウト期間。 単位: 秒。"
    },
    "SafeRule": {
      "Type": "String",
      "Description": "データベースインスタンスのセキュリティルール。 \nエンタープライズのセキュリティルールの名前を入力します。\n指定されたセキュリティルールを照会するには、DMS enterpriseコンソールにログインし、\n System Management> セキュリティルールを選択します。 セキュリティルールがセキュリティルール \nlistに表示されます。
    },
    "DdlOnline": {
      "Type": "Number",
      "Description": "[重要] オンラインデータ記述言語 (DDL)\nserviceを有効にするかどうかを指定します。 現在、このサービスはMySQLおよびPolarDBデータベースでのみ使用できます。\n0: サービスは無効です。\n1: ネイティブオンラインDDLサービスが優先します。\n2: DMSが提供するテーブルロックなしのデータ変更が優先します。
    },
    "EnvType": {
      "Type": "String",
      "Description": "データベースインスタンスが属する環境のタイプ。 有効な値:\nproduct: 本番環境。\ndev: テスト環境。
    },
    "Tid": {
      "Type": "Number",
      "説明": "テナントのID。\n注IDを照会するには、DMS Enterpriseコンソールにログインし、[システム管理] \n> [インスタンス管理] または [システム管理]> [ユーザー管理] を選択します。 テナントのIDは、サービス仕様セクションに表示されます。
    },
    "UseDsql": {
      "Type": "Number",
      "Description": "データベースインスタンスのクロスデータベースクエリを有効にするかどうかを指定します。 有効な \n値:\n0: disabled\n1: enabled "、
      "AllowedValues": [
        0,
        1
      ]
    },
    "Sid": {
      "Type": "String",
      "Description": "データベースインスタンスのシステムID (SID) 。\n InstanceTypeパラメーターがPostgreSQLまたはOracleに設定されている場合は、このパラメーターを指定する必要があります。
    },
    "EcsInstanceId": {
      "Type": "String",
      "説明": "データベースインスタンスが属するECSインスタンスのIDです。\n InstanceSourceパラメーターがECS_OWNに設定されている場合は、このパラメーターを指定する必要があります。
    },
    "VpcId": {
      "Type": "String",
      "Description": "データベースインスタンスが属するVPCのIDです。\n InstanceSourceパラメーターがVPC_IDCに設定されている場合は、このパラメーターを指定する必要があります。
    },
    "DbaUid": {
      "Type": "Number",
      "説明": "データベースのデータベース管理者 (DBA) のAlibaba Cloud一意ID (UID) \ninstance。\n注意UIDを照会するには、DMS Enterpriseコンソールにログインし、[システム管理] \n> [ユーザー管理] を選択します。
    },
    "EcsRegion": {
      "Type": "String",
      "説明": "データベースインスタンスが存在するリージョンです。\n InstanceSourceパラメーターがECS_OWNまたはVPC_IDCに設定されている場合は、このパラメーターを指定する必要があります。
    },
    "NetworkType": {
      "Type": "String",
      "Description": "データベースインスタンスのネットワークタイプ。 有効な値:\nCLASSIC\nVPC "、
      "AllowedValues": [
        "クラシック" 、
        "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" 、
        "オラクル" 、
        "DRDS" 、
        "OceanBase" 、
        "モンゴ" 、
        「Redis」
      ]
    },
    "DataLinkName": {
      "Type": "String",
      "Description": "クロスデータベースクエリのデータリンクの名前。
    },
    "QueryTimeout": {
      "Type": "Number",
      "Description": "データベースインスタンスを照会するためのタイムアウト期間。 単位: 秒。"
    }
  },
  "Resources": {
    "インスタンス": {
      "タイプ": "ALIYUN::DMS:: インスタンス" 、
      "Properties": {
        "InstanceSource": {
          "Ref": "InstanceSource"
        },
        "DatabasePassword": {
          "Ref": "DatabasePassword"
        },
        "ポート": {
          "Ref": "ポート"
        },
        "ホスト": {
          "Ref": "ホスト"
        },
        "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": [
          「インスタンス」、
          "InstanceId"
        ]
      }
    },
    "ポート": {
      "Description": "データベースインスタンスの接続ポート" 、
      "Value": {
        "Fn::GetAtt": [
          「インスタンス」、
          「ポート」
        ]
      }
    },
    "ホスト": {
      "Description": "データベースインスタンスのエンドポイント。" 、
      "Value": {
        "Fn::GetAtt": [
          「インスタンス」、
          「ホスト」
        ]
      }
    }
  }
}