すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::GraphDatabase::DbInstance

最終更新日:Mar 12, 2025

ALIYUN::GraphDatabase::DbInstance は、Graph Database (GDB) インスタンスを作成するために使用されます。

構文

{
  "Type": "ALIYUN::GraphDatabase::DbInstance",
  "Properties": {
    "ZoneId": String,
    "ResourceGroupId": String,
    "DbInstanceNetworkType": String,
    "VSwitchId": String,
    "EcsSecurityGroupRelations": List,
    "DbInstanceStorageType": String,
    "DbNodeStorage": Integer,
    "BackupSetId": String,
    "DbInstanceCategory": String,
    "SourceDbInstanceId": String,
    "VpcId": String,
    "DBInstanceIPArray": List,
    "DbVersion": String,
    "CreateType": String,
    "PaymentType": String,
    "DbInstanceDescription": String,
    "RestoreType": String,
    "DbNodeClass": String,
    "MaintainTime": String,
    "Tags": List
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

ZoneId

String

いいえ

いいえ

ゾーンの ID です。

なし。

ResourceGroupId

String

いいえ

はい

リソースグループの ID です。

なし。

DbInstanceNetworkType

String

はい

いいえ

インスタンスのネットワークタイプです。

値を VPC に設定します。

VSwitchId

String

いいえ

いいえ

vSwitch の ID です。

なし。

EcsSecurityGroupRelations

List

いいえ

いいえ

インスタンスに関連付けるセキュリティグループです。

詳細については、「EcsSecurityGroupRelations プロパティ」をご参照ください。

DbInstanceStorageType

String

はい

いいえ

インスタンスのストレージタイプです。

有効な値:

  • cloud_essd: 企業向け SSD (ESSD)。

  • cloud_ssd: 標準 SSD。

DbNodeStorage

Integer

はい

はい

インスタンスのストレージ容量です。

なし。

BackupSetId

String

いいえ

いいえ

バックアップセットの ID です。

なし。

DbInstanceCategory

String

はい

いいえ

インスタンスのエディションです。

値を ha に設定します。 ha の値は Pro Edition を指定します。

SourceDbInstanceId

String

いいえ

いいえ

ソースインスタンスの ID です。

なし。

VpcId

String

いいえ

いいえ

仮想プライベートクラウド (VPC) の ID です。

なし。

DBInstanceIPArray

List

いいえ

はい

インスタンスの IP アドレスホワイトリストの詳細です。

詳細については、「DBInstanceIPArray プロパティ」をご参照ください。

DbVersion

String

はい

いいえ

エンジンバージョンです。

有効な値:

  • 1.0

  • 1.0-OpenCypher

CreateType

String

いいえ

いいえ

インスタンスの作成に使用するメソッドです。

有効な値:

  • CreateDBInstance

  • CloneDBInstance

  • CreateReadDBInstance

PaymentType

String

いいえ

いいえ

課金方法です。

有効な値:

  • PostPaid: 従量課金。

  • PrePaid: サブスクリプション。

DbInstanceDescription

String

いいえ

はい

説明です。

なし。

RestoreType

String

いいえ

いいえ

復元タイプです。

値を backup に設定します。

DbNodeClass

String

はい

はい

インスタンス上のノードのインスタンスタイプです。

なし。

MaintainTime

String

いいえ

はい

インスタンスのメンテナンスウィンドウです。

なし。

Tags

List

いいえ

はい

カスタムタグです。

詳細については、「Tags プロパティ」をご参照ください。

EcsSecurityGroupRelations 構文

"EcsSecurityGroupRelations": [
  {
    "NetworkType": String,
    "SecurityGroupId": String,
    "RegionId": String
  }
]

EcsSecurityGroupRelations プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

NetworkType

String

いいえ

いいえ

ネットワークのタイプです。

なし。

SecurityGroupId

String

はい

はい

セキュリティグループの ID です。

なし。

RegionId

String

いいえ

いいえ

リージョンの ID です。

なし。

DBInstanceIPArray 構文

"DBInstanceIPArray": [
  {
    "SecurityIps": String,
    "DbInstanceIpArrayName": String
  }
]

DBInstanceIPArray プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

SecurityIps

String

はい

はい

IP アドレスホワイトリストです。

なし。

DbInstanceIpArrayName

String

いいえ

いいえ

IP アドレスホワイトリストの名前です。

なし。

Tags 構文

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Value

String

いいえ

いいえ

タグの値です。

値は 1 ~ 128 文字で、http:// または https:// を含めることはできません。 aliyun または acs: で始めることはできません。

Key

String

はい

いいえ

タグのキーです。

キーは 1 ~ 128 文字で、http:// または https:// を含めることはできません。 aliyun または acs: で始めることはできません。

戻り値

Fn::GetAtt

  • ResourceGroupId: リソースグループの ID。

  • DbInstanceNetworkType: インスタンスのネットワークタイプ。

  • Port: インスタンスへの接続に使用するポート。

  • DbInstanceType: インスタンスのインスタンスタイプ。

  • DbInstanceStorageType: インスタンスのストレージタイプ。

  • DbNodeStorage: インスタンスのストレージ容量。

  • DbInstanceCategory: インスタンスのエディション。

  • DbVersion: エンジンバージョン。

  • CurrentMinorVersion: 現在のカーネルバージョン。

  • PaymentType: 課金方法。

  • PublicConnectionString: インスタンスのパブリックエンドポイント。

  • DBInstanceId: インスタンスの ID。

  • LockReason: インスタンスがロックされている理由。

  • DbNodeClass: インスタンス上のノードのインスタンスタイプ。

  • MaintainTime: インスタンスのメンテナンスウィンドウ。

  • Tags: インスタンスのタグ。

  • ZoneId: インスタンスのゾーン ID。

  • VSwitchId: インスタンスの vSwitch ID。

  • CreateTime: インスタンスの作成時間。

  • DbNodeCount: ノード数。

  • LatestMinorVersion: インスタンスでサポートされている最新のカーネルバージョン。

  • Expired: インスタンスの有効期限。

  • EcsSecurityGroupRelations: インスタンスに関連付けられているセキュリティグループ。

  • LockMode: インスタンスのロックモード。

  • DbInstanceMemory: インスタンスのメモリサイズ。

  • ReadOnlyDbInstanceIds: 読み取り専用インスタンスの ID。

  • VpcId: インスタンスの VPC ID。

  • DBInstanceIPArray: インスタンスの IP アドレスホワイトリストの詳細。

  • DbInstanceDescription: インスタンスの説明。

  • DbInstanceCpu: インスタンスの vCPU 数。

  • ConnectionString: インスタンスのエンドポイント。

  • ExpireTime: データベースの有効期限。

  • PublicPort: データベースへの接続に使用するポート。

  • YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      ExtensionResource:
        Type: ALIYUN::GraphDatabase::DbInstance
        Properties:
          DbInstanceNetworkType: VPC
          DbInstanceStorageType: cloud_essd
          DbNodeStorage: 100
          DbInstanceCategory: ha
          DbVersion: '1.0'
          PaymentType: PostPaid
          DbNodeClass: gdb.r.2xlarge
    Outputs:
      DbInstanceId:
        Description: リソースの最初の ID。
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - DbInstanceId
  • JSON 形式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "ExtensionResource": {
          "Type": "ALIYUN::GraphDatabase::DbInstance",
          "Properties": {
            "DbInstanceNetworkType": "VPC",
            "DbInstanceStorageType": "cloud_essd",
            "DbNodeStorage": 100,
            "DbInstanceCategory": "ha",
            "DbVersion": "1.0",
            "PaymentType": "PostPaid",
            "DbNodeClass": "gdb.r.2xlarge"
          }
        }
      },
      "Outputs": {
        "DbInstanceId": {
          "Description": "リソースの最初の ID。",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "DbInstanceId"
            ]
          }
        }
      }
    }