翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# Neptune グローバルデータベース API
<a name="api-global-dbs"></a>

**アクション:**
+ [CreateGlobalCluster (アクション)](#CreateGlobalCluster)
+ [DeleteGlobalCluster (アクション)](#DeleteGlobalCluster)
+ [ModifyGlobalCluster (アクション)](#ModifyGlobalCluster)
+ [DescribeGlobalClusters (アクション)](#DescribeGlobalClusters)
+ [FailoverGlobalCluster (アクション)](#FailoverGlobalCluster)
+ [RemoveFromGlobalCluster (アクション)](#RemoveFromGlobalCluster)

**構造:**
+ [GlobalCluster (構造)](#GlobalCluster)
+ [GlobalClusterMember (構造)](#GlobalClusterMember)

## CreateGlobalCluster (アクション)
<a name="CreateGlobalCluster"></a>

         この API の AWS CLI 名は `create-global-cluster` です。

複数の Amazon リージョンにまたがる Neptune グローバルデータベースを作成します。グローバルデータベースには、読み取り/書き込み機能を備えた 1 つのプライマリクラスターと、Neptune ストレージサブシステムによって実行される高速レプリケーションによってプライマリクラスターからデータを受信する読み取り専用のセカンダリクラスターが含まれます。

最初は空のグローバルデータベースを作成し、そのデータベースに、プライマリクラスターとセカンダリクラスターを追加できます。または、作成操作時にグローバルデータベースのプライマリクラスターになるように既存の Neptune クラスターを指定できます。

**[リクエスト**]
+ **DatabaseName** (CLI では: `--database-name`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  新しいグローバルデータベースの名前 (英数字 64 文字以内)。
+ **DeletionProtection** (CLI では: `--deletion-protection`) — タイプ `boolean` の BooleanOptional (ブール値 (真または偽) の値)。

  新しいグローバルデータベースの削除保護設定。削除保護が有効な場合、グローバルデータベースは削除できません。
+ **Engine** (CLI では: `--engine`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースで使用されるデータベースエンジンの名前。

  有効な値: `neptune`
+ **EngineVersion** (CLI では: `--engine-version`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune エンジンのバージョン。

  有効な値は、`1.2.0.0` 以上です。
+ **GlobalClusterIdentifier** (CLI では: `--global-cluster-identifier`) — *必須:* GlobalClusterIdentifier、タイプ: `string` (UTF-8 でエンコードされた文字列)、1 以上または 255 以下、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  新しいグローバルデータベースクラスターのクラスター識別子。
+ **SourceDBClusterIdentifier** (CLI では: `--source-db-cluster-identifier`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  (*オプション*) 新しいグローバルデータベースのプライマリクラスターとして使用する既存の Neptune DB クラスターの Amazon リソースネーム (ARN)。
+ **StorageEncrypted** (CLI では: `--storage-encrypted`) — タイプ `boolean` の BooleanOptional (ブール値 (真または偽) の値)。

  新しいグローバルデータベースクラスターのストレージ暗号化設定。

**レスポンス**

Amazon Neptune グローバルデータベースの詳細を含みます。

このデータ型は、[CreateGlobalCluster (アクション)](#CreateGlobalCluster)、[DescribeGlobalClusters (アクション)](#DescribeGlobalClusters)、[ModifyGlobalCluster (アクション)](#ModifyGlobalCluster)、[DeleteGlobalCluster (アクション)](#DeleteGlobalCluster)、[FailoverGlobalCluster (アクション)](#FailoverGlobalCluster)、および [RemoveFromGlobalCluster (アクション)](#RemoveFromGlobalCluster) アクションのレスポンス要素として使用されます。
+ **DeletionProtection** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースの削除保護設定。
+ **Engine** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune データベースエンジン (`"neptune"`)。
+ **EngineVersion** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune エンジンのバージョン。
+ **GlobalClusterArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースの Amazon リソースネーム (ARN)。
+ **GlobalClusterIdentifier** — GlobalClusterIdentifier、Type: `string` (UTF-8 でエンコードされた文字列)、1～255、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルデータベースを識別する一意のキーです。
+ **GlobalClusterMembers** – [GlobalClusterMember](#GlobalClusterMember) オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。
+ **GlobalClusterResourceId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。
+ **StorageEncrypted** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースのストレージ暗号化設定。

**エラー**
+ [GlobalClusterAlreadyExistsFault](api-faults.md#GlobalClusterAlreadyExistsFault)
+ [GlobalClusterQuotaExceededFault](api-faults.md#GlobalClusterQuotaExceededFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## DeleteGlobalCluster (アクション)
<a name="DeleteGlobalCluster"></a>

         この API の AWS CLI 名は `delete-global-cluster` です。

グローバルデータベースを削除します。プライマリクラスターとすべてのセカンダリクラスターは、最初にデタッチまたは削除されているする必要があります。

**[リクエスト**]
+ **GlobalClusterIdentifier** (CLI では: `--global-cluster-identifier`) — *必須:* GlobalClusterIdentifier、タイプ: `string` (UTF-8 でエンコードされた文字列)、1 以上または 255 以下、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  削除されるグローバルデータベースクラスターのクラスター識別子。

**レスポンス**

Amazon Neptune グローバルデータベースの詳細を含みます。

このデータ型は、[CreateGlobalCluster (アクション)](#CreateGlobalCluster)、[DescribeGlobalClusters (アクション)](#DescribeGlobalClusters)、[ModifyGlobalCluster (アクション)](#ModifyGlobalCluster)、[DeleteGlobalCluster (アクション)](#DeleteGlobalCluster)、[FailoverGlobalCluster (アクション)](#FailoverGlobalCluster)、および [RemoveFromGlobalCluster (アクション)](#RemoveFromGlobalCluster) アクションのレスポンス要素として使用されます。
+ **DeletionProtection** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースの削除保護設定。
+ **Engine** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune データベースエンジン (`"neptune"`)。
+ **EngineVersion** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune エンジンのバージョン。
+ **GlobalClusterArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースの Amazon リソースネーム (ARN)。
+ **GlobalClusterIdentifier** — GlobalClusterIdentifier、Type: `string` (UTF-8 でエンコードされた文字列)、1～255、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルデータベースを識別する一意のキーです。
+ **GlobalClusterMembers** – [GlobalClusterMember](#GlobalClusterMember) オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。
+ **GlobalClusterResourceId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。
+ **StorageEncrypted** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースのストレージ暗号化設定。

**エラー**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)

## ModifyGlobalCluster (アクション)
<a name="ModifyGlobalCluster"></a>

         この API の AWS CLI 名は `modify-global-cluster` です。

Amazon Neptune グローバルクラスターの設定を変更します。これらのパラメータと新しい値をリクエストで指定することで、1 つ以上のデータベース設定パラメータを変更できます。

**[リクエスト**]
+ **AllowMajorVersionUpgrade** (CLI では: `--allow-major-version-upgrade`) — タイプ `boolean` の BooleanOptional (ブール値 (真または偽) の値)。

  メジャーバージョンアップグレードを許可するかどうかを示す値。

  制約: DB クラスターの現在のバージョンとは異なるメジャーバージョンである `EngineVersion` パラメータの値を指定する場合は、メジャーバージョンアップグレードを許可する必要があります。

  グローバルデータベースのメジャーバージョンをアップグレードする場合、クラスターと DB インスタンスのパラメータグループは新しいバージョンのデフォルトパラメータグループに設定されるため、アップグレードの完了後にカスタムパラメータグループを適用する必要があります。
+ **DeletionProtection** (CLI では: `--deletion-protection`) — タイプ `boolean` の BooleanOptional (ブール値 (真または偽) の値)。

  グローバルデータベースの削除保護が有効になっているかどうかを示します。削除保護が有効な場合、グローバルデータベースは削除できません。
+ **EngineVersion** (CLI では: `--engine-version`) — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  アップグレードするデータベースエンジンのバージョン番号。このパラメータを変更すると、機能停止が発生します。`ApplyImmediately` が有効でない限り、変更は次のメンテナンスウィンドウ時に適用されます。

  使用可能なエンジンバージョンをすべて一覧表示するには、次のコマンドを使用します。  
**Example**  

  ```
  aws neptune describe-db-engine-versions \
            --engine neptune \
            --query '*[]|[?SupportsGlobalDatabases == 'true'].[EngineVersion]'
  ```
+ **GlobalClusterIdentifier** (CLI では: `--global-cluster-identifier`) — *必須:* GlobalClusterIdentifier、タイプ: `string` (UTF-8 でエンコードされた文字列)、1 以上または 255 以下、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  変更されるグローバルクラスターの DB クラスター識別子。このパラメータは大文字と小文字が区別されません。

  既存のグローバルデータベースクラスターの識別子と一致する必要があります。
+ **NewGlobalClusterIdentifier** (CLI では: `--new-global-cluster-identifier`) — GlobalClusterIdentifier、タイプ: `string`(UTF-8 でエンコードされた文字列)、1 以上または 255 以下、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  グローバルデータベースに割り当てる新しいクラスター識別子。この値は小文字で保存されます。

  制約:
  + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。
  + 1 字目は文字である必要があります。
  + 文字列の最後にハイフンを使用したり、ハイフンを 2 つ続けて使用したりすることはできません。

  例:`my-cluster2`

**レスポンス**

Amazon Neptune グローバルデータベースの詳細を含みます。

このデータ型は、[CreateGlobalCluster (アクション)](#CreateGlobalCluster)、[DescribeGlobalClusters (アクション)](#DescribeGlobalClusters)、[ModifyGlobalCluster (アクション)](#ModifyGlobalCluster)、[DeleteGlobalCluster (アクション)](#DeleteGlobalCluster)、[FailoverGlobalCluster (アクション)](#FailoverGlobalCluster)、および [RemoveFromGlobalCluster (アクション)](#RemoveFromGlobalCluster) アクションのレスポンス要素として使用されます。
+ **DeletionProtection** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースの削除保護設定。
+ **Engine** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune データベースエンジン (`"neptune"`)。
+ **EngineVersion** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune エンジンのバージョン。
+ **GlobalClusterArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースの Amazon リソースネーム (ARN)。
+ **GlobalClusterIdentifier** — GlobalClusterIdentifier、Type: `string` (UTF-8 でエンコードされた文字列)、1～255、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルデータベースを識別する一意のキーです。
+ **GlobalClusterMembers** – [GlobalClusterMember](#GlobalClusterMember) オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。
+ **GlobalClusterResourceId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。
+ **StorageEncrypted** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースのストレージ暗号化設定。

**エラー**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)

## DescribeGlobalClusters (アクション)
<a name="DescribeGlobalClusters"></a>

         この API の AWS CLI 名は `describe-global-clusters` です。

Neptune グローバルデータベースクラスターに関する情報を返します。この API はページ分割をサポートします。

**[リクエスト**]
+ **GlobalClusterIdentifier** (CLI では: `--global-cluster-identifier`) — GlobalClusterIdentifier、タイプ: `string`(UTF-8 でエンコードされた文字列)、1 以上または 255 以下、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  ユーザーが指定した DB クラスター識別子。このパラメータが指定された場合は、指定された DB クラスターに関する情報だけが返されます。このパラメータは大文字と小文字が区別されません。

  制約: 指定された場合、既存の DB クラスター識別子と一致している必要があります。
+ **Marker** (CLI では: `--marker`) — タイプ: `string` (UTF-8 でエンコードされた文字列) の文字列。

  (*オプション*) `DescribeGlobalClusters` に対する以前の呼び出しから返されたページ割りトークン。このパラメータが指定された場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。
+ **MaxRecords** (CLI では: `--max-records`) — タイプ `integer` の IntegerOptional (符号付き 32 ビット整数)。

  レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ分割マーカートークンがレスポンスに含まれるため、それを使用して残りの結果を取得できます。

  デフォルト: `100`

  制約: 最小 20、最大 100。

**応答**
+ **GlobalClusters** – [GlobalCluster](#GlobalCluster) オブジェクトの配列。

  このリクエストによって返されたグローバルクラスタとインスタンスのリスト。
+ **Marker** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  ページ分割トークン。このパラメータがレスポンスで返された場合、さらに多くのレコードが使用可能になり、`DescribeGlobalClusters` をさらに 1 回以上呼び出すことで取得できます。

**エラー**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)

## FailoverGlobalCluster (アクション)
<a name="FailoverGlobalCluster"></a>

         この API の AWS CLI 名は `failover-global-cluster` です。

Neptune グローバルデータベースのフェイルオーバープロセスを開始します。

Neptune グローバルデータベースのフェイルオーバーは、読み取り専用のセカンダリ DB クラスターの 1 つをプライマリ DB クラスターに昇格させ、プライマリ DB クラスターをセカンダリ (読み取り専用) DB クラスターに降格させます。つまり、現在のプライマリ DB クラスターと選択されたターゲットのセカンダリ DB クラスターの役割が入れ替わります。選択されたセカンダリ DB クラスターは、Neptune グローバルデータベースの完全な読み取り/書き込み機能を前提としています。

**注記**  
このアクションは、Neptune グローバルデータベースに**のみ**適用されます。このアクションは、Neptune DB クラスターが正常で、リージョン全体で停止していない正常な Neptune グローバルデータベースでの使用、災害復旧シナリオのテスト、またはグローバルデータベーストポロジの再構成のみを目的としています。

**[リクエスト**]
+ **GlobalClusterIdentifier** (CLI では: `--global-cluster-identifier`) — *必須:* GlobalClusterIdentifier、タイプ: `string` (UTF-8 でエンコードされた文字列)、1 以上または 255 以下、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  フェイルオーバーする必要がある Neptune グローバルデータベースの識別子。識別子は、Neptune グローバルデータベースの作成時にユーザーによって割り当てられた一意のキーです。つまり、フェイルオーバーするグローバルデータベースの名前です。

  制約: 既存の Neptune グローバルデータベースの識別子と一致する必要があります。
+ **TargetDbClusterIdentifier** (CLI では: `--target-db-cluster-identifier`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースのプライマリに昇格するセカンダリ Neptune DB クラスターの Amazon リソースネーム (ARN)。

**レスポンス**

Amazon Neptune グローバルデータベースの詳細を含みます。

このデータ型は、[CreateGlobalCluster (アクション)](#CreateGlobalCluster)、[DescribeGlobalClusters (アクション)](#DescribeGlobalClusters)、[ModifyGlobalCluster (アクション)](#ModifyGlobalCluster)、[DeleteGlobalCluster (アクション)](#DeleteGlobalCluster)、[FailoverGlobalCluster (アクション)](#FailoverGlobalCluster)、および [RemoveFromGlobalCluster (アクション)](#RemoveFromGlobalCluster) アクションのレスポンス要素として使用されます。
+ **DeletionProtection** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースの削除保護設定。
+ **Engine** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune データベースエンジン (`"neptune"`)。
+ **EngineVersion** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune エンジンのバージョン。
+ **GlobalClusterArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースの Amazon リソースネーム (ARN)。
+ **GlobalClusterIdentifier** — GlobalClusterIdentifier、Type: `string` (UTF-8 でエンコードされた文字列)、1～255、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルデータベースを識別する一意のキーです。
+ **GlobalClusterMembers** – [GlobalClusterMember](#GlobalClusterMember) オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。
+ **GlobalClusterResourceId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。
+ **StorageEncrypted** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースのストレージ暗号化設定。

**エラー**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## RemoveFromGlobalCluster (アクション)
<a name="RemoveFromGlobalCluster"></a>

         この API の AWS CLI 名は `remove-from-global-cluster` です。

Neptune DB クラスターを Neptune グローバルデータベースからデタッチします。セカンダリクラスターは、読み取り専用の代わりに読み書き機能を備えた通常のスタンドアロンクラスターになり、プライマリクラスターからデータを受信しなくなります。

**[リクエスト**]
+ **DbClusterIdentifier** (CLI では: `--db-cluster-identifier`) — *必須:* タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  Neptune グローバルデータベースクラスターからデタッチされるクラスターを識別する Amazon リソースネーム (ARN)。
+ **GlobalClusterIdentifier** (CLI では: `--global-cluster-identifier`) — *必須:* GlobalClusterIdentifier、タイプ: `string` (UTF-8 でエンコードされた文字列)、1 以上または 255 以下、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  指定された Neptune DB クラスターをデタッチする Neptune グローバルデータベースの識別子。

**レスポンス**

Amazon Neptune グローバルデータベースの詳細を含みます。

このデータ型は、[CreateGlobalCluster (アクション)](#CreateGlobalCluster)、[DescribeGlobalClusters (アクション)](#DescribeGlobalClusters)、[ModifyGlobalCluster (アクション)](#ModifyGlobalCluster)、[DeleteGlobalCluster (アクション)](#DeleteGlobalCluster)、[FailoverGlobalCluster (アクション)](#FailoverGlobalCluster)、および [RemoveFromGlobalCluster (アクション)](#RemoveFromGlobalCluster) アクションのレスポンス要素として使用されます。
+ **DeletionProtection** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースの削除保護設定。
+ **Engine** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune データベースエンジン (`"neptune"`)。
+ **EngineVersion** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune エンジンのバージョン。
+ **GlobalClusterArn** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  グローバルデータベースの Amazon リソースネーム (ARN)。
+ **GlobalClusterIdentifier** — GlobalClusterIdentifier、Type: `string` (UTF-8 でエンコードされた文字列)、1～255、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルデータベースを識別する一意のキーです。
+ **GlobalClusterMembers** – [GlobalClusterMember](#GlobalClusterMember) オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。
+ **GlobalClusterResourceId** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。
+ **Status** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。
+ **StorageEncrypted** — BooleanOptional、タイプ:`boolean` (ブール値 (真または偽))。

  グローバルデータベースのストレージ暗号化設定。

**エラー**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## *構造:*
<a name="api-global-dbs-structures-spacer"></a>

## GlobalCluster (構造)
<a name="GlobalCluster"></a>

Amazon Neptune グローバルデータベースの詳細を含みます。

このデータ型は、[CreateGlobalCluster (アクション)](#CreateGlobalCluster)、[DescribeGlobalClusters (アクション)](#DescribeGlobalClusters)、[ModifyGlobalCluster (アクション)](#ModifyGlobalCluster)、[DeleteGlobalCluster (アクション)](#DeleteGlobalCluster)、[FailoverGlobalCluster (アクション)](#FailoverGlobalCluster)、および [RemoveFromGlobalCluster (アクション)](#RemoveFromGlobalCluster) アクションのレスポンス要素として使用されます。

**フィールド**
+ **DeletionProtection** — BooleanOptional、タイプ: `boolean` (ブール値 (真または偽))。

  グローバルデータベースの削除保護設定。
+ **Engine** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune データベースエンジン (`"neptune"`)。
+ **EngineVersion** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  グローバルデータベースによって使用される Neptune エンジンのバージョン。
+ **GlobalClusterArn** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  グローバルデータベースの Amazon リソースネーム (ARN)。
+ **GlobalClusterIdentifier** — GlobalClusterIdentifier、タイプ `string` (UTF-8 でエンコードされた文字列)、1～255 バイト長、正規表現 `[A-Za-z][0-9A-Za-z-:._]*` に一致。

  ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルデータベースを識別する一意のキーです。
+ **GlobalClusterMembers** — これは [GlobalClusterMember](#GlobalClusterMember) オブジェクトの配列です。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。
+ **GlobalClusterResourceId** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。
+ **Status** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。
+ **StorageEncrypted** — BooleanOptional、タイプ: `boolean` (ブール値 (真または偽))。

  グローバルデータベースのストレージ暗号化設定。

`GlobalCluster` は、以下のレスポンス要素として使用されます。
+ [CreateGlobalCluster](#CreateGlobalCluster)
+ [ModifyGlobalCluster](#ModifyGlobalCluster)
+ [DeleteGlobalCluster](#DeleteGlobalCluster)
+ [RemoveFromGlobalCluster](#RemoveFromGlobalCluster)
+ [FailoverGlobalCluster](#FailoverGlobalCluster)

## GlobalClusterMember (構造)
<a name="GlobalClusterMember"></a>

 Neptune グローバルデータベースに関連付けられているプライマリおよびセカンダリクラスターに関する情報を含むデータ構造。

**フィールド**
+ **DBClusterArn** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

   各 Neptune クラスターの Amazon リソースネーム (ARN)。
+ **IsWriter** — ブール値、タイプ: `boolean` (ブール値 (真または偽))。

   Neptune クラスターが、関連付けられている Neptune グローバルデータベースのプライマリクラスター (すなわち、読み取り/書き込み機能を持つ) かどうかを指定します。
+ **Readers** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

   Neptune グローバルデータベースに関連付けられている各読み取り専用セカンダリクラスターの Amazon リソースネーム (ARN)。