DATASOURCE::DMS::Database - 资源编排

DATASOURCE::DMS::Database类型用于获取具体库详情信息。

语法

{
  "Type": "DATASOURCE::DMS::Database",
  "Properties": {
    "Host": String,
    "Port": Integer,
    "SchemaName": String,
    "RefreshOptions": String,
    "Sid": String,
    "Tid": Integer
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
Host	String	是	是	数据库连接地址。	无
Port	Integer	是	是	数据库的连接端口。	取值范围：1~65535。
SchemaName	String	是	是	数据库名称。	无
RefreshOptions	String	否	是	当资源栈更新时，数据源资源的刷新策略。	取值： Never（默认值）：更新堆栈时，从不刷新数据源资源。 Always：更新堆栈时，始终刷新数据源资源。
Sid	String	否	是	数据库 Sid。	说明数据库 Sid 是 Oracle 数据库的唯一标识符。当建立一个数据库时，系统将自动赋予一个初始 ID。
Tid	Integer	否	是	租户 ID。	您可以通过调用 GetUserActiveTenant - 获取当前所处的租户信息接口获取该参数。

返回值

Fn::GetAtt

InstanceId：数据库实例 ID。
SearchName：数据库的搜索名称。
Port：数据库的连接端口。
DatabaseId：数据库 ID。
Encoding：数据库编码。
Host：数据库连接地址。
EnvType：数据库环境类型。
DbType：数据库类型。
Sid：数据库 Sid。
DbaName：目标数据库的 DBA 昵称。
DbaId：目标数据库的 DBA 的用户 ID。
State：数据库状态。
InstanceAlias：实例别名。
OwnerNameList：数据库 Owner 昵称列表。
CatalogName：数据库目录名。
SchemaName：数据库名称。
OwnerIdList：数据库 Owner 的用户 ID 列表。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Port:
    Type: Number
    Description:
      en: Database connection port.
    Required: true
    MinValue: 1
    MaxValue: 65535
  Host:
    Type: String
    Description:
      en: Database connection address.
    Required: true
  SchemaName:
    Type: String
    Description:
      en: Database schema name.
    Required: true
Resources:
  Database:
    Type: DATASOURCE::DMS::Database
    Properties:
      Port:
        Ref: Port
      Host:
        Ref: Host
      SchemaName:
        Ref: SchemaName
Outputs:
  InstanceId:
    Description: Database instance ID.
    Value:
      Fn::GetAtt:
        - Database
        - InstanceId
  SearchName:
    Description: Database search name.
    Value:
      Fn::GetAtt:
        - Database
        - SearchName
  Port:
    Description: Database connection port.
    Value:
      Fn::GetAtt:
        - Database
        - Port
  DatabaseId:
    Description: Database ID.
    Value:
      Fn::GetAtt:
        - Database
        - DatabaseId
  Encoding:
    Description: Database encoding.
    Value:
      Fn::GetAtt:
        - Database
        - Encoding
  Host:
    Description: Database connection address.
    Value:
      Fn::GetAtt:
        - Database
        - Host
  EnvType:
    Description: Database environment type.
    Value:
      Fn::GetAtt:
        - Database
        - EnvType
  DbType:
    Description: Database type.
    Value:
      Fn::GetAtt:
        - Database
        - DbType
  Sid:
    Description: Database SID.
    Value:
      Fn::GetAtt:
        - Database
        - Sid
  DbaName:
    Description: Database administrator name.
    Value:
      Fn::GetAtt:
        - Database
        - DbaName
  DbaId:
    Description: Database administrator ID.
    Value:
      Fn::GetAtt:
        - Database
        - DbaId
  State:
    Description: Database state.
    Value:
      Fn::GetAtt:
        - Database
        - State
  InstanceAlias:
    Description: Database instance alias.
    Value:
      Fn::GetAtt:
        - Database
        - InstanceAlias
  OwnerNameList:
    Description: Database owner name list.
    Value:
      Fn::GetAtt:
        - Database
        - OwnerNameList
  CatalogName:
    Description: Database catalog name.
    Value:
      Fn::GetAtt:
        - Database
        - CatalogName
  SchemaName:
    Description: Database schema name.
    Value:
      Fn::GetAtt:
        - Database
        - SchemaName
  OwnerIdList:
    Description: Database owner ID list.
    Value:
      Fn::GetAtt:
        - Database
        - OwnerIdList

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Port": {
      "Type": "Number",
      "Description": {
        "en": "Database connection port."
      },
      "Required": true,
      "MinValue": 1,
      "MaxValue": 65535
    },
    "Host": {
      "Type": "String",
      "Description": {
        "en": "Database connection address."
      },
      "Required": true
    },
    "SchemaName": {
      "Type": "String",
      "Description": {
        "en": "Database schema name."
      },
      "Required": true
    }
  },
  "Resources": {
    "Database": {
      "Type": "DATASOURCE::DMS::Database",
      "Properties": {
        "Port": {
          "Ref": "Port"
        },
        "Host": {
          "Ref": "Host"
        },
        "SchemaName": {
          "Ref": "SchemaName"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "Database instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "InstanceId"
        ]
      }
    },
    "SearchName": {
      "Description": "Database search name.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "SearchName"
        ]
      }
    },
    "Port": {
      "Description": "Database connection port.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "Port"
        ]
      }
    },
    "DatabaseId": {
      "Description": "Database ID.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "DatabaseId"
        ]
      }
    },
    "Encoding": {
      "Description": "Database encoding.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "Encoding"
        ]
      }
    },
    "Host": {
      "Description": "Database connection address.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "Host"
        ]
      }
    },
    "EnvType": {
      "Description": "Database environment type.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "EnvType"
        ]
      }
    },
    "DbType": {
      "Description": "Database type.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "DbType"
        ]
      }
    },
    "Sid": {
      "Description": "Database SID.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "Sid"
        ]
      }
    },
    "DbaName": {
      "Description": "Database administrator name.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "DbaName"
        ]
      }
    },
    "DbaId": {
      "Description": "Database administrator ID.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "DbaId"
        ]
      }
    },
    "State": {
      "Description": "Database state.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "State"
        ]
      }
    },
    "InstanceAlias": {
      "Description": "Database instance alias.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "InstanceAlias"
        ]
      }
    },
    "OwnerNameList": {
      "Description": "Database owner name list.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "OwnerNameList"
        ]
      }
    },
    "CatalogName": {
      "Description": "Database catalog name.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "CatalogName"
        ]
      }
    },
    "SchemaName": {
      "Description": "Database schema name.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "SchemaName"
        ]
      }
    },
    "OwnerIdList": {
      "Description": "Database owner ID list.",
      "Value": {
        "Fn::GetAtt": [
          "Database",
          "OwnerIdList"
        ]
      }
    }
  }
}