Neptune グローバルデータベース API

• CreateGlobalCluster (アクション)

• DeleteGlobalCluster (アクション)

• ModifyGlobalCluster (アクション)

• DescribeGlobalClusters (アクション)

• FailoverGlobalCluster (アクション)

• RemoveFromGlobalCluster (アクション)

• GlobalCluster (構造)

• GlobalClusterMember (構造)

• 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 (ブール値 (真または偽) の値)。

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

• 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 オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。

• GlobalClusterResourceId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。

• Status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。

• StorageEncrypted — BooleanOptional、タイプ:boolean (ブール値 (真または偽))。

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

エラー

• GlobalClusterAlreadyExistsFault

• GlobalClusterQuotaExceededFault

• InvalidDBClusterStateFault

• DBClusterNotFoundFault

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

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

• 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 オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。

• GlobalClusterResourceId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。

• Status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。

• StorageEncrypted — BooleanOptional、タイプ:boolean (ブール値 (真または偽))。

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

エラー

• GlobalClusterNotFoundFault

• InvalidGlobalClusterStateFault

• 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 が有効でない限り、変更は次のメンテナンスウィンドウ時に適用されます。

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

  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

• 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 オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。

• GlobalClusterResourceId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。

• Status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。

• StorageEncrypted — BooleanOptional、タイプ:boolean (ブール値 (真または偽))。

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

エラー

• GlobalClusterNotFoundFault

• InvalidGlobalClusterStateFault

• 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 オブジェクトの配列。

  このリクエストによって返されたグローバルクラスタとインスタンスのリスト。

• Marker — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

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

エラー

• GlobalClusterNotFoundFault

• 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)。

• 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 オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。

• GlobalClusterResourceId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。

• Status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。

• StorageEncrypted — BooleanOptional、タイプ:boolean (ブール値 (真または偽))。

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

エラー

• GlobalClusterNotFoundFault

• InvalidGlobalClusterStateFault

• InvalidDBClusterStateFault

• DBClusterNotFoundFault

• 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 グローバルデータベースの識別子。

• 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 オブジェクトの配列。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。

• GlobalClusterResourceId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。

• Status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。

• StorageEncrypted — BooleanOptional、タイプ:boolean (ブール値 (真または偽))。

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

エラー

• GlobalClusterNotFoundFault

• InvalidGlobalClusterStateFault

• DBClusterNotFoundFault

フィールド

• 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 オブジェクトの配列です。

  グローバルデータベースに含まれるすべての DB クラスターのクラスター ARN とインスタンス ARN のリスト。

• GlobalClusterResourceId — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

  すべてのリージョンで一意な、グローバルデータベースのイミュータブルな識別子。この識別子は、DB クラスターの KMS キーにアクセスするたびに CloudTrail ログエントリに記録されます。

• Status — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

  このグローバルデータベースの現在の状態を指定します。

• StorageEncrypted — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

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

• CreateGlobalCluster

• ModifyGlobalCluster

• DeleteGlobalCluster

• RemoveFromGlobalCluster

• FailoverGlobalCluster

フィールド

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

  各 Neptune クラスターの Amazon リソースネーム (ARN)。

• IsWriter — ブール値、タイプ: boolean (ブール値 (真または偽))。

  Neptune クラスターが、関連付けられている Neptune グローバルデータベースのプライマリクラスター (すなわち、読み取り/書き込み機能を持つ) かどうかを指定します。

• Readers — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

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