ModifyDBCluster

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

制約:

タイプ: 文字列

必須: はい

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

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

型: ブール値

必須: いいえ

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

ApplyImmediately パラメータは、NewDBClusterIdentifier 値と MasterUserPassword 値のみに影響します。このパラメータ値を false に設定すると、NewDBClusterIdentifier 値と MasterUserPassword 値への変更は次のメンテナンスウィンドウ中に適用されます。他のすべての変更は、ApplyImmediately パラメータの値に関係なく、即時に適用されます。

デフォルト: false

タイプ: ブール値

必須: いいえ

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

デフォルト: 1

制約:

タイプ: 整数

必須: いいえ

特定のインスタンスまたはクラスターの Amazon CloudWatch Logs へのエクスポートを有効にするログタイプの構成設定。EnableLogTypes および DisableLogTypes配列は、どのログを CloudWatch ログにエクスポートするか (またはエクスポートしないか) を決定します。

型: CloudwatchLogsExportConfiguration オブジェクト

必須: いいえ

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

タイプ: 文字列

必須: いいえ

このクラスターを削除できるかどうかを指定します。DeletionProtection を有効にすると、クラスターが変更され DeletionProtection が無効にならない限り、クラスターを削除することができません。DeletionProtection はクラスターが誤って削除されるのを防ぎます。

型: ブール値

必須: いいえ

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

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

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

タイプ: 文字列

必須: いいえ

Amazon Web Services Secrets Manager でマスターユーザーパスワードを管理するかどうかを指定します。クラスターが Amazon Web Services Secrets Manager でマスターユーザーパスワードを管理していない場合は、この管理を有効にできます。この場合、 を指定することはできませんMasterUserPassword。クラスターが Amazon Web Services Secrets Manager でマスターユーザーパスワードをすでに管理しており、マスターユーザーパスワードが Amazon Web Services Secrets Manager で管理されないように指定する場合は、 を指定する必要がありますMasterUserPassword。この場合、Amazon DocumentDB はシークレットを削除し、 で指定されたマスターユーザーの新しいパスワードを使用しますMasterUserPassword。

型: ブール値

必須: いいえ

マスターデータベースユーザーのパスワードです。このパスワードには、スラッシュ (/)、二重引用符 (")、または「at」記号 (@) を除く印刷可能な任意のASCII文字を含めることができます。

制約: 8 ～ 100 文字の長さの英数字である必要があります。

タイプ: 文字列

必須: いいえ

Amazon Web Services Secrets Manager で自動的に生成および管理されるシークレットを暗号化するための Amazon Web Services KMSキー識別子。

この設定は、次の条件の両方が満たされた場合にのみ有効です。

Amazon Web Services KMSキー識別子は、キー ARN、キー ID、エイリアス ARN、またはKMSキーのエイリアス名です。別の Amazon Web Services アカウントでKMSキーを使用するには、キーARNまたはエイリアス を指定しますARN。

Amazon Web Services アカウントにはデフォルトKMSキーがあります。Amazon Web Services アカウントには、Amazon Web Services リージョンごとに異なるデフォルトKMSキーがあります。

タイプ: 文字列

必須: いいえ

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

制約:

例: my-cluster2

タイプ: 文字列

必須: いいえ

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

制限: 1150 ～ 65535 の値である必要があります。

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

タイプ: 整数

必須: いいえ

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

デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウです AWS リージョン。

制約:

タイプ: 文字列

必須: いいえ

システムメンテナンスを実行できる週次時間範囲 (協定世界時UTC）。

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

デフォルトは、各 の 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウであり AWS リージョン、ランダムな曜日に発生します。

有効な曜日: 月、火、水、木、金、土、日

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

タイプ: 文字列

必須: いいえ

Amazon Web Services Secrets Manager が管理するシークレットをマスターユーザーパスワードにローテーションするかどうかを指定します。

この設定は、マスターユーザーパスワードがクラスターの Amazon Web Services Secrets Manager で Amazon DocumentDB によって管理されている場合にのみ有効です。シークレット値には、更新されたパスワードが含まれます。

制約: マスターユーザーのパスワードをローテーションするときは、すぐに変更を適用する必要があります。

型: ブール値

必須: いいえ

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

Amazon DocumentDB クラスターのストレージタイプの詳細については、「Amazon DocumentDB 開発者ガイド」の「クラスターストレージ設定」を参照してください。

ストレージタイプの有効な値 - standard | iopt1

デフォルト値は standard です

タイプ: 文字列

必須: いいえ

クラスターが属する仮想プライベートクラウド (VPC) セキュリティグループのリスト。

タイプ: 文字列の配列

必須: いいえ

クラスターに関する詳細情報。

型: DBCluster オブジェクト

指定された識別子を持つクラスターをすでに持っています。

HTTP ステータスコード: 400

DBClusterIdentifier は既存のクラスターを参照していません。

HTTP ステータスコード: 404

DBClusterParameterGroupName は既存のパラメータグループを参照していません。

HTTP ステータスコード: 404

DBSubnetGroupName は既存のサブネットグループを参照していません。

HTTP ステータスコード: 404

クラスターは有効な状態ではありません。

HTTP ステータスコード: 400

指定されたインスタンスは 利用可能な 状態ではありません。

HTTP ステータスコード: 400

セキュリティグループの状態では削除できません。

HTTP ステータスコード: 400

サブネットグループは使用中のため削除できません。

HTTP ステータスコード: 400

リクエストされたサブネットが無効であるか、複数のサブネットがリクエストされ、すべてが共通の仮想プライベートクラウド (VPC) にない。

HTTP ステータスコード: 400

サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。

HTTP ステータスコード: 400

リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。

HTTP ステータスコード: 400