ALIYUN::DMS::Instance - mendaftarkan instans database DMS - Resource Orchestration Service

ALIYUN::DMS::Instance mendaftarkan sebuah instans database untuk perusahaan Anda.

Sintaks

{
  "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
  }
}

Properti

Property Name	Type	Required	Allow updates	Description	Constraint
InstanceSource	String	Yes	No	Sumber instans database.	Nilai yang valid: PUBLIC_OWN: Database yang dikelola sendiri di jaringan publik RDS: Instans ApsaraDB RDS ECS_OWN: Database yang dikelola sendiri pada Instance ECS VPC_IDC: Database yang dikelola sendiri di pusat data yang terhubung ke VPC
DatabasePassword	String	Yes	Yes	Kata sandi untuk menghubungkan ke instans database.	None.
Port	Integer	Yes	No	Port koneksi instans database.	None.
Host	String	Yes	No	Titik akhir instans database.	None.
ExportTimeout	Integer	Yes	Yes	Periode timeout untuk mengekspor data.	Unit: detik.
SafeRule	String	Yes	Yes	Aturan keamanan untuk instans database. Gunakan aturan yang telah ditentukan di perusahaan Anda.	None.
DdlOnline	Integer	No	No	Apakah layanan DDL online diaktifkan.	Nilai yang valid: 0: dinonaktifkan 1: DDL online native diprioritaskan 2: Perubahan skema tanpa lock dari DMS diprioritaskan Catatan Hanya didukung untuk MySQL dan PolarDB.
EnvType	String	Yes	Yes	Jenis lingkungan.	Nilai yang valid: product: lingkungan produksi dev: lingkungan pengembangan pre: lingkungan pra-rilis test: lingkungan pengujian sit: lingkungan pengujian integrasi sistem (SIT) uat: lingkungan pengujian penerimaan pengguna (UAT) pet: lingkungan uji stres stag: lingkungan staging
Tid	Integer	No	No	ID penyewa.	None.
UseDsql	Integer	No	No	Apakah kueri lintas-instans diaktifkan.	Nilai yang valid: 0: Dinonaktifkan. 1: Diaktifkan
Sid	String	No	No	System ID (SID) database.	Wajib diisi jika InstanceType adalah PostgreSQL atau Oracle.
EcsInstanceId	String	No	No	ID Instance ECS.	Wajib diisi jika InstanceSource adalah ECS_OWN.
VpcId	String	No	No	ID VPC.	Wajib diisi jika InstanceSource adalah VPC_IDC.
InstanceAlias	String	Yes	Yes	Nama instans database.	None.
DbaUid	Integer	Yes	No	UID Alibaba Cloud pemilik instans database.	None.
EcsRegion	String	No	No	Wilayah tempat instans berada.	Wajib diisi jika InstanceSource adalah RDS, ECS_OWN, atau VPC_IDC.
NetworkType	String	Yes	No	Jenis jaringan.	Nilai yang valid: CLASSIC: jaringan klasik VPC: Virtual Private Cloud
DatabaseUser	String	Yes	Yes	Username untuk menghubungkan ke instans database.	None.
InstanceType	String	Yes	No	Jenis instans database.	Nilai yang valid: MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis
DataLinkName	String	No	No	Nama tautan data untuk kueri lintas-database.	None.
QueryTimeout	Integer	Yes	Yes	Periode timeout untuk mengkueri data.	Unit: detik.

Nilai kembalian

Fn::GetAtt

InstanceId: ID instans database.
Port: port koneksi instans database.
Host: titik akhir instans database.

Contoh

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceSource:
    Type: String
    Description: >-
      Sumber instans database. Nilai yang valid:
      PUBLIC_OWN: database on-premises yang dibangun di jaringan publik
      RDS: instans ApsaraDB for RDS (RDS).
      ECS_OWN: database on-premises yang dibangun di Elastic Compute Service (ECS)
      instance.
      VPC_IDC: database on-premises yang dibangun di Internet data center (IDC) di
      Virtual Private
      Cloud (VPC).
  DatabasePassword:
    Type: String
    Description: Kata sandi logon instans database.
  Port:
    Type: Number
    Description: Port koneksi instans database.
  Host:
    Type: String
    Description: Titik akhir instans database.
  ExportTimeout:
    Type: Number
    Description: 'Periode timeout untuk mengekspor instans database. Unit: detik.'
  SafeRule:
    Type: String
    Description: >-
      Aturan keamanan instans database. Masukkan nama aturan keamanan untuk
      perusahaan Anda.
      Catatan Untuk mengkueri aturan keamanan tertentu, login ke konsol DMS Enterprise dan pilih
      System Management > Security Rules. Aturan keamanan muncul dalam daftar
      aturan keamanan.
  DdlOnline:
    Type: Number
    Description: >-
      [Penting] Menentukan apakah layanan data description language (DDL) online
      diaktifkan.

      Saat ini, layanan ini hanya tersedia untuk database MySQL dan PolarDB.
      0: Layanan dinonaktifkan.
      1: Layanan DDL online native diprioritaskan.
      2: Perubahan data tanpa penguncian tabel yang disediakan oleh DMS diprioritaskan.
  EnvType:
    Type: String
    Description: >-
      Jenis lingkungan tempat instans database berada. Nilai yang valid:
      product: lingkungan produksi.
      dev: lingkungan pengujian.
  Tid:
    Type: Number
    Description: >-
      ID penyewa.
      Catatan Untuk mengkueri ID tersebut, login ke konsol DMS Enterprise dan pilih
      System Management
      > Instance Management atau System Management > User Management. ID penyewa
      muncul di bagian Spesifikasi Layanan.
  UseDsql:
    Type: Number
    Description: >-
      Menentukan apakah kueri lintas-database diaktifkan untuk instans database. Nilai
      yang valid:
      0: dinonaktifkan
      1: diaktifkan
    AllowedValues:
      - 0
      - 1
  Sid:
    Type: String
    Description: >-
      System ID (SID) instans database.
      Catatan Anda harus menentukan parameter ini jika parameter InstanceType diatur
      ke PostgreSQL atau Oracle.
  EcsInstanceId:
    Type: String
    Description: >-
      ID Instance ECS tempat instans database berada.
      Catatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur
      ke ECS_OWN.
  VpcId:
    Type: String
    Description: >-
      ID VPC tempat instans database berada.
      Catatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur
      ke VPC_IDC.
  DbaUid:
    Type: Number
    Description: >-
      Unique ID (UID) Alibaba Cloud administrator basis data (DBA) instans
      database.
      Catatan Untuk mengkueri UID tersebut, login ke konsol DMS Enterprise dan pilih
      System Management
      > User Management.
  EcsRegion:
    Type: String
    Description: >-
      Wilayah tempat instans database berada.
      Catatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur
      ke ECS_OWN atau VPC_IDC.
  NetworkType:
    Type: String
    Description: |-
      Jenis jaringan instans database. Nilai yang valid:
      CLASSIC
      VPC
    AllowedValues:
      - CLASSIC
      - VPC
  InstanceAlias:
    Type: String
    Description: >-
      Alias instans database. Alias membantu Anda dengan cepat menemukan
      instans yang diperlukan.
  DatabaseUser:
    Type: String
    Description: Username logon instans database.
  InstanceType:
    Type: String
    Description: >-
      Jenis instans database. Nilai yang valid: MySQL, SQLServer,
      PostgreSQL, Oracle, DRDS, OceanBase, Mongo, Redis
    AllowedValues:
      - MySQL
      - SQLServer
      - PostgreSQL
      - Oracle
      - DRDS
      - OceanBase
      - Mongo
      - Redis
  DataLinkName:
    Type: String
    Description: Nama tautan data untuk kueri lintas-database.
  QueryTimeout:
    Type: Number
    Description: 'Periode timeout untuk mengkueri instans database. Unit: detik.'
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 instans database.
    Value:
      'Fn::GetAtt':
        - Instance
        - InstanceId
  Port:
    Description: Port koneksi instans database.
    Value:
      'Fn::GetAtt':
        - Instance
        - Port
  Host:
    Description: Titik akhir instans database.
    Value:
      'Fn::GetAtt':
        - Instance
        - Host

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceSource": {
      "Type": "String",
      "Description": "Sumber instans database. Nilai yang valid:\nPUBLIC_OWN: database on-premises yang dibangun di jaringan publik.\nRDS: instans ApsaraDB for RDS (RDS).\nECS_OWN: database on-premises yang dibangun di Elastic Compute Service (ECS) instance.\nVPC_IDC: database on-premises yang dibangun di Internet data center (IDC) di Virtual Private\nCloud (VPC)."
    },
    "DatabasePassword": {
      "Type": "String",
      "Description": "Kata sandi logon instans database."
    },
    "Port": {
      "Type": "Number",
      "Description": "Port koneksi instans database."
    },
    "Host": {
      "Type": "String",
      "Description": "Titik akhir instans database."
    },
    "ExportTimeout": {
      "Type": "Number",
      "Description": "Periode timeout untuk mengekspor instans database. Unit: detik."
    },
    "SafeRule": {
      "Type": "String",
      "Description": "Aturan keamanan instans database. Masukkan nama aturan keamanan untuk\nperusahaan Anda.\nCatatan Untuk mengkueri aturan keamanan tertentu, login ke konsol DMS Enterprise dan pilih\nSystem Management > Security Rules. Aturan keamanan muncul dalam daftar aturan keamanan\nlist."
    },
    "DdlOnline": {
      "Type": "Number",
      "Description": "[Penting] Menentukan apakah layanan data description language (DDL) online\ndiaktifkan. Saat ini, layanan ini hanya tersedia untuk database MySQL dan PolarDB.\n0: Layanan dinonaktifkan.\n1: Layanan DDL online native diprioritaskan.\n2: Perubahan data tanpa penguncian tabel yang disediakan oleh DMS diprioritaskan."
    },
    "EnvType": {
      "Type": "String",
      "Description": "Jenis lingkungan tempat instans database berada. Nilai yang valid:\nproduct: lingkungan produksi.\ndev: lingkungan pengujian."
    },
    "Tid": {
      "Type": "Number",
      "Description": "ID penyewa.\nCatatan Untuk mengkueri ID tersebut, login ke konsol DMS Enterprise dan pilih System Management\n> Instance Management atau System Management > User Management. ID penyewa\nmuncul di bagian Spesifikasi Layanan."
    },
    "UseDsql": {
      "Type": "Number",
      "Description": "Menentukan apakah kueri lintas-database diaktifkan untuk instans database. Nilai\nyang valid:\n0: dinonaktifkan\n1: diaktifkan",
      "AllowedValues": [
        0,
        1
      ]
    },
    "Sid": {
      "Type": "String",
      "Description": "System ID (SID) instans database.\nCatatan Anda harus menentukan parameter ini jika parameter InstanceType diatur ke PostgreSQL atau Oracle."
    },
    "EcsInstanceId": {
      "Type": "String",
      "Description": "ID Instance ECS tempat instans database berada.\nCatatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur ke ECS_OWN."
    },
    "VpcId": {
      "Type": "String",
      "Description": "ID VPC tempat instans database berada.\nCatatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur ke VPC_IDC."
    },
    "DbaUid": {
      "Type": "Number",
      "Description": "Unique ID (UID) Alibaba Cloud administrator basis data (DBA) instans database.\nCatatan Untuk mengkueri UID tersebut, login ke konsol DMS Enterprise dan pilih System Management\n> User Management."
    },
    "EcsRegion": {
      "Type": "String",
      "Description": "Wilayah tempat instans database berada.\nCatatan Anda harus menentukan parameter ini jika parameter InstanceSource diatur ke ECS_OWN atau VPC_IDC."
    },
    "NetworkType": {
      "Type": "String",
      "Description": "Jenis jaringan instans database. Nilai yang valid:\nCLASSIC\nVPC",
      "AllowedValues": [
        "CLASSIC",
        "VPC"
      ]
    },
    "InstanceAlias": {
      "Type": "String",
      "Description": "Alias instans database. Alias membantu Anda dengan cepat menemukan instans yang diperlukan\ninstance."
    },
    "DatabaseUser": {
      "Type": "String",
      "Description": "Username logon instans database."
    },
    "InstanceType": {
      "Type": "String",
      "Description": "Jenis instans database. Nilai yang valid: MySQL, SQLServer, PostgreSQL, Oracle, DRDS, OceanBase, Mongo, Redis",
      "AllowedValues": [
        "MySQL",
        "SQLServer",
        "PostgreSQL",
        "Oracle",
        "DRDS",
        "OceanBase",
        "Mongo",
        "Redis"
      ]
    },
    "DataLinkName": {
      "Type": "String",
      "Description": "Nama tautan data untuk kueri lintas-database."
    },
    "QueryTimeout": {
      "Type": "Number",
      "Description": "Periode timeout untuk mengkueri instans database. Unit: detik."
    }
  },
  "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 instans database.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "Port": {
      "Description": "Port koneksi instans database.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Port"
        ]
      }
    },
    "Host": {
      "Description": "Titik akhir instans database.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Host"
        ]
      }
    }
  }
}