Neptune DB クラスター API - Amazon Neptune
CreateDBClusterDeleteDBClusterModifyDBClusterStartDBClusterStopDBClusterAddRoleToDBClusterRemoveRoleFromDBClusterFailoverDBClusterPromoteReadReplicaDBClusterDescribeDBClusters________________________DBClusterDBClusterMemberDBClusterRoleCloudwatchLogsExportConfigurationPendingCloudwatchLogsExportsClusterPendingModifiedValues

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

Neptune DB クラスター API

アクション:

構造:

CreateDBCluster (アクション)

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

新しい Amazon Neptune DB クラスターを作成します。

ReplicationSourceIdentifier パラメータを使用して、別の DB クラスターまたは Amazon Neptune DB インスタンスのリードレプリカとして DB クラスターを作成できます。

CreateDBCluster を直接使用して新しいクラスターを作成する場合、削除保護はデフォルトで無効になっています (コンソールで新しい本番稼働用クラスターを作成する場合、削除保護はデフォルトで有効になっています)。DB クラスターは、DeletionProtection フィールドが false に設定されている場合にのみ削除できます。

リクエスト

  • AvailabilityZones (CLI では: --availability-zones) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスター内のインスタンスを作成できる EC2 アベイラビリティーゾーンのリスト。

  • BackupRetentionPeriod (CLI では: --backup-retention-period) — タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動バックアップを保管する日数。最小値 1 を指定しなければなりません。

    デフォルト: 1

    制約:

    • 1 ～ 35 の値にする必要があります。

  • CopyTagsToSnapshot (CLI では: --copy-tags-to-snapshot) — タイプ boolean の BooleanOptional (ブール値 (真または偽) の値)。

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

  • DatabaseName (CLI では: --database-name) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    データベースの名前を、英数字 64 文字以内で入力します。名前を入力しない場合は、Amazon Neptune はここで作成する DB クラスター上にデータベースを作成しません。

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスター識別子。このパラメータは小文字で保存されます。

    制約:

    • 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。

    • 1 字目は英字である必要があります。

    • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。

    例: my-cluster1

  • DBClusterParameterGroupName (CLI では: --db-cluster-parameter-group-name) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    このクラスターに関連付ける DB クラスターパラメータグループの名前。この引数を省略すると、デフォルトが使用されます。

    制約:

    • 指定した場合、既存の DBClusterParameterGroup の名前と一致する必要があります。

  • DBSubnetGroupName (CLI では: --db-subnet-group-name) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスターに関連付ける DB サブネットグループ。

    制約: 既存の DBSubnetGroup の名前と一致する必要があります。デフォルト値を使用することはできません。

    例: mySubnetgroup

  • DeletionProtection (CLI では: --deletion-protection) — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

    DB クラスターで削除保護が有効になっているかどうかを示す値。削除保護が有効になっている場合、データベースを削除することはできません。デフォルトでは、削除保護は有効です。

  • EnableCloudwatchLogsExports (CLI では: --enable-cloudwatch-logs-exports) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスターが CloudWatch Logs にエクスポートするログタイプのリスト。有効なログタイプは、audit (監査ログを公開する場合) と slowquery (スロークエリログを公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

  • EnableIAMDatabaseAuthentication (CLI では: --enable-iam-database-authentication) — タイプ boolean の BooleanOptional (ブール値 (真または偽) の値)。

    true に設定されている場合、DB クラスター全体の Amazon Identity and Access Management (IAM) 認証を有効にします（インスタンスレベルでは設定できません）。

    デフォルト: false。

  • Engine (CLI では: --engine) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスターに使用されるデータベースエンジンの名前。

    有効な値：neptune

  • EngineVersion (CLI では: --engine-version) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    新しい DB クラスターに使用するデータベースエンジンのバージョン。

    例: 1.2.1.0

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

    この新しい DB クラスターを追加する必要がある Neptune グローバルデータベースの ID。

  • KmsKeyId (CLI では: --kms-key-id) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    暗号化された DB クラスターの Amazon KMS キー識別子。

    KMS キー識別子は、KMS 暗号化キーの Amazon リソースネーム (ARN) です。新しい DB クラスターの暗号化に使用する KMS 暗号化キーを所有する Amazon アカウントと同じアカウントを使用して DB クラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーのエイリアスを使用できます。

    KmsKeyId で暗号化キーが指定されていない場合:

    • ReplicationSourceIdentifier が暗号化されたソースを識別した場合、Amazon Neptune はソースの暗号化に使用された暗号化キーを使用します。それ以外の場合、Amazon Neptune はデフォルトの暗号化キーを使用します。

    • StorageEncrypted パラメータが true の場合で ReplicationSourceIdentifier が指定されていない場合、Amazon Neptune はデフォルトの暗号化キーを使用します。

    Amazon KMS は、Amazon アカウント用にデフォルトの暗号化キーを作成します。Amazon アカウントには、Amazon のリージョンごとにデフォルトの暗号化キーがあります。

    別の Amazon リージョンで暗号化された DB クラスターのリードレプリカを作成する場合は、KmsKeyId を移行先の Amazon リージョンで有効な KMS キー ID に設定する必要があります。このキーはその Amazon リージョンでリードレプリカの暗号化に使用されます。

  • Port (CLI では: --port) — タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    DB クラスターのインスタンスが接続を受け付けることができるポート番号。

    デフォルト: 8182

  • PreferredBackupWindow (CLI では: --preferred-backup-window) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    BackupRetentionPeriod パラメータを使用して自動バックアップが有効になっている場合に、自動バックアップが作成される毎日の時間範囲。

    デフォルトのバックアップウィンドウは 30 分のウィンドウで、Amazon リージョンごとに 8 時間の時間ブロックからランダムに選択されます。使用可能な時間帯を表示するには、「Amazon Neptune ユーザーガイド」の「Neptune メンテナンスウィンドウ」を参照してください。

    制約:

    • hh24:mi-hh24:mi の形式である必要があります。

    • 時間は協定世界時 (UTC) である必要があります。

    • 必要なメンテナンス期間と競合してはいけません。

    • 少なくとも 30 分以上必要です。

  • PreferredMaintenanceWindow (CLI では: --preferred-maintenance-window) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。

    形式: ddd:hh24:mi-ddd:hh24:mi

    デフォルトは、1 週間のうちのランダムな日に起こる、Amazon リージョンあたり 8 時間の範囲からランダムに選択された 30 分の時間窓です。使用可能な時間帯を表示するには、「Amazon Neptune ユーザーガイド」の「Neptune メンテナンスウィンドウ」を参照してください。

    有効な日数: Mon, Tue, Wed, Thu, Fri, Sat, Sun です。

    制約: 最小限の 30 分単位のウィンドウ。

  • PreSignedUrl (CLI では: --pre-signed-url) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    このパラメータは、現在サポートされていません。

  • ReplicationSourceIdentifier (CLI では: --replication-source-identifier) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    この DB クラスターがリードレプリカとして作成されている場合の、ソース DB インスタンスまたは DB クラスターの Amazon リソースネーム (ARN)。

  • ServerlessV2ScalingConfiguration (CLI では: --serverless-v2-scaling-configuration) — ServerlessV2ScalingConfiguration オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング構成を含みます。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

  • StorageEncrypted (CLI では: --storage-encrypted) — タイプ boolean の BooleanOptional (ブール値 (真または偽) の値)。

    DB クラスターが暗号化されているかどうかを指定します。

  • StorageType (CLI では: --storage-type) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    新しい DB クラスターのストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを設定します。standard に設定すると、ストレージタイプは応答で返されません。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • Tags (CLI では: --tags) - タグ オブジェクトの配列。

    新しい DB クラスターに割り当てるタグ。

  • VpcSecurityGroupIds (CLI では: --vpc-security-group-ids) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    この DB クラスターに関連付ける EC2 VPC セキュリティグループのリスト。

レスポンス

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles – DBClusterRole オブジェクトの配列。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

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

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

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

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

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

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

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

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

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

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

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

    DB クラスターの Amazon リソースネーム (ARN) を返します。

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

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers – DBClusterMember オブジェクトの配列。

    DB クラスターを構成するインスタンスのリストを入力します。

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

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

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

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

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

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

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

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

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

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

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

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

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

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

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

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — GlobalClusterIdentifier、Type: string (UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

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

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

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

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

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

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

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

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues – ClusterPendingModifiedValues オブジェクト。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

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

    オペレーションの進行状況をパーセンテージで指定します。

  • Port - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

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

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

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

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

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

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

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

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

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

    Neptune ではサポートされていません。

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

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration – ServerlessV2ScalingConfigurationInfo オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

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

    この DB クラスターの現在の状態を指定します。

  • StorageEncrypted - タイプ boolean のブール値 (ブール値 (真または偽))。

    DB クラスターが暗号化されているかどうかを指定します。

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

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups – VpcSecurityGroupMembership オブジェクトの配列。

    DB クラスターが属する VPC セキュリティグループのリストを入力します。

エラー

DeleteDBCluster (アクション)

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

DeleteDBCluster アクションでは、以前にプロビジョニングされた DB クラスターを削除します。DB クラスターを削除すると、その DB クラスターの自動バックアップはすべて削除され、復旧できません。指定した DB クラスターの手動 DB クラスタースナップショットは削除されません。

削除保護が有効になっている場合、DB クラスターは削除できません。削除するには、まず DeletionProtection フィールドを False に設定する必要があります。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    削除する DB クラスターの DB クラスター識別子。このパラメータでは大文字と小文字は区別されません。

    制約:

    • 既存の DBClusterIdentifier と一致する必要があります。

  • FinalDBSnapshotIdentifier (CLI では: --final-db-snapshot-identifier) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    SkipFinalSnapshot が false に設定された場合の、作成された新規の DB クラスタースナップショットの DB クラスタースナップショット識別子。

    注記

    このパラメータを指定して SkipFinalShapshot パラメータを true に設定すると、エラーが発生します。

    制約:

    • 1 ～ 255 の英字、数字、ハイフンである必要があります。

    • 1 字目は英字である必要があります。

    • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません

  • SkipFinalSnapshot (CLI では: --skip-final-snapshot) — タイプ: boolean のブール値 (ブール値 (真または偽) の値)。

    DB クラスターの削除前に最終 DB クラスタースナップショットを作成するかどうかを指定します。true を指定した場合、DB クラスタースナップショットが作成されます。false が指定されている場合、DB クラスターの削除前に DB クラスタースナップショットが作成されます。

    注記

    SkipFinalSnapshot が false の場合は、FinalDBSnapshotIdentifier パラメータを指定する必要があります。

    デフォルト: false

レスポンス

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles – DBClusterRole オブジェクトの配列。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

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

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

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

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

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

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

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

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

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

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

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

    DB クラスターの Amazon リソースネーム (ARN) を返します。

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

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers – DBClusterMember オブジェクトの配列。

    DB クラスターを構成するインスタンスのリストを入力します。

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

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

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

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

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

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

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

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

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

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

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

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

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

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

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

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — GlobalClusterIdentifier、Type: string (UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

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

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

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

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

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

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

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

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues – ClusterPendingModifiedValues オブジェクト。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

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

    オペレーションの進行状況をパーセンテージで指定します。

  • Port - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

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

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

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

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

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

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

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

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

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

    Neptune ではサポートされていません。

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

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration – ServerlessV2ScalingConfigurationInfo オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

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

    この DB クラスターの現在の状態を指定します。

  • StorageEncrypted - タイプ boolean のブール値 (ブール値 (真または偽))。

    DB クラスターが暗号化されているかどうかを指定します。

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

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups – VpcSecurityGroupMembership オブジェクトの配列。

    DB クラスターが属する VPC セキュリティグループのリストを入力します。

エラー

ModifyDBCluster (アクション)

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

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

リクエスト

  • AllowMajorVersionUpgrade (CLI では: --allow-major-version-upgrade) — タイプ: boolean のブール値 (ブール値 (真または偽) の値)。

    異なるメジャーバージョンへのアップグレードが許可されるかどうかを示す値。

    制約: DB クラスターの現在のバージョンとは異なるメジャーバージョンを使用する EngineVersion パラメータを指定するときには、allow-major-version-upgrade フラグを設定する必要があります。

  • ApplyImmediately (CLI では: --apply-immediately) — タイプ: boolean のブール値 (ブール値 (真または偽) の値)。

    DB クラスターの PreferredMaintenanceWindow の設定に関係なく、このリクエストの変更と保留中の変更をできるだけ早く非同期に適用するかどうかを指定する値。このパラメータを false に設定した場合、DB クラスターへの変更は次のメンテナンスウィンドウ中に適用されます。

    ApplyImmediately パラメータは、NewDBClusterIdentifier 値にのみ影響します。ApplyImmediately パラメータ値を false に設定した場合、NewDBClusterIdentifier の値への変更は、次のメンテナンス期間中に適用されます。他のすべての変更は、ApplyImmediately パラメータの値に関係なく、即時に適用されます。

    デフォルト: false

  • BackupRetentionPeriod (CLI では: --backup-retention-period) — タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動バックアップを保管する日数。最小値 1 を指定しなければなりません。

    デフォルト: 1

    制約:

    • 1 ～ 35 の値にする必要があります。

  • CloudwatchLogsExportConfiguration (CLI では: --cloudwatch-logs-export-configuration) — CloudwatchLogsExportConfiguration オブジェクト。

    特定の DB クラスターの CloudWatch Logs にエクスポートするために有効にするログタイプの設定。「CLI を使用して Neptune 監査ログを CloudWatch Logs に発行する」を参照してください。

  • CopyTagsToSnapshot (CLI では: --copy-tags-to-snapshot) — タイプ boolean の BooleanOptional (ブール値 (真または偽) の値)。

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

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

    制約:

    • 既存の DBCluster の識別子と一致する必要があります。

  • DBClusterParameterGroupName (CLI では: --db-cluster-parameter-group-name) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    DB クラスターに使用する DB クラスターパラメータグループの名前。

  • DBInstanceParameterGroupName (CLI では: --db-instance-parameter-group-name) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    DB クラスターのすべてのインスタンスに適用する DB パラメータグループの名前です。

    注記

    DBInstanceParameterGroupName を使用してパラメータグループを適用すると、パラメータの変更は次のメンテナンスウィンドウには適用されるのではなく、ただちに適用されます。

    デフォルト: 既存の名前設定

    制約:

    • DB パラメータグループは、ターゲットの DB クラスターのバージョンと同じ DB パラメータグループファミリーに属している必要があります。

    • DBInstanceParameterGroupName パラメータは、AllowMajorVersionUpgrade パラメータと組み合わせた場合のみ有効です。

  • DeletionProtection (CLI では: --deletion-protection) — タイプ boolean の BooleanOptional (ブール値 (真または偽) の値)。

    DB クラスターで削除保護が有効になっているかどうかを示す値。削除保護が有効になっている場合、データベースを削除することはできません。デフォルトでは、削除保護は無効です。

  • EnableIAMDatabaseAuthentication (CLI では: --enable-iam-database-authentication) — タイプ boolean の BooleanOptional (ブール値 (真または偽) の値)。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

    デフォルト: false

  • EngineVersion (CLI では: --engine-version) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

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

    有効なエンジンバージョンのリストについては、「Amazon Neptune のエンジンリリース」を参照するか、DescribeDBEngineVersions (アクション) に連絡してください。

  • NewDBClusterIdentifier (CLI では: --new-db-cluster-identifier) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    DB クラスターの名前を変更する場合の DB クラスターの新規 DB クラスター識別子 この値は小文字で保存されます。

    制約:

    • 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。

    • 1 字目は文字である必要があります

    • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません

    例: my-cluster2

  • Port (CLI では: --port) — タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    DB クラスターが接続を受け付けるポート番号。

    制約: 値は 1150-65535 である必要があります。

    デフォルト : 元の DB クラスターと同じポート。

  • PreferredBackupWindow (CLI では: --preferred-backup-window) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    BackupRetentionPeriod パラメータを使用して自動バックアップが有効になっている場合に、自動バックアップが作成される毎日の時間範囲。

    デフォルトのバックアップウィンドウは 30 分のウィンドウで、Amazon リージョンごとに 8 時間の時間ブロックからランダムに選択されます。

    制約:

    • hh24:mi-hh24:mi の形式である必要があります。

    • 時間は協定世界時 (UTC) である必要があります。

    • 必要なメンテナンス期間と競合してはいけません。

    • 少なくとも 30 分以上必要です。

  • PreferredMaintenanceWindow (CLI では: --preferred-maintenance-window) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。

    形式: ddd:hh24:mi-ddd:hh24:mi

    デフォルトは、1 週間のうちのランダムな日に起こる、Amazon リージョンあたり 8 時間の範囲からランダムに選択された 30 分の時間窓です。

    有効な日数: Mon, Tue, Wed, Thu, Fri, Sat, Sun です。

    制約: 最小限の 30 分単位のウィンドウ。

  • ServerlessV2ScalingConfiguration (CLI では: --serverless-v2-scaling-configuration) — ServerlessV2ScalingConfiguration オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング構成を含みます。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

  • StorageType (CLI では: --storage-type) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    DB クラスターに関連付けるストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを設定します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroupIds (CLI では: --vpc-security-group-ids) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    DB クラスターが属する VPC セキュリティグループのリスト。

レスポンス

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles – DBClusterRole オブジェクトの配列。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

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

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

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

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

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

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

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

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

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

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

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

    DB クラスターの Amazon リソースネーム (ARN) を返します。

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

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers – DBClusterMember オブジェクトの配列。

    DB クラスターを構成するインスタンスのリストを入力します。

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

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

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

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

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

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

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

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

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

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

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

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

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

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

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

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — GlobalClusterIdentifier、Type: string (UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

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

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

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

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

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

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

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

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues – ClusterPendingModifiedValues オブジェクト。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

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

    オペレーションの進行状況をパーセンテージで指定します。

  • Port - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

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

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

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

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

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

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

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

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

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

    Neptune ではサポートされていません。

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

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration – ServerlessV2ScalingConfigurationInfo オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

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

    この DB クラスターの現在の状態を指定します。

  • StorageEncrypted - タイプ boolean のブール値 (ブール値 (真または偽))。

    DB クラスターが暗号化されているかどうかを指定します。

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

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups – VpcSecurityGroupMembership オブジェクトの配列。

    DB クラスターが属する VPC セキュリティグループのリストを入力します。

エラー

StartDBCluster (アクション)

        この API AWS の CLI 名は ですstart-db-cluster。

Amazon コンソール、Amazon CLI の stop-db-cluster コマンド、または StopDBCluster API を使用して停止された Amazon Neptune DB クラスターを起動します。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    起動する Neptune DB クラスターの DB クラスター識別子。このパラメータは小文字で保存されます。

レスポンス

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles – DBClusterRole オブジェクトの配列。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

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

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

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

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

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

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

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

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

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

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

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

    DB クラスターの Amazon リソースネーム (ARN) を返します。

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

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers – DBClusterMember オブジェクトの配列。

    DB クラスターを構成するインスタンスのリストを入力します。

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

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

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

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

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

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

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

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

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

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

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

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

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

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

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

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — GlobalClusterIdentifier、Type: string (UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

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

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

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

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

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

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

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

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues – ClusterPendingModifiedValues オブジェクト。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

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

    オペレーションの進行状況をパーセンテージで指定します。

  • Port - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

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

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

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

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

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

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

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

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

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

    Neptune ではサポートされていません。

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

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration – ServerlessV2ScalingConfigurationInfo オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

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

    この DB クラスターの現在の状態を指定します。

  • StorageEncrypted - タイプ boolean のブール値 (ブール値 (真または偽))。

    DB クラスターが暗号化されているかどうかを指定します。

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

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups – VpcSecurityGroupMembership オブジェクトの配列。

    DB クラスターが属する VPC セキュリティグループのリストを入力します。

エラー

StopDBCluster (アクション)

        この API AWS の CLI 名は ですstop-db-cluster。

Amazon Neptune DB クラスターを停止します。DB クラスターを停止すると、Neptune は DB クラスターのメタデータ (エンドポイントや DB パラメータグループを含む) を保持します。

Neptune はトランザクションログも保持するため、必要に応じてポイントインタイムの復元を実行できます。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    停止する Neptune DB クラスターの DB クラスター識別子。このパラメータは小文字で保存されます。

レスポンス

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles – DBClusterRole オブジェクトの配列。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

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

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

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

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

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

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

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

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

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

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

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

    DB クラスターの Amazon リソースネーム (ARN) を返します。

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

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers – DBClusterMember オブジェクトの配列。

    DB クラスターを構成するインスタンスのリストを入力します。

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

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

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

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

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

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

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

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

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

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

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

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

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

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

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

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — GlobalClusterIdentifier、Type: string (UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

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

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

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

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

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

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

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

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues – ClusterPendingModifiedValues オブジェクト。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

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

    オペレーションの進行状況をパーセンテージで指定します。

  • Port - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

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

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

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

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

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

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

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

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

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

    Neptune ではサポートされていません。

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

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration – ServerlessV2ScalingConfigurationInfo オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

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

    この DB クラスターの現在の状態を指定します。

  • StorageEncrypted - タイプ boolean のブール値 (ブール値 (真または偽))。

    DB クラスターが暗号化されているかどうかを指定します。

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

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups – VpcSecurityGroupMembership オブジェクトの配列。

    DB クラスターが属する VPC セキュリティグループのリストを入力します。

エラー

AddRoleToDBCluster (アクション)

        この API AWS の CLI 名は ですadd-role-to-db-cluster。

Neptune DB クラスターから Identity and Access Management (IAM) ロールを関連付けます。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    IAM ロールを関連付ける DB クラスターの名前。

  • FeatureName (CLI では: --feature-name) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    IAM ロールの関連付けを解除する Neptune DB クラスターの機能の名前。サポートされている機能名のリストについては、「DBEngineVersion (構造)」を参照してください 。

  • RoleArn (CLI では: --role-arn) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    Neptune DB クラスターに関連付ける IAM ロールの Amazon リソースネーム (ARN) 。例: arn:aws:iam::123456789012:role/NeptuneAccessRole

レスポンス

  • 応答パラメータはありません。

エラー

RemoveRoleFromDBCluster (アクション)

        この API AWS の CLI 名は ですremove-role-from-db-cluster。

DB クラスターから Identity and Access Management (IAM) ロールの関連付けを解除します。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    IAM ロールの関連付けを解除する DB クラスターの名前。

  • FeatureName (CLI では: --feature-name) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    IAM ロールの関連付けを解除する DB クラスターの機能の名前。サポートされている機能名のリストについては、「DescribeDBEngineVersions (アクション)」を参照してください 。

  • RoleArn (CLI では: --role-arn) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスターから関連付けを解除する IAM ロールの Amazon リソースネーム (ARN) 。例: arn:aws:iam::123456789012:role/NeptuneAccessRole

レスポンス

  • 応答パラメータはありません。

エラー

FailoverDBCluster (アクション)

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

DB クラスターのフェイルオーバーを強制実行します。

DB クラスターのフェイルオーバーにより、DB クラスター内のリードレプリカの 1 つ (読み取り専用インスタンス) が、プライマリインスタンス (クラスターライター) に昇格されます。

Amazon Neptune は、プライマリインスタンスが失敗した場合、自動的にリードレプリカにフェイルオーバーします (存在する場合)。テストのため、プライマリインスタンスの失敗をシミュレートする場合は、フェイルオーバーを強制できます。DB クラスター内の各インスタンスには独自のエンドポイントアドレスがあるため、フェイルオーバーが完了したときに、それらのエンドポイントアドレスを使用する既存の接続をクリーンアップして再確立する必要があります。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    フェイルオーバーを強制する DB クラスター識別子。このパラメータは大文字と小文字が区別されません。

    制約:

    • 既存の DBCluster の識別子と一致する必要があります。

  • TargetDBInstanceIdentifier (CLI では: --target-db-instance-identifier) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    プライマリインスタンスに昇格するインスタンスの名前。

    DB クラスター内のリードレプリカのインスタンス識別子を指定する必要があります。例えば、mydbcluster-replica1。

レスポンス

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles – DBClusterRole オブジェクトの配列。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

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

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

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

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

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

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

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

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

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

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

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

    DB クラスターの Amazon リソースネーム (ARN) を返します。

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

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers – DBClusterMember オブジェクトの配列。

    DB クラスターを構成するインスタンスのリストを入力します。

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

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

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

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

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

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

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

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

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

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

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

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

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

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

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

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — GlobalClusterIdentifier、Type: string (UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

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

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

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

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

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

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

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

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues – ClusterPendingModifiedValues オブジェクト。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

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

    オペレーションの進行状況をパーセンテージで指定します。

  • Port - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

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

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

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

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

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

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

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

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

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

    Neptune ではサポートされていません。

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

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration – ServerlessV2ScalingConfigurationInfo オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

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

    この DB クラスターの現在の状態を指定します。

  • StorageEncrypted - タイプ boolean のブール値 (ブール値 (真または偽))。

    DB クラスターが暗号化されているかどうかを指定します。

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

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups – VpcSecurityGroupMembership オブジェクトの配列。

    DB クラスターが属する VPC セキュリティグループのリストを入力します。

エラー

PromoteReadReplicaDBCluster (アクション)

        この API AWS の CLI 名は ですpromote-read-replica-db-cluster。

サポート外。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    サポート外。

レスポンス

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles – DBClusterRole オブジェクトの配列。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

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

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

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

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

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

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

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

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

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

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

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

    DB クラスターの Amazon リソースネーム (ARN) を返します。

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

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers – DBClusterMember オブジェクトの配列。

    DB クラスターを構成するインスタンスのリストを入力します。

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

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

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

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

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

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

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

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

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

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

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

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

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

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

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

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — GlobalClusterIdentifier、Type: string (UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

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

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

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

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

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

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

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

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues – ClusterPendingModifiedValues オブジェクト。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

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

    オペレーションの進行状況をパーセンテージで指定します。

  • Port - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

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

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

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

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

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

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

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

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

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

    Neptune ではサポートされていません。

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

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration – ServerlessV2ScalingConfigurationInfo オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

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

    この DB クラスターの現在の状態を指定します。

  • StorageEncrypted - タイプ boolean のブール値 (ブール値 (真または偽))。

    DB クラスターが暗号化されているかどうかを指定します。

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

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups – VpcSecurityGroupMembership オブジェクトの配列。

    DB クラスターが属する VPC セキュリティグループのリストを入力します。

エラー

DescribeDBClusters (アクション)

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

プロビジョニングされた DB クラスターに関する情報を返し、ページ分割をサポートします。

注記

このオペレーションは、Amazon RDS クラスターと Amazon DocDB クラスターの情報を返すこともできます。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

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

    制約:

    • 指定した場合、既存の DBClusterIdentifier と一致する必要があります。

  • Filters (CLI では: --filters) - フィルター オブジェクトの配列。

    記述する 1 つ以上の DB クラスターを指定するフィルター。

    サポートされているフィルター:

    • db-cluster-id - DB クラスター識別子と DB クラスターの Amazon リソースネーム (ARN) を受け入れます。結果リストには、これらの ARN によって識別された DB クラスターに関する情報のみが含まれます。

    • engine - エンジン名 (neptuneなど) を受け入れ、そのエンジンによって作成された DB クラスターに結果リストを制限します。

    たとえば、Amazon CLI からこの API を呼び出し、Neptune DB クラスターのみが返されるようにフィルタリングするには、次のコマンドを使用します。

    aws neptune describe-db-clusters \
            --filters  Name=engine,Values=neptune

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

    以前の DescribeDBClusters (アクション) リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには MaxRecords で指定された値まで、マーカーを超えるレコードのみが含まれます。

  • MaxRecords (CLI では: --max-records) — タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

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

    デフォルト: 100

    制約: 最小 20、最大 100。

レスポンス

  • DBClusters – DBCluster オブジェクトの配列。

    ユーザーの DB クラスターのリストが含まれます。

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

    後続の DescribeDBClusters リクエストで使用できるページ分割トークン。

エラー

構造:

DBCluster (構造)

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

フィールド

  • AllocatedStorage — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles — これは DBClusterRole オブジェクトの配列です。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

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

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

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

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

  • CopyTagsToSnapshot — これは BooleanOptional、タイプ: boolean です (ブール値 (真または偽))。

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

  • CrossAccountClone — これは BooleanOptional、タイプ: boolean です (ブール値 (真または偽))。

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

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

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

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

    DB クラスターの Amazon リソースネーム (ARN) を返します。

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

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers — これは DBClusterMember オブジェクトの配列です。

    DB クラスターを構成するインスタンスのリストを入力します。

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

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

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

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

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

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

  • DeletionProtection — これは BooleanOptional、タイプ: boolean です (ブール値 (真または偽))。

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

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

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

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

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

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

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

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

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — これは GlobalClusterIdentifier、タイプ string、(UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

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

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

  • IAMDatabaseAuthenticationEnabled — これはブール値、タイプ: boolean です (ブール値 (真または偽))。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

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

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

  • MultiAZ — これはブール値、タイプ: boolean です (ブール値 (真または偽))。

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues - これは ClusterPendingModifiedValues オブジェクトです。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

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

    オペレーションの進行状況をパーセンテージで指定します。

  • Port — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

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

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

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

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

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

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

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

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

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

    Neptune ではサポートされていません。

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

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration - これは ServerlessV2ScalingConfigurationInfo オブジェクトです。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

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

    この DB クラスターの現在の状態を指定します。

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

    DB クラスターが暗号化されているかどうかを指定します。

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

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups — これは VpcSecurityGroupMembership オブジェクトの配列です。

    DB クラスターが属する VPC セキュリティグループのリストを入力します。

DBCluster は、以下のレスポンス要素として使用されます。

DBClusterMember (構造)

DB クラスターの一部であるインスタンスに関する情報が含まれています。

フィールド

  • DBClusterParameterGroupStatus - 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターのこのメンバーの DB クラスターパラメータグループのステータスを指定します。

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

    DB クラスターのこのメンバーのインスタンス ID を指定します。

  • IsClusterWriter — これはブール値、タイプ: boolean です (ブール値 (真または偽))。

    クラスターメンバーが DB クラスターのプライマリインスタンスの場合は true、それ以外の場合は false です。

  • PromotionTier — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    既存のプライマリインスタンスの障害後に、リードレプリカをプライマリインスタンスに昇格される順序を指定する値。

DBClusterRole (構造)

DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールを記述します。

フィールド

  • FeatureName - 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    Amazon Identity and Access Management(IAM) ロールに関連付けられている機能の名前。サポートされている機能名のリストについては、「DescribeDBEngineVersions (アクション)」を参照してください 。

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

    DB クラスターに関連付けられる IAM ロール Amazon リソースネーム (ARN)。

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

    IAM ロールと DB クラスターの間の関連付けの状態を説明します。Status プロパティは以下のいずれかの値を返します。

    • ACTIVE - IAM ロール ARN は DB クラスターに関連付けられており、代わりに他の Amazon のサービスにアクセスするために使用できます。

    • PENDING - IAM ロール ARN は DB クラスターに関連付けられています。

    • INVALID - IAM ロール ARN は DB クラスターに関連付けられていますが、DB クラスターはユーザーに代わって他の Amazon のサービスにアクセスするために IAM ロールを引き受けることができません。

CloudwatchLogsExportConfiguration (構造)

特定の DB インスタンスまたは DB クラスターの CloudWatch Logs にエクスポートするために有効にするログタイプの設定。

EnableLogTypes および DisableLogTypes の配列では、CloudWatch Logs にエクスポートする (または、エクスポートしない) ログを決定します。

有効なログタイプは、audit (監査ログを公開する場合) と slowquery (スロークエリログを公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

フィールド

  • DisableLogTypes - 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    無効にするログタイプのリスト。

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

    有効にするログタイプのリスト。

PendingCloudwatchLogsExports (構造)

設定がまだ保留中のログタイプのリスト。つまり、これらのログタイプは有効化中または無効化中です。

有効なログタイプは、audit (監査ログを公開する場合) と slowquery (スロークエリログを公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

フィールド

  • LogTypesToDisable - 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    有効化中のログタイプ。有効にすると、これらのログタイプは CloudWatch Logs にエクスポートされます。

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

    無効化中のログタイプ。無効化されたログタイプは CloudWatch Logs にエクスポートされません。

ClusterPendingModifiedValues (構造)

このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

フィールド

  • AllocatedStorage — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    データベースエンジンに割り当てられたストレージのサイズ (ギビバイト (GiB) 単位)。Neptune の場合、AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていず、必要に応じて自動的に調整されるためです。

  • BackupRetentionPeriod — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数。

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

    DB クラスターの DBClusterIdentifier 値。

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

    データベースエンジンのバージョン。

  • IAMDatabaseAuthenticationEnabled — これは BooleanOptional、タイプ: boolean です (ブール値 (真または偽))。

    AWS Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効になっているかどうかを示す値。

  • Iops — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    プロビジョンド IOPS (I/O operations per second) 値。この設定は、マルチ AZ DB クラスター専用です。

  • PendingCloudwatchLogsExports - これは PendingCloudwatchLogsExports オブジェクトです。

    この PendingCloudwatchLogsExports 構造は、CloudWatch ログを有効および無効にする保留中の変更を指定します。

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

    DB クラスターのストレージタイプにおける保留中の変更。  有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを設定します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。