DATASOURCE::GraphDatabase::DbInstance_资源编排(ROS)-阿里云帮助中心

DATASOURCE::GraphDatabase::DbInstance类型用于获取单个实例详情。

语法

{
  "Type": "DATASOURCE::GraphDatabase::DbInstance",
  "Properties": {
    "DbInstanceId": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

DbInstanceId

String

是

实例ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

ResourceGroupId：资源组ID。
DbInstanceNetworkType：数据库网络类型。
Port：应用访问端口。
DbInstanceType：数据库实例类型。
DbInstanceStorageType：数据库实例存储类型。
DbNodeStorage：数据库存储空间。
DbInstanceCategory：数据库实例系列。
DbVersion：数据库版本。
CurrentMinorVersion：数据库内核版本。
PaymentType：付费类型。
PublicConnectionString：实例的公共连接地址。
DbInstanceId：实例ID。
LockReason：资源被锁定的原因。
DbNodeClass：节点规格。
MaintainTime：实例的可维护时间。
Tags：实例绑定的标签。
ZoneId：实例所属的可用区ID。
VSwitchId：实例所属的交换机ID。
CreateTime：实例的创建时间。
DbNodeCount：节点数量。
LatestMinorVersion：实例支持的最新内核版本。
Expired：实例过期时间。
EcsSecurityGroupRelations：绑定的安全组关系列表。
LockMode：实例锁定状态。
DbInstanceMemory：实例的内存空间。
ReadOnlyDbInstanceIds：只读实例ID列表。
VpcId：实例绑定的专有网络ID。
DBInstanceIPArray：IP白名单列表。
DbInstanceDescription：数据库实例描述。
DbInstanceCpu：实例CPU数量。
ConnectionString：数据库连接地址。
ExpireTime：数据库过期时间。
PublicPort：数据库连接端口。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DbInstanceId:
    Type: String
    Description:
      en: The ID of the GDB Instance.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::GraphDatabase::DbInstance
    Properties:
      DbInstanceId:
        Ref: DbInstanceId
Outputs:
  ResourceGroupId:
    Description: Resource Group ID.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  DbInstanceNetworkType:
    Description: The network type of the db instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceNetworkType
  Port:
    Description: Application Port.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Port
  DbInstanceType:
    Description: The type of the db instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceType
  DbInstanceStorageType:
    Description: Cloud Disk.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceStorageType
  DbNodeStorage:
    Description: Instance storage space, which is measured in GB.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbNodeStorage
  DbInstanceCategory:
    Description: The category of the db instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceCategory
  DbVersion:
    Description: Kernel Version 1.0 is represented as gremlin,1.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbVersion
  CurrentMinorVersion:
    Description: The current kernel image version.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CurrentMinorVersion
  PaymentType:
    Description: The DB instance attribute field representing the paid type is desirable.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  PublicConnectionString:
    Description: The public connection string ID of the DB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PublicConnectionString
  DbInstanceId:
    Description: The ID of the GDB Instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceId
  LockReason:
    Description: An instance is locked the reason.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LockReason
  DbNodeClass:
    Description: The class of the db node.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbNodeClass
  MaintainTime:
    Description: Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MaintainTime
  Tags:
    Description: The tags of the GDB Instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  ZoneId:
    Description: The zone ID of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
  VSwitchId:
    Description: The vswitch id of the DB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitchId
  CreateTime:
    Description: Creation time, which follows the format of YYYY-MM-DD 'T'hh:mm:ssZ, such as 2011-05-30 T12:11:4Z.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  DbNodeCount:
    Description: The count of the db node.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbNodeCount
  LatestMinorVersion:
    Description: The latest kernel image version.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LatestMinorVersion
  Expired:
    Description: The expire status of the db instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Expired
  EcsSecurityGroupRelations:
    Description: Security group information array.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EcsSecurityGroupRelations
  LockMode:
    Description: Instance lock state.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LockMode
  DbInstanceMemory:
    Description: Instance memory, which is measured in MB.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceMemory
  ReadOnlyDbInstanceIds:
    Description: The array of the readonly db instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReadOnlyDbInstanceIds
  VpcId:
    Description: The vpc id of the db instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
  DBInstanceIPArray:
    Description: IP ADDRESS whitelist for the instance group list.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceIPArray
  DbInstanceDescription:
    Description: According to the practical example or notes.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceDescription
  DbInstanceCpu:
    Description: For example, instances can be grouped according to Cpu core count.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbInstanceCpu
  ConnectionString:
    Description: Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ConnectionString
  ExpireTime:
    Description: The instance after it expires time for subscription instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpireTime
  PublicPort:
    Description: The public port ID of the DB instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PublicPort

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DbInstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the GDB Instance."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::GraphDatabase::DbInstance",
      "Properties": {
        "DbInstanceId": {
          "Ref": "DbInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "ResourceGroupId": {
      "Description": "Resource Group ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "DbInstanceNetworkType": {
      "Description": "The network type of the db instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceNetworkType"
        ]
      }
    },
    "Port": {
      "Description": "Application Port.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Port"
        ]
      }
    },
    "DbInstanceType": {
      "Description": "The type of the db instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceType"
        ]
      }
    },
    "DbInstanceStorageType": {
      "Description": "Cloud Disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceStorageType"
        ]
      }
    },
    "DbNodeStorage": {
      "Description": "Instance storage space, which is measured in GB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbNodeStorage"
        ]
      }
    },
    "DbInstanceCategory": {
      "Description": "The category of the db instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceCategory"
        ]
      }
    },
    "DbVersion": {
      "Description": "Kernel Version 1.0 is represented as gremlin,1.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbVersion"
        ]
      }
    },
    "CurrentMinorVersion": {
      "Description": "The current kernel image version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CurrentMinorVersion"
        ]
      }
    },
    "PaymentType": {
      "Description": "The DB instance attribute field representing the paid type is desirable.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "PublicConnectionString": {
      "Description": "The public connection string ID of the DB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicConnectionString"
        ]
      }
    },
    "DbInstanceId": {
      "Description": "The ID of the GDB Instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceId"
        ]
      }
    },
    "LockReason": {
      "Description": "An instance is locked the reason.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LockReason"
        ]
      }
    },
    "DbNodeClass": {
      "Description": "The class of the db node.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbNodeClass"
        ]
      }
    },
    "MaintainTime": {
      "Description": "Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainTime"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the GDB Instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "ZoneId": {
      "Description": "The zone ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "The vswitch id of the DB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "CreateTime": {
      "Description": "Creation time, which follows the format of YYYY-MM-DD 'T'hh:mm:ssZ, such as 2011-05-30 T12:11:4Z.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "DbNodeCount": {
      "Description": "The count of the db node.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbNodeCount"
        ]
      }
    },
    "LatestMinorVersion": {
      "Description": "The latest kernel image version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LatestMinorVersion"
        ]
      }
    },
    "Expired": {
      "Description": "The expire status of the db instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Expired"
        ]
      }
    },
    "EcsSecurityGroupRelations": {
      "Description": "Security group information array.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EcsSecurityGroupRelations"
        ]
      }
    },
    "LockMode": {
      "Description": "Instance lock state.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LockMode"
        ]
      }
    },
    "DbInstanceMemory": {
      "Description": "Instance memory, which is measured in MB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceMemory"
        ]
      }
    },
    "ReadOnlyDbInstanceIds": {
      "Description": "The array of the readonly db instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReadOnlyDbInstanceIds"
        ]
      }
    },
    "VpcId": {
      "Description": "The vpc id of the db instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "DBInstanceIPArray": {
      "Description": "IP ADDRESS whitelist for the instance group list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceIPArray"
        ]
      }
    },
    "DbInstanceDescription": {
      "Description": "According to the practical example or notes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceDescription"
        ]
      }
    },
    "DbInstanceCpu": {
      "Description": "For example, instances can be grouped according to Cpu core count.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbInstanceCpu"
        ]
      }
    },
    "ConnectionString": {
      "Description": "Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConnectionString"
        ]
      }
    },
    "ExpireTime": {
      "Description": "The instance after it expires time for subscription instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpireTime"
        ]
      }
    },
    "PublicPort": {
      "Description": "The public port ID of the DB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicPort"
        ]
      }
    }
  }
}