翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # UpdateCluster エラスティッククラスターを変更します。これには、管理者ユーザー名/パスワードの更新、API バージョンのアップグレード、バックアップウィンドウとメンテナンスウィンドウの設定が含まれます ## リクエストの構文 ``` PUT /cluster/clusterArn HTTP/1.1 Content-type: application/json { "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターの ARN 識別子。必須: はい ## リクエストボディリクエストは以下の JSON 形式のデータを受け入れます。 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスター管理者に関連付けられているパスワード。このパスワードをには、スラッシュ (/)、二重引用符 (")、または「at」記号 (@) 以外の印刷可能な ASCII 文字を含むことができます。制約: 8 ～ 100 文字の長さの英数字である必要があります。タイプ: 文字列必須: いいえ ** [authType](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターへのアクセスに使用するパスワードの取得先の特定に使用している認証タイプ。有効なタイプは、`PLAIN_TEXT` または `SECRET_ARN` です。型: 文字列有効な値：`PLAIN_TEXT | SECRET_ARN` 必須：いいえ ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) ** 自動スナップショットが保持される日数。タイプ: 整数必須: いいえ ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターのクライアントトークン。タイプ: 文字列必須: いいえ ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) ** `backupRetentionPeriod` に応じた、自動バックアップが有効な場合に毎日自動バックアップが作成される時間範囲を指定します。タイプ: 文字列必須: いいえ ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) ** 週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。 *形式:* `ddd:hh24:mi-ddd:hh24:mi` *デフォルト*: それぞれ 8 時間の時間ブロックからランダムに選択された AWS リージョン 30 分のウィンドウ。ランダムな曜日に発生します。 *有効な曜日*: 月、火、水、木、金、土、日 *制約*: 最小 30 分のウィンドウ。タイプ: 文字列必須: いいえ ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) ** 各エラスティッククラスターシャードに割り当てられている vCPU の数。最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。タイプ: 整数必須: いいえ ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターに割り当てられているシャードの数。最大数は 32 です。タイプ: 整数必須: いいえ ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) ** Elastic クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。`shardInstanceCount` 値が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。タイプ: 整数必須: いいえ ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターの Amazon EC2 サブネット ID。型: 文字列の配列必須: いいえ ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) ** このエラスティッククラスターに関連付ける EC2 VPC セキュリティグループのリスト。型: 文字列の配列必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) ** 更新されたエラスティッククラスターに関する情報を返します。型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)