翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Amazon DocumentDB エラスティッククラスターのメンテナンス
**Topics**
+ [保留中のエラスティッククラスターメンテナンスアクションの表示](#view-elastic-cluster-maintenance)
+ [エラスティッククラスターエンジンの更新](#elastic-cluster-engine-updates)
+ [エラスティッククラスターのオペレーティングシステムの更新](#elastic-cluster-os-updates)
Amazon DocumentDB は定期的に、Amazon DocumentDB エラスティッククラスターリソースのメンテナンスを行います。通常、メンテナンスにはデータベースエンジンの更新（エラスティッククラスターのメンテナンス）やエラスティッククラスターの基盤となるオペレーティングシステム (OS) の更新 (OS の更新) が伴います。データベースエンジンの更新は必須のパッチであり、セキュリティ修正、バグ修正、データベースエンジンの強化などが含まれます。一方ほとんどのオペレーティングシステムパッチはオプションですが、しばらく適用しないで放置していると、セキュリティ体制の維持のためにパッチが必要となった結果、自動的に適用されることがあります。そのため、Amazon DocumentDB エラスティッククラスター向けのオペレーティングシステム更新が利用可能になったらすぐに適用することをお勧めします。
データベースエンジンパッチの適用には、Amazon DocumentDB エラスティッククラスターを短時間オフラインにする必要があります。パッチが利用可能になるたびに、Amazon DocumentDB エラスティッククラスターの次のメンテナンスウィンドウでの実施予定に組み込まれ、自動的に適用されます。
エラスティッククラスターには、それぞれ独自のメンテナンスウィンドウがあります。エラスティッククラスターの修正をすぐには適用しないことを選択した場合は、メンテナンスウィンドウ中に自動的に適用されます。デフォルトでは、エラスティッククラスターを作成すると、Amazon DocumentDB はエラスティッククラスターにメンテナンスウィンドウを割り当てます。エラスティッククラスターを作成するときにメンテナンスウィンドウを選択できます。また、ビジネススケジュールや業務に合わせてメンテナンスウィンドウをいつでも変更できます。一般的には、メンテナンスによるアプリケーションへの影響を最小限に抑えるメンテナンスウィンドウ（夜間、週末など）を選択することをお勧めします。
## 保留中のエラスティッククラスターメンテナンスアクションの表示
エラスティッククラスターでメンテナンス更新が利用可能かどうかを確認するには、 AWS CLIを使用します。
更新が利用可能な場合は、以下のいずれかの操作を行います。
+ 現在次のメンテナンスウィンドウにスケジュールされているメンテナンスアクションを延期することができます (OS パッチのみ)。
+ メンテナンスアクションをすぐに適用する。
+ メンテナンスアクションを次のメンテナンスウィンドウ中に開始するようにスケジュールを設定する。
+ メンテナンスアクションを選択した適用日ウィンドウ中に開始するようにスケジュールを設定する。
メンテナンスウィンドウによって、保留中のオペレーションを開始する時刻が決定されますが、これらのオペレーションの合計実行時間は制限されません。
次の AWS CLI オペレーションを使用して、保留中のメンテナンスアクションを決定します。保留中のすべてのメンテナンスアクションを一覧表示します。
```
aws docdb-elastic list-pending-maintenance-actions
```
このオペレーションによる出力は、次のようになります (JSON 形式)。
```
{
'ResourcePendingMaintenanceActions': [
{
'ResourceArn': 'string-arn',
'PendingMaintenanceActionDetails': [
{
'Action': 'ENGINE_UPDATE',
'AutoAppliedAfterDate': 'string',
'ForcedApplyDate': 'string',
'OptInStatus': 'string',
'CurrentApplyDate': 'string',
'Description': 'string'
},
]
},
],
'NextToken': 'string'
}
```
特定の `resourceArn` で保留中のメンテナンスアクション (存在する場合) を取得します。
```
aws docdb-elastic get-pending-maintenance-action --resource-arn string-arn
```
このオペレーションによる出力は、次のようになります (JSON 形式)。
```
{
'ResourcePendingMaintenanceAction': {
'ResourceArn': 'string-arn',
'PendingMaintenanceActionDetails': [
{
'Action': 'ENGINE_UPDATE',
'AutoAppliedAfterDate': 'string',
'ForcedApplyDate': 'string',
'OptInStatus': 'string',
'CurrentApplyDate': 'string',
'Description': 'string'
}
]
}
}
```
パラメータ :
+ `ResourceArn` - 保留中のメンテナンスアクションが適用されるリソースの Amazon DocumentDB ARN (Amazon リソースネーム) です。
+ `Action` - メンテナンスアクションはリソースに適用中です。
有効な値:
+ `ENGINE_UPDATE`
+ `ENGINE_UPGRADE`
+ `SECURITY_UPDATE`
+ `OS_UPDATE`
+ `MASTER_USER_PASSWORD_UPDATE`
+ `AutoAppliedAfterDate` — この日付以降の最初のメンテナンスウィンドウ。この場合、`NEXT_MAINTENANCE OPT_IN` は無視されます。
+ `ForcedApplyDate` — メンテナンスウィンドウに関係なく適用されます。この場合、`IMMEDIATE OPT_IN` は無視されます。
+ `OptInStatus` — オプトインリクエストのタイプを指定するか、オプトインクエストを元に戻す値です。タイプ `IMMEDIATE` のオプトインリクエストは元に戻すことができません。
有効な値:
+ `IMMEDIATE` — メンテナンスアクションをすぐに適用します。
+ `NEXT_MAINTENANCE` — リソースの次のメンテナンスウィンドウ中にメンテナンスアクションを適用します。
+ `APPLY_ON` — リソースの次のメンテナンスウィンドウに関係なく、指定された適用日にメンテナンスアクションを適用します。
+ `UNDO_OPT_IN` — 既存の `NEXT_MAINTENANCE` または `APPLY_ON` オプトインリクエストをキャンセルします。
+ `CurrentApplyDate` — opt-in-type が `APPLY_ON` の場合に表示されます。
+ `Description` — メンテナンスアクションのオプションの説明。
## エラスティッククラスターエンジンの更新
Amazon DocumentDB では、メンテナンスオペレーションを適用するタイミングを選択することができます。Amazon DocumentDB がいつ更新を適用するかは、 AWS CLIを使用して決めることができます。
保留中のメンテナンスアクションを適用する:
```
aws docdb-elastic apply-pending-maintenance-action
--resource-arn string-arn
--apply-action string-enum
--opt-in-type string-enum
[--apply-on string-date-range]
```
パラメータ :
+ **--resource-arn** - 保留中のメンテナンスアクションが適用されるリソースの Amazon DocumentDB ARN (Amazon リソースネーム) です。
+ **--apply-action** — このリソースに適用する保留中のメンテナンスアクションです。
有効な値:
+ `ENGINE_UPDATE`
+ `ENGINE_UPGRADE`
+ `SECURITY_UPDATE`
+ `OS_UPDATE`
+ `MASTER_USER_PASSWORD_UPDATE`
+ **--opt-in-type** — オプトインリクエストのタイプを指定するか、オプトインクエストを元に戻す値です。タイプ `IMMEDIATE` のオプトインリクエストは元に戻すことができません。
有効な値:
+ `IMMEDIATE` — メンテナンスアクションをすぐに適用します。
+ `NEXT_MAINTENANCE` — リソースの次のメンテナンスウィンドウ中にメンテナンスアクションを適用します。
+ `APPLY_ON` — リソースの次のメンテナンスウィンドウに関係なく、指定された適用日にメンテナンスアクションを適用します。
+ `UNDO_OPT_IN` — 既存の `NEXT_MAINTENANCE` または `APPLY_ON` オプトインリクエストをキャンセルします。
+ **[--apply-on]** — opt-in-type が `APPLY_ON` の場合は必須です。形式: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm` (このオプションでは UTC 時間を使用します。 開始時刻は、今後の最小 30 分から最大 14 日の任意の時刻、または保留中のアクションの強制/適用日で、いずれか早い方にすることができます。 開始から終了までの時間は、最小で 30 分、最大で 8 時間にすることができます)。
このオペレーションによる出力は、次のようになります (JSON 形式)。
```
{
'ResourcePendingMaintenanceAction': {
'ResourceArn': 'string-arn',
'PendingMaintenanceActionDetails': [
{
'Action': 'SECURITY_UPDATE',
'AutoAppliedAfterDate': 'string',
'ForcedApplyDate': 'string',
'OptInStatus': 'IMMEDIATE',
'CurrentApplyDate': 'string',
'Description': 'string'
},
]
}
}
```
パラメータ :
+ `ResourceArn` - 保留中のメンテナンスアクションが適用されるリソースの Amazon DocumentDB ARN (Amazon リソースネーム) です。
+ `Action` - メンテナンスアクションはリソースに適用中です。
有効な値:
+ `ENGINE_UPDATE`
+ `ENGINE_UPGRADE`
+ `SECURITY_UPDATE`
+ `OS_UPDATE`
+ `MASTER_USER_PASSWORD_UPDATE`
+ `AutoAppliedAfterDate` — この日付以降の最初のメンテナンスウィンドウ。この場合、`NEXT_MAINTENANCE OPT_IN` は無視されます。
+ `ForcedApplyDate` — メンテナンスウィンドウに関係なく適用されます。この場合、`IMMEDIATE OPT_IN` は無視されます。
+ `OptInStatus` — オプトインリクエストのタイプを指定するか、オプトインクエストを元に戻す値です。タイプ `IMMEDIATE` のオプトインリクエストは元に戻すことができません。
有効な値:
+ `IMMEDIATE` — メンテナンスアクションをすぐに適用します。
+ `NEXT_MAINTENANCE` — リソースの次のメンテナンスウィンドウ中にメンテナンスアクションを適用します。
+ `APPLY_ON` — リソースの次のメンテナンスウィンドウに関係なく、指定された適用日にメンテナンスアクションを適用します。
+ `UNDO_OPT_IN` — 既存の `NEXT_MAINTENANCE` または `APPLY_ON` オプトインリクエストをキャンセルします。
+ `CurrentApplyDate` — opt-in-type が `APPLY_ON` の場合に表示されます。
+ `Description` — メンテナンスアクションのオプションの説明。
### 適用日
各メンテナンスアクションにはそれぞれ、保留中のメンテナンスアクションを記述する際に確認できる適用日が設定されています。から保留中のメンテナンスアクションの出力を読み取ると AWS CLI、次の 3 つの日付が表示されます。
+ `CurrentApplyDate` - メンテナンスアクションが即座に、または次のメンテナンスウィンドウに適用される日付です。メンテナンスがオプションである場合は、この値を null に設定できます。
+ `ForcedApplyDate` - メンテナンスウィンドウとは関係なく、メンテナンスが自動的に適用される日付です。
+ `AutoAppliedAfterDate` - クラスターのメンテナンスウィンドウでメンテナンスが適用される日付です。
### ユーザー作成のメンテナンスアクション
Amazon DocumentDBelastic クラスターのユーザーとして、クラスター設定への更新を開始することができます。
**クラスターのプライマリパスワードの更新**
```
aws docdb-elastic update-cluster
--cluster-arn string-arn
[--admin-user-password string]
[--auth-type string-enum]
[--apply-method string-enum]
[--apply-on string-date-range]
#... other parameters of the API that follow here are not relevant for this configuration
```
パラメータ :
+ **--cluster-arn** — メンテナンスアクションが適用されるリソースの Amazon DocumentDB Amazon リソースネーム (ARN)。
+ **[--admin-user-password]** — 管理者ユーザーに関連付けられているパスワード。
+ **[--auth-type]** — エラスティッククラスターへのアクセスに使用するパスワードの取得先の特定に使用している認証タイプ。有効なタイプは、`PLAIN_TEXT` または `SECRET_ARN` です。
+ **[--apply-method]** — 適用するメソッドのタイプを指定する値。指定できる値は `IMMEDIATE` と `APPLY_ON` です。デフォルトは `IMMEDIATE` です。
+ **[--apply-on]** — `apply-method` が `APPLY_ON` の場合は必須です。形式: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm` (このオプションでは UTC 時間を使用します。 開始時刻は、今後の最小 30 分から最大 14 日の任意の時刻にすることができます。 開始から終了までの時間は、最小で 30 分、最大で 8 時間にすることができます)。
このオペレーションによる出力は、次のようになります (JSON 形式)。
```
{
'ResourcePendingMaintenanceAction': {
'ResourceArn': 'string-arn',
'PendingMaintenanceActionDetails': [
{
'Action': 'MASTER_USER_PASSWORD_UPDATE',
'OptInStatus': 'APPLY_ON',
'CurrentApplyDate': 'string',
'Description': 'string'
},
]
}
}
```
### Amazon DocumentDB メンテナンスウィンドウを変更する
メンテナンスウィンドウは使用率の最も低い時間帯に設定する必要があります。このため、場合によっては変更が必要になります。この間、エラスティッククラスターは、システムの変更 (スケールストレージオペレーションの変更など) が適用されていて停止が必要な場合に限り、使用できません。必要な変更を加えるのに必要な最小限の時間のみ使用不可となります。
デフォルトは、1 週間のうちのランダムな日に起こる、Amazon Web Services リージョンあたり 8 時間の範囲からランダムに選択された 30 分のウィンドウです。
メンテナンスウィンドウを変更するには、「[Elastic クラスター設定の変更](elastic-managing.md#elastic-modify)」を参照してください。
## エラスティッククラスターのオペレーティングシステムの更新
Amazon DocumentDB エラスティッククラスターでは、オペレーティングシステムの更新が必要になる時があります。Amazon DocumentDB は、データベースパフォーマンスと顧客の全体的なセキュリティ体制改善のために、オペレーティングシステムを新しいバージョンにアップグレードします。オペレーティングシステムの更新では、Amazon DocumentDB イエラスティッククラスターのクラスターエンジンのバージョンは変更されません。
Amazon DocumentDB エラスティッククラスターのほとんどのオペレーティングシステムの更新はオプションであり、特定の適用日付は設定されていません。ただし、これらの更新をしばらく適用せずに放置していると、クラスターのメンテナンスウィンドウ時に最終的に必要になり、想定外のタイミングで自動的に適用される場合があります。これは、データベースのセキュリティ体制を維持するために行われます。予期しないダウンタイムを避けるため、Amazon DocumentDB エラスティッククラスター向けオペレーティングシステム更新が使用可能になったらすぐに適用するように努め、ビジネスニーズに応じて都合の良いときにインスタンスメンテナンスウィンドウを設定することをお勧めします。