

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# Amazon DocumentDB のエラスティッククラスター
<a name="docdb-using-elastic-clusters"></a>

Amazon DocumentDB エラスティッククラスターは、1 秒あたり数百万回の読み取り/書き込み速度とペタバイトのストレージ容量でワークロードに対応できます。また、インスタンスを選択、管理、アップグレードする必要がなくなるため、開発者は Amazon DocumentDB を簡単に操作できるようになります。

**注記**  
Elastic クラスターは MongoDB 5.0 互換のワイヤプロトコルを使用します。Amazon DocumentDB エンジンバージョン 8.0 ではサポートされておらず、中国リージョンまたは AWS GovCloud では使用できません。

Amazon DocumentDB エラスティッククラスター作成の目的は以下の通りです。
+ 豊富なクエリ機能と MongoDB API との互換性を備え、事実上無制限のスケーリング機能を持つデータベースをお探しのお客様にソリューションを提供する。
+ 接続制限を緩和し、パッチ適用によるダウンタイムを短縮する。
+ 引き続き、JSON ワークロード向けのクラウドネイティブで、伸縮性のある最高水準のアーキテクチャへの投資してください。

 

**Topics**
+ [エラスティッククラスターのユースケース](#elastic-use-cases)
+ [エラスティッククラスターの利点](#elastic-advantages)
+ [エラスティッククラスターのリージョンとバージョンの可用性](#elastic-region-version)
+ [制限事項](#elastic-limitations)
+ [Amazon DocumentDB のエラスティッククラスター](elastic-how-it-works.md)
+ [Amazon DocumentDB エラスティッククラスターの開始方法](elastic-get-started.md)
+ [Amazon DocumentDB のエラスティッククラスターのベストプラクティス](elastic-best-practices.md)
+ [Amazon DocumentDB エラスティッククラスターの管理](elastic-managing.md)
+ [Amazon DocumentDB エラスティッククラスターで保管中のデータ暗号化](elastic-encryption.md)
+ [エラスティッククラスター上のサービスにリンクされたロール](elastic-service-linked-roles.md)

## エラスティッククラスターのユースケース
<a name="elastic-use-cases"></a>

ドキュメントデータベースは、迅速で反復性のある開発のための柔軟なスキーマを必要とするワークロードに適しています。Amazon DocumentDB のユースケース例については、「[ドキュメントデータベースのユースケース](document-database-use-cases.md)」を参照してください。

以下では、ドキュメントデータベースに大きな利点があるユースケース例をいくつか紹介します。

### ユーザープロファイル
<a name="elastic-use-case-user-profiles"></a>

ドキュメントデータベースに柔軟性の高いスキーマがあるため、多種多様の属性およびデータ値を大量に持つドキュメントを保存できます。エラスティッククラスターは、さまざまなユーザーがさまざまな種類の情報を提供するオンラインプロファイルに対する実用的なソリューションです。アプリケーションが何億というユーザープロファイルをサポートしていると仮定してみましょう。エラスティッククラスターは、そのようなアプリケーションに対応できます。なぜなら、エラスティッククラスター自体をスケールアップおよびスケールアウトして、ユーザープロファイルへの何百万回もの書き込みと読み取りに対応できるためです。オフピークの時間帯には、スケールダウンしてコストを削減することもできます。

### コンテンツの管理と履歴の記録
<a name="elastic-use-case-content-mgmt-records"></a>

コンテンツを効果的に管理するために、さまざまなソースからコンテンツを収集して集計し、お客様に提供する必要があります。ドキュメントデータベースは、柔軟性の高いスキーマがあるため、あらゆる種類のデータの収集および保存に最適です。イメージやコメント、ビデオなど、ユーザーが生成したコンテンツをはじめとして、新しい種類のコンテンツを作成し、取り込むことができます。時間が経つにつれて、データベースにはより多くのストレージが必要になります。エラスティッククラスターでは、データをより多くのストレージボリュームに分散できるため、1 つのクラスターにペタバイト規模のデータを保存できます。

## エラスティッククラスターの利点
<a name="elastic-advantages"></a>



### AWS サービス統合
<a name="elastic-service-integration"></a>

Amazon DocumentDB エラスティッククラスターは、Amazon DocumentDB と同じ方法で他の AWS サービスと統合されます。
+ **移行** — AWS Database Migration Service (DMS) を使用して、MongoDB およびその他のリレーショナルデータベースから Amazon DocumentDB エラスティッククラスターに移行できます。
+ **モニタリング** - Amazon CloudWatch を使用して、エラスティッククラスターの状態とパフォーマンスをモニタリングできます。
+ **セキュリティ** — AWS Identity and Access Management (IAM) を使用して認証と認可を設定して、Elastic クラスターの作成や更新などの Elastic クラスターリソースを管理し、Amazon VPC を使用して VPC のみの安全な接続を実現できます。エラスティッククラスターの IAM 認証ログインはサポートされていません。
+ **データ管理** — を使用して AWS Glue 、Amazon S3、Amazon Redshift、Amazon OpenSearch Service などの他の AWS サービスとの間でデータをインポートおよびエクスポートできます。

## エラスティッククラスターのリージョンとバージョンの可用性
<a name="elastic-region-version"></a>

### Elastic クラスターのリージョン可用性
<a name="elastic-region-availability"></a>

次の表は、Amazon DocumentDB エラスティッククラスターが現在利用可能な AWS リージョンと、各リージョンのエンドポイントを示しています。


| リージョン名 | リージョン | アベイラビリティーゾーン | 
| --- | --- | --- | 
|  米国東部 (バージニア北部)  |  `us-east-1`  |  5  | 
|  米国東部 (オハイオ)  |  `us-east-2`  |  3  | 
|  米国西部 (オレゴン)  |  `us-west-2`  |  3  | 
|  アジアパシフィック (香港)  |  `ap-east-1`  |  3  | 
|  アジアパシフィック (ムンバイ)  |  `ap-south-1`  |  3  | 
|  アジアパシフィック (ソウル)  |  `ap-northeast-2`  |  3  | 
|  アジアパシフィック (シンガポール)  |  `ap-southeast-1`  |  3  | 
|  アジアパシフィック (シドニー)  |  `ap-southeast-2`  |  3  | 
|  アジアパシフィック (東京)  |  `ap-northeast-1`  |  3  | 
|  カナダ (中部)  |  `ca-central-1`  |  3  | 
|  南米 (サンパウロ)  |  `sa-east-1`  |  3  | 
|  欧州 (フランクフルト)  |  `eu-central-1`  |  3  | 
|  欧州 (アイルランド)  |  `eu-west-1`  |  3  | 
|  欧州 (ロンドン)  |  `eu-west-2`  |  3  | 
|  欧州 (ミラノ)  |  `eu-south-1`  |  3  | 
|  欧州 (パリ)  |  `eu-west-3`  |  3  | 

### バージョンの可用性
<a name="elastic-version-availability"></a>

エラスティッククラスターは MongoDB 5.0 互換のワイヤープロトコルをサポートします。Amazon DocumentDB 4.0 のインスタンスベースのクラスターとエラスティッククラスターの相違点については、「[Amazon DocumentDB 4.0 と Elastic クラスター の機能上の違い](elastic-how-it-works.md#elastic-functional-differences)」を参照してください。注: Elastic クラスターは Amazon DocumentDB 8.0 ではサポートされていません 

## 制限事項
<a name="elastic-limitations"></a>



### エラスティッククラスターの管理
<a name="elastic-management-limitations"></a>

このリリースでは、以下のクラスター管理機能はサポートされて*いません*。
+ カスタムポート (27017 のみがサポートされています)
+  IAM ユーザーとロールを使用してデータベースへの認証を行う機能
+ グローバルクラスターの作成機能
+ 既存の Amazon DocumentDB イベントとイベントのサブスクリプション
+ レンジシャーディング
+ シャードの既存のコレクション
+ マルチフィールドシャードキー
+ シャードキーを変更する
+ ポイントインタイム復元
+ クローン作成
+ Performance Insights

**注記**  
エラスティッククラスターの制限については、「[Amazon DocumentDB のクォータと制限事項](limits.md)」を参照してください。

### クエリ操作と書き込み操作
<a name="elastic-query-limitations"></a>

このリリースでは、次のクエリおよび書き込み操作コマンド/機能はサポートされて*いません*。
+ スケーリング中の DDL コマンド
+ プロファイラー
+ パラメータグループ
+ AWS Config
+ AWS Backup

### コレクションとインデックスの管理
<a name="elastic-index-limits"></a>

このリリースでは、以下のコレクションおよびインデックス管理機能はサポートされて*いません*。
+ 一意のインデックス
+ 部分インデックス
+ テキストインデックス
+ ベクトルインデックス
+ ドキュメント圧縮

### 管理と診断
<a name="elastic-admin-diagnostics-limitations"></a>

このリリースでは、以下の管理および診断コマンド/機能はサポートされて*いません*。
+ AWS Secrets Manager
+ ロールベースのアクセスコントロール (RBAC) におけるカスタムロール
+ 接続時、 0 の Write Concern はサポートされていません。
+ VPC に属していて、既存のエラスティッククラスターに割り当てられていないサブネットの変更。

### オプトイン機能
<a name="elastic-opt-in-feature-limitations"></a>

このリリースでは、以下の Amazon DocumentDB オプトイン機能はサポートされて*いません*。
+ ACID トランザクション
+ DDL/DML 監査
+ Change streams
+ セッション系コマンド

# Amazon DocumentDB のエラスティッククラスター
<a name="elastic-how-it-works"></a>

このセクションのトピックでは、Amazon DocumentDB エラスティッククラスターを支えているメカニズムと機能について説明します。

**Topics**
+ [Amazon DocumentDB エラスティッククラスターのシャーディング](#elastic-how-it-works.sharding)
+ [エラスティッククラスターの移行](#elastic-how-it-works-migration)
+ [エラスティッククラスターのスケーリング](#elastic-how-it-works-scaling)
+ [エラスティッククラスターの信頼性](#elastic-reliability)
+ [エラスティッククラスターのストレージと可用性](#how-it-works-storage)
+ [Amazon DocumentDB 4.0 と Elastic クラスター の機能上の違い](#elastic-functional-differences)

## Amazon DocumentDB エラスティッククラスターのシャーディング
<a name="elastic-how-it-works.sharding"></a>

Amazon DocumentDB エラスティッククラスターは、ハッシュベースのシャーディングを使用して、分散型ストレージシステム全体にデータをパーティショニングします。シャーディングはパーティショニングとも呼ばれ、大きなデータセットを複数のノードにまたがる小さなデータセットに分割し、垂直スケーリングの限界を超えてデータベースをスケールアウトできるようにします。エラスティッククラスターでは、Amazon DocumentDB のコンピューティングとストレージを分離、つまり「デカップリング」することで、互いを別々にスケーリングできます。エラスティッククラスターは、コンピューティングノード間で小さなデータを移動してコレクションを再分割するのではなく、分散型ストレージシステム内でデータを効率的にコピーします。

![\[Amazon DocumentDB エラスティッククラスターには、大きなデータセットを小さなデータセットに分割するための複数のシャードが含まれており、データベースのスケーリングを改善できます。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/shard-architecture.png)


### シャードの定義
<a name="w2aac35c23b7b7"></a>

以下はシャード命名法の定義です。
+ **シャード**: - シャードは エラスティッククラスターのコンピューティング能力を提供します。1 つのライターインスタンスと 0～15 個のリードレプリカがあります。デフォルトでは、シャードにはライターと 1 つのリードレプリカの 2 つのインスタンスがあります。最大 32 個のシャードを設定でき、各シャードインスタンスには最大 64 個の vCPU を設定できます。
+ **シャードキー** - シャードキーは、エラスティッククラスターが読み取りと書き込みトラフィックを分散するために使用する、シャードコレクション内の JSON ドキュメントの必須フィールドです。
+ **シャードコレクション** - シャードコレクションは、データがデータパーティション内の 1 つのエラスティッククラスター全体に分散されるコレクションです。
+ **パーティション** - パーティションはシャードされたデータの論理的な部分です。シャードコレクションを作成すると、データはシャードキーに基づいて各シャード内のパーティションに自動的に編成されます。1 つのシャードには複数のパーティションがあります。

### 設定された複数のシャードに対するデータの分散
<a name="w2aac35c23b7b9"></a>

多数の一意の値を持つシャードキーを作成します。シャードキーが適切であると、その土台のシャード間でデータが均等にパーティショニングされ、ワークロードに最高のスループットとパフォーマンスを提供されます。次の例は、「user\$1id」という名前のシャードキーを使用する従業員名のデータです。

![\[データセットからのデータは、多数のシャードに均等に分散されます。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/sharding-detail-1.png)


DocumentDB はハッシュシャーディングを使用して、土台のシャードの間でデータをパーティショニングします。追加データも同じ方法で挿入および分散されます。

![\[新しいデータセットのデータは、ハッシュシャーディングを介してシャードに分散されます。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/sharding-detail-2.png)


シャードが追加されてデータベースがスケールアウトされると、Amazon DocumentDB はデータを自動的に再分散します。

![\[データセットからのデータは、データベースに追加のシャードが追加されると再分散されます。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/sharding-detail-3.png)


## エラスティッククラスターの移行
<a name="elastic-how-it-works-migration"></a>

Amazon DocumentDB では、シャードされた MongoDB のデータをエラスティッククラスターに移行することができます。オフライン、オンライン、ハイブリッドの移行方法がサポートされています。詳細については、「[Amazon DocumentDB への移行](docdb-migration.md)」を参照してください。

## エラスティッククラスターのスケーリング
<a name="elastic-how-it-works-scaling"></a>

Amazon DocumentDB エラスティッククラスターでは、エラスティッククラスター内のシャードの数を増やしたり (スケールアウト)、各シャードに適用される vCPU の数を増やしたり (スケールアップ) することができます。必要に応じてシャードの数とコンピューティング能力 (vCPU) を減らすこともできます。

スケーリングのベストプラクティスについては、「[エラスティッククラスターのスケーリング](elastic-best-practices.md#scaling)」を参照してください。

**注記**  
クラスターレベルのスケーリングもできます。詳細については、「[Amazon DocumentDB クラスターのスケーリング](db-cluster-manage-performance.md)」を参照してください。

## エラスティッククラスターの信頼性
<a name="elastic-reliability"></a>

Amazon DocumentDB は、信頼性、耐久性、および耐障害性を持つように設計されています。可用性を向上させるため、エラスティッククラスターは異なるアベイラビリティーゾーンに配置されたシャードごとに 2 つのノードを展開します。Amazon DocumentDB には、信頼性の高いデータベースソリューションとなるいくつかの自動機能も含まれています。詳細については、「[Amazon DocumentDB の信頼性](how-it-works.md#how-it-works.reliability)」を参照してください。

## エラスティッククラスターのストレージと可用性
<a name="how-it-works-storage"></a>

Amazon DocumentDB のデータは クラスターボリューム に保存されます。これは、SSD (Solid State Drive) を使用する単一の仮想ボリュームです。クラスターボリュームは、データの 6 つのコピーで構成され、1 つの AWS リージョン内の複数のアベイラビリティーゾーンに自動的にレプリケートされます。このレプリケーションにより、データの高い耐久性が保証され、データ損失の可能性が低くなります。また、データのコピーが他のアベイラビリティーゾーンにすでに存在するため、フェイルオーバー中のクラスターの可用性が高まります。ストレージ、高可用性、レプリケーションの詳細については、「[Amazon DocumentDB の 仕組み](how-it-works.md)」を参照してください。

## Amazon DocumentDB 4.0 と Elastic クラスター の機能上の違い
<a name="elastic-functional-differences"></a>

Amazon DocumentDB 4.0 と エラスティッククラスターの間には、次のような機能上の違いがあります。
+ `top` および `collStats` の結果はシャード別にパーティショニングされます。シャードコレクションの場合、データは複数のパーティションに分散され、`collStats` は、各パーティションから集約された `collScans` のレポートを作成します。
+ シャードされたコレクションの `top` と `collStats` からコレクション統計は、クラスターのシャード数が変更されるとリセットされます。
+ バックアップビルトインロールが `serverStatus` をサポートするようになりました。アクション - バックアップロールを持つデベロッパーおよびアプリケーションは、Amazon DocumentDB クラスターの状態に関する統計を収集できます。
+ `replSetGetConfig` 出力では `SecondaryDelaySecs` フィールドが `slaveDelay` を置き換えます。
+ `hello` コマンドは `isMaster` を置き換え、`hello` は エラスティッククラスターの役割を説明したドキュメント返します。
+ エラスティッククラスターでは、 `$elemMatch` 演算子は配列の最初の入れ子レベルのドキュメントのみを一致検索します。Amazon DocumentDB 4.0 では、この演算子はすべてのレベルを横断して、一致したドキュメントを返します。例えば、次のようになります。

```
db.foo.insert(
[
    {a: {b: 5}},
    {a: {b: [5]}},
    {a: {b: [3, 7]}},
    {a: [{b: 5}]},
    {a: [{b: 3}, {b: 7}]},
    {a: [{b: [5]}]},
    {a: [{b: [3, 7]}]},
    {a: [[{b: 5}]]},
    {a: [[{b: 3}, {b: 7}]]},
    {a: [[{b: [5]}]]},
    {a: [[{b: [3, 7]}]]}
]);
// Elastic clusters
> db.foo.find({a: {$elemMatch: {b: {$elemMatch: {$lt: 6, $gt: 4}}}}}, {_id: 0})
{ "a" : [ { "b" : [ 5 ] } ] }

// Docdb 4.0: traverse more than one level deep
> db.foo.find({a: {$elemMatch: {b: {$elemMatch: {$lt: 6, $gt: 4}}}}}, {_id: 0})
{ "a" : [ { "b" : [ 5 ] } ] }
{ "a" : [ [ { "b" : [ 5 ] } ] ] }
```
+ Amazon DocumentDB 4.0 では、「\$1」プロジェクションはすべてのドキュメントとすべてのフィールドを返します。エラスティッククラスターでは、「\$1」プロジェクションが指定された `find` コマンドは、「\$1」プロジェクションと一致するフィールドのみを含むクエリパラメータに一致するドキュメントを返します。
+ エラスティッククラスターでは、`$regex` および `$options` クエリパラメーターが指定された `find` コマンドは、「\$1regex と \$1options の両方にオプションを設定することはできません」というエラーを返します。
+ エラスティッククラスターの場合、`$indexOfCP` は以下のいずれかの場合に 「-1」を返します。
  + `string expression` でサブ文字列が見つからない。
  + 数値 `start` は `end` より大きい。
  + 数値 `start` は文字列のバイト長より大きい。

  Amazon DocumentDB 4.0 の場合、`$indexOfCP` は位置 `start` の数値が `end` または文字列のバイト長よりも大きい場合に「0」を返します。
+ エラスティッククラスターの場合、`_id fields` プロジェクトオペレーション (例: `{"_id.nestedField" : 1}`) はプロジェクトされたフィールドのみを含むドキュメントを返します。一方、Amazon DocumentDB 4.0 の場合、入れ子にされたフィールドプロジェクトコマンドではどのドキュメントも除外しません。

# Amazon DocumentDB エラスティッククラスターの開始方法
<a name="elastic-get-started"></a>

このセクションでは、初めてのエラスティッククラスターを作成してクエリする方法を順を追って説明します。

Amazon DocumentDB に接続して開始する方法は複数あります。以下の手順は、ユーザーが私たちの強力なドキュメントデータベースの使用を開始するための最も迅速、シンプルかつ簡単な方法です。このガイドでは、[AWS CloudShell](https://docs.aws.amazon.com/cloudshell/latest/userguide/welcome.html) を使用して、 AWS マネジメントコンソールから直接 Amazon DocumentDB クラスターに接続してクエリを実行します。 AWS 無料利用枠の対象となる新規のお客様は、Amazon DocumentDB と CloudShell を無料で使用できます。 AWS CloudShell 環境または Amazon DocumentDB エラスティッククラスターが無料利用枠を超えるリソースを使用する場合、それらのリソースの通常の AWS 料金が課金されます。このガイドでは、5 分以内に Amazon DocumentDB の使用を開始します。

**Topics**
+ [前提条件](#elastic-clusters-prerequisites)
+ [ステップ 1: エラスティッククラスターを作成する](#elastic-get-started-clusters)
+ [ステップ 2: エラスティッククラスターに接続する](#ec-gs-connect)
+ [ステップ 3: コレクションをシャーディングし、データを挿入してクエリする](#elastic-get-started-shard)
+ [ステップ 4: 探索する](#ec-gs-congrats)

## 前提条件
<a name="elastic-clusters-prerequisites"></a>

最初の Amazon DocumentDB クラスターを作成する前に、以下の操作を行う必要があります。

**Amazon Web Services (AWS) アカウントを作成する**  
Amazon DocumentDB を使用する前に、Amazon Web Services (AWS) アカウントを持っている必要があります。 AWS アカウントは無料です。使用しているサービスとリソースに対してのみ料金をお支払いいただきます。  
がない場合は AWS アカウント、次の手順を実行して作成します。  

**にサインアップするには AWS アカウント**

1. [https://portal.aws.amazon.com/billing/signup](https://portal.aws.amazon.com/billing/signup) を開きます。

1. オンラインの手順に従います。

   サインアップ手順の一環として、電話またはテキストメッセージを受け取り、電話キーパッドで検証コードを入力します。

   にサインアップすると AWS アカウント、 *AWS アカウントのルートユーザー* が作成されます。ルートユーザーには、アカウントのすべての AWS のサービス とリソースへのアクセス権があります。セキュリティベストプラクティスとして、ユーザーに管理アクセス権を割り当て、[ルートユーザーアクセスが必要なタスク](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#root-user-tasks)の実行にはルートユーザーのみを使用するようにしてください。

**必要な AWS Identity and Access Management (IAM) アクセス許可を設定します。**  
クラスター、インスタンス、クラスターパラメータグループなどの Amazon DocumentDB リソースを管理するには、 がリクエストの認証 AWS に使用できる認証情報が必要です。詳細については、「[Amazon DocumentDB の Identity and Access Management](security-iam.md)」を参照してください。  

1. の検索バーで AWS マネジメントコンソール、IAM と入力し、ドロップダウンメニューで **IAM** を選択します。

1. IAM コンソールにアクセスしたら、ナビゲーションペインから [**ユーザー**] を選択します。

1. ユーザーネームを選択します。

1. **[Add permissions]** (アクセス許可の追加) をクリックします。

1. **[ポリシーを直接アタッチする]** を選択します。

1. 検索バーに `AmazonDocDBElasticFullAccess` と入力し、検索結果に表示されたら、それを選択します。

1. **[次へ]** をクリックします。

1. **[Add permissions]** (アクセス許可の追加) をクリックします。

****  
 AWS アカウントには、各リージョンにデフォルトの VPC が含まれています。Amazon VPC を使用することを選択した場合は、「[Amazon VPC ユーザーガイド](https://docs.aws.amazon.com/vpc/latest/userguide/create-vpc.html)」の「*Amazon VPC を作成する*」トピックの手順を完了します。

## ステップ 1: エラスティッククラスターを作成する
<a name="elastic-get-started-clusters"></a>

このセクションでは、 AWS マネジメントコンソール または を使用して、以下の手順 AWS CLI で新しい Elastic クラスターを作成する方法について説明します。

------
#### [ Using the AWS マネジメントコンソール ]

 AWS マネジメントコンソールを使用して エラスティッククラスター設定を作成するには、以下の手順に従います。

1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。

1. **Amazon DocumentDB マネジメントコンソール**の **[クラスター]** で **[作成]** を選択します。  
![\[開始点としてクラスターがないことを示すエラスティッククラスターテーブル。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-gs-start.png)

1. **[Amazon DocumentDB クラスターの作成]** ページの **[クラスタータイプ]** セクションで、**[エラスティッククラスター]** を選択します。  
![\[インスタンスベースのクラスターとエラスティッククラスターの選択を表示するエラスティッククラスタータイプのダイアログ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-gs-type.png)

1. **[設定]** セクションで、次を実行します:

   1. **クラスター名** フィールドに、一意のクラスター識別子を入力します (フィールドの下の命名要件に従います)。

   1. **[シャード数]** フィールドに、クラスターに必要なシャードの数を入力します。クラスターあたりのシャードの最大数は 32 です。
**注記**  
シャードごとに 2 つのノードが展開されます。両方のノードのシャード容量は同じになります。

   1. **[シャードインスタンス数]** フィールドで、各シャードに関連付けるレプリカインスタンスの数を選択します。シャードインスタンスの最大数は 16 で、1 刻みで設定できます。すべてのレプリカインスタンスのシャード容量は、次のフィールドで定義するものと同じになります。テスト目的では、デフォルト値の 2 で十分です。
**注記**  
レプリカインスタンスの数は、Elastic クラスター内のすべてのシャードに適用されます。シャードインスタンス数の値が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカで、読み取りや可用性の向上に使用できます。テスト目的では、デフォルト値の 2 で十分です。

   1. **[シャード容量]** フィールドで、各シャードインスタンスに関連付ける仮想 CPU (vCPU) の数を選択します。1 シャードインスタンスあたりの vCPU の最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。テスト目的では、デフォルト値の 2 で十分です。

   1. **[仮想プライベートクラウド (VPC)]** フィールドのドロップダウンリストから VPC を選択します。

   1. **[サブネット]** と **[VPC セキュリティグループ]** では、デフォルトを使用するか、選択した 3 つのサブネットと最大 3 つの **VPC セキュリティグループ** (最低 1 つ) を選択できます。  
![\[設定可能なフィールドを表示するエラスティッククラスター設定ダイアログ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-gs-configuration.png)

1. **[認証]** セクションの **[ユーザー名]** フィールドで、プライマリユーザーのログイン名を示す文字列を入力します。

   **[パスワード]** フィールドに、指示に従った一意のパスワードを入力して確認します。  
![\[[ユーザー名] と [パスワード] の入力フィールドを含む [認証] セクション。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-gs-authentication.png)

1. **[暗号化]** セクションは、デフォルト設定 (**デフォルトキー**) をそのまま使用します。

   必要に応じて、作成した AWS KMS key ARN を入力できます。詳細については、「[Amazon DocumentDB エラスティッククラスターで保管中のデータ暗号化](elastic-encryption.md)」を参照してください。
**重要**  
エラスティッククラスターでは暗号化を有効にする必要があります。

1. **[バックアップ]** セクションで、該当するバックアップ要件に従ってフィールドを編集します。テスト目的で、デフォルト設定を保持できます。  
![\[クラスターバックアップウィンドウを設定するステップを示すバックアップダイアログのスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-gs-backup.png)

   1. [**バックアップ保持期間**] - リストで、このクラスターの自動バックアップを削除するまで保持する日数を選択します。

   1. **[バックアップウィンドウ]** - Amazon DocumentDB によってこのクラスターのバックアップが作成される毎日の時刻と期間を設定します。

      1. バックアップの作成タイミングと期間を設定したい場合は、**[ウィンドウを選択]** を選択します。

         [**開始時刻**] - 最初のリストで、自動バックアップを開始する時間 (UTC 時) を選択します。2 番目のリストで、自動バックアップを開始する時間 (UTC 分) を選択します。

         [**期間**] - リストで、自動バックアップの作成に割り当てる時間を選択します。

      1. Amazon DocumentDB 動作に従ってバックアップの作成タイミングや期間を自動選択する場合は、**[設定なし]** を選択します。

1. **[メンテナンス]** セクションで、クラスターに変更やパッチを適用する日と時間、期間を選択します。テスト目的で、デフォルト設定を保持できます。  
![\[メンテナンスウィンドウオプションを示す [メンテナンス] セクション。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-gs-maintenance.png)

1. **[クラスターを作成]** を選択します。

エラスティッククラスターは現在プロビジョニング中です。このプロセスには数分かかることがあります。**[クラスター]** リストに エラスティッククラスターのステータスが **使用可能** と表示されている場合は、クラスターに接続できます。

------
#### [ Using the AWS CLI ]

を使用して Elastic クラスターを作成するには AWS CLI、以下のパラメータを指定して `create-cluster`オペレーションを使用します。
+ **--cluster-name** — 必須 作成時に入力した、または最終変更時のエラスティックスケールクラスターの現在の名前。
+ **--shard-capacity** — 必須 各シャードに割り当てられた vCPU の数。最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。
+ **--shard-count** — 必須 クラスターに割り当てられたシャードの数。最大数は 32 です。
+ **--shard-instance-count** - オプションです。このクラスター内のすべてのシャードに適用されるレプリカインスタンスの数。最大数は 16 です。
+ **--admin-user-name** — 必須 管理者ユーザーに関連付けられているユーザー名。
+ **--admin-user-password** — 必須 管理者ユーザーに関連付けられているパスワード。
+ **--auth-type** — 必須 エラスティッククラスターへのアクセスに使用するパスワードの取得先の特定に使用している認証タイプ。有効なタイプは、`PLAIN_TEXT` または `SECRET_ARN` です。
+ **--vpc-security-group-ids** - オプションです。このクラスターに関連付ける EC2 VPC セキュリティグループのリストを設定します。
+ **--preferred-maintenance-window** - オプションです。週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC)) を設定します。

  形式は `ddd:hh24:mi-ddd:hh24:mi` です。有効な曜日 (ddd): 月、火、水、木、金、土、日

  デフォルトは、1 週間のうちのランダムな日に起こる、Amazon Web Services リージョンあたり 8 時間の範囲からランダムに選択された 30 分のウィンドウです。

  最小 30 分のウィンドウ。
+ **--kms-key-id** - オプションです。暗号化されたクラスターの KMS キー識別子を設定します。

  KMS キー識別子は、 AWS KMS 暗号化キーの Amazon リソースネーム (ARN) です。新しいクラスターの暗号化に使用する KMS 暗号化キーを所有する Amazon Web Services アカウントと同じアカウントを使用してクラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーエイリアスを使用できます。

  KmsKeyId で暗号化キーが指定がなく、かつ `StorageEncrypted` パラメータが true の場合、Amazon DocumentDB はデフォルトの暗号化キーを使用します。
+ **--preferred-backup-window** - オプションです。毎日自動バックアップを作成する希望の時間帯。デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウです AWS リージョン。
+ **--backup-retention-period** - オプション。自動バックアップを保管する日数。デフォルト値は 1 です。
+ **--storage-encrypted** - オプションです。クラスターが暗号化されているかどうかを設定します。

  `--no-storage-encrypted` はクラスターが暗号化されていない指定です。
+ **--subnet-ids** - オプションです。ネットワークのサブネット ID を設定します。

次の例では、各 *ユーザー入力プレースホルダー* を独自の情報に置き換えます。

**注記**  
以下の例には、特定の KMS キーの作成例が含まれています。デフォルトの KMS キーを使用するには、`--kms-key-id` パラメータを含めないでください。

Linux、macOS、Unix の場合:

```
aws docdb-elastic create-cluster \
     --cluster-name sample-cluster-123 \
     --shard-capacity 8 \
     --shard-count 4 \
     --shard-instance-count 3 \
     --auth-type PLAIN_TEXT \
     --admin-user-name testadmin \
     --admin-user-password testPassword \
     --vpc-security-group-ids 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 \
     --preferred-backup-window 18:00-18:30 \ 
     --backup-retention-period 7
```

Windows の場合:

```
aws docdb-elastic create-cluster ^
     --cluster-name sample-cluster-123 ^
     --shard-capacity 8 ^
     --shard-count 4 ^
     --shard-instance-count 3 ^
     --auth-type PLAIN_TEXT ^
     --admin-user-name testadmin ^
     --admin-user-password testPassword ^
     --vpc-security-group-ids 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 \
     --preferred-backup-window 18:00-18:30 \ 
     --backup-retention-period 7
```

------

## ステップ 2: エラスティッククラスターに接続する
<a name="ec-gs-connect"></a>

を使用して Amazon DocumentDB エラスティッククラスターに接続します AWS CloudShell。

1. Amazon DocumentDB マネジメントコンソールの **[クラスター]** で、作成したエラスティッククラスターを探します。クラスターの横にあるチェックボックスをクリックして選択します。  
![\[エラスティッククラスターを示す [Amazon DocumentDB クラスター管理] インターフェイス\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-gs-cluster-new.png)

1. **[クラスターに接続]** をクリックします(**[アクション]** ドロップダウンメニューの横にある)。このボタンは、クラスターの横にあるチェックボックスをクリックし、クラスターのステータスが **使用可能** と表示された後にのみ有効になります。CloudShell の **[Run コマンド]** 画面が表示されます。

1. **[新しい環境の名前]** フィールドに、「test」などの一意の名前を入力し、**[作成して実行する]** をクリックします。VPC 環境の詳細は、Amazon DocumentDB データベースに自動的に設定されます。  
![\[新しい環境名をリクエストするエラスティッククラスター CloudShell Run コマンド画面\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-gs-run-command.png)

1. プロンプトが表示されたら、ステップ 1: Amazon DocumentDB エラスティッククラスターを作成する (サブステップ 5) で作成したパスワードを入力します。  
![\[ユーザーパスワードをリクエストするエラスティッククラスター CloudShell 画面\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec-gs-cs-password.png)

   パスワードを入力して、プロンプトが `direct: mongos] <env-name>>` に変わったら、Amazon DocumentDB クラスターに正常に接続できています

**注記**  
トラブルシューティングについては、「[Amazon DocumentDB のトラブルシューティング](https://docs.aws.amazon.com/documentdb/latest/developerguide/troubleshooting.html)」を参照してください。

## ステップ 3: コレクションをシャーディングし、データを挿入してクエリする
<a name="elastic-get-started-shard"></a>

エラスティッククラスターでは Amazon DocumentDB でのシャーディングのサポートが追加されています。クラスターに接続できたので、クラスターをシャーディングし、データを挿入して、クエリを実行できます。

1. コレクションをシャーディングするには、次のように入力します。

   ```
   sh.shardCollection("db.Employee1" , { "Employeeid" : "hashed" })
   ```

1. 1 つのドキュメントを挿入するには、次のように入力します。

   ```
   db.Employee1.insertOne({"Employeeid":1, "Name":"Joe", "LastName": "Bruin", "level": 1 })
   ```

   以下のような出力が表示されます。

   ```
   WriteResult({ "nInserted" : 1 })
   ```

1. `findOne()` コマンドで書き込んだドキュメントを読み取るには、 コマンドを入力します (コマンドから一つのドキュメントが返される)。

   ```
   db.Employee1.findOne()
   ```

   以下のような出力が表示されます。

   ```
   {
   "_id" : ObjectId("61f344e0594fe1a1685a8151"),
   "EmployeeID" : 1,
   "Name" : "Joe",
   "LastName" : "Bruin",
   "level" : 1
   }
   ```

1. さらにクエリを実行するには、ゲームプロファイルのユースケースを検討してみてください。最初に、「Employee」というタイトルのコレクションにエントリをいくつか挿入します。次のように入力します。

   ```
   db.profiles.insertMany([ { "_id": 1, "name": "Matt", "status": "active", "level": 12, "score": 202 }, 
        { "_id": 2, "name": "Frank", "status": "inactive", "level": 2, "score": 9 }, 
        { "_id": 3, "name": "Karen", "status": "active", "level": 7, "score": 87 }, 
        { "_id": 4, "name": "Katie", "status": "active", "level": 3, "score": 27 }
   ])
   ```

   以下のような出力が表示されます。

   ```
   { acknowledged: true, 
        insertedIds: { 
           '0': ObjectId('679d02cd6b5a0581be78bcbd'),
           '1': ObjectId('679d02cd6b5a0581be78bcbe'),
           '2': ObjectId('679d02cd6b5a0581be78bcbf'),
           '3': ObjectId('679d02cd6b5a0581be78bcc0')
       }
   }
   ```

1. プロファイルコレクション内のすべてのドキュメントを取得するには、`find`() コマンドを使用します。

   ```
   db.Employee.find()
   ```

   ステップ 4 で入力したデータが表示されます。

1. 1 つのドキュメントに対してクエリを発行するには、フィルター (「Katie」など) を含めます。次のように入力します。

   ```
   db.Employee.find({name: "Katie"})
   ```

    以下のような出力が表示されます。

   ```
   [ 
      { 
        _id: ObjectId('679d02cd6b5a0581be78bcc0'), 
        Employeeid: 4, 
        name: 'Katie', 
        lastname: 'Schaper', 
        level: 3 
      } 
   ]
   ```

1. プロファイルを見つけて変更するには、`findAndModify` コマンドを入力します。この例では、従業員「Matt」にはより高いレベル「14」が割り当てられています。

   ```
   db.Employee.findAndModify({     
       query: { "Employeeid" : 1, "name" : "Matt"},     
       update: { "Employeeid" : 1, "name" : "Matt", "lastname" : "Winkle", "level" : 14 } 
   })
   ```

   以下のような出力が表示されます (レベルはまだ変更されていないことに注意してください)。

   ```
   { 
      _id: ObjectId('679d02cd6b5a0581be78bcbd'), 
      Employeeid: 1, 
      name: 'Matt', 
      lastname: 'Winkle', 
      level: 12 
   }
   ```

1. レベルが上がったことを確認するには、次のクエリを入力します。

   ```
   db.Employee.find({name: "Matt"})
   ```

   以下のような出力が表示されます。

   ```
   [
      { 
      _id: ObjectId('679d02cd6b5a0581be78bcbd'), 
      Employeeid: 1, 
      name: 'Matt', 
      lastname: 'Winkle', 
      level: 14 
      }
   ]
   ```

## ステップ 4: 探索する
<a name="ec-gs-congrats"></a>

お疲れ様でした。Amazon DocumentDB エラスティッククラスターの開始手順が正常に完了しました。

次のステップ このデータベースを一般的な機能の一部を使用して、完全に活用する方法を学びましょう。
+  [Amazon DocumentDB のエラスティッククラスターのベストプラクティス](elastic-best-practices.md) 
+  [Amazon DocumentDB エラスティッククラスターの管理](elastic-managing.md) 

**注記**  
この開始手順で作成したエラスティッククラスターは、削除しない限り、引き続きコストを計上します。手順については、「[Elastic クラスターの削除](elastic-managing.md#elastic-delete)」を参照してください。

# Amazon DocumentDB のエラスティッククラスターのベストプラクティス
<a name="elastic-best-practices"></a>

Amazon DocumentDB のエラスティッククラスターを使用するためのベストプラクティスについて説明します。[インスタンスベースの Amazon DocumentDB クラスターのベストプラクティス](https://docs.aws.amazon.com/documentdb/latest/developerguide/best_practices.html)はすべて、エラスティッククラスターに適用されます。新しいベストプラクティスが確認されると、このセクションは更新されます。

**Topics**
+ [シャードキーの選択](#choosing-shard-keys)
+ [接続管理](#connection-management)
+ [非シャード型コレクション](#unsharded-collections)
+ [エラスティッククラスターのスケーリング](#scaling)
+ [エラスティッククラスターのモニタリング](#monitoring-elastic-clusters)

## シャードキーの選択
<a name="choosing-shard-keys"></a>

以下は、シャードキーの作成に関するガイドラインです。
+ クラスター内のすべてのシャードにデータを分散するには、均等分散型のハッシュキーを使用する (ホットキーの使用は避ける)。
+ スキャッターギャザークエリを回避するには、読み取り/更新/削除リクエストでシャードキーを使用する。
+ 読み取り/更新/削除操作では、入れ子型のシャードキーの使用を避ける。
+ バッチ操作では、すべてのシャードが並列実行され、レイテンシーが改善されるよう `ordered` を false に設定する。

## 接続管理
<a name="connection-management"></a>

以下は、データベースへの接続管理に関するガイドラインです。
+ 接続数、および、新しい接続の開閉の頻度をモニタリングする。
+ アプリケーションの設定のすべてのサブネットに接続を分散する。複数のサブネットにクラスターを設定しているにもかかわらず、サブネットの一部しか使用されないと、最大接続数でボトルネックが発生する可能性があります。

## 非シャード型コレクション
<a name="unsharded-collections"></a>

以下は、非シャード型コレクションに関するガイドラインです。
+ 非シャード型コレクションで負荷を分散するには、使用率の高い非シャード型コレクションを複数のデータベースに保存するようにする。Amazon DocumentDB のエラスティッククラスターは、データベースを複数のシャードに配置します。この時、同じデータベースの非シャード型コレクションは、同じシャードに配置されます。

## エラスティッククラスターのスケーリング
<a name="scaling"></a>

以下は、エラスティッククラスターのスケーリングに関するガイドラインです。
+ スケーリング操作によって、データベースエラーやネットワークエラーが短時間断続的に発生する場合があります。可能な限り、ピーク時間帯のスケーリングは避けてください。スケーリングは、メンテナンスウィンドウ中に行うようにしてください。
+ コンピュートを増やす場合は、シャード数を増減するよりも、シャードの容量を増減 (各シャードの vCPU 数の変更) することをお勧めします。高速であり、データベースやネットワークの断続的なエラーが発生する時間が短くなります。
+ 成長が見込まれる場合は、シャード容量をスケールするではなく、シャード数を増やすことをお勧めします。シャード容量を増やしてクラスターをスケールすることで、迅速なスケーリングが必要とされる状況に対応できます。
+ クライアント側の再試行ポリシーをモニタリングして、エクスポネンシャルバックオフとジッターを試し、スケーリング中にエラーが発生したときにデータベースが過負荷にならないようにしてください。

## エラスティッククラスターのモニタリング
<a name="monitoring-elastic-clusters"></a>

以下は、エラスティッククラスターのモニタリングに関するガイドラインです。
+ 各シャードのメトリクスのピーク対平均比を追跡して、トラフィックが不均等 (ホットキー/ホットスポットがある) になっていないか判断してください。ピーク対平均比を追跡するための主なメトリクスは次のとおりです。
  + `PrimaryInstanceCPUUtilization`
    + これはシャード単位にモニタリングできます。
    + クラスターレベルでは、平均から p99 までのスキューをモニタリングできます。
  + `PrimaryInstanceFreeableMemory`
    + これはシャード単位にモニタリングできます。
    + クラスターレベルでは、平均から p99 までのスキューをモニタリングできます。
  + `DatabaseCursorsMax`
    + スキューを判断するには、シャード単位でモニタリングする必要があります。
  + `Documents-Inserted/Updated/Returned/Deleted`
    + スキューを判断するには、シャード単位でモニタリングする必要があります。

# Amazon DocumentDB エラスティッククラスターの管理
<a name="elastic-managing"></a>

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 クラスター設定の変更
<a name="elastic-modify"></a>

このセクションでは、 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 クラスターのモニタリング
<a name="elastic-monitor"></a>

このセクションでは、 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 クラスターの削除
<a name="elastic-delete"></a>

このセクションでは、 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 クラスタースナップショットの管理
<a name="elastic-manage-snapshots"></a>

手動スナップショットは、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 クラスタースナップショットの作成
<a name="elastic-create-snapshot"></a>

このセクションでは、 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 クラスタースナップショットの表示
<a name="elastic-view-snapshot"></a>

このセクションでは、 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 クラスターの復元
<a name="elastic-restore-snapshot"></a>

このセクションでは、 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 クラスタースナップショットのコピー
<a name="elastic-copy-snapshot"></a>

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 <sample ARN> \
     ‐‐target-cluster-snapshot-name my-target-copied-snapshot
```

Windows の場合:

```
aws docdb-elastic copy-cluster-snapshot ^
     ‐‐source-cluster-snapshot-arn <sample ARN> ^
     ‐‐target-cluster-snapshot-name my-target-copied-snapshot
```

------

## Elastic クラスタースナップショットの削除
<a name="elastic-delete-snapshot"></a>

このセクションでは、 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 クラスタースナップショットの自動バックアップの管理
<a name="elastic-auto-snapshot"></a>

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 クラスターの停止と開始
<a name="elastic-cluster-stop-start"></a>

Amazon DocumentDB Elastic クラスターの停止および開始機能は、開発環境やテスト環境のコストを管理するのに便利です。Amazon DocumentDB を使用するたびに Elastic クラスターを作成したり削除する代わりに、必要ではないときにクラスターを一時的に停止させることができます。必要になった時にクラスターを再開すれば、テストを再開することができます。

**Topics**
+ [Elastic クラスターの停止と開始の概要](#elastic-cluster-stop-start-overview)
+ [停止中の Elastic クラスターのみで実行できるオペレーション。](#elastic-cluster-stopped-operations)

## Elastic クラスターの停止と開始の概要
<a name="elastic-cluster-stop-start-overview"></a>

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 クラスターのみで実行できるオペレーション。
<a name="elastic-cluster-stopped-operations"></a>

クラスターが停止中は、Amazon DocumentDB Elastic クラスターの設定を変更することはできません。そのような管理アクションを実行する前に、クラスターを開始する必要があります。

Amazon DocumentDB は、停止中の Elastic クラスターにスケジュールされているメンテナンスについては、クラスターの再開後に適用します。Amazon DocumentDB は停止した Elastic クラスターを 7 日後に自動的に再開するため、メンテナンス実施状況が過剰に遅延することはありません。Elastic クラスターが再開すると、クラスター内のシャードへの課金が再開します。

Elastic クラスターの停止中、Amazon DocumentDB は自動バックアップを一切実行せず、またバックアップ保持期間を延長することはありません。

# Amazon DocumentDB エラスティッククラスターのメンテナンス
<a name="elastic-cluster-maintenance"></a>

**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 はエラスティッククラスターにメンテナンスウィンドウを割り当てます。エラスティッククラスターを作成するときにメンテナンスウィンドウを選択できます。また、ビジネススケジュールや業務に合わせてメンテナンスウィンドウをいつでも変更できます。一般的には、メンテナンスによるアプリケーションへの影響を最小限に抑えるメンテナンスウィンドウ（夜間、週末など）を選択することをお勧めします。

## 保留中のエラスティッククラスターメンテナンスアクションの表示
<a name="view-elastic-cluster-maintenance"></a>

エラスティッククラスターでメンテナンス更新が利用可能かどうかを確認するには、 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` — メンテナンスアクションのオプションの説明。

## エラスティッククラスターエンジンの更新
<a name="elastic-cluster-engine-updates"></a>

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` — メンテナンスアクションのオプションの説明。

### 適用日
<a name="w2aac35c29c19c13c21"></a>

各メンテナンスアクションにはそれぞれ、保留中のメンテナンスアクションを記述する際に確認できる適用日が設定されています。から保留中のメンテナンスアクションの出力を読み取ると AWS CLI、次の 3 つの日付が表示されます。
+ `CurrentApplyDate` - メンテナンスアクションが即座に、または次のメンテナンスウィンドウに適用される日付です。メンテナンスがオプションである場合は、この値を null に設定できます。
+ `ForcedApplyDate` - メンテナンスウィンドウとは関係なく、メンテナンスが自動的に適用される日付です。
+ `AutoAppliedAfterDate` - クラスターのメンテナンスウィンドウでメンテナンスが適用される日付です。

### ユーザー作成のメンテナンスアクション
<a name="w2aac35c29c19c13c23"></a>

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 メンテナンスウィンドウを変更する
<a name="w2aac35c29c19c13c25"></a>

メンテナンスウィンドウは使用率の最も低い時間帯に設定する必要があります。このため、場合によっては変更が必要になります。この間、エラスティッククラスターは、システムの変更 (スケールストレージオペレーションの変更など) が適用されていて停止が必要な場合に限り、使用できません。必要な変更を加えるのに必要な最小限の時間のみ使用不可となります。

デフォルトは、1 週間のうちのランダムな日に起こる、Amazon Web Services リージョンあたり 8 時間の範囲からランダムに選択された 30 分のウィンドウです。

メンテナンスウィンドウを変更するには、「[Elastic クラスター設定の変更](elastic-managing.md#elastic-modify)」を参照してください。

## エラスティッククラスターのオペレーティングシステムの更新
<a name="elastic-cluster-os-updates"></a>

Amazon DocumentDB エラスティッククラスターでは、オペレーティングシステムの更新が必要になる時があります。Amazon DocumentDB は、データベースパフォーマンスと顧客の全体的なセキュリティ体制改善のために、オペレーティングシステムを新しいバージョンにアップグレードします。オペレーティングシステムの更新では、Amazon DocumentDB イエラスティッククラスターのクラスターエンジンのバージョンは変更されません。

Amazon DocumentDB エラスティッククラスターのほとんどのオペレーティングシステムの更新はオプションであり、特定の適用日付は設定されていません。ただし、これらの更新をしばらく適用せずに放置していると、クラスターのメンテナンスウィンドウ時に最終的に必要になり、想定外のタイミングで自動的に適用される場合があります。これは、データベースのセキュリティ体制を維持するために行われます。予期しないダウンタイムを避けるため、Amazon DocumentDB エラスティッククラスター向けオペレーティングシステム更新が使用可能になったらすぐに適用するように努め、ビジネスニーズに応じて都合の良いときにインスタンスメンテナンスウィンドウを設定することをお勧めします。

# Amazon DocumentDB エラスティッククラスターで保管中のデータ暗号化
<a name="elastic-encryption"></a>

以下のトピックは、Amazon DocumentDB エラスティッククラスターの AWS Key Management Service 暗号化キーについて学習、作成、モニタリングするのに役立ちます。

**Topics**
+ [Amazon DocumentDB エラスティッククラスターが で許可を使用する方法 AWS KMS](#ec-encrypt-grants)
+ [カスタマーマネージドキーを作成する](#ec-encrypt-create)
+ [Amazon DocumentDB エラスティック クラスター の暗号化キーのモニタリング](#ec-encrypt-monitor)
+ [詳細情報](#ec-encrypt-learn)

Amazon DocumentDB エラスティッククラスターは、キー管理のために AWS Key Management Service (AWS KMS) と自動的に統合され、エンベロープ暗号化と呼ばれる方法を使用してデータを保護します。エンベロープ暗号化の仕組みの詳細については、*AWS Key Management Service デベロッパーガイド*の「[エンベロープ暗号化](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#enveloping)」を参照してください。

 AWS KMS key はキーの論理表現です。KMS キーには、キー ID、作成日、説明、キーステータスなどのメタデータが含まれます。KMS キーには、データの暗号化と復号に使用されるキーマテリアルも含まれています。KMS キーの詳細については、*AWS Key Management Service デベロッパーガイド*の「[AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) 」を参照してください。

Amazon DocumentDB エラスティッククラスターは、次の 2 種類のキーによる暗号化をサポートしています。
+ **AWS 所有キー —** Amazon DocumentDB エラスティッククラスターは、デフォルトでこれらのキーを使用して、個人を特定できるデータを自動的に暗号化します。 AWS所有キーを表示、管理、使用したり、その使用を監査したりすることはできません。ただし、データを暗号化するキーを保護するためのアクションの実施やプログラムの変更を行う必要はありません。詳細については、AWS Key Management Service デベロッパーガイドの「[AWS 所有キー](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk)」を参照してください。
+ **カスタマーマネージドキー —** AWS KMS keys ユーザーが作成、所有、管理する対称キー。この暗号化層はユーザーが完全に制御できるため、次のようなタスクを実行できます。
  + キーポリシーの策定と維持
  + IAM ポリシーとグラントの策定と維持
  + キーポリシーの有効化と無効化
  + キー暗号化マテリアルのローテーション
  +  タグを追加する
  + キーエイリアスの作成
  + 削除のためのキースケジューリング

  詳細については、「[AWS Key Management Service デベロッパーガイド](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)」の「カスタマーマネージドキー」を参照してください。

**重要**  
Amazon DocumentDB がサポートしているのは対称 KMS キーのみであるため、クラスターの暗号化には対称暗号化 KMS キーを使用して必要があります。Amazon DocumentDB エラスティッククラスター内のデータの暗号化に非対称 KMS キー を使用しないでください。詳細については、AWS Key Management Service デベロッパーガイドの「[AWS KMSの非対称キーの](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。  
Amazon DocumentDB がクラスターの暗号化キーにアクセスできなくなった場合、例えばキーへのアクセス権が失効した場合など、暗号化されたクラスターは終了状態になります。この場合、クラスターはバックアップからのみ復元できます。Amazon DocumentDB では、バックアップは常に 1 日間有効になります。また、暗号化された Amazon DocumentDB クラスターのキーを無効にすると、最終的にそのクラスタに対する読み取りおよび書き込みのアクセス権は失われます。Amazon DocumentDB で、アクセスできないキーで暗号化されたクラスターが発生すると、クラスターが終了状態になります。この場合、クラスターは使用できなくなり、データベースの現在の状態を復元することはできません。クラスターを復元するには、Amazon DocumentDB の暗号化キーへのアクセスを再び有効にした後、バックアップからクラスターを復元します。

**重要**  
暗号化されたクラスターの KMS キーを作成した後は、そのクラスターを変更することはできません。暗号化されたエラスティッククラスターを作成する前に、暗号化キーの要件を確認してください。

## Amazon DocumentDB エラスティッククラスターが で許可を使用する方法 AWS KMS
<a name="ec-encrypt-grants"></a>

Amazon DocumentDB エラスティック クラスター には、カスタマーマネージドキーを使用するための[グラント](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html)が必要です。

カスタマーマネージドキーで暗号化されたクラスターを作成すると、Amazon DocumentDB エラスティッククラスターは`CreateGrant`リクエストを送信してユーザーに代わって許可を作成します AWS KMS。の許可 AWS KMS は、Amazon DocumentDB エラスティッククラスターに顧客アカウントの KMS キーへのアクセスを許可するために使用されます。

Amazon DocumentDB エラスティッククラスターでは、以下の内部操作にカスタマーマネージドキーを使用するためのグラントが必要です。
+ `DescribeKey` トラッカーまたはジオフェンスコレクションの作成時に入力された対称カスタマーマネージド KMS キー ID が有効であることを確認する AWS KMS リクエストを に送信します。
+ カスタマーマネージドキーによって暗号化されたデータキーを生成する`GenerateDataKey`リクエスト AWS KMS を に送信します。
+ データを暗号化 AWS KMS するために使用できるように、暗号化されたデータキーを復号化するための`Decrypt`リクエストを に送信します。
+ グラントへのアクセスの取り消しや、カスタマーマネージドキーに対するサービスのアクセスの取り消しは、いつでもできます。これを行うと、Amazon DocumentDB エラスティッククラスターはカスタマーマネージドキーによって暗号化されたすべてのデータにアクセスできなくなり、そのデータに依存しているオペレーションが影響を受けます。

## カスタマーマネージドキーを作成する
<a name="ec-encrypt-create"></a>

対称カスタマーマネージドキーは、 AWS マネジメントコンソール または AWS KMS API を使用して作成できます。

**対称カスタマー管理キーの作成**

*AWS Key Management Service デベロッパーガイド* にある [対称カスタマーマネージドキーの作成](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) ステップに従います。

**キーポリシー**

キーポリシーは、カスタマーマネージドキーへのアクセスを制御します。すべてのカスタマーマネージドキーには、キーポリシーが 1 つだけ必要です。このポリシーには、そのキーを使用できるユーザーとその使用方法を決定するステートメントが含まれています。キーポリシーは、カスタマーマネージドキーの作成時に指定できます。詳細については、AWS Key Management Service デベロッパーガイドの「[AWS Key Management Service 概要](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html)」にあるKMS キーアクセス情報を参照してください。

Amazon DocumentDB エラスティック クラスター で顧客管理キーを使用するには、キーポリシーで次の API オペレーションを許可する必要があります。
+ [https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html) - カスタマーマネージドキーに許可を追加します。この権限は、指定された KMS キーへのアクセスを制御します。これにより、必要な許可の付与オペレーションに対し Amazon Location Service がアクセスできるようにします。許可の詳細については、AWS Key Management Service デベロッパーガイドの「[許可の使用 AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html)」 を参照してください。
+ [https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) — お客様が管理するキーの詳細を提供し、DocDB-Elastic がキーを検証できるようにします。
+ [https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) – 暗号化されたデータにアクセスするために、Docdb-Elastic が保存された暗号化データキーを使用できるようにします。
+ [https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html) – Docdb-Elastic が暗号化されたデータキーを生成して保存できるようにします。データキーはすぐに暗号化に使用されないからです。

詳細については、「 *AWS Key Management Service デベロッパーガイド*[」の「キーポリシーの AWS サービスのアクセス許可](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-services.html)」および[「キーアクセスのトラブルシューティング](https://docs.aws.amazon.com/kms/latest/developerguide/policy-evaluation.html)」を参照してください。

**IAM ポリシーによるカスタマーマネージドキーアクセスの制限**

KMS キーポリシーに加えて、IAM ポリシーで KMS キー権限を制限することもできます。

さまざまな方法で、IAM ポリシー をより厳しくすることができます。例えば、Amazon DocumentDB エラスティッククラスターを起点とするリクエストにのみカスタマーマネージドキーを使用できるようにするには、`docdb-elastic.<region-name>.amazonaws.com` 値で [`kms:ViaService` 条件キー](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-via-service)を使用します。

詳細については、*AWS Key Management Service デベロッパーガイド*の「[他のアカウントのユーザーに KMS キーの使用を許可する](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html)」を参照してください。

## Amazon DocumentDB エラスティック クラスター の暗号化キーのモニタリング
<a name="ec-encrypt-monitor"></a>

Docdb Elastic リソースで AWS KMS key カスタマーマネージドキーを使用する場合、 AWS CloudTrail または Amazon CloudWatch Logs を使用して、Docdb Elastic が送信するリクエストを追跡できます AWS KMS。

次の例は`CreateGrant`、Amazon DocumentDB エラスティッククラスターによって呼び出される AWS KMS key オペレーションをモニタリングして、カスタマーマネージドキーによって暗号化されたデータにアクセス`DescribeKey`するための `Decrypt`、、、および `GenerateDataKeyWithoutPlainText`の AWS CloudTrail イベントです。

------
#### [ CreateGrant ]

```
{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01",
        "accountId": "111122223333",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE3",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AROAIGDTESTANDEXAMPLE",
                "arn": "arn:aws:iam::111122223333:assumed-role/Admin/Sampleuser01",
                "accountId": "111122223333",
                "userName": "Sampleuser01"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-05-09T23:04:20Z",
                "mfaAuthenticated": "false"
            }
        },
        "invokedBy": "docdb-elastic.amazonaws.com"
    },
    "eventTime": "2023-05-09T23:55:48Z",
    "eventSource": "kms.amazonaws.com",
    "eventName": "CreateGrant",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "docdb-elastic.amazonaws.com",
    "userAgent": "docdb-elastic.amazonaws.com",
    "requestParameters": {
        "retiringPrincipal": "docdb-elastic.us-east-1.amazonaws.com",
        "granteePrincipal": "docdb-elastic.us-east-1.amazonaws.com",
        "operations": [
            "Decrypt",
            "Encrypt",
            "GenerateDataKey",
            "GenerateDataKeyWithoutPlaintext",
            "ReEncryptFrom",
            "ReEncryptTo",
            "CreateGrant",
            "RetireGrant",
            "DescribeKey"
        ],
        "keyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
    },
    "responseElements": {
        "grantId": "0ab0ac0d0b000f00ea00cc0a0e00fc00bce000c000f0000000c0bc0a0000aaafSAMPLE",
        "keyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
    },
    "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
    "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
    "readOnly": false,
    "resources": [
        {
            "accountId": "AWS Internal",
            "type": "AWS::KMS::Key",
            "ARN": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
        }
    ],
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "111122223333",
    "eventCategory": "Management"
}
```

------
#### [ GenerateDataKey ]

```
{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01",
        "accountId": "111122223333",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE3",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AROAIGDTESTANDEXAMPLE",
                "arn": "arn:aws:iam::111122223333:assumed-role/Admin/Sampleuser01",
                "accountId": "111122223333",
                "userName": "Sampleuser01"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-05-10T18:02:59Z",
                "mfaAuthenticated": "false"
            }
        },
        "invokedBy": "docdb-elastic.amazonaws.com"
    },
    "eventTime": "2023-05-10T18:03:25Z",
    "eventSource": "kms.amazonaws.com",
    "eventName": "GenerateDataKey",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "docdb-elastic.amazonaws.com",
    "userAgent": "docdb-elastic.amazonaws.com",
    "requestParameters": {
        "keySpec": "AES_256",
        "keyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
    },
    "responseElements": null,
    "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
    "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
    "readOnly": true,
    "resources": [
        {
            "accountId": "AWS Internal",
            "type": "AWS::KMS::Key",
            "ARN": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
        }
    ],
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "111122223333",
    "eventCategory": "Management"
}
```

------
#### [ Decrypt ]

```
{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01",
        "accountId": "111122223333",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE3",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AROAIGDTESTANDEXAMPLE",
                "arn": "arn:aws:iam::111122223333:assumed-role/Admin/Sampleuser01",
                "accountId": "111122223333",
                "userName": "Sampleuser01"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-05-10T18:05:49Z",
                "mfaAuthenticated": "false"
            }
        },
        "invokedBy": "docdb-elastic.amazonaws.com"
    },
    "eventTime": "2023-05-10T18:06:19Z",
    "eventSource": "kms.amazonaws.com",
    "eventName": "Decrypt",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "docdb-elastic.amazonaws.com",
    "userAgent": "docdb-elastic.amazonaws.com",
    "requestParameters": {
        "encryptionAlgorithm": "SYMMETRIC_DEFAULT"
    },
    "responseElements": null,
    "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
    "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
    "readOnly": true,
    "resources": [
        {
            "accountId": "AWS Internal",
            "type": "AWS::KMS::Key",
            "ARN": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
        }
    ],
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "111122223333",
    "eventCategory": "Management"
}
```

------
#### [ DescribeKey ]

```
{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "AssumedRole",
        "principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01",
        "accountId": "111122223333",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE3",
        "sessionContext": {
            "sessionIssuer": {
                "type": "Role",
                "principalId": "AROAIGDTESTANDEXAMPLE",
                "arn": "arn:aws:iam::111122223333:assumed-role/Admin/Sampleuser01",
                "accountId": "111122223333",
                "userName": "Sampleuser01"
            },
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-05-09T23:04:20Z",
                "mfaAuthenticated": "false"
            }
        },
        "invokedBy": "docdb-elastic.amazonaws.com"
    },
    "eventTime": "2023-05-09T23:55:48Z",
    "eventSource": "kms.amazonaws.com",
    "eventName": "DescribeKey",
    "awsRegion": "us-east-1",
    "sourceIPAddress": "docdb-elastic.amazonaws.com",
    "userAgent": "docdb-elastic.amazonaws.com",
    "requestParameters": {
        "keyId": "alias/SampleKmsKey"
    },
    "responseElements": null,
    "requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
    "eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
    "readOnly": true,
    "resources": [
        {
            "accountId": "AWS Internal",
            "type": "AWS::KMS::Key",
            "ARN": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
        }
    ],
    "eventType": "AwsApiCall",
    "managementEvent": true,
    "recipientAccountId": "111122223333",
    "eventCategory": "Management"
}
```

------

## 詳細情報
<a name="ec-encrypt-learn"></a>

次のリソースは、保管時のデータ暗号化についての詳細を説明しています。
+  AWS KMS 概念の詳細については、「 *AWS Key Management Service デベロッパーガイド*」の[AWS Key Management Service 「基本概念](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html)」を参照してください。
+  AWS KMS セキュリティの詳細については、 *AWS Key Management Service デベロッパーガイド*の「 [のセキュリティのベストプラクティス AWS Key Management Service](https://docs.aws.amazon.com/kms/latest/developerguide/best-practices.html)」を参照してください。

# エラスティッククラスター上のサービスにリンクされたロール
<a name="elastic-service-linked-roles"></a>

Amazon DocumentDB エラスティッククラスターは AWS Identity and Access Management 、(IAM) [サービスにリンクされたロール](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role)を使用します。サービスにリンクされているロールは、Amazon DocumentDB エラスティッククラスターに直接リンクされれている特殊なタイプの IAM ロールです。サービスにリンクされたロールは Amazon DocumentDB エラスティッククラスターによって事前定義されており、サービスがユーザーに代わって他の AWS サービスを呼び出すために必要なすべてのアクセス許可が含まれています。

サービスにリンクされているロールを使用すると、必要な権限を手動で追加する必要がないため、Amazon DocumentDB の使用が簡単になります。Amazon DocumentDB エラスティッククラスターには、サービスにリンクされているロールのアクセス許可が定義されます。特に定義されていない限り、Amazon DocumentDB のみがそのロールを引き受けることができます。定義されたアクセス許可には、信頼ポリシーとアクセス許可ポリシーが含まれ、そのアクセス許可ポリシーを他の IAM エンティティにアタッチすることはできません。ロールを削除するには、まず関連リソースを削除します。これにより、リソースにアクセスするためのアクセス許可を誤って削除することができないため、Amazon DocumentDB エラスティッククラスターが保護されます。

サービスにリンクされているロールをサポートするその他のサービスについては、「[IAM と連携するAWS のサービス](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)」を参照し、**[サービスにリンクされたロール]** 列が **[はい]** になっているサービスを探してください。サービスリンクロールに関するドキュメントをサービスで表示するには、リンクで [はい] を選択します。

## エラスティッククラスターに対するサービスにリンクされたロールのアクセス許可
<a name="permissions"></a>

Amazon DocumentDB エラスティッククラスターは、 という名前のサービスにリンクされたロールを使用して`AWS ServiceRoleForDocDB-Elastic`、Amazon DocumentDB エラスティッククラスターがクラスターに代わって AWS サービスを呼び出すことを許可します。

このサービスにリンクされたロールには、アカウントで操作するためのアクセス許可を付与する `AmazonDocDB-ElasticServiceRolePolicy` というアクセス許可ポリシーがアタッチされています。ロールのアクセス許可ポリシーは、Amazon DocumentDB エラスティッククラスターが指定リソースに対して以下のアクションを実行することを 許可します。

------
#### [ JSON ]

****  

```
{
    "Version":"2012-10-17",		 	 	 
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "cloudwatch:PutMetricData"
            ],
            "Resource": "*",
            "Condition": {
                "StringEquals": {
                    "cloudwatch:namespace": [
                        "AWS/DocDB-Elastic"
                    ]
                }
            }
        }
    ]
}
```

------

**注記**  
サービスリンクロールの作成、編集、削除を IAM エンティティ (ユーザー、グループ、ロールなど) に許可するにはアクセス許可を設定する必要があります。次のエラーメッセージ、**「リソースを作成できません。サービスにリンクされたロールを作成するために必要なアクセス許可があることを確認します。それ以外の場合は、時間をおいてからもう一度お試しください。」**が表示された場合は、以下のアクセス許可が有効であることを確認します。

```
{
"Action": "iam:CreateServiceLinkedRole",
    "Effect": "Allow",
    "Resource": "arn:aws:iam::*:role/aws-service-role/docdb-elastic.amazonaws.com/AWSServiceRoleForDocDB-Elastic",
    "Condition": {
"StringLike": {
"iam:AWSServiceName":"docdb-elastic.amazonaws.com"
        }
    }
}
```

詳細については、「*AWS ID とアクセス管理ユーザーガイド*」の「[サービスにリンクされたロールのアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#service-linked-role-permissions)」を参照してください。

### Amazon DocumentDB エラスティッククラスター用のサービスにリンクされたロールの作成
<a name="w2aac35c33c11c19"></a>

サービスリンクロールを手動で作成する必要はありません。DB インスタンスが作成されると、Amazon DocumentDB の Elastic クラスターはサービスにリンクされたロールを自動的に作成します。

### Amazon DocumentDB エラスティッククラスター用のサービスにリンクされたロールの編集
<a name="w2aac35c33c11c21"></a>

Amazon DocumentDB のエラスティッククラスターでは、`AWS ServiceRoleForDocDB-Elastic` サービスにリンクされたロールを編集することはできません。サービスリンクロールの作成後は、さまざまなエンティティがロールを参照する可能性があるため、ロール名を変更することはできません。ただし、IAM を使用してロールの説明を編集することはできます。詳細については、「*AWS ID とアクセス管理ユーザーガイド*」の「[サービスにリンクされたロールの編集](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#edit-service-linked-role)」を参照してください。

#### Amazon DocumentDB エラスティッククラスター用のサービスにリンクされたロールの削除
<a name="w2aac35c33c11c21b5b1"></a>

サービスリンクロールを必要とする機能やサービスが不要になった場合は、ロールを削除することをお勧めします。そうすることで、使用していないエンティティがアクティブにモニタリングされたり、メンテナンスされたりすることがなくなります。ただし、サービスにリンクされたロールを削除する前に、すべての クラスターを削除する必要があります。

##### サービスにリンクされたロールのクリーンアップ
<a name="w2aac35c33c11c21b5b1b5"></a>

IAM を使用してサービスにリンクされたロールを削除するには、まずそのロールにアクティブなセッションがないことを確認し、そのロールで使用されているリソースをすべて削除する必要があります。

サービスにリンクされたロールにアクティブなセッションがあるかどうかを、IAM コンソールで確認するには:

1. [AWS マネジメントコンソール](https://console.aws.amazon.com/iam/) にサインインし、IAM コンソール を開きます。

1. IAM コンソールのナビゲーションペインで **[ロール]** を選択します。次に、`AWS ServiceRoleForDocDB-Elastic` ロールの名前 (チェックボックスではありません) を選択します。

1. 選択したロールの [**概要**] ページで、[**アクセスアドバイザー**] タブを選択します。

**注記**  
Amazon DocumentDB が `AWS ServiceRoleForDocDB-Elastic` ロールを使用しているかどうか不明な場合は、ロールの削除を試みることができます。サービスがロールを使用している場合、削除は失敗し、ロールが使用されている AWS リージョン を表示できます。ロールが使用されている場合は、ロールを削除する前にセッションが終了するのを待つ必要があります。サービスにリンクされたロールのセッションを取り消すことはできません。  
`AWS ServiceRoleForDocDB-Elastic` ロールを削除する場合は、最初にすべてのクラスターを削除する必要があります。

##### すべてのクラスターの削除
<a name="w2aac35c33c11c21b5b1b7"></a>

Amazon DocumentDB コンソールからクラスターを削除する

1. [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb) にサインインし、Amazon DocumentDB コンソール を開きます。

1. ナビゲーションペインで **[Clusters]** (クラスター) を選択してください。

1. 削除するクラスターを選択します。

1. **[アクション]** で、**[削除]** を選択します。

1. **[最終スナップショットを作成しますか?]** が表示されたら、**[はい]** または **[いいえ]** を選択します。

1. 前のステップで [**はい**] を選択した場合は、[**最終スナップショット名**] に最終スナップショットの名前を入力します。

1. **[削除]** を選択します。

**注記**  
`AWS ServiceRoleForDocDB-Elastic` サービスにリンクされたロールは、IAM コンソール、IAM CLI、または IAM API を使用して削除することができます。詳細については、「*AWS ID とアクセス管理ユーザーガイド*」の「[サービスにリンクされたロールの削除](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role)」を参照してください。