ModifyGlobalCluster - Amazon DocumentDB

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

ModifyGlobalCluster

Amazon DocumentDB グローバルクラスターの設定を変更します。リクエストでこれらのパラメータと新しい値を指定すると、1 つ以上の設定パラメータ (例: 削除保護) またはグローバルクラスター識別子を変更できます。

注記

このアクションは Amazon DocumentDB クラスターにのみ適用されます。

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

GlobalClusterIdentifier

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

制約:

  • 既存のグローバルクラスターの識別子と一致する必要があります。

型: 文字列

長さの制限:最小長は 1 です。最大長は 255 です。

パターン: [A-Za-z][0-9A-Za-z-:._]*

必須:はい

DeletionProtection

グローバルクラスターで削除保護を有効にするかどうかを指定します。削除保護が有効な場合、グローバルクラスターは削除できません。

型: ブール値

必須: いいえ

NewGlobalClusterIdentifier

グローバルクラスターを変更するときのグローバルクラスターの新しい識別子。この値は小文字で保存されます。

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

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

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

例: my-cluster2

型: 文字列

長さの制限:最小長は 1 です。最大長は 255 です。

パターン: [A-Za-z][0-9A-Za-z-:._]*

必須:いいえ

レスポンス要素

以下の要素がサービスによって返されます。

GlobalCluster

Amazon DocumentDB グローバルクラスターを表すデータ型。

型: GlobalCluster オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

GlobalClusterNotFoundFault

GlobalClusterIdentifier は既存のグローバルクラスターを参照していません。

HTTP ステータスコード: 404

InvalidGlobalClusterStateFault

要求された操作は、クラスターがこの状態にある間は実行できません。

HTTP ステータスコード:400

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。