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 | 是 | 否 | 數據庫實例來源。 | 取值：
|
DatabasePassword | String | 是 | 是 | 數據庫訪問密碼。 | 無 |
Port | Integer | 是 | 否 | 目標數據庫的訪問端口。 | 無 |
Host | String | 是 | 否 | 目標數據庫的主機地址。 | 無 |
ExportTimeout | Integer | 是 | 是 | 導出超時時間。 | 單位：s（秒）。 |
SafeRule | String | 是 | 是 | 實例的安全規則，傳入企業內的安全規則名稱。 | 無 |
DdlOnline | Integer | 否 | 否 | 是否使用online服務。 | 取值：
說明 目前僅支持MySQL和PolarDB。 |
EnvType | String | 是 | 是 | 環境類型。 | 取值：
|
Tid | Integer | 否 | 否 | 租戶ID。 | 無 |
UseDsql | Integer | 否 | 否 | 是否開啟跨實例查詢。 | 取值：
|
Sid | String | 否 | 否 | 數據庫SID。 | InstanceType取值為PostgreSQL、Oracle時該參數必須指定。 |
EcsInstanceId | String | 否 | 否 | ECS實例ID。 | InstanceSource取值為ECS_OWN該參數必須指定。 |
VpcId | String | 否 | 否 | 專有網絡ID。 | InstanceSource取值為VPC_IDC時該參數必須指定。 |
InstanceAlias | String | 是 | 是 | 實例名稱。 | 無 |
DbaUid | Integer | 是 | 否 | 數據庫所屬阿里云賬號的UID。 | 無 |
EcsRegion | String | 否 | 否 | 實例所在地域。 | InstanceSource取值為RDS、ECS_OWN或VPC_IDC時該參數必須指定。 |
NetworkType | String | 是 | 否 | 網絡類型。 | 取值：
|
DatabaseUser | String | 是 | 是 | 數據庫訪問賬號。 | 無 |
InstanceType | String | 是 | 否 | 數據庫類型。 | 取值：
|
DataLinkName | String | 否 | 否 | 跨庫查詢datalink名稱。 | 無 |
QueryTimeout | Integer | 是 | 是 | 查詢超時時間。 | 單位：s（秒）。 |
返回值
Fn::GetAtt
InstanceId：數據庫實例ID。
Port：數據庫連接端口。
Host：數據庫連接地址。
示例
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
InstanceSource:
Type: String
Description: >-
The source of the database instance. Valid values:
PUBLIC_OWN: an on-premises database built on the public network
RDS: an ApsaraDB for RDS (RDS) instance.
ECS_OWN: an on-premises database built on an Elastic Compute Service (ECS)
instance.
VPC_IDC: an on-premises database built in an Internet data center (IDC) in
Virtual Private
Cloud (VPC).
DatabasePassword:
Type: String
Description: The logon password of the database instance.
Port:
Type: Number
Description: The connection port of the database instance.
Host:
Type: String
Description: The endpoint of the database instance.
ExportTimeout:
Type: Number
Description: 'The timeout period for exporting the database instance. Unit: seconds.'
SafeRule:
Type: String
Description: >-
The security rule of the database instance. Enter the name of the security
rule for
your enterprise.
Note To query a specified security rule, log on to the DMS Enterprise
console and choose
System Management > Security Rules. The security rule appears in the
security rule
list.
DdlOnline:
Type: Number
Description: >-
[Important] Specifies whether to enable the online data description
language (DDL)
service. Currently, this service is available only for the MySQL and
PolarDB databases.
0: The service is disabled.
1: The native online DDL service prevails.
2: Data change without table locking provided by DMS prevails.
EnvType:
Type: String
Description: >-
The type of the environment to which the database instance belongs. Valid
values:
product: the production environment.
dev: the test environment.
Tid:
Type: Number
Description: >-
The ID of the tenant.
Note To query the ID, log on to the DMS Enterprise console and choose
System Management
> Instance Management or System Management > User Management. The ID of
the tenant
appears in the Service Specification section.
UseDsql:
Type: Number
Description: >-
Specifies whether to enable cross-database query for the database
instance. Valid
values:
0: disabled
1: enabled
AllowedValues:
- 0
- 1
Sid:
Type: String
Description: >-
The system ID (SID) of the database instance.
Note You must specify this parameter if the InstanceType parameter is set
to PostgreSQL or Oracle.
EcsInstanceId:
Type: String
Description: >-
The ID of the ECS instance to which the database instance belongs.
Note You must specify this parameter if the InstanceSource parameter is
set to ECS_OWN.
VpcId:
Type: String
Description: >-
The ID of the VPC to which the database instance belongs.
Note You must specify this parameter if the InstanceSource parameter is
set to VPC_IDC.
DbaUid:
Type: Number
Description: >-
The Alibaba Cloud unique ID (UID) of the database administrator (DBA) of
the database
instance.
Note To query the UID, log on to the DMS Enterprise console and choose
System Management
> User Management.
EcsRegion:
Type: String
Description: >-
The region where the database instance resides.
Note You must specify this parameter if the InstanceSource parameter is
set to ECS_OWN or VPC_IDC.
NetworkType:
Type: String
Description: |-
The network type of the database instance. Valid values:
CLASSIC
VPC
AllowedValues:
- CLASSIC
- VPC
InstanceAlias:
Type: String
Description: >-
The alias of the database instance. The alias helps you quickly find the
required
instance.
DatabaseUser:
Type: String
Description: The logon username of the database instance.
InstanceType:
Type: String
Description: >-
The type of the database instance. Valid values: MySQL, SQLServer,
PostgreSQL, Oracle, DRDS, OceanBase, Mongo, Redis
AllowedValues:
- MySQL
- SQLServer
- PostgreSQL
- Oracle
- DRDS
- OceanBase
- Mongo
- Redis
DataLinkName:
Type: String
Description: The name of the data link for cross-database query.
QueryTimeout:
Type: Number
Description: 'The timeout period for querying the database instance. Unit: seconds.'
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: The ID of the database instance.
Value:
'Fn::GetAtt':
- Instance
- InstanceId
Port:
Description: The connection port of the database instance.
Value:
'Fn::GetAtt':
- Instance
- Port
Host:
Description: The endpoint of the database instance.
Value:
'Fn::GetAtt':
- Instance
- Host{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"InstanceSource": {
"Type": "String",
"Description": "The source of the database instance. Valid values:\nPUBLIC_OWN: an on-premises database built on the public network.\nRDS: an ApsaraDB for RDS (RDS) instance.\nECS_OWN: an on-premises database built on an Elastic Compute Service (ECS) instance.\nVPC_IDC: an on-premises database built in an Internet data center (IDC) in Virtual Private\nCloud (VPC)."
},
"DatabasePassword": {
"Type": "String",
"Description": "The logon password of the database instance."
},
"Port": {
"Type": "Number",
"Description": "The connection port of the database instance."
},
"Host": {
"Type": "String",
"Description": "The endpoint of the database instance."
},
"ExportTimeout": {
"Type": "Number",
"Description": "The timeout period for exporting the database instance. Unit: seconds."
},
"SafeRule": {
"Type": "String",
"Description": "The security rule of the database instance. Enter the name of the security rule for\nyour enterprise.\nNote To query a specified security rule, log on to the DMS Enterprise console and choose\nSystem Management > Security Rules. The security rule appears in the security rule\nlist."
},
"DdlOnline": {
"Type": "Number",
"Description": "[Important] Specifies whether to enable the online data description language (DDL)\nservice. Currently, this service is available only for the MySQL and PolarDB databases.\n0: The service is disabled.\n1: The native online DDL service prevails.\n2: Data change without table locking provided by DMS prevails."
},
"EnvType": {
"Type": "String",
"Description": "The type of the environment to which the database instance belongs. Valid values:\nproduct: the production environment.\ndev: the test environment."
},
"Tid": {
"Type": "Number",
"Description": "The ID of the tenant.\nNote To query the ID, log on to the DMS Enterprise console and choose System Management\n> Instance Management or System Management > User Management. The ID of the tenant\nappears in the Service Specification section."
},
"UseDsql": {
"Type": "Number",
"Description": "Specifies whether to enable cross-database query for the database instance. Valid\nvalues:\n0: disabled\n1: enabled",
"AllowedValues": [
0,
1
]
},
"Sid": {
"Type": "String",
"Description": "The system ID (SID) of the database instance.\nNote You must specify this parameter if the InstanceType parameter is set to PostgreSQL or Oracle."
},
"EcsInstanceId": {
"Type": "String",
"Description": "The ID of the ECS instance to which the database instance belongs.\nNote You must specify this parameter if the InstanceSource parameter is set to ECS_OWN."
},
"VpcId": {
"Type": "String",
"Description": "The ID of the VPC to which the database instance belongs.\nNote You must specify this parameter if the InstanceSource parameter is set to VPC_IDC."
},
"DbaUid": {
"Type": "Number",
"Description": "The Alibaba Cloud unique ID (UID) of the database administrator (DBA) of the database\ninstance.\nNote To query the UID, log on to the DMS Enterprise console and choose System Management\n> User Management."
},
"EcsRegion": {
"Type": "String",
"Description": "The region where the database instance resides.\nNote You must specify this parameter if the InstanceSource parameter is set to ECS_OWN or VPC_IDC."
},
"NetworkType": {
"Type": "String",
"Description": "The network type of the database instance. Valid values:\nCLASSIC\nVPC",
"AllowedValues": [
"CLASSIC",
"VPC"
]
},
"InstanceAlias": {
"Type": "String",
"Description": "The alias of the database instance. The alias helps you quickly find the required\ninstance."
},
"DatabaseUser": {
"Type": "String",
"Description": "The logon username of the database instance."
},
"InstanceType": {
"Type": "String",
"Description": "The type of the database instance. Valid values: MySQL, SQLServer, PostgreSQL, Oracle, DRDS, OceanBase, Mongo, Redis",
"AllowedValues": [
"MySQL",
"SQLServer",
"PostgreSQL",
"Oracle",
"DRDS",
"OceanBase",
"Mongo",
"Redis"
]
},
"DataLinkName": {
"Type": "String",
"Description": "The name of the data link for cross-database query."
},
"QueryTimeout": {
"Type": "Number",
"Description": "The timeout period for querying the database instance. Unit: seconds."
}
},
"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": "The ID of the database instance.",
"Value": {
"Fn::GetAtt": [
"Instance",
"InstanceId"
]
}
},
"Port": {
"Description": "The connection port of the database instance.",
"Value": {
"Fn::GetAtt": [
"Instance",
"Port"
]
}
},
"Host": {
"Description": "The endpoint of the database instance.",
"Value": {
"Fn::GetAtt": [
"Instance",
"Host"
]
}
}
}
}文檔內容是否對您有幫助？