ROS スタックで DMS にデータベースインスタンスを登録 - Resource Orchestration Service (ROS)

ALIYUN::DMS::Instance2 は、新しいデータ管理 (DMS) にデータベースインスタンスを登録するために使用されます。

構文

{
  "Type": "ALIYUN::DMS::Instance2",
  "Properties": {
    "DatabasePassword": String,
    "DbaId": Integer,
    "DatabaseUser": String,
    "ExportTimeout": Integer,
    "EnvType": String,
    "EnableSellTrust": String,
    "Host": String,
    "InstanceAlias": String,
    "InstanceType": String,
    "InstanceSource": String,
    "NetworkType": String,
    "Port": Integer,
    "QueryTimeout": Integer,
    "SafeRule": String,
    "DataLinkName": String,
    "DdlOnline": Integer,
    "EcsRegion": String,
    "EnableSellSitd": String,
    "EnableSellStable": String,
    "EnableSellCommon": String,
    "EcsInstanceId": String,
    "SkipTest": Boolean,
    "Sid": String,
    "TemplateId": Integer,
    "TemplateType": String,
    "Tid": Integer,
    "UseSsl": Integer,
    "UseDsql": Integer,
    "VpcId": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
DatabasePassword	String	はい	はい	データベースアカウントのパスワード。	なし。
DbaId	Integer	はい	はい	データベースインスタンスのデータベース管理者 (DBA) ロールを担当するユーザーの ID。	なし。
DatabaseUser	String	はい	はい	データベースアカウント。	なし。
ExportTimeout	Integer	はい	はい	データエクスポートのタイムアウト期間。	単位：秒。
EnvType	String	はい	はい	環境のタイプ。	有効な値： product：本番環境。 dev：開発環境。 pre：プレリリース環境。 test：テスト環境。 sit：システム統合テスト (SIT) 環境。 uat：ユーザー受け入れテスト (UAT) 環境。 pet：ストレステスト環境。 stag：ステージング環境。
EnableSellTrust	String	はい	はい	データベースインスタンスのセキュリティホスティング機能を有効にするかどうかを指定します。	有効な値： Y：データベースインスタンスのセキュリティホスティング機能を有効にします。 NULL またはその他の値：データベースインスタンスのセキュリティホスティング機能を無効にします。
Host	String	はい	はい	データベースのエンドポイント。	なし。
InstanceAlias	String	はい	はい	データベースインスタンスのエイリアス。	なし。
InstanceType	String	はい	はい	データベースエンジンのタイプ。	なし。
InstanceSource	String	はい	はい	データベースインスタンスのソース。	有効な値： PUBLIC_OWN：インターネット上にデプロイされている自己管理データベースインスタンス。 RDS：ApsaraDB RDS インスタンス。 ECS_OWN：Elastic Compute Service (ECS) インスタンス上にデプロイされている自己管理データベースインスタンス。 VPC_IDC：仮想プライベートクラウド (VPC) 経由で接続されたデータセンターにデプロイされている自己管理データベースインスタンス。 GATEWAY：database gateway を使用して接続されたデータベースインスタンス。
NetworkType	String	はい	はい	ネットワークのタイプ。	有効な値： CLASSIC：クラシックネットワーク。 VPC：VPC。
Port	Integer	はい	はい	データベースインスタンスのポート。	なし。
QueryTimeout	Integer	はい	はい	データクエリ用のタイムアウト期間。	単位：秒。
SafeRule	String	はい	はい	データベースインスタンスに構成するセキュリティルールセット。セキュリティルールセットの名前は GroupName によって指定されます。	なし。
DataLinkName	String	いいえ	はい	クロスデータベースクエリ用のデータベースリンクの名前。	説明このプロパティは、UseDsql が 1 に設定されている場合に指定する必要があります。名前に使用できるのは、小文字とアンダースコア (_) のみです。名前はテナント内で一意である必要があります。
DdlOnline	Integer	いいえ	はい	ロックフリースキーマ変更機能を有効にするかどうかを指定します。	有効な値： 0：ロックフリースキーマ変更機能を無効にします。 1：最初に MySQL のオンライン DDL を使用します。 2：ロックフリースキーマ変更機能を有効にします。説明以下のタイプのデータベースがサポートされています：ApsaraDB RDS for MySQL、PolarDB for MySQL、ApsaraDB MyBase for MySQL、およびサードパーティの MySQL データベース。
EcsRegion	String	いいえ	はい	データベースインスタンスのリージョン。	説明このプロパティは、InstanceSource が RDS、ECS_OWN、GATEWAY、または VPC_IDC に設定されている場合に指定する必要があります。
EnableSellSitd	String	いいえ	はい	データベースインスタンスの機密データ保護機能を有効にするかどうかを指定します。	有効な値： Y：データベースインスタンスの機密データ保護機能を有効にします。 NULL またはその他の値：データベースインスタンスの機密データ保護機能を無効にします。
EnableSellStable	String	いいえ	はい	データベースインスタンスの安定的な変更機能を有効にするかどうかを指定します。	有効な値： Y：データベースインスタンスの安定的な変更機能を有効にします。 NULL またはその他の値：データベースインスタンスの安定的な変更機能を無効にします。
EnableSellCommon	String	いいえ	はい	データベースインスタンスのセキュリティコラボレーション機能を有効にするかどうかを指定します。	説明 Y：データベースインスタンスのセキュリティコラボレーション機能を有効にします。 NULL またはその他の値：データベースインスタンスのセキュリティコラボレーション機能を無効にします。
EcsInstanceId	String	いいえ	はい	ECS インスタンスの ID。	インスタンスが database gateway を使用して接続されたデータベースインスタンスである場合は、このプロパティの値としてゲートウェイ ID を指定します。説明このプロパティは、InstanceSource が ECS_OWN または GATEWAY に設定されている場合に指定する必要があります。
SkipTest	Boolean	いいえ	はい	データベースインスタンスの接続テストをスキップするかどうかを指定します。	有効な値： true false
Sid	String	いいえ	はい	データベースインスタンスのシステム ID (SID)。	説明このプロパティは、InstanceType が ORACLE に設定されている場合に指定する必要があります。
TemplateId	Integer	いいえ	はい	分類と等級分けテンプレートの ID。	なし。
TemplateType	String	いいえ	はい	分類と等級分けテンプレートのタイプ。	なし。
Tid	Integer	いいえ	はい	テナントの ID。	なし。
UseSsl	Integer	いいえ	はい	データベースインスタンスの SSL 接続機能を有効にするかどうかを指定します。	データベースインスタンスでこの機能を有効にすると、DMS は SSL を使用してデータベースに接続できます。このプロパティは、データベースで SSL 接続機能が既に有効になっている場合にのみ使用できます。有効な値： 0 (デフォルト)：DMS はデータベースサービスと自動的にネゴシエートして、データベースインスタンスの SSL 接続機能を有効にするかどうかを決定します。データベースでこの機能が既に有効になっている場合、DMS は SSL を使用してデータベースに接続します。データベースでこの機能が無効になっている場合、DMS は SSL を使用せずにデータベースに接続します。 1：データベースインスタンスの SSL 接続機能を有効にします。この値は、データベースで SSL 接続機能が無効になっている場合は無効です。 -1：データベースインスタンスの SSL 接続機能を無効にします。説明以下の情報にご注意ください。このプロパティは MySQL または Redis データベースにのみ使用できます。 SSL はトランスポート層でネットワーク接続を暗号化し、転送中のデータのセキュリティと整合性を向上させます。ただし、SSL はネットワーク接続の応答時間を増加させます。
UseDsql	Integer	いいえ	はい	クロスデータベースクエリ機能を有効にするかどうかを指定します。	有効な値： 0：クロスデータベースクエリ機能を無効にします。 1：クロスデータベースクエリ機能を有効にします。説明以下のタイプのデータベースがサポートされています：MySQL、SQL Server、PostgreSQL、PolarDB for Oracle、および Redis データベース。
VpcId	String	いいえ	はい	VPC の ID。	説明このプロパティは、InstanceSource が VPC_IDC に設定されている場合に指定する必要があります。

戻り値

Fn::GetAtt

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

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DatabasePassword:
    Type: String
    Description:
      ja: データベースインスタンスのログインパスワード。
    Required: true
  Port:
    Type: Number
    Description:
      ja: データベースインスタンスの接続ポート。
    Required: true
  SafeRule:
    Type: String
    Description:
      ja: |-
        データベースインスタンスのセキュリティルール。企業のセキュリティルール名を入力します。
        注：特定のセキュリティルールを照会するには、DMS Enterprise コンソールにログインし、[システム管理] > [セキュリティルール] を選択します。セキュリティルールはセキュリティルールリストに表示されます。
    Required: true
  ExportTimeout:
    Type: Number
    Description:
      ja: 'データベースインスタンスをエクスポートするためのタイムアウト期間。単位：秒。'
    Required: true
  EnvType:
    Type: String    Description:
      ja: |-
        データベースインスタンスが属する環境のタイプ。有効な値：
        product：本番環境。
        dev：テスト環境。
    Required: true
  DbaId:
    Type: Number
    Description:
      ja: インスタンス DBA ロールのユーザー ID。ListUsers または GetInstance 操作を呼び出して、このパラメータの値を取得できます。
    Required: true
  InstanceAlias:
    Type: String
    Description:
      ja: |-
        データベースインスタンスのエイリアス。エイリアスを使用すると、必要なインスタンスをすばやく見つけることができます。
    Required: true
  NetworkType:
    Type: String
    Description:
      ja: |-
        データベースインスタンスのネットワークタイプ。有効な値：
        CLASSIC
        VPC
    AllowedValues:
      - CLASSIC
      - VPC
    Required: true
  EnableSellTrust:
    Type: String
    Description:
      ja: |-
        インスタンスでセキュアホスティングを有効にする必要があるかどうか。
        - Y：セキュアホスティングモードを有効にします。
        - NULL またはその他：セキュアホスティングモードを有効にしません。
    Required: true
  InstanceType:
    Type: String
    Description:
      ja: 'データベースインスタンスのタイプ。有効な値：MySQL、SQLServer、PostgreSQL、Oracle、DRDS、OceanBase、Mongo、Redis'
    Required: true
  QueryTimeout:
    Type: Number
    Description:
      ja: 'データベースインスタンスをクエリするためのタイムアウト期間。単位：秒。'
    Required: true
  InstanceSource:
    Type: String
    Description:
      ja: |-
        データベースインスタンスのソース。有効な値：
        PUBLIC_OWN：パブリックネットワーク上に構築されたオンプレミスデータベース。
        RDS：RDS (ApsaraDB for RDS) インスタンス。
        ECS_OWN：Elastic Compute Service (ECS) インスタンス上に構築されたオンプレミスデータベース。
        VPC_IDC：Virtual Private Cloud (VPC) のインターネットデータセンター (IDC) に構築されたオンプレミスデータベース。
    Required: true
  Host:
    Type: String
    Description:
      ja: データベースインスタンスのエンドポイント。
    Required: true
  DatabaseUser:
    Type: String
    Description:
      ja: データベースインスタンスのログインユーザー名。
    Required: true
Resources:
  Instance2:
    Type: ALIYUN::DMS::Instance2
    Properties:
      DatabasePassword:
        Ref: DatabasePassword
      Port:
        Ref: Port
      SafeRule:
        Ref: SafeRule
      ExportTimeout:
        Ref: ExportTimeout
      EnvType:
        Ref: EnvType
      DbaId:
        Ref: DbaId
      InstanceAlias:
        Ref: InstanceAlias
      NetworkType:
        Ref: NetworkType
      EnableSellTrust:
        Ref: EnableSellTrust
      InstanceType:
        Ref: InstanceType
      QueryTimeout:
        Ref: QueryTimeout
      InstanceSource:
        Ref: InstanceSource
      Host:
        Ref: Host
      DatabaseUser:
        Ref: DatabaseUser
Outputs:
  InstanceId:
    Description: データベースインスタンスの ID。
    Value:
      Fn::GetAtt:
        - Instance2
        - InstanceId
  Port:
    Description: データベースインスタンスの接続ポート。
    Value:
      Fn::GetAtt:
        - Instance2
        - Port
  Host:
    Description: データベースインスタンスのエンドポイント。
    Value:
      Fn::GetAtt:
        - Instance2
        - Host

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DatabasePassword": {
      "Type": "String",
      "Description": {
        "ja": "データベースインスタンスのログインパスワード。"
      },
      "Required": true
    },
    "Port": {
      "Type": "Number",
      "Description": {
        "ja": "データベースインスタンスの接続ポート。"
      },
      "Required": true
    },
    "SafeRule": {
      "Type": "String",
      "Description": {
        "ja": "データベースインスタンスのセキュリティルール。企業のセキュリティルール名を入力します。\n注：特定のセキュリティルールを照会するには、DMS Enterprise コンソールにログインし、[システム管理] > [セキュリティルール] を選択します。セキュリティルールはセキュリティルールリストに表示されます。"
      },
      "Required": true
    },
    "ExportTimeout": {
      "Type": "Number",
      "Description": {
        "ja": "データベースインスタンスをエクスポートするためのタイムアウト期間。単位：秒。"
      },
      "Required": true
    },
    "EnvType": {
      "Type": "String",
      "Description": {
        "ja": "データベースインスタンスが属する環境のタイプ。有効な値：\nproduct：本番環境。\ndev：テスト環境。"
      },
      "Required": true
    },
    "DbaId": {
      "Type": "Number",
      "Description": {
        "ja": "インスタンス DBA ロールのユーザー ID。ListUsers または GetInstance 操作を呼び出して、このパラメータの値を取得できます。"
      },
      "Required": true
    },
    "InstanceAlias": {
      "Type": "String",
      "Description": {
        "ja": "データベースインスタンスのエイリアス。エイリアスを使用すると、必要なインスタンスをすばやく見つけることができます。"
      },
      "Required": true
    },
    "NetworkType": {
      "Type": "String",
      "Description": {
        "ja": "データベースインスタンスのネットワークタイプ。有効な値：\nCLASSIC\nVPC"
      },
      "AllowedValues": [
        "CLASSIC",
        "VPC"
      ],
      "Required": true
    },
    "EnableSellTrust": {
      "Type": "String",
      "Description": {
        "ja": "インスタンスでセキュアホスティングを有効にする必要があるかどうか。\n- Y：セキュアホスティングモードを有効にします。\n- NULL またはその他：セキュアホスティングモードを有効にしません。"
      },
      "Required": true
    },
    "InstanceType": {
      "Type": "String",
      "Description": {
        "ja": "データベースインスタンスのタイプ。有効な値：MySQL、SQLServer、PostgreSQL、Oracle、DRDS、OceanBase、Mongo、Redis"
      },
      "Required": true
    },
    "QueryTimeout": {
      "Type": "Number",
      "Description": {
        "ja": "データベースインスタンスをクエリするためのタイムアウト期間。単位：秒。"
      },
      "Required": true
    },
    "InstanceSource": {
      "Type": "String",
      "Description": {
        "ja": "データベースインスタンスのソース。有効な値：\nPUBLIC_OWN：パブリックネットワーク上に構築されたオンプレミスデータベース。\nRDS：RDS (ApsaraDB for RDS) インスタンス。\nECS_OWN：Elastic Compute Service (ECS) インスタンス上に構築されたオンプレミスデータベース。\nVPC_IDC：Virtual Private Cloud (VPC) のインターネットデータセンター (IDC) に構築されたオンプレミスデータベース。"
      },
      "Required": true
    },
    "Host": {
      "Type": "String",
      "Description": {
        "ja": "データベースインスタンスのエンドポイント。"
      },
      "Required": true
    },
    "DatabaseUser": {
      "Type": "String",
      "Description": {
        "ja": "データベースインスタンスのログインユーザー名。"
      },
      "Required": true
    }
  },
  "Resources": {
    "Instance2": {
      "Type": "ALIYUN::DMS::Instance2",
      "Properties": {
        "DatabasePassword": {
          "Ref": "DatabasePassword"
        },
        "Port": {
          "Ref": "Port"
        },
        "SafeRule": {
          "Ref": "SafeRule"
        },
        "ExportTimeout": {
          "Ref": "ExportTimeout"
        },
        "EnvType": {
          "Ref": "EnvType"
        },
        "DbaId": {
          "Ref": "DbaId"
        },
        "InstanceAlias": {
          "Ref": "InstanceAlias"
        },
        "NetworkType": {
          "Ref": "NetworkType"
        },
        "EnableSellTrust": {
          "Ref": "EnableSellTrust"
        },
        "InstanceType": {
          "Ref": "InstanceType"
        },
        "QueryTimeout": {
          "Ref": "QueryTimeout"
        },
        "InstanceSource": {
          "Ref": "InstanceSource"
        },
        "Host": {
          "Ref": "Host"
        },
        "DatabaseUser": {
          "Ref": "DatabaseUser"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "データベースインスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "Instance2",
          "InstanceId"
        ]
      }
    },
    "Port": {
      "Description": "データベースインスタンスの接続ポート。",
      "Value": {
        "Fn::GetAtt": [
          "Instance2",
          "Port"
        ]
      }
    },
    "Host": {
      "Description": "データベースインスタンスのエンドポイント。",
      "Value": {
        "Fn::GetAtt": [
          "Instance2",
          "Host"
        ]
      }
    }
  }
}