翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ModifyDBCluster
Amazon DocumentDB クラスターの設定を変更します。これらのパラメータとリクエストに新しい値を指定することで、1 つ以上のデータベース設定パラメータを変更できます。
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
- DBClusterIdentifier
-
変更するクラスターのクラスター識別子。このパラメータは大文字と小文字が区別されません。
制約:
-
既存の
DBClusterの識別子と一致する必要があります。
型: 文字列
必須: はい
-
- AllowMajorVersionUpgrade
-
メジャーバージョンアップグレードを許可するかどうかを示す値。
制約: DB インスタンスの現在のバージョンとは異なるメジャーバージョンである
EngineVersionパラメータの値を指定する場合は、メジャーバージョンアップグレードを許可する必要があります。タイプ: ブール
必須: いいえ
- ApplyImmediately
-
クラスターの
PreferredMaintenanceWindowの設定に関係なく、このリクエストの変更と保留中の変更をできるだけ早く非同期に適用するかどうかを指定する値。このパラメータをfalseに設定した場合、クラスターへの変更は次のメンテナンスウィンドウ中に適用されます。ApplyImmediatelyパラメータは、NewDBClusterIdentifier値とMasterUserPassword値のみに影響します。このパラメータ値をfalseに設定すると、NewDBClusterIdentifier値とMasterUserPassword値への変更は次のメンテナンスウィンドウ中に適用されます。他のすべての変更は、ApplyImmediatelyパラメータの値に関係なく、即時に適用されます。デフォルト:
falseタイプ: ブール値
必須: いいえ
- BackupRetentionPeriod
-
自動バックアップを保管する日数。最小値 1 を指定しなければなりません。
デフォルト: 1
制約:
-
1 ～ 35 の値にする必要があります。
タイプ: 整数
必須: いいえ
-
- CloudwatchLogsExportConfiguration
-
特定のインスタンスまたはクラスターの Amazon CloudWatch Logs へのエクスポートを有効にするログタイプの構成設定。
EnableLogTypesおよびDisableLogTypes配列は、どのログを Logs にエクスポートするか (またはエクスポートしないか) CloudWatch を決定します。タイプ：CloudwatchLogsExportConfiguration オブジェクト
必須: いいえ
- DBClusterParameterGroupName
-
クラスターに使用するクラスターパラメータグループの名前。
タイプ: 文字列
必須: いいえ
- DeletionProtection
-
このクラスターを削除できるかどうかを指定します。
DeletionProtectionを有効にすると、クラスターが変更されDeletionProtectionが無効にならない限り、クラスターを削除することができません。DeletionProtectionはクラスターが誤って削除されるのを防ぎます。タイプ: ブール
必須: いいえ
- EngineVersion
-
アップグレードするデータベースエンジンのバージョン番号。このパラメータを変更すると、機能停止が発生します。
ApplyImmediatelyパラメータが true に設定されされない限り、変更は次のメンテナンスウィンドウ中に適用されます。Amazon DocumentDB に利用可能なエンジンバージョンをすべて一覧表示するには、次のコマンドを使用します。
aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"タイプ: 文字列
必須: いいえ
- MasterUserPassword
-
マスターデータベースユーザーのパスワードです。このパスワードをには、スラッシュ (/)、二重引用符 (")、または「at」記号 (@) 以外の印刷可能な ASCII 文字を含むことができます。
制約: 8 ～ 100 文字の長さの英数字である必要があります。
タイプ: 文字列
必須: いいえ
- NewDBClusterIdentifier
-
クラスターの名前を変更する場合のクラスターの新しいクラスター識別子。この値は小文字で保存されます。
制約:
-
1 ～ 63 の文字、数字またはハイフンを使用する必要があります。
-
1 字目は文字である必要があります。
-
ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。
例:
my-cluster2タイプ: 文字列
必須: いいえ
-
- Port
-
クラスターが接続を受け入れるポート番号。
制限:
1150～65535の値である必要があります。デフォルト : 元のクラスターと同じポート。
タイプ: 整数
必須: いいえ
- PreferredBackupWindow
-
BackupRetentionPeriodパラメータを使用して自動バックアップが有効になっている場合に、自動バックアップが作成される毎日の時間範囲。デフォルトは、AWS リージョン ごとに 8 時間の範囲からランダムに選択された、30 分の時間枠です。
制約:
-
hh24:mi-hh24:miの形式である必要があります。 -
時間は協定世界時 (UTC) である必要があります。
-
必要なメンテナンス期間と競合してはいけません。
-
少なくとも 30 分以上必要です。
タイプ: 文字列
必須: いいえ
-
- PreferredMaintenanceWindow
-
週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。
形式:
ddd:hh24:mi-ddd:hh24:miデフォルトは、1 週間のうちのランダムな日に起こる、AWS リージョン あたり 8 時間の範囲からランダムに選択された、30 分の時間枠です。
有効な日: 月、火、水、木、金、土、日
制約: 最小限の 30 分単位のウィンドウ。
タイプ: 文字列
必須: いいえ
- StorageType
-
DB クラスターに関連付けるストレージタイプ。
Amazon DocumentDB クラスターのストレージタイプの詳細については、「Amazon Amazon DocumentDB デベロッパーガイド」の「クラスターストレージ設定」を参照してください。
ストレージタイプの有効な値 -
standard | iopt1デフォルト値は
standardですタイプ: 文字列
必須: いいえ
- VpcSecurityGroupIds.VpcSecurityGroupId.N
-
クラスターに関連付けられる仮想プライベートクラウド （VPC） セキュリティグループのリスト。
タイプ：文字列の配列
必須: いいえ
レスポンス要素
以下の要素がサービスによって返されます。
- DBCluster
-
クラスターに関する詳細情報。
型: DBCluster オブジェクト
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- DBClusterAlreadyExistsFault
-
指定された識別子を持つクラスターをすでに持っています。
HTTP ステータスコード：400
- DBClusterNotFoundFault
-
DBClusterIdentifierは既存のクラスターを参照していません。HTTP ステータスコード: 404
- DBClusterParameterGroupNotFound
-
DBClusterParameterGroupNameは既存のパラメータグループを参照していません。HTTP ステータスコード: 404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupNameは既存のサブネットグループを参照していません。HTTP ステータスコード: 404
- InvalidDBClusterStateFault
-
クラスターは有効な状態ではありません。
HTTP ステータスコード：400
- InvalidDBInstanceState
-
指定されたインスタンスは 利用可能な 状態ではありません。
HTTP ステータスコード：400
- InvalidDBSecurityGroupState
-
セキュリティグループの状態では削除できません。
HTTP ステータスコード：400
- InvalidDBSubnetGroupStateFault
-
サブネットグループは使用中のため削除できません。
HTTP ステータスコード：400
- InvalidSubnet
-
要求されたサブネットが無効であるか、共通の仮想プライベートクラウド （VPC） 内に存在しない複数のサブネットが要求されました。
HTTP ステータスコード：400
- InvalidVPCNetworkStateFault
-
サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。
HTTP ステータスコード：400
- StorageQuotaExceeded
-
リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
