翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Amazon DocumentDB エラスティッククラスターの管理
Amazon DocumentDB Elestic クラスターを管理するには、適切な Amazon DocumentDB コントロールプレーンアクセス許可を持つ IAM ポリシーが必要です。これらのアクセス許可により、クラスターとインスタンスを作成、変更、削除できます。Amazon DocumentDBFullAccess ポリシーは、 Amazon DocumentDB Elastic クラスターを管理するために必要なすべてのアクセス許可を提供します。
以下のトピックでは、Amazon DocumentDB Elastic クラスターを操作するときのさまざまなタスクの実行方法を示します。
**Topics**
+ [Elastic クラスター設定の変更](#elastic-modify)
+ [Elastic クラスターのモニタリング](#elastic-monitor)
+ [Elastic クラスターの削除](#elastic-delete)
+ [Elastic クラスタースナップショットの管理](elastic-manage-snapshots.md)
+ [Amazon DocumentDB Elastic クラスターの停止と開始](elastic-cluster-stop-start.md)
+ [Amazon DocumentDB エラスティッククラスターのメンテナンス](elastic-cluster-maintenance.md)
## Elastic クラスター設定の変更
このセクションでは、 AWS マネジメントコンソール または を使用して Elastic クラスターを変更する方法について説明します AWS CLI 。
クラスターを変更する主な用途は、シャード数やシャードの計算能力を増減してシャードをスケールすることです。
------
#### [ Using the AWS マネジメントコンソール ]
を使用して Elastic クラスターの設定を変更するには AWS マネジメントコンソール:
1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/home?region=us-east-1) にサインインし、Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで **[Clusters]** (クラスター) を選択します。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ナビゲーションペインの左上隅にあるメニューアイコンを選択します。
1. **[クラスター識別子]** 列で、変更するクラスターの名前を選択します。
1. **[Modify]** (変更) を選択します。
1. 変更するフィールドを編集し、**[クラスターの変更]** を選択します。
![\[右下隅に [クラスターの変更] ボタンがある、変更できる設定、メンテナンス、認証、およびネットワーク設定オプションを示すフォーム。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/cluster-shard-modify-3.png)
**注記**
または、**[クラスター]** ページに移動し、該当するクラスターの横にあるボックスにチェックを入れ、**[アクション]**、**[変更]** の順に選択して **[クラスターの変更]** ダイアログにアクセスします。
------
#### [ Using the AWS CLI ]
を使用して Elastic クラスターの設定を変更するには AWS CLI、以下のパラメータを指定して `update-cluster`オペレーションを使用します。
+ **--cluster-arn** — 必須 変更するクラスターの ARN 識別子。
+ **--shard-capacity** - オプションです。各シャードに割り当てられた vCPU の数。最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。
+ **--shard-count** - オプションです。クラスターに割り当てられたシャードの数。最大数は 32 です。
+ **--shard-instance** 数 — オプション。このクラスター内のすべてのシャードに適用されるレプリカインスタンスの数。最大数は 16 です。
+ **--auth-type** - オプションです。エラスティッククラスターへのアクセスに使用するパスワードの取得先の特定に使用している認証タイプ。有効なタイプは、`PLAIN_TEXT` または `SECRET_ARN` です。
+ **--admin-user-password** - オプションです。 – 管理者ユーザーに関連付けられているパスワード。
+ **--vpc-security-group-ids** - オプションです。このクラスターに関連付ける Amazon EC2 と Amazon 仮想プライベートクラウド (VPC) セキュリティグループのリストを設定します。
+ **--preferred-maintenance-window** - オプションです。週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))を設定します。
形式は `ddd:hh24:mi-ddd:hh24:mi` です。有効な曜日 (ddd): 月、火、水、木、金、土、日
デフォルトは、1 週間のうちのランダムな日に起こる、Amazon Web Services リージョンあたり 8 時間の範囲からランダムに選択された 30 分のウィンドウです。
最小 30 分のウィンドウ。
+ **--subnet-ids** - オプションです。ネットワークのサブネット ID を設定します。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic update-cluster \
--cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 \
--shard-capacity 8 \
--shard-count 4 \
--shard-instance-count 3 \
--admin-user-password testPassword \
--vpc-security-group-ids ec-65f40350 \
--subnet-ids subnet-9253c6a3, subnet-9f1b5af9
```
Windows の場合:
```
aws docdb-elastic update-cluster ^
--cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 ^
--shard-capacity 8 ^
--shard-count 4 ^
--shard-instance-count 3 ^
--admin-user-password testPassword ^
--vpc-security-group-ids ec-65f40350 ^
--subnet-ids subnet-9253c6a3, subnet-9f1b5af9
```
------
変更後の Elastic クラスターのステータスをモニタリングするには、「Elastic クラスターのモニタリング」を参照してください。
## Elastic クラスターのモニタリング
このセクションでは、 AWS マネジメントコンソール または を使用して Elastic クラスターをモニタリングする方法を、次の手順 AWS CLI で説明します。
------
#### [ Using the AWS マネジメントコンソール ]
を使用して Elastic クラスター設定をモニタリングするには AWS マネジメントコンソール:
1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/home?region=us-east-1) にサインインし、Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで **[Clusters]** (クラスター) を選択します。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ナビゲーションペインの左上隅にあるメニューアイコンを選択します。
1. **[クラスター識別子]** 列で、モニタリングするクラスターの名前を選択します。
1. **[モニタリング]** タブを選択します。
![\[[モニタリング] タブに表示されるエラスティッククラスターの概要情報。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/cluster-shard-monitor-2.png)
Amazon CloudWatch からの多くのチャートは、以下のモニタリングカテゴリについて表示されます。
+ リソース使用率
+ スループット
+ オペレーション
+ システム
経由で Amazon CloudWatch にアクセスして AWS マネジメントコンソール 、Elastic クラスター用に独自のモニタリング環境を設定することもできます。
------
#### [ Using the AWS CLI ]
を使用して特定の Elastic クラスター設定をモニタリングするには AWS CLI、以下のパラメータを指定して `get-cluster`オペレーションを使用します。
+ **--cluster-arn** — 必須 情報が必要なクラスターの識別子。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic get-cluster \
--cluster-arn arn:aws:docdb-elastic:us-west-2:123456789012:cluster:/68ffcdf8-e3af-40a3-91e4-24736f2dacc9
```
Windows の場合:
```
aws docdb-elastic get-cluster ^
--cluster-arn arn:aws:docdb:-elastic:us-west-2:123456789012:cluster:/68ffcdf8-e3af-40a3-91e4-24736f2dacc9
```
このオペレーションによる出力は、次のようになります。
```
"cluster": {
...
"clusterArn": "arn:aws:docdb-elastic:us-west-2:123456789012:cluster:/68ffcdf8-e3af-40a3-91e4-24736f2dacc9",
"clusterEndpoint": "stretch-11-477568257630.us-east-1.docdb-elastic.amazonaws.com",
"readerEndpoint": "stretch-11-477568257630-ro.us-east-1.docdb-elastic.amazonaws.com",
"clusterName": "stretch-11",
"shardCapacity": 2,
"shardCount": 3,
"shardInstanceCount: 5,
"status": "ACTIVE",
...
}
```
詳細については、「Amazon DocumentDB リソース管理 API リファレンス」の「`DescribeClusterSnapshot`」を参照してください。
を使用してすべての Elastic クラスターの詳細を表示するには AWS CLI、以下のパラメータを指定して `list-clusters`オペレーションを使用します。
+ **--next-token** - オプションです。出力される項目数 (`--max-results`) が基本の API コールによって返される合計項目数より少ない場合、出力には `NextToken` が含まれ、これにより、後続のコマンドを渡して、次の項目のセットを取得できます。
+ **--max-results** - オプションです。コマンドの出力で返される項目の総数。指定された `max-results` の値よりも多くの結果が存在する場合、ページ割りトークン (`next-token`) がレスポンスに含まれるため、残りの結果を取得できます。
+ デフォルト: 100
+ 最小は 20、最大は 100 です
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic list-clusters \
--next-token eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ== \
--max-results 2
```
Windows の場合:
```
aws docdb-elastic list-clusters ^
--next-token eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ== ^
--max-results 2
```
このオペレーションによる出力は、次のようになります。
```
{
"Clusters": [
{
"ClusterIdentifier":"mycluster-1",
"ClusterArn":"arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster"
"Status":"available",
"ClusterEndpoint":"sample-cluster.sharded-cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com"
}
{
"ClusterIdentifier":"mycluster-2",
"ClusterArn":"arn:aws:docdb:us-west-2:987654321098:sharded-cluster:sample-cluster"
"Status":"available",
"ClusterEndpoint":"sample-cluster2.sharded-cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com"
}
]
}
```
------
## Elastic クラスターの削除
このセクションでは、 AWS マネジメントコンソール または を使用して Elastic クラスターを削除する方法を次の手順 AWS CLI で説明します。
------
#### [ Using the AWS マネジメントコンソール ]
AWS マネジメントコンソールを使用して Elastic クラスター設定を削除するには、以下の手順に従います。
1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/home?region=us-east-1) にサインインし、Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで **[Clusters]** (クラスター) を選択します。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ナビゲーションペインの左上隅にあるメニューアイコンを選択します。
1. クラスターリストの表で、削除するクラスター名の左にあるチェックボックスをオンにし、**[アクション]** を選択します。ドロップダウンメニューから **[削除]** を選択します。
1. **[「cluster-name」の Elastic クラスターを削除しますか?]** ダイアログボックスで **[削除]** を選択します。
![\[右下隅に [削除] ボタンがある [削除] ダイアログボックス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/cluster-delete-dialog.png)
クラスターが削除されるまでに数分かかります。クラスターのステータスをモニタリングするには、「[Amazon DocumentDB クラスターのステータスのモニタリング](https://docs.aws.amazon.com//documentdb/latest/developerguide/monitoring_docdb-cluster_status.html)」を参照してください。
------
#### [ Using the AWS CLI ]
を使用して Elastic クラスターを削除するには AWS CLI、次のパラメータを指定して `delete-cluster`オペレーションを使用します。
+ **--cluster-arn** — 必須 削除するクラスターの ARN 識別子。
+ **--no-skip-final-backup** - オプションです。最終バックアップを作成する場合は、最終バックアップの名前を指定して、このパラメータを含める必要があります。`--final-backup-identifier` または `--skip-final-backup` のどちらかを含める必要があります。
+ **--skip-final-backup** - オプションです。クラスターを削除する前に最終バックアップを作成しない場合のみ、このパラメータを使用します。デフォルトでは、最終スナップショットを作成します。
次の AWS CLI コード例では、ARN が arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster のクラスターを最終バックアップで削除します。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic delete-cluster \
--cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster \
--no-skip-final-backup \
--final-backup-identifier finalArnBU-arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster
```
Windows の場合:
```
aws docdb-elastic delete-cluster ^
--cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster ^
--no-skip-final-backup ^
--final-backup-identifier finalArnBU-arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster
```
次の AWS CLI コード例では、ARN が arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster のクラスターを最終バックアップなしで削除します。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic delete-cluster \
--cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster \
--skip-final-backup \
```
Windows の場合:
```
aws docdb-elastic delete-cluster ^
--cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster ^
--skip-final-backup ^
```
`delete-cluster` オペレーションの出力は、削除するクラスターの表示になります。
クラスターが削除されるまでに数分かかります。クラスターのステータスをモニタリングするには、「[Amazon DocumentDB クラスターのステータスのモニタリング](https://docs.aws.amazon.com/documentdb/latest/developerguide/monitoring_docdb-cluster_status.html)」を参照してください。
------
# Elastic クラスタースナップショットの管理
手動スナップショットは、Elastic クラスターの作成後に作成できます。自動バックアップは、Elastic クラスタースナップショットが作成されると直ちに作成されます。
**注記**
手動スナップショットを作成するには、クラスターのスタータスが `Available` である必要があります。
このセクションでは、Elastic クラスタースナップショットを作成、表示、復元、削除する方法について説明します。
以下のトピックでは、Amazon DocumentDB Elastic クラスタースナップショットを操作するときのさまざまなタスクの実行方法を示します。
**Topics**
+ [手動 Elastic クラスタースナップショットの作成](#elastic-create-snapshot)
+ [Elastic クラスタースナップショットの表示](#elastic-view-snapshot)
+ [スナップショットからの Elastic クラスターの復元](#elastic-restore-snapshot)
+ [Elastic クラスタースナップショットのコピー](#elastic-copy-snapshot)
+ [Elastic クラスタースナップショットの削除](#elastic-delete-snapshot)
+ [Elastic クラスタースナップショットの自動バックアップの管理](#elastic-auto-snapshot)
## 手動 Elastic クラスタースナップショットの作成
このセクションでは、 AWS マネジメントコンソール または を使用して、次の手順 AWS CLI で手動 Elastic クラスタースナップショットを作成する方法について説明します。
------
#### [ Using the AWS マネジメントコンソール ]
AWS マネジメントコンソールを使用して手動 Elastic クラスタースナップショットを作成するには、以下の手順に従います。
1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/home?region=us-east-1) にサインインし、Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで、[**Snapshots**] を選択してください。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ナビゲーションペインの左上隅にあるメニューアイコンを選択します。
1. [**スナップショット**] ページで、[**作成**] を選択します。
1. **[クラスタースナップショットの作成]** ページの **[クラスター識別子]** フィールドで、ドロップダウンリストからご使用の Elastic クラスターを選択します。
**[スナップショット識別子]** フィールドに、Elastic クラスターの一意識別子を入力します。
**[作成]** を選択します。
![\[図: Elastic クラスターによるスナップショットの作成\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/elastic-create-snapshot.png)
**注記**
または、**[クラスター]** ページに移動して **[クラスタースナップショットの作成]** ダイアログにアクセスし、対象クラスターの横にあるボックスにチェックを入れ、**[アクション]**、**[スナップショットの取得]** の順に選択します。
Elastic クラスタースナップショットがプロビジョニングされます。このプロセスには数分かかることがあります。**[スナップショット]** リストにステータスが `Available` と表示されたら、スナップショットを表示して復元できます。
------
#### [ Using the AWS CLI ]
を使用して手動 Elastic クラスタースナップショットを作成するには AWS CLI、以下のパラメータを指定して `create-cluster-snapshot`オペレーションを使用します。
+ **--snapshot-name** — 必須 作成するクラスターの名前。
+ **--cluster-arn** — 必須 スナップショットを作成するクラスターの ARN 識別子。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic create-cluster-snapshot \
--snapshot-name sample-snapshot-1 \
--cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster
```
Windows の場合:
```
aws docdb-elastic create-cluster-snapshot ^
--snapshot-name sample-snapshot-1 ^
--cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster
```
------
## Elastic クラスタースナップショットの表示
このセクションでは、 AWS マネジメントコンソール または を使用して Elastic クラスタースナップショット情報を表示する方法について説明します AWS CLI 。
------
#### [ Using the AWS マネジメントコンソール ]
を使用して特定の Elastic クラスタースナップショットに関する情報を表示するには AWS マネジメントコンソール:
1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/home?region=us-east-1) にサインインし、Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで、[**Snapshots**] を選択してください。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ナビゲーションペインの左上隅にあるメニューアイコンを選択します。
1. **[スナップショット]** ページで、**[スナップショット識別子]** 列の名前をクリックして、リストから目的のスナップショットを選択します。
1. **[詳細]** にスナップショットの情報が表示されます。
![\[図: Elastic クラスタービュースナップショット\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/elastic-snapshot-view.png)
------
#### [ Using the AWS CLI ]
を使用して特定の Elastic クラスタースナップショットに関する情報を表示するには AWS CLI、以下のパラメータを指定して `get-cluster-snapshot`オペレーションを使用します。
+ **--snapshot-arn** — 必須 情報が必要なスナップショットの ARN 識別子。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic get-cluster-snapshot \
--snapshot-arn sampleResourceName
```
Windows の場合:
```
aws docdb-elastic get-cluster-snapshot ^
--snapshot-arn sampleResourceName
```
を使用して特定の Elastic クラスタースナップショットに関する情報を表示するには AWS CLI、以下のパラメータを指定して `get-cluster-snapshot`オペレーションを使用します。
+ **--snapshot-arn** — 必須 情報が必要なスナップショットの ARN 識別子。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic get-cluster-snapshot \
--snapshot-arn sampleResourceName
```
Windows の場合:
```
aws docdb-elastic get-cluster-snapshot ^
--snapshot-arn sampleResourceName
```
を使用してすべての Elastic クラスタースナップショットに関する情報を表示するには AWS CLI、以下のパラメータを指定して `list-cluster-snapshots`オペレーションを使用します。
+ **--snapshot-type** - オプションです。返されるクラスタースナップショットのタイプ。次のいずれかの値を指定できます。
+ `automated` - Amazon DocumentDB が AWS アカウントに対して自動的に作成したすべてのクラスタースナップショットを返します。
+ `manual` - AWS アカウント用に手動で作成したすべてのクラスタースナップショットを返します。
+ `shared` - AWS アカウントに共有されているすべての手動クラスタースナップショットを返します。
+ `public` - 公開とマークされたクラスタースナップショットをすべて返します。
+ **--next-token** - オプションです。以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスにはこのマーカーを超え、 `max-results` で指定された値までのレコードのみが含まれます。
+ **--max-results** - オプションです。レスポンスに含める結果の最大数。指定された `max-results` の値よりも多くの結果が存在する場合、ページ割りトークン (`next-token`) がレスポンスに含まれるため、残りの結果を取得できます。
+ デフォルト: 100
+ 最小は 20、最大は 100 です
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic list-cluster-snapshots \
--snapshot-type value \
--next-token value \
--max-results 50
```
Windows の場合:
```
aws docdb-elastic list-cluster-snapshots ^
--snapshot-type value ^
--next-token value ^
--max-results 50
```
------
## スナップショットからの Elastic クラスターの復元
このセクションでは、 AWS マネジメントコンソール または を使用して、スナップショットから Elastic クラスターを復元する方法を次の手順 AWS CLI で説明します。
------
#### [ Using the AWS マネジメントコンソール ]
AWS マネジメントコンソールを試用してスナップショットから Elastic クラスターから復元するには:
1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/home?region=us-east-1) にサインインし、Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで、[**Snapshots**] を選択してください。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ナビゲーションペインの左上隅にあるメニューアイコンを選択します。
1. **[スナップショット識別子]** 列で、クラスターの復元に使用するスナップショットの左側にあるボタンを選択します。
1. **[アクション]**、**[復元]** の順に選択します。
![\[図: スナップショットからの Elastic クラスターの復元\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/elastic-restore-snapshot.png)
1. **[スナップショットの復元]** ページで、**[クラスター識別子]** フィールドに新しいクラスターの名前を入力します。
**注記**
手動スナップショットの復元では、新しいクラスターを作成する必要があります。
1. **[仮想プライベートクラウド (VPC)]** フィールドのドロップダウンリストから VPC を選択します。
1. **[サブネット]**と **[VPC セキュリティグループ]**では、デフォルトを使用するか、任意の 3 つのサブネットと最大 3 つまでの VPC セキュリティグループ (最低 1 つ) を選択できます。
1. クラスター設定に問題がなければ、[**Restore cluster (クラスターの復元)**] を選択し、クラスターが復元されるのを待ちます。
------
#### [ Using the AWS CLI ]
を使用してスナップショットから Elastic クラスターを復元するには AWS CLI、次のパラメータを指定して `restore-cluster-from-snapshot`オペレーションを使用します。
+ **--cluster-name** — 必須 作成時または最終変更時に入力された Elastic クラスターの現在名。
+ **--snapshot-arn** — 必須 クラスターの復元に使用されているスナップショットの ARN 識別子。
+ **--vpc-security-group-ids** - オプションです。1 つまたは複数の Amazon EC2 と Amazon 仮想プライベートクラウド (VPC) セキュリティグループをクラスターに関連付けます。
+ **--kms-key-id** - オプションです。暗号化されたクラスターの KMS キー識別子を設定します。
KMS キー識別子は、 AWS KMS 暗号化キーの Amazon リソースネーム (ARN) です。新しいクラスターの暗号化に使用する KMS 暗号化キーを所有する Amazon Web Services アカウントと同じアカウントを使用してクラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーエイリアスを使用できます。
KmsKeyId で暗号化キーが指定がなく、かつ `StorageEncrypted` パラメータが true の場合、Amazon DocumentDB はデフォルトの暗号化キーを使用します。
+ **--subnet-ids** - オプションです。ネットワークサブネット ID。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic restore-cluster-from-snapshot \
--cluster-name elastic-sample-cluster \
--snapshot-arn sampleResourceName \
--vpc-security-group-ids value ec-65f40350 \
--kms-key-id arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 \
--subnet-ids subnet-9253c6a3, subnet-9f1b5af9
```
Windows の場合:
```
aws docdb-elastic restore-cluster-from-snapshot ^
--cluster-name elastic-sample-cluster ^
--snapshot-arn sampleResourceName ^
--vpc-security-group-ids value ec-65f40350 ^
--kms-key-id arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 ^
--subnet-ids subnet-9253c6a3, subnet-9f1b5af9
```
------
## Elastic クラスタースナップショットのコピー
Amazon DocumentDB では、Elastic クラスターの手動スナップショットと自動スナップショットを同じリージョン内、あるいは同じアカウント内でコピーできます。このセクションでは、 AWS マネジメントコンソール または を使用して Elastic クラスタースナップショットをコピーする方法について説明します AWS CLI。
------
#### [ Using the AWS マネジメントコンソール ]
を使用して Elastic クラスタースナップショットをコピーするには AWS マネジメントコンソール:
1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/home?region=us-east-1) にサインインし、Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで、[**Snapshots**] を選択してください。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ナビゲーションペインの左上隅にあるメニューアイコンを選択します。
1. **[スナップショット識別子]** 列で、コピーしたいスナップショットの左側にあるボタンを選択します。
1. **[アクション]**、**[コピー]** の順に選択します。
![\[図: コピーされた Elastic クラスタースナップショット\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-copy-snapshot.png)
1. **[新しいスナップショット識別子]** で、新しいスナップショットの名前を入力します。
1. コピー元の Elastic クラスタースナップショットからコピー先の Elastic クラスタースナップショットにすべてのタグをコピーしたい場合は、**[タグのコピー]** のチェックボックスをオンにします。
1. **暗号化**では、デフォルトの KMS AWS キーまたは任意の KMS キーを選択します。任意の KMS キーを選択することで、過去に作成した既存の KMS キーを選択したり、あるいは新しい KMS キーを作成することができます。
1. 完了したら、**[スナップショットのコピー]** を選択します。
------
#### [ Using the AWS CLI ]
を使用して Elastic クラスタースナップショットをコピーするには AWS CLI、以下のパラメータを指定して `copy-cluster-snapshot`オペレーションを使用します。
+ **‐‐source-db-cluster-snapshot-identifier** — 必須 コピーしたい 既存の Elastic クラスタースナップショットの識別子。その Elastic クラスターのスナップショットが実際に存在し、利用可能な状態である必要があります。このパラメータは大文字と小文字が区別されません。
+ **‐‐target-db-cluster-snapshot-identifier** — 必須 既存のクラスタースナップショットから作成する新しいクラスタースナップショット向けの識別子。このパラメータは大文字と小文字が区別されません。
コピー先のスナップショットの名前付けに関する制約事項:
+ 既存のスナップショットの名前にすることはできません。
+ 長さは、[1 ～ 63] 個の英字、数字、またはハイフンです。
+ 1 字目は英字である必要があります。
+ ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic copy-cluster-snapshot \
‐‐source-cluster-snapshot-arn \
‐‐target-cluster-snapshot-name my-target-copied-snapshot
```
Windows の場合:
```
aws docdb-elastic copy-cluster-snapshot ^
‐‐source-cluster-snapshot-arn ^
‐‐target-cluster-snapshot-name my-target-copied-snapshot
```
------
## Elastic クラスタースナップショットの削除
このセクションでは、 AWS マネジメントコンソール または を使用して Elastic クラスタースナップショットを削除する方法について説明します AWS CLI。
------
#### [ Using the AWS マネジメントコンソール ]
AWS マネジメントコンソールを試用してスナップショットから Elastic クラスターから復元するには:
1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/home?region=us-east-1) にサインインし、Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで、[**Snapshots**] を選択してください。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ナビゲーションペインの左上隅にあるメニューアイコンを選択します。
1. **[スナップショット識別子]** 列で、クラスターの復元に使用するスナップショットの左側にあるボタンを選択します。
1. [**Actions (アクション)**] を選択してから [**Delete (削除)**] を選択します。
![\[図: Elastic クラスター削除スナップショット\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/elastic-delete-snapshot.png)
1. **[「snapshot-name」スナップショットの削除]** ダイアログで、**[削除]** を選択します。
------
#### [ Using the AWS CLI ]
を使用して Elastic クラスタースナップショットを削除するには AWS CLI、次のパラメータを指定して `delete-cluster-snapshot`オペレーションを使用します。
+ **--snapshot-arn** — 必須 クラスターの復元に使用されているスナップショットの ARN 識別子。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
Linux、macOS、Unix の場合:
```
aws docdb-elastic delete-cluster-snapshot \
--snapshot-arn sampleResourceName
```
Windows の場合:
```
aws docdb-elastic delete-cluster-snapshot ^
--snapshot-arn sampleResourceName
```
------
## Elastic クラスタースナップショットの自動バックアップの管理
Amazon DocumentDB は、お使いの各 Elastic クラスターのスナップショットを毎日作成します。新規または既存の Elastic クラスタースナップショット設定で、希望するバックアップウィンドウ (タイミング) とバックアップ保持期間を指定できます。このセクションでは、 AWS マネジメントコンソール または を使用して、Elastic クラスタースナップショットに自動バックアップパラメータを設定する方法について説明します AWS CLI。
------
#### [ Using the AWS マネジメントコンソール ]
を使用して新しい Elastic クラスタースナップショットの自動バックアップを設定するには AWS マネジメントコンソール:
1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/home?region=us-east-1) にサインインし、Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで **[Clusters]** (クラスター) を選択します。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ナビゲーションペインの左上隅にあるメニューアイコンを選択します。
1. **[クラスター識別子]** 列で、バックアップ設定を変更したいクラスターの左側にあるボタンを選択します。
1. **[アクション]**、**[変更]** の順にクリックします。
1. **[バックアップ]** セクションで、該当するバックアップ要件に従ってフィールドを編集します。
![\[バックアップウィンドウを設定するステップを示すバックアップペインのスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-backup.png)
1. [**バックアップ保持期間**] - リストで、このクラスターの自動バックアップを削除するまで保持する日数を選択します。
1. **[バックアップウィンドウ]** - Amazon DocumentDB によってこのクラスターのバックアップが作成される毎日の時刻と期間を設定します。
1. バックアップの作成タイミングと期間を設定したい場合は、**[ウィンドウを選択]** を選択します。
[**開始時刻**] - 最初のリストで、自動バックアップを開始する時間 (UTC 時) を選択します。2 番目のリストで、自動バックアップを開始する時間 (UTC 分) を選択します。
[**期間**] - リストで、自動バックアップの作成に割り当てる時間を選択します。
1. Amazon DocumentDB 動作に従ってバックアップの作成タイミングや期間を自動選択する場合は、**[設定なし]** を選択します。
1. 完了したら **[クラスターの変更]** を選択します。
------
#### [ Using the AWS CLI ]
を使用して新しい Elastic クラスタースナップショットの自動バックアップを設定するには AWS CLI、次のパラメータを指定して `create-cluster-snapshot`オペレーションを使用します。
+ **--preferred-backup-window** - オプションです。毎日自動バックアップを作成する希望の時間帯。デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウです AWS リージョン。
制約:
+ `hh24:mi-hh24:mi` の形式である必要があります。
+ 時間は協定世界時 (UTC) である必要があります。
+ 必要なメンテナンス期間と競合してはいけません。
+ 少なくとも 30 分以上必要です。
+ **--backup-retention-period** - オプション。自動バックアップを保管する日数。デフォルト値は 1 です。
制約:
+ 最小でも 1 を指定する必要があります。
+ 1 から 35 の範囲の数を指定できます。
**注記**
自動バックアップは、そのクラスターが「アクティブ」状態である場合にのみ実行されます。
**注記**
`aws docdb-elastic update-cluster` コマンドを使用して、既存の Elastic クラスターの `preferred-backup-window` および `backup-retention-period` パラメータを変更することもできます。
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
次の `create-cluster` 例では、自動バックアップの保持期間が *7* 日間で、優先バックアップウィンドウが *18:00～18:30 UTC* である Amazon DocumentDB Elastic クラスターの*サンプルクラスター*を作成します。
Linux、macOS、Unix の場合:
```
aws docdb-elastic create-cluster \
--cluster-name sample-cluster \
--shard-capacity 2 \
--shard-count 2 \
--admin-user-name SampleAdmin \
--auth-type PLAIN_TEXT \
--admin-user-password SamplePass123! \
--preferred-backup-window 18:00-18:30 \
--backup-retention-period 7
```
Windows の場合:
```
aws docdb-elastic create-cluster ^
--cluster-name sample-cluster ^
--shard-capacity 2 ^
--shard-count 2 ^
--admin-user-name SampleAdmin ^
--auth-type PLAIN_TEXT ^
--admin-user-password SamplePass123! ^
--preferred-backup-window 18:00-18:30 ^
--backup-retention-period 7
```
------
# Amazon DocumentDB Elastic クラスターの停止と開始
Amazon DocumentDB Elastic クラスターの停止および開始機能は、開発環境やテスト環境のコストを管理するのに便利です。Amazon DocumentDB を使用するたびに Elastic クラスターを作成したり削除する代わりに、必要ではないときにクラスターを一時的に停止させることができます。必要になった時にクラスターを再開すれば、テストを再開することができます。
**Topics**
+ [Elastic クラスターの停止と開始の概要](#elastic-cluster-stop-start-overview)
+ [停止中の Elastic クラスターのみで実行できるオペレーション。](#elastic-cluster-stopped-operations)
## Elastic クラスターの停止と開始の概要
Amazon DocumentDB Elastic クラスターが必要ではない期間は、そのクラスターを停止することができます。そして、クラスターを使用する必要がある時はいつでもクラスターを開始できます。開始と停止は、継続的な可用性を必要としない開発、テスト、または類似のアクティビティに使用される Elastic クラスターのセットアップと解放のプロセスを簡素化します。Elastic クラスターを停止および開始するには、 AWS マネジメントコンソール または を 1 つのアクション AWS CLI で使用します。
Elastic クラスターの停止中は、そのクラスターのストレージボリュームは変更されません。指定された保持期間内でのストレージ、手動のスナップショット、および自動化されたバックアップストレージに対してのみ課金されます。Amazon DocumentDB は、7 日後に Elastic クラスターを自動的に再開するため、必要なメンテナンスの更新が遅延することはありません。7 日後にクラスターが再開すると、その Elastic クラスター内のインスタンスに対する課金が再開します。クラスターの停止中は、そのストレージボリュームに対するクエリを実行できません。クエリを実行するにはクラスターが使用可能状態であることが必要であるからです。
Amazon DocumentDB Elastic クラスターの停止中は、そのクラスターには一切変更を加えることはできません。これには、クラスターの削除も含まれます。
------
#### [ Using the AWS マネジメントコンソール ]
次の手順では、利用可能な状態にある Elastic クラスターの停止方法と、停止状態にある Elastic クラスターの再開方法を示します。
**Amazon DocumentDB Elastic クラスターを停止または開始するには**
1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで **クラスター** を選択します。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-menu-icon.png)) を選択します。
1. クラスターのリストで、停止または開始するクラスター名の左側にあるボタンを選択します。
![\[クラスター名の左側のチェックボックスが選択されている、クラスターリストからのクラスター。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/cluster-list-ec.png)
1. [**Actions (アクション)**] を選択したら、このクラスターで実行するアクションを選択します。
+ クラスターを停止したいときに、このクラスターが利用可能な場合:
1. **[停止]** を選択します。
![\[[停止] オプションが選択された [アクション] ドロップダウンリスト。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-stop.png)
1. 確認ダイアログで **[クラスターの停止]** を選択して Elastic クラスターの停止を確定するか、もしくは **[キャンセル]** を選択してクラスター動作を継続させます。
![\[下部に [キャンセル] と [クラスターの停止] ボタンがある、クラスターを停止するための確認ダイアログ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-stop-confirm.png)
+ クラスターを開始したいときにこのクラスターが停止されている場合、[**Start (開始)**] を選択します。
![\[[開始] オプションが選択された [アクション] ドロップダウンリスト。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-start.png)
1. Elastic クラスターのステータスをモニタリングします。クラスターの再開を選択すると、クラスターが*利用可能な状態*にあればクラスターの使用を再開できます。詳細については、「[クラスターのステータスの評価](db-cluster-status.md)」を参照してください。
![\[[使用可能] と [開始] ステータスを示すクラスターテーブルのステータス列。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-starting-status.png)
------
#### [ Using the AWS CLI ]
次のコード例では、アクティブもしくは利用可能な状態にある Elastic クラスターを停止する方法と、停止状態にある Elastic クラスターを再開する方法を示します。
を使用して Elastic クラスターを停止するには AWS CLI、 `stop-cluster`オペレーションを使用します。停止しているクラスターを開始するには、 `start-cluster` オペレーションを使用します。どちらのオペレーションも `--cluster-arn` パラメータを使用します。
**パラメータ:**
+ **--cluster-arn** — 必須 停止もしくは再開したい Elastic クラスターの ARN 識別子。
**Example — を使用して Elastic クラスターを停止するには AWS CLI**
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
次のコードにより、ARN が `arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2` である Elastic クラスターを停止します。
これには、その Elastic クラスターがアクティブまたは利用可能な状態でなければなりません。
Linux、macOS、Unix の場合:
```
aws docdb-elastic stop-cluster \
--cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2
```
Windows の場合:
```
aws docdb-elastic stop-cluster ^
--cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2
```
**Example — を使用して Elastic クラスターを起動するには AWS CLI**
次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。
次のコードにより、ARN が `arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2` である Elastic クラスターを再開します。
これには、その Elastic クラスターが現在停止状態である必要があります。
Linux、macOS、Unix の場合:
```
aws docdb-elastic start-cluster \
--cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2
```
Windows の場合:
```
aws docdb-elastic start-cluster ^
--cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2
```
------
## 停止中の Elastic クラスターのみで実行できるオペレーション。
クラスターが停止中は、Amazon DocumentDB Elastic クラスターの設定を変更することはできません。そのような管理アクションを実行する前に、クラスターを開始する必要があります。
Amazon DocumentDB は、停止中の Elastic クラスターにスケジュールされているメンテナンスについては、クラスターの再開後に適用します。Amazon DocumentDB は停止した Elastic クラスターを 7 日後に自動的に再開するため、メンテナンス実施状況が過剰に遅延することはありません。Elastic クラスターが再開すると、クラスター内のシャードへの課金が再開します。
Elastic クラスターの停止中、Amazon DocumentDB は自動バックアップを一切実行せず、またバックアップ保持期間を延長することはありません。
# 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 エラスティッククラスター向けオペレーティングシステム更新が使用可能になったらすぐに適用するように努め、ビジネスニーズに応じて都合の良いときにインスタンスメンテナンスウィンドウを設定することをお勧めします。