翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Amazon DocumentDB クラスターのライフサイクル
Amazon DocumentDB クラスターのライフサイクルには、クラスターの作成、記述、変更、削除が含まれます。このセクションでは、これらのプロセスを完了する方法について説明します。
**Topics**
+ [クラスターの作成](db-cluster-create.md)
+ [クラスターの説明](db-cluster-view-details.md)
+ [クラスターの変更](db-cluster-modify.md)
+ [実施待ちのメンテナンスの確認](db-cluster-determine-pending-maintenance.md)
+ [クラスターのエンジンバージョンのパッチ更新](db-cluster-version-upgrade.md)
+ [クラスターの停止と開始](db-cluster-stop-start.md)
+ [クラスターの削除](db-cluster-delete.md)
# Amazon DocumentDB クラスターの作成
Amazon DocumentDB クラスターは、インスタンスと、クラスターのデータを表すクラスターボリュームで構成されます。クラスターボリュームは、3 つのアベイラビリティーゾーン間で 1 つの仮想ボリュームとして 6 つの方法でレプリケートされます。クラスターには、プライマリインスタンスと、オプションで最大 15 個のレプリカインスタンスが含まれます。
以下のセクションでは、 AWS マネジメントコンソール または を使用して Amazon DocumentDB クラスターを作成する方法を示します AWS CLI。次に、そのクラスターのレプリカインスタンスを追加できます。コンソールを使用して Amazon DocumentDB クラスターを作成すると、プライマリインスタンスが自動的に作成されます。を使用して Amazon DocumentDB クラスター AWS CLI を作成する場合、クラスターのステータスが*使用可能*になったら、そのクラスターのプライマリインスタンスを作成する必要があります。
## 前提条件
Amazon DocumentDB クラスターを作成するための前提条件を以下に示します。
がない場合は 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)の実行にはルートユーザーのみを使用するようにしてください。
### VPC 前提条件
Amazon DocumentDB クラスターは Amazon Virtual Private Cloud (Amazon VPC) でのみ作成できます。Amazon VPC には、Amazon DocumentDB クラスターで使用するために、少なくとも 2 つのアベイラビリティーゾーンのそれぞれに、1 つ以上のサブネットが必要です。アベイラビリティーゾーンにまたがってクラスターインスタンスを配信することで、ごく稀にアベイラビリティーゾーンに障害が発生した場合でも、クラスター内で使用できるインスタンスを確保できます。
### サブネットの前提条件
Amazon DocumentDB クラスターを作成するときは、その VPC 内の VPC と対応するサブネットグループを選択して、クラスターを起動する必要があります。サブネットにより、アベイラビリティーゾーン と、そのアベイラビリティーゾーン内でインスタンスの起動に使用する IP 範囲が決まります。ここでは、*サブネット*と*アベイラビリティーゾーン*という用語を同じ意味で使用します。サブネットグループは、サブネット (またはアベイラビリティーゾーン) の名前付きセットです。サブネットグループでは、Amazon DocumentDB インスタンスの起動に使用するアベイラビリティーゾーンを指定できます。たとえば、3 つのインスタンスを含むクラスターでは、各インスタンスを別々のアベイラビリティーゾーンにプロビジョニングして高可用性を実現することをお勧めします。これにより、1 つのアベイラビリティーゾーンがダウンした場合、1 つのインスタンスにのみ影響します。
Amazon DocumentDB インスタンスは現在、最大 3 つのアベイラビリティーゾーンにプロビジョニングできます。サブネットグループに 3 つ以上のサブネットがある場合でも、それらのサブネットのうちの 3 つのみを使用して Amazon DocumentDB クラスターを作成できます。したがって、サブネットグループを作成するときは、インスタンスのデプロイ先として 3 つのサブネットのみを選択することをお勧めします。米国東部 (バージニア北部) では、サブネットグループに 6 つのサブネット (アベイラビリティーゾーン) を含めることができます。ただし、Amazon DocumentDB クラスターがプロビジョニングされると、Amazon DocumentDB によってインスタンスのプロビジョニングに使用される 3 つのアベイラビリティーゾーンが選択されます。
例えば、クラスターを作成する際、Amazon DocumentDB でアベイラビリティーゾーン (1A、1B、および 1C) を選択するとします。この場合、アベイラビリティーゾーン \$11D\$1 にインスタンスを作成しようとすると、その API コールは失敗します。ただし、特定のアベイラビリティーゾーンを指定せずにインスタンスを作成した場合、Amazon DocumentDB がお客様に代わってアベイラビリティーゾーンを選択します。Amazon DocumentDB では、複数のアベイラビリティーゾーン間でロードバランスのインスタンスの負荷を分散するアルゴリズムを使用して、高可用性が実現されます。たとえば、3 つのインスタンスがプロビジョニングされる場合、デフォルトでは 3 つのアベイラビリティーゾーンに別々にプロビジョニングされ、1 つのアベイラビリティーゾーンにまとめてプロビジョニングされません。
**推奨事項:**
+ 特に理由がない限り、常に 3 つのサブネットを含むサブネットグループを作成します。その結果、3 つのアベイラビリティーゾーン間でインスタンスがプロビジョニングされるため、3 つ以上のインスタンスを含むクラスターで高可用性を実現できます。
+ 高可用性を実現するには、常に複数のアベイラビリティーゾーンにインスタンスを分散させます。クラスターのすべてのインスタンスを 1 つのアベイラビリティーゾーンにまとめて配置しないでください。
+ フェイルオーバーイベントはいつでも発生する可能性があるため、プライマリインスタンスまたはレプリカインスタンスが常に特定のアベイラビリティーゾーンに存在すると想定しないでください。
### 追加の前提条件
Amazon DocumentDB クラスターを作成するための追加の前提条件をいくつか次に示します。
+ AWS Identity and Access Management (IAM) 認証情報 AWS を使用して に接続する場合、IAM アカウントには、Amazon DocumentDB オペレーションの実行に必要なアクセス許可を付与する IAM ポリシーが必要です。
IAM アカウントを使用して Amazon DocumentDB コンソールにアクセスする場合は、まず IAM アカウント AWS マネジメントコンソール で にサインインする必要があります。Amazon DocumentDB コンソールを次の場所で開きます。[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb)
+ クラスターの設定パラメータを調整する場合は、必須のパラメータ設定を定義したクラスターパラメータグループとパラメータグループを指定する必要があります。クラスターパラメータグループまたはパラメータグループの作成または変更については、「[Amazon DocumentDB クラスターパラメータグループの管理](cluster_parameter_groups.md)」を参照してください。
+ クラスター用に指定する TCP/IP ポート番号を決定する必要があります。会社のファイアウォールによっては、Amazon DocumentDB のデフォルトポートへの接続がブロックされます。会社のファイアウォールがデフォルトのポートをブロックする場合は、お客様のクラスター用に別のポートを選択します。クラスターのすべてのインスタンスは同じポートを使用します。
## を使用したクラスターとプライマリインスタンスの作成 AWS マネジメントコンソール
以下の手順では、コンソールを使用して 1 つまたは複数のインスタンスで Amazon DocumentDB クラスターを起動する方法について説明します。
### クラスターの作成: デフォルト設定を使用した作成
**を使用してデフォルト設定を使用してインスタンスを持つクラスターを作成するには AWS マネジメントコンソール**
1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。
1. 米国東部 (バージニア北部) リージョン AWS リージョン 以外の でクラスターを作成する場合は、コンソールの右上セクションにあるリストからリージョンを選択します。
1. ナビゲーションペインで、[**クラスター**] を選択し、[**作成**] を選択します。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-menu-icon.png)) を選択します。
1. [**Amazon DocumentDB クラスターの作成**] ページで、[**設定**] ペインに入力します。
1. **クラスター識別子** − Amazon DocumentDB 指定の名前を使用するか、クラスターの名前 (**sample-cluster** など) を使用します。
クラスターの名前付けの制約:
+ 長さは [1 〜 63] 個の英字、数字、またはハイフンです。
+ 1 字目は英字である必要があります。
+ ハイフンで終わる、または 2 つのハイフンを連続して含めることはできません。
+ Amazon RDS、Neptune、Amazon DocumentDB のすべてのクラスターで AWS アカウント、リージョンごとに一意である必要があります。
1. **エンジンバージョン** — デフォルトのエンジンバージョン 5.0.0 を受け入れるか、オプションで 8.0.0、4.0.0、または 3.6.0 を選択します。
1. [**インスタンスクラス**] - デフォルトの `db.r5.large` を使用するか、リストから必要なインスタンスクラスを選択します。
1. [**インスタンス数**] - リストで、このクラスターに作成するインスタンスの数を選択します。最初のインスタンスはプライマリインスタンスになり、他のインスタンスはすべて読み取り専用レプリカインスタンスになります。後でインスタンスを追加したり削除したりできます。デフォルトでは、Amazon DocumentDB クラスターは、3 つのインスタンス (1 つのプライマリと 2 つのレプリカ) 構成で起動します。
1. **[クラスターストレージ設定]** セクションの設定を完了します。
**[Amazon DocumentDB 標準]** (デフォルト) または **[Amazon DocumentDB I/O 最適化]** を選択します。詳細については、「[Amazon DocumentDB クラスターストレージ設定](db-cluster-storage-configs.md)」を参照してください。
1. [**認証**] ペインに入力します。
1. **[ユーザー名]** - プライマリユーザーの名前を入力します。クラスターにログインする際には、このプライマリユーザー名を使用する必要があります。
プライマリユーザーの命名に関する制約事項:
+ 長さは 1～63 バイトの英数字です。
+ 1 字目は英字である必要があります。
+ データベースエンジンの予約語は使用できません。
1. 以下のパスワードオプションのいずれかを選択します。
+ **Managed in AWS Secrets Manager** — プライマリユーザーのパスワードを自動的に管理する場合は AWS Secrets Manager 、このオプションを選択します。
このオプションを選択した場合は、独自のものを作成するか、Secrets Manager が作成するキーを使用して KMS キーを設定します。
+ **[セルフマネージド]** — プライマリユーザーのパスワードを自己管理する場合は、このオプションを選択します。このオプションを選択した場合は、プライマリユーザーのパスワードを入力して確認します。クラスターにログインする際には、このプライマリユーザーパスワードを使用する必要があります。
パスワードの制約:
+ 長さは、[8～100] 個の印刷可能な ASCII 文字です。
+ 以下のものを除くすべての印刷可能な ASCII 文字を使用できます。
+ **/** (スラッシュ)
+ **"** (二重引用符)
+ **@** (アットマーク)
1. 画面の下部で、以下のいずれかを選択します。
+ ここでクラスターを作成するには、[**クラスターの作成**] を選択します。
+ クラスターを作成しない場合は、[**Cancel (取り消し)**] を選択します。
+ 作成前にクラスターをさらに設定するには、[**Show additional configurations (追加設定の表示)**] を選択し、「[クラスターを作成する: その他の設定](#db-cluster-create-con-additional-configs)」に進みます。
[**追加設定**] セクションの設定内容は次のとおりです。
+ [**ネットワーク設定**] - デフォルトでは、`default` VPC セキュリティグループを使用します。
+ [**クラスターオプション**] - デフォルトでは、ポート 27017 およびデフォルトのパラメータグループを使用します。
+ [**暗号化**] - デフォルトでは、`(default) aws/rds` キーを使用した暗号化が有効になります。
**重要**
クラスターはいったん暗号化されると、復号できません。
+ **バックアップ** - デフォルトでは、バックアップが 1 日間保持され、Amazon DocumentDB によってバックアップウィンドウが選択されます。
+ **ログのエクスポート** - デフォルトでは、監査ログは CloudWatch Logs にエクスポートされません。
+ **メンテナンス** - デフォルトでは、Amazon DocumentDB によってメンテナンスウィンドウが選択されます。
+ [**削除保護**] - クラスターが誤って削除されることから保護します。コンソールを使用して作成されたクラスターのデフォルトでは、*有効* になっています。
デフォルト設定を使用しても、これらの設定のほとんどは、後でクラスターを修正して変更できます。
1. クラスターのセキュリティグループに対してインバウンド接続を有効にします。
クラスターのデフォルト設定を変更しなかった場合は、特定のリージョン内のデフォルト VPC のデフォルトセキュリティグループを使用してクラスターが作成されました。Amazon DocumentDB に接続するには、クラスターのセキュリティグループのポート 27017 (または選択したポート) でインバウンド接続を有効にする必要があります。
**クラスターのセキュリティグループにインバウンド接続を追加するには**
1. にサインイン AWS マネジメントコンソール し、[https://console.aws.amazon.com/ec2/](https://console.aws.amazon.com/ec2/) で Amazon EC2 コンソールを開きます。
1. メインウィンドウの [**Resources (リソース)**] セクションで、[**Security groups (セキュリティグループ)**] を選択します。
![\[イメージ: セキュリティグループのリンクオプションを強調表示したリソースリスト。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-ec2-security-groups.png)
1. セキュリティグループのリストから、クラスターの作成時に使用したセキュリティグループを探し (おそらく*デフォルト*のセキュリティグループです)、セキュリティグループの名前の左側にあるボックスを選択します。
![\[イメージ: ボックスが選択されているセキュリティグループを強調表示したセキュリティグループリスト。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-ec2-default-sg.png)
1. [**Actions (アクション)**] メニューから、[**Edit inbound rules (インバウンドルールを編集する)**] を選択し、次にルールの制約を選択するか入力します。
1. **タイプ** - リストから、プロトコルを選択してネットワークトラフィックを開きます。
1. [**プロトコル**] - リストから、プロトコルのタイプを選択します。
1. [**ポート範囲**] - カスタムルールでは、ポート番号またはポート範囲を選択します。ポート番号またはポート範囲には、クラスターを作成したときに指定したポートが含まれていることを確認してください (デフォルト: 27017)。
1. **ソース** - インスタンスに到達できるトラフィックを指定します。リストからトラフィックの送信元を選択します。[**Custom (カスタム)**] を選択する場合は、単一の IP アドレスまたは IP アドレス範囲を CIDR 表記で指定します (例: 203.0.113.5/32)。
1. [**Description**] - ルールの説明を入力します。
1. ルールの作成を終了したら、[**Save (保存)**] を選択します。
### クラスターを作成する: その他の設定
クラスターのデフォルト設定を使用する場合は、以下のステップをスキップして [**クラスターの作成**] を選択します。
1. [**Network settings (ネットワーク設定)**] ウィンドウに入力します。
![\[ネットワーク設定ペインと、ネットワークを定義するステップを示すスクリーンショット\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-db-cluster-console-network-settings.png)
1. [**Virtual Private Cloud (VPC)**] - リストで、このクラスターを起動する Amazon VPC を選択します。
1. [**サブネットグループ**] - リストで、このクラスターに使用するサブネットグループを選択します。
1. [**VPC セキュリティグループ**] - リストで、このクラスターの VPC セキュリティグループを選択します。
1. [**Cluster options (クラスターオプション)**] ペインに入力します。
![\[クラスター設定を行うステップを含むクラスターオプションペインを示すスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-db-cluster-console-cluster-options.png)
1. [**データベースポート**] - 上下の矢印を使用して、アプリケーションによってインスタンスへの接続に使用される TCP/IP ポートを設定します。
1. [**クラスターパラメータグループ**] - パラメータグループのリストで、このクラスターのクラスターパラメータグループを選択します。
1. [**Encryption (暗号化)**] ペインに入力します。
![\[クラスターの暗号化を設定するステップを示す暗号化ペインのスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/encrypt-at-rest.png)
1. [**保管時に暗号化**] - 以下のいずれかを選択します。
+ **暗号の有効化** - デフォルト すべてのデータは保管時に暗号化されます。データの暗号化を選択した場合、この操作を元に戻すことはできません。
+ [**暗号化の無効化**] - データは暗号化されません。
1. **AWS KMS キー** — これは、データを暗号化している場合にのみ使用できます。リストで、このクラスターのデータの暗号化に使用するキーを選択します。デフォルトは `(default) aws/rds` です。
[**キーの ARN を入力**] を選択した場合は、キーの Amazon リソースネーム (ARN) を入力する必要があります。
1. [**バックアップ**] ペインに入力します。
![\[バックアップウィンドウを設定するステップを示すバックアップペインのスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-db-cluster-console-backup.png)
1. [**バックアップ保持期間**] - リストで、このクラスターの自動バックアップを削除するまで保持する日数を選択します。
1. **[バックアップウィンドウ]** - Amazon DocumentDB によってこのクラスターのバックアップが作成される毎日の時刻と期間を設定します。
1. [**開始時刻**] - 最初のリストで、自動バックアップを開始する時間 (UTC 時) を選択します。2 番目のリストで、自動バックアップを開始する時間 (UTC 分) を選択します。
1. [**期間**] - リストで、自動バックアップの作成に割り当てる時間を選択します。
1. **ログのエクスポート** ペインで、CloudWatch Logs にエクスポートするログのタイプを選択して完了します。
![\[クラスターの DML ログ記録を設定するステップを示す [ログのエクスポート] ペインのスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-db-cluster-console-log-exports.png)
+ **[Audit logs (監査ログ)]** - Amazon CloudWatch Logs にエクスポートするには、このオプションを選択します。[**Audit logs (監査ログ)**] を選択した場合は、クラスターのカスタムパラメータグループで `audit_logs` を有効にする必要があります。詳細については、「[Amazon DocumentDB イベントの監査](event-auditing.md)」を参照してください。
+ [**Profiler logs (プロファイラーログ)**] - オペレーションのプロファイラーログの Amazon CloudWatch Logs へのエクスポートを有効にするには、このオプションを選択します。[**Profiler logs (プロファイラーログ)**] を選択した場合は、クラスターのカスタムパラメータグループの次のパラメータも変更する必要があります。
+ `profiler` — `enabled` に設定します。
+ `profiler_threshold_ms` の値に設定して、プロファイリングオペレーションのしきい値を `[0-INT_MAX]` に設定します。
+ `profiler_sampling_rate` プロファイルする低速オペレーションの割合を設定するには、`[0.0-1.0]` の値に設定します。
詳細については、「[Amazon DocumentDB オペレーションのプロファイリング](profiling.md)」を参照してください。
1. [**メンテナンス**] ペインに入力します。
![\[クラスターのメンテナンスウィンドウを設定するステップを示すメンテナンスペインのスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-db-cluster-console-maintenance.png)
1. 以下のいずれかを選択します。
+ [**Select window (ウィンドウの選択)**] - Amazon DocumentDB によってクラスターでメンテナンスが実行される曜日、UTC 開始時刻、期間を指定できます。
1. [**Start day (開始日)**] - リストから、クラスターのメンテナンスを開始する曜日を選択します。
1. [**Start time (開始時刻)**] リストで、メンテナンスを開始する時間と分 (UTC) を選択します。
1. [**Duration (期間)**] - リストで、クラスターメンテナンスに割り当てる時間を選択します。指定した期間内にメンテナンスが完了できない場合、メンテナンスプロセスは指定した期間を過ぎて終了するまで続行されます。
+ [**No preference (指定なし)**] - Amazon DocumentDB によってメンテナンスが実行される曜日、開始時刻、期間が選択されます。
1. このクラスターに 1 つ以上のタグを追加する場合、[**Tags (タグ)**] ペインを完了します。
![\[選択された削除に対する保護チェックボックスを有効にするスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-db-cluster-console-tags.png)
クラスターに追加するタグごとに、以下のステップを繰り返します。クラスターでは最大 10 まで保持できます。
1. [**Add tags (タグの追加)**] を選択します。
1. タグの [**キー**] を入力します。
1. 必要に応じてタグの [**値**] を入力します。
タグを削除するには、[**タグの削除**] を選択します。
1. コンソールを使用してクラスターを作成する場合、[**Deletion Protection (削除に対する保護)**] がデフォルトで有効になっています。削除に対する保護を無効化するには、[**Enable deletion protection (削除に対する保護の有効化)**] のチェックを外します。有効にすると、削除に対する保護はクラスターが削除されることを防ぎます。削除に対して保護されているクラスターを削除するには、まずクラスターに変更を加えて削除に対する保護を無効化する必要があります。
![\[選択された削除に対する保護チェックボックスを有効にするスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-db-cluster-console-deletion-protection.png)
削除に対する保護についての詳細は、「[Amazon DocumentDB クラスターの削除](db-cluster-delete.md)」を参照してください。
1. クラスターを作成するには、[**Create cluster (クラスターの作成)**] を選択します。または、**[キャンセル]** を選択します。
## を使用したクラスターの作成 AWS CLI
次の手順では、 を使用して Amazon DocumentDB クラスターを起動し AWS CLI 、Amazon DocumentDB レプリカを作成する方法について説明します。
**パラメータ**
+ **--db-cluster-identifier** — 必須 このクラスターを識別する小文字の文字列。
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/db-cluster-create.html)
+ **--engine** — 必須 **docdb** を指定してください。
+ **--deletion-protection \$1 --no-deletion-protection** - オプション 削除に対する保護が有効にされている場合、これによってクラスターが削除されることを防ぎます。を使用する場合 AWS CLI、デフォルト設定では削除保護が無効になっています。
削除に対する保護についての詳細は、「[Amazon DocumentDB クラスターの削除](db-cluster-delete.md)」を参照してください。
+ **--storage-type standard \$1 iopt1** - オプションです。デフォルト: **standard**。クラスターのストレージ設定 有効な値は、`standard` (標準) または `iopt1` (I/O 最適化) です。
+ **--master-username** — 必須 ユーザーの認証に使用されるユーザー名。
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/db-cluster-create.html)
+ **--master-user-password** - オプションです。ユーザーの認証に使用されるユーザーのパスワード。
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/db-cluster-create.html)
+ **--manage-master-user-password** - オプション。Amazon DocumentDB はマスターユーザーパスワードを生成し、そのライフサイクル全体を通じて Secrets Manager で管理します。
その他のパラメータについては、「[CreateDBCluster](API_CreateDBCluster.md)」を参照してください。
**を使用して Amazon DocumentDB クラスターを起動するには AWS CLI**
Amazon DocumentDB クラスターを作成するには、 を呼び出します`create-db-cluster` AWS CLI。次の AWS CLI コマンドは、削除保護を有効に`sample-cluster`して、 という名前の Amazon DocumentDB クラスターを作成します。削除に対する保護についての詳細は、「[Amazon DocumentDB クラスターの削除](db-cluster-delete.md)」を参照してください。
また、`--engine-version` は、デフォルトで最新のメジャーエンジンバージョンとなるオプションのパラメータです。現在のデフォルトのエンジンバージョンは 5.0.0 です (注: Amazon DocumentDB 8.0 は使用できますが、明示的に指定する必要があります）。新しいメジャーエンジンバージョンがリリースされると、`--engine-version` のデフォルトのエンジンバージョンが最新のメジャーエンジンバージョンに更新されます。そのため、本稼働ワークロード、特にスクリプト、オートメーション、または CloudFormation テンプレートに依存するワークロードの場合は、目的のメジャーバージョン`--engine-version`に を明示的に指定することをお勧めします。
**注記**
もし `db-subnet-group-name` または `vpc-security-group-id` が指定されていない場合、Amazon DocumentDB は、指定されたリージョンに対してデフォルトのサブネットグループと Amazon VPC セキュリティグループを使用します。
Linux、macOS、Unix の場合:
```
aws docdb create-db-cluster \
--db-cluster-identifier sample-cluster \
--engine docdb \
--engine-version 5.0.0 \
--deletion-protection \
--master-username masteruser \
--master-user-password password
```
Windows の場合:
```
aws docdb create-db-cluster ^
--db-cluster-identifier sample-cluster ^
--engine docdb ^
--engine-version 5.0.0 ^
--deletion-protection ^
--master-username masteruser ^
--master-user-password password
```
このオペレーションによる出力は、次のようになります (JSON 形式)。
```
{
"DBCluster": {
"StorageEncrypted": false,
"DBClusterMembers": [],
"Engine": "docdb",
"DeletionProtection" : "enabled",
"ClusterCreateTime": "2018-11-26T17:15:19.885Z",
"DBSubnetGroup": "default",
"EngineVersion": "5.0.0",
"MasterUsername": "masteruser",
"BackupRetentionPeriod": 1,
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
"DBClusterIdentifier": "sample-cluster",
"MultiAZ": false,
"DBClusterParameterGroup": "default.docdb5.0",
"PreferredBackupWindow": "09:12-09:42",
"DbClusterResourceId": "cluster-KQSGI4MHU4NTDDRVNLNTU7XVAY",
"PreferredMaintenanceWindow": "tue:04:17-tue:04:47",
"Port": 27017,
"Status": "creating",
"ReaderEndpoint": "sample-cluster.cluster-ro-sfcrlcjcoroz.us-east-1.docdb.amazonaws.com",
"AssociatedRoles": [],
"HostedZoneId": "ZNKXTT8WH85VW",
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"AvailabilityZones": [
"us-east-1a",
"us-east-1c",
"us-east-1e"
],
"Endpoint": "sample-cluster.cluster-sfcrlcjcoroz.us-east-1.docdb.amazonaws.com"
}
}
```
クラスターが作成されるまでに数分かかります。 AWS マネジメントコンソール または を使用して AWS CLI 、クラスターのステータスをモニタリングできます。詳細については、「[Amazon DocumentDB クラスターのステータスのモニタリング](monitoring_docdb-cluster_status.md)」を参照してください。
**重要**
を使用して Amazon DocumentDB クラスター AWS CLI を作成する場合、インスタンスは作成されません。したがって、プライマリインスタンスと必要なレプリカインスタンスを明示的に作成してください。コンソールまたは を使用してインスタンス AWS CLI を作成できます。詳細については、「[クラスターへの Amazon DocumentDB インスタンスの追加](db-instance-add.md)」を参照してください。
詳細については、[*Amazon DocumentDB API リファレンス* の [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBCluster.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBCluster.html)] を参照してください。
# Amazon DocumentDB クラスター の説明
Amazon DocumentDB マネジメントコンソールまたは AWS CLI を使用して、Amazon DocumentDB クラスターに関連する接続エンドポイント、セキュリティグループ、VPCs、パラメータグループなどの詳細を表示できます。
詳細については次を参照してください:
+ [Amazon DocumentDB クラスターのステータスのモニタリング](monitoring_docdb-cluster_status.md)
+ [クラスターのエンドポイントの検索](db-cluster-endpoints-find.md)
------
#### [ Using the AWS マネジメントコンソール ]
次の手順を使用して、コンソールを使用して指定された Amazon DocumentDB クラスターの詳細を表示します。
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. クラスターの一覧で、詳細を表示するクラスターの名前を選択します。クラスターに関する情報は、次のグループで分けられます。
+ [**概要**] - エンジンバージョン、クラスターのステータス、保留中のメンテナンス、パラメータグループのステータスなど、クラスターに関する一般情報。
+ [**接続とセキュリティ**] - [**接続**] セクションには、mongo シェルやアプリケーションを使用してこのクラスターに接続するための接続エンドポイントが一覧表示されます。[**セキュリティグループ**] セクションには、このクラスターに関連付けられているセキュリティグループと、その VPC ID や説明が一覧表示されます。
+ [**設定**] - [**クラスターの詳細**] セクションには、クラスターの Amazon リソースネーム (ARN)、エンドポイント、パラメータグループなど、クラスターに関する詳細が一覧表示されます。また、クラスターのバックアップ情報、メンテナンスの詳細、セキュリティとネットワークの設定も一覧表示されます。[**クラスターのインスタンス**] セクションには、このクラスターに属するすべてのインスタンスが一覧表示されます。各インスタンスのロールとクラスターパラメータグループのステータスも一緒に表示されます。
+ [**モニタリング**] — このクラスターの Amazon CloudWatch Logs メトリクス。詳細については、「[Amazon DocumentDB と CloudWatch のモニタリング](cloud_watch.md)」を参照してください。
+ [**イベントとタグ**] — [**最近のイベント**] セクションには、このクラスターの最近のイベントの一覧が表示されます。Amazon DocumentDB は、クラスター、インスタンス、スナップショット、セキュリティグループ、およびクラスターパラメータグループに関連するイベントのレコードを保持します。この情報には、各イベントに関連する日付、時刻、およびメッセージが含まれます。[**タグ**] セクションには、このクラスターにアタッチされているタグが一覧表示されます。
------
#### [ Using the AWS CLI ]
を使用して Amazon DocumentDB クラスターの詳細を表示するには AWS CLI、以下の例に示すように `describe-db-clusters` コマンドを使用します。詳細については、「*Amazon DocumentDB リソース管理 API リファレンス*」の「[https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusters.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusters.html)」を参照してください。
**注記**
クラスターやインスタンスのライフサイクル管理などの特定の管理機能において、Amazon DocumentDB は Amazon RDS と共有される運用テクノロジーを使用します。`filterName=engine,Values=docdb` フィルターパラメータは Amazon DocumentDB クラスターのみを返します。
**Example**
**例 1: すべての Amazon DocumentDB クラスターを一覧表示する**
次の AWS CLI コードは、リージョン内のすべての Amazon DocumentDB クラスターの詳細を一覧表示します。
```
aws docdb describe-db-clusters --filter Name=engine,Values=docdb
```
このオペレーションによる出力は、次のようになります。
```
{
"DBClusters": [
{
"AvailabilityZones": [
"us-east-1c",
"us-east-1b",
"us-east-1a"
],
"BackupRetentionPeriod": 1,
"DBClusterIdentifier": "sample-cluster-1",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
...
},
{
"AvailabilityZones": [
"us-east-1c",
"us-east-1b",
"us-east-1a"
],
"BackupRetentionPeriod": 1,
"DBClusterIdentifier": "sample-cluster-2",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
...
},
{
"AvailabilityZones": [
"us-east-1c",
"us-east-1b",
"us-east-1a"
],
"BackupRetentionPeriod": 1,
"DBClusterIdentifier": "sample-cluster-3",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
...
}
]
}
```
**Example**
**例 2: 指定した Amazon DocumentDB クラスターのすべての詳細を一覧表示する**
次の AWS CLI コードは、クラスター の詳細を一覧表示します`sample-cluster`。
Linux、macOS、Unix の場合:
```
aws docdb describe-db-clusters \
--filter Name=engine,Values=docdb \
--db-cluster-identifier sample-cluster
```
Windows の場合:
```
aws docdb describe-db-clusters ^
--filter Name=engine,Values=docdb ^
--db-cluster-identifier sample-cluster
```
このオペレーションによる出力は、次のようになります。
```
{
"DBClusters": [
{
"AllocatedStorage": 1,
"AvailabilityZones": [
"us-east-1c",
"us-east-1a",
"us-east-1d"
],
"BackupRetentionPeriod": 2,
"DBClusterIdentifier": "sample-cluster",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
"EarliestRestorableTime": "2023-11-07T22:34:08.148000+00:00",
"Endpoint": "sample-cluster.node.us-east-1.amazon.com",
"ReaderEndpoint": "sample-cluster.node.us-east-1.amazon.com",
"MultiAZ": false,
"Engine": "docdb",
"EngineVersion": "5.0.0",
"LatestRestorableTime": "2023-11-10T07:21:16.772000+00:00",
"Port": 27017,
"MasterUsername": "chimeraAdmin",
"PreferredBackupWindow": "22:22-22:52",
"PreferredMaintenanceWindow": "sun:03:01-sun:03:31",
"ReadReplicaIdentifiers": [],
"DBClusterMembers": [
{
"DBInstanceIdentifier": "sample-instance-1",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
},
{
"DBInstanceIdentifier": "sample-instance-2",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
},
],
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-9084c2ec",
"Status": "active"
}
],
"HostedZoneId": "Z06853723JYKYBXTJ49RB",
"StorageEncrypted": false,
"DbClusterResourceId": "cluster-T4LGLANHVAPGQYYULWUDKLVQL4",
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
"AssociatedRoles": [],
"IAMDatabaseAuthenticationEnabled": false,
"ClusterCreateTime": "2023-11-06T18:05:41.568000+00:00",
"EngineMode": "provisioned",
"DeletionProtection": false,
"HttpEndpointEnabled": false,
"CopyTagsToSnapshot": false,
"CrossAccountClone": false,
"DomainMemberships": [],
"TagList": [],
"StorageType": "iopt1",
"AutoMinorVersionUpgrade": false,
"NetworkType": "IPV4",
"IOOptimizedNextAllowedModificationTime": "2023-12-07T18:05:41.580000+00:00"
}
]
}
```
**Example**
**例 3: Amazon DocumentDB クラスターの特定の詳細をリストする**
を使用してクラスターの詳細のサブセットを一覧表示するには AWS CLI、`describe-db-clusters`オペレーションが一覧表示`--query`するクラスターメンバーを指定する を追加します。`--db-cluster-identifier` パラメータは、詳細を表示する対象のクラスターの識別子です。クエリの詳細については、「[で出力をフィルタリングする方法 `--query` オプション](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-output.html#controlling-output-filter) の *AWS Command Line Interface ユーザーガイド* 」を参照してください。
次の例では、リージョン内のすべての Amazon DocumentDB クラスターを一覧表示します。
Linux、macOS、Unix の場合:
```
aws docdb describe-db-clusters \
--filter Name=engine,Values=docdb \
--db-cluster-identifier sample-cluster \
--query 'DBClusters[*].[DBClusterMembers]'
```
Windows の場合:
```
aws docdb describe-db-clusters ^
--filter Name=engine,Values=docdb ^
--db-cluster-identifier sample-cluster ^
--query 'DBClusters[*].[DBClusterMembers]'
```
このオペレーションによる出力は、次のようになります。
```
[
[
[
{
"DBInstanceIdentifier": "sample-instance-1",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
},
{
"DBInstanceIdentifier": "sample-instance-2",
"IsClusterWriter": false,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
}
]
]
]
```
------
# Amazon DocumentDB クラスターの変更
クラスターを変更するには、クラスターが *使用可能* 状態である必要があります。停止しているクラスターを変更することはできません。クラスターが停止している場合は、まずクラスターを起動し、クラスターが *使用可能* になるまで待ってから、必要な変更を加えます。詳細については、「[Amazon DocumentDB クラスターの停止と開始](db-cluster-stop-start.md)」を参照してください。
------
#### [ Using the AWS マネジメントコンソール ]
コンソールを使用して特定の Amazon DocumentDB クラスターを変更するには、次の手順を使用します。
**Amazon DocumentDB クラスターの変更**
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. クラスター名の左側にあるボタンを選択して、変更するクラスターを指定します。
1. [**アクション**] を選択してから、[**変更**] を選択します。
1. [**クラスターの変更: **] ペインで、必要な変更を行います。次の分野で変更を行うことができます。
+ [**クラスターの仕様**] - クラスターの名前、セキュリティグループ、および認証情報管理。
+ **[クラスターストレージ設定]** — クラスターのデータストレージモードです。標準設定と I/O 最適化設定のいずれかを選択します。
+ [**クラスターオプション**] -クラスターのポートおよびパラメータグループ。
+ [**バックアップ**] - クラスターの保持期間およびバックアップ保持期間。
+ [**ログのエクスポート**] - 監査ログまたはプロファイラーログのエクスポートを有効または無効にします。
+ [**メンテナンス**] - クラスターのメンテナンスウィンドウを設定します。
+ [**削除保護**] - クラスターで削除保護を有効または無効にします。削除保護は、デフォルトで有効になります。
1. 完了したら、[**続行**] を選択して変更の概要を表示します。
1. 変更に問題がなければ、[**クラスターの変更**] を選択してクラスターを変更できます。または、[**戻る**] を選択して変更を編集したり、[**キャンセル**] を選択して変更をキャンセルしたりすることもできます。
変更が適用されるまでに数分かかります。クラスターを使用できるのは、そのステータスが [*available (使用可能)*] であるときのみです。コンソールまたは AWS CLIを使用して、クラスターのステータスをモニタリングできます。詳細については、「[Amazon DocumentDB クラスターのステータスのモニタリング](monitoring_docdb-cluster_status.md)」を参照してください。
------
#### [ Using the AWS CLI ]
指定したクラスターを `modify-db-cluster` で変更するには、 AWS CLIオペレーションを使用します。詳細については、[*Amazon DocumentDB API リファレンス* の [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html)] を参照してください。
**パラメータ**
+ **--db-cluster-identifier** — 必須 変更しようとしている Amazon DocumentDB クラスターの識別子。
+ **--backup-retention-period** - オプション。自動バックアップを保管する日数。有効な値は、1 – 35 です。
+ **--storage-type** - オプション。クラスターのストレージ設定 有効な値は、`standard` (標準) または `iopt1` (I/O 最適化) です。
+ **--db-cluster-parameter-group-name** - オプション。クラスターに使用するクラスターパラメータグループの名前。
+ **--manage-master-user-password** - オプション。Amazon DocumentDB はマスターユーザーパスワードを生成し、そのライフサイクル全体を通じて Secrets Manager で管理します。
+ **--rotate-master-user-password** - オプションです。Secrets Manager は、既存のシークレットの新しいシークレットバージョンを生成します。新しいバージョンのシークレットには、新しいプライマリユーザーパスワードが含まれています。Amazon DocumentDB は、クラスターのプライマリユーザーパスワードを、新しいシークレットバージョンのパスワードと一致するように変更します。
プライマリパスワードをローテーションするときは、**--apply-immediately** オプションを指定する必要があります。
+ **--master-user-password** - オプションです。プライマリデータベースユーザー向け新しいパスワード。
パスワードの制約:
+ 長さは 8 ～ 100 バイトの印刷可能な ASCII 文字です。
+ 以下のものを除くすべての印刷可能な ASCII 文字を使用できます。
+ **/** (スラッシュ)
+ **"** (二重引用符)
+ **@** (アットマーク)
+ **--new-db-cluster-identifier** - オプション。クラスターの名前を変更する場合のクラスターの新しいクラスター識別子。この値は小文字で保存されます。
命名に関する制約:
+ 1 − 63 個の英字、数字、またはハイフンで構成します。
+ 1 字目は英字である必要があります。
+ ハイフンで終わる、または 2 つのハイフンを連続して含めることはできません。
+ Amazon RDS、Amazon Neptune、Amazon DocumentDB のすべてのクラスターで AWS アカウント、リージョンごとに一意である必要があります。
+ **--preferred-backup-window** - オプション。自動バックアップが作成される毎日の時間帯 (世界協定時刻 (UTC))。
+ 形式: `hh24:mm-hh24:mm`
+ **--preferred-maintenance-window** - オプション。週 1 回のシステムメンテナンスを実行できる時間帯 (UTC)。
+ 形式: `ddd:hh24:mm-ddd:hh24:mm`
+ 有効な日: `Sun`、`Mon`、`Tue`、`Wed`、`Thu`、`Fri`、および `Sat`。
+ **--deletion-protection** または **--no-deletion-protection** - オプション。このクラスターで削除に対する保護を有効にするかを指定します。削除保護では、クラスターを変更して削除保護を無効にするまで、クラスターが誤って削除されないようにします。詳細については、「[Amazon DocumentDB クラスターの削除](db-cluster-delete.md)」を参照してください。
+ **--apply-immediately** または **--no-apply-immediately** − 今すぐ変更を適用するには、`--apply-immediately` を使用します。クラスターの次のメンテナンスウィンドウ時に変更するには、`--no-apply-immediately` を使用します。
**Example**
次のコードは、クラスター `sample-cluster` のバックアップ保持期間を変更します。
Linux、macOS、Unix の場合:
```
aws docdb modify-db-cluster \
--db-cluster-identifier sample-cluster \
--apply-immediately \
--backup-retention-period 7
```
Windows の場合:
```
aws docdb modify-db-cluster ^
--db-cluster-identifier sample-cluster ^
--apply-immediately ^
--backup-retention-period 7
```
このオペレーションによる出力は、次のようになります。
```
{
"DBCluster": {
"BackupRetentionPeriod": 7,
"DbClusterResourceId": "cluster-VDP53QEWST7YHM36TTXOPJT5YE",
"Status": "available",
"DBClusterMembers": [
{
"PromotionTier": 1,
"DBClusterParameterGroupStatus": "in-sync",
"DBInstanceIdentifier": "sample-cluster-instance",
"IsClusterWriter": true
}
],
"ReadReplicaIdentifiers": [],
"AvailabilityZones": [
"us-east-1b",
"us-east-1c",
"us-east-1a"
],
"ReaderEndpoint": "sample-cluster.cluster-ro-ctevjxdlur57.us-east-1.rds.amazonaws.com",
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
"PreferredMaintenanceWindow": "sat:09:51-sat:10:21",
"EarliestRestorableTime": "2018-06-17T00:06:19.374Z",
"StorageEncrypted": false,
"MultiAZ": false,
"AssociatedRoles": [],
"MasterUsername": "",
"DBClusterIdentifier": "sample-cluster",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
],
"HostedZoneId": "Z2SUY0A1719RZT",
"LatestRestorableTime": "2018-06-18T21:17:05.737Z",
"AllocatedStorage": 1,
"Port": 27017,
"Engine": "docdb",
"DBClusterParameterGroup": "default.docdb3.4",
"Endpoint": "sample-cluster.cluster-ctevjxdlur57.us-east-1.rds.amazonaws.com",
"DBSubnetGroup": "default",
"PreferredBackupWindow": "00:00-00:30",
"EngineVersion": "3.4",
"ClusterCreateTime": "2018-06-06T19:25:47.991Z",
"IAMDatabaseAuthenticationEnabled": false
}
}
```
変更が適用されるまでに数分かかります。クラスターを使用できるのは、そのステータスが [*available (使用可能)*] であるときのみです。コンソールまたは AWS CLIを使用して、クラスターのステータスをモニタリングできます。詳細については、「[Amazon DocumentDB クラスターのステータスのモニタリング](monitoring_docdb-cluster_status.md)」を参照してください。
------
# 実施待ちのメンテナンスの確認
Amazon DocumentDB エンジンのバージョンが最新であるかどうかを確認するには、保留中のクラスターメンテナンスがあるかどうかを確認します。
------
#### [ Using the AWS マネジメントコンソール ]
を使用して AWS マネジメントコンソール 、クラスターに保留中のメンテナンスがあるかどうかを判断できます。
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. [**メンテナンス**] 列を探して、クラスターに保留中のメンテナンスがあるかどうかを確認します。
![\[Amazon DocumentDB クラスターメンテナンスフィールドを示すコンソールのスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-cluster-pending-maintenance.png)
[**なし**] は、クラスターが最新のエンジンバージョンを実行していることを示します。[**利用可能**] は、クラスターに保留中のメンテナンスがあることを示し、エンジンのアップグレードが必要である可能性があります。
1. クラスターに保留中のメンテナンスがある場合は、[クラスターのエンジンバージョンへのパッチ更新の実行](db-cluster-version-upgrade.md) のステップに進みます。
------
#### [ Using the AWS CLI ]
を使用して、クラスターに最新のエンジンバージョンがあるかどうか AWS CLI を確認するには、次のパラメータを指定して `describe-pending-maintenance-actions`オペレーションを使用します。
**パラメータ**
+ **--resource-identifier** - オプション。リソースの ARN (クラスター)。このパラメータを省略すると、すべてのクラスターの保留中のメンテナンスアクションがリストされます。
+ **--region** - オプション。このオペレーションを実行する AWS リージョン (`us-east-1` など)。
**Example**
Linux、macOS、Unix の場合:
```
aws docdb describe-pending-maintenance-actions \
--resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster \
--region us-east-1
```
Windows の場合:
```
aws docdb describe-pending-maintenance-actions ^
--resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster ^
--region us-east-1
```
このオペレーションによる出力は、次のようになります。
```
{
"PendingMaintenanceActions": [
{
"ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
"PendingMaintenanceActionDetails": [
{
"Description": "New feature",
"Action": "db-upgrade",
"ForcedApplyDate": "2019-02-25T21:46:00Z",
"AutoAppliedAfterDate": "2019-02-25T07:41:00Z",
"CurrentApplyDate": "2019-02-25T07:41:00Z"
}
]
}
]
}
```
クラスターに保留中のメンテナンスがある場合は、[クラスターのエンジンバージョンへのパッチ更新の実行](db-cluster-version-upgrade.md) のステップに進みます。
------
# クラスターのエンジンバージョンへのパッチ更新の実行
このセクションでは、 AWS マネジメントコンソール または を使用してパッチ更新をデプロイする方法について説明します AWS CLI。パッチ更新とは、同じエンジンバージョン内のアップデートです (たとえば、3.6 エンジンバージョンを新しい 3.6 エンジンバージョンにアップデートするなど)。すぐにアップグレードするか、クラスターの次回のメンテナンス期間中にアップデートできます。エンジンのアップグレードが必要かどうかを確認するには、[実施待ちのメンテナンスの確認](db-cluster-determine-pending-maintenance.md) を参照してください。更新を適用すると、クラスターでダウンタイムが生じることを理解しておいてください。
**注記**
3.6 から 5.0 など、メジャーエンジンバージョンから別のエンジンバージョンにアップグレードする場合は、「[Amazon DocumentDB のインプレースメジャーバージョンアップグレード](docdb-mvu.md)」または「[を使用した Amazon DocumentDB クラスターのアップグレード AWS Database Migration Service](docdb-migration.versions.md)」を参照してください。メジャーバージョン一括アップグレードでは、ターゲットエンジンバージョンとして docdb 5.0 のみがサポートされます。
クラスターのエンジンバージョンの最新のパッチアップデートを取得するには、次の 2 つの構成要件があります。
+ クラスターステータスは *使用可能* でなければなりません。
+ クラスターが以前のエンジンバージョンで実行されている必要があります。
------
#### [ Using the AWS マネジメントコンソール ]
次の手順では、コンソールを使用して、パッチを適用し、クラスターのエンジンバージョンを最新のバージョンに更新します。すぐにアップグレードするか、クラスターの次のメンテナンスウィンドウ時に更新できます。
1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで **[Clusters]** (クラスター) を選択してください。クラスターのリストで、アップグレードするクラスターの左側にあるボタンを選択します。クラスターのステータスは *使用可能* でなければなりません。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-menu-icon.png)) を選択します。
1. [**アクション**] メニューから、以下のいずれかのオプションを選択します。これらのメニューオプションは、選択したクラスターで最新のエンジンバージョンが実行されていない場合にのみ選択できます。
![\[イメージ: Amazon DocumentDB アップグレードアクション\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-upgrade-action.png)
+ [**今すぐアップグレード**] − 今すぐアップグレードプロセスが開始されます。最新のエンジンバージョンにアップグレードしている間、クラスターはしばらくオフラインになります。
+ [**次のウィンドウでアップグレード**] - クラスターの次のメンテナンスウィンドウ時にアップグレードを開始します。クラスターは、最新のエンジンバージョンにアップグレードしている間、しばらくオフラインになります。
1. 確認ウィンドウが開いたら、次のいずれかを選択します。
+ [**アップグレード**] - 前のステップで選択したスケジュールに基づき、クラスターを最新のエンジンバージョンにアップグレードします。
+ [**キャンセル**] - クラスターのエンジンアップグレードをキャンセルし、クラスターの最新エンジンバージョンを引き続き使用します。
------
#### [ Using the AWS CLI ]
AWS CLI および `apply-pending-maintenance-action`オペレーションを使用して、以下のパラメータを指定して、クラスターにパッチ更新を適用できます。
**パラメータ**
+ **--resource-identifier** — 必須 アップグレードしようとしている Amazon DocumentDB クラスターの ARN。
+ **--apply-action** — 必須 以下の値を指定できます。クラスターのエンジンバージョンをアップグレードするには、`db-upgrade` を使用します。
+ **db-upgrade**
+ **system-update**
+ **--opt-in-type** — 必須 以下の値を指定できます。
+ `immediate` -メンテナンスアクションをすぐに適用します。
+ `next-maintenance` - 次回のメンテナンス期間中にメンテナンスアクションを適用します。
+ `undo-opt-in` -既存の `next-maintenance` オプトインリクエストをキャンセルします。
**Example**
次の例では、`sample-cluster` のエンジンバージョンをエンジン 4.0.0 にパッチを更新します。
Linux、macOS、Unix の場合:
```
aws docdb apply-pending-maintenance-action \
--resource-identifier arn:aws:rds:us-east-1:123456789012\:cluster:sample-cluster \
--apply-action db-upgrade \
--opt-in-type immediate
```
Windows の場合:
```
aws docdb apply-pending-maintenance-action ^
--resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster ^
--apply-action db-upgrade ^
--opt-in-type immediate
```
このオペレーションの出力は、次のようになります。
```
{
"ResourcePendingMaintenanceActions": {
"ResourceIdentifier": "arn:aws:rds:us-east-1:444455556666:cluster:docdb-2019-01-09-23-55-38",
"PendingMaintenanceActionDetails": [
{
"CurrentApplyDate": "2019-02-20T20:57:06.904Z",
"Description": "Bug fixes",
"ForcedApplyDate": "2019-02-25T21:46:00Z",
"OptInStatus": "immediate",
"Action": "db-upgrade",
"AutoAppliedAfterDate": "2019-02-25T07:41:00Z"
}
]
}
}
```
------
# Amazon DocumentDB クラスターの停止と開始
Amazon DocumentDB クラスターの停止と開始は、開発とテスト環境のコストを管理するために便利です。Amazon DocumentDB を使用するたびにクラスターとインスタンスを作成したり削除する代わりに、インスタンスが必要ではないときにクラスター内ですべてのインスタンスを一時的に停止できます。テストを再開するときに、このインスタンスを再開できます。
**Topics**
+ [クラスターの停止と開始の概要](#db-cluster-stop-start-overview)
+ [停止時のクラスターのみで実行できるオペレーション](#db-cluster-stopped-operations)
## クラスターの停止と開始の概要
Amazon DocumentDB クラスターが必要ではない期間は、そのクラスターですべてのインスタンスを一度に停止することができます。そして、クラスターを使用する必要がある時はいつでもクラスターを開始できます。開始と停止は、継続的な可用性を必要としない開発、テスト、または類似のアクティビティに使用されるクラスターのセットアップと解放のプロセスを簡素化します。クラスター内のインスタンスの数に関係なく、 AWS マネジメントコンソール または を使用して 1 つのアクション AWS CLI でクラスターを停止および開始できます。
クラスターが停止されている間、このクラスターのストレージボリュームは変更されません。指定された保持期間内でのストレージ、手動のスナップショット、および自動化されたバックアップストレージに対してのみ課金されます。インスタンス時間に対しては請求されません。Amazon DocumentDB は、7 日後に DB クラスターを自動的に開始するため、必要なメンテナンスの更新が遅延することはありません。7 日後にクラスターが開始すると、このクラスター内のインスタンスに対する課金が再開します。クラスターが停止している間は、ストレージボリュームに対するクエリを実行できません。クエリを実行するにはインスタンスが使用可能状態であることが必要です。
Amazon DocumentDB クラスターが停止されている場合、クラスターもそのインスタンスも、いかなる方法でも変更できません。これには、インスタンスの追加や削除、クラスターの削除が含まれます。
------
#### [ Using the AWS マネジメントコンソール ]
次の手順では、利用可能な 1 つ以上のインスタンスがあるクラスターを停止したり、停止しているクラスターを開始する方法を示します。
**Amazon DocumentDB クラスターを停止または開始するには**
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. クラスターのリストで、停止または開始するクラスター名の左側にあるボタンを選択します。
1. [**Actions (アクション)**] を選択したら、このクラスターで実行するアクションを選択します。
+ クラスターを停止したいときに、このクラスターが利用可能な場合:
1. **[停止]** を選択します。
![\[イメージ: クラスターを停止する\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cluster-stop.png)
フェイルオーバーメカニズムが発動することを回避するため、停止オペレーションはまずレプリカインスタンスを停止してからプライマリインスタンスを停止します。
1. 確認ダイアログで、クラスターを停止するには [**Stop cluster (クラスターの停止)**]、あるいはクラスターを継続して実行するには [**Cancel (キャンセル)**] を選択して確認します。
![\[イメージ: クラスターの開始\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cluster-stop-confirm.png)
+ クラスターを開始したいときにこのクラスターが停止されている場合、[**Start (開始)**] を選択します。
![\[イメージ: クラスターの開始\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cluster-start.png)
1. クラスターおよびそのインスタンスの状態をモニタリングします。クラスターを開始すると、クラスターおよびそのインスタンスが*利用可能な*場合にこのクラスターの使用を再開できます。詳細については、「[クラスターのステータスの評価](db-cluster-status.md)」を参照してください。
![\[イメージ: クラスターの停止時および開始時の状態\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cluster-stop-start-status.png)
------
#### [ Using the AWS CLI ]
次のコード例では、利用可能な状態にある 1 つ以上のインスタンスがあるクラスターを停止あるいは停止しているクラスターを開始する方法を示しています。
を使用して 1 つ以上の使用可能なインスタンスを持つクラスターを停止するには AWS CLI、 `stop-db-cluster`オペレーションを使用します。停止しているクラスターを開始するには、 `start-db-cluster` オペレーションを使用します。どちらのオペレーションも `--db-cluster-identifier` パラメータを使用します。
**パラメータ:**
+ **--db-cluster-identifier** — 必須 停止または開始するクラスターの名前。
**Example — を使用してクラスターを停止するには AWS CLI**
次のコードは、クラスター `sample-cluster` を停止します。クラスターには、利用可能な状態にある 1 つ以上のインスタンスがある必要があります。
Linux、macOS、Unix の場合:
```
aws docdb stop-db-cluster \
--db-cluster-identifier sample-cluster
```
Windows の場合:
```
aws docdb stop-db-cluster ^
--db-cluster-identifier sample-cluster
```
**Example — を使用してクラスターを起動するには AWS CLI**
次のコードは、クラスター `sample-cluster` を開始します。クラスターは現在停止している必要があります。
Linux、macOS、Unix の場合:
```
aws docdb start-db-cluster \
--db-cluster-identifier sample-cluster
```
Windows の場合:
```
aws docdb start-db-cluster ^
--db-cluster-identifier sample-cluster
```
------
## 停止時のクラスターのみで実行できるオペレーション
Amazon DocumentDB クラスター停止中に、指定された自動バックアップ保持期間内であれば、ポイントインタイムの復元を実行できます。ポイントインタイムの復元の実行の詳細については、「[特定時点への復元](backup_restore-point_in_time_recovery.md)」を参照してください。
クラスターを停止している間は、Amazon DocumentDB クラスターまたはその インスタンスの設定を変更することはできません。クラスターにインスタンスを追加または削除することも、関連するインスタンスがまだある場合はクラスターを削除することもできません。そのような管理アクションを実行する前に、クラスターを開始する必要があります。
Amazon DocumentDB は、スケジュールされたメンテナンスを、再び開始してからのみ停止したクラスターに適用します。7 日後、Amazon DocumentDB は停止したクラスターを自動的に開始するため、そのメンテナンス状態より過剰に遅れることはありません。クラスターが再開始すると、クラスター内のインスタンスへの課金が再開します。
クラスターが停止している間、Amazon DocumentDB は自動バックアップを一切実行せず、またバックアップ保持期間を延長しません。
# Amazon DocumentDB クラスターの削除
Amazon DocumentDB クラスターは、 AWS マネジメントコンソール または を使用して削除できます AWS CLI。クラスターを削除するには、クラスターが *使用可能* 状態であり、インスタンスが関連付けられていないことが必要です。クラスターが停止している場合は、まずクラスターを起動し、クラスターが *使用可能* になるまで待ってから、クラスターを削除します。詳細については、「[Amazon DocumentDB クラスターの停止と開始](db-cluster-stop-start.md)」を参照してください。
## 削除保護
クラスターが誤って削除されることを防ぐために、*削除保護* を有効にできます。コンソールを使用してクラスターを作成する場合は、デフォルトで削除保護が有効になっています。ただし、 AWS CLIを使用してクラスターを作成する場合、削除保護はデフォルトで無効になっています。
Amazon DocumentDB は、コンソールまたは AWS CLIを使用した削除オペレーションのどちらの実行でも、クラスターに対する削除保護を適用します。削除保護が有効になっている場合、クラスターを削除することはできません。削除に対する保護が有効化されているクラスターを削除するには、まずクラスターを変更して削除保護を無効化する必要があります。
クラスター上で削除保護を有効にしたコンソールを使用する場合、クラスターの最後のインスタンスを削除することはできません。これを削除するとクラスターも削除されるためです。 AWS CLIを使用すると、削除保護されているクラスターの最後のインスタンスを削除できます。ただし、クラスター自体は削除されず、データを保持されます。クラスターに新しいインスタンスを作成して、このデータにアクセスできます。削除保護の有効化および無効化の詳細については、以下を参照してください。
+ [Amazon DocumentDB クラスターの作成](db-cluster-create.md)
+ [Amazon DocumentDB クラスターの変更](db-cluster-modify.md)
------
#### [ Using the AWS マネジメントコンソール ]
を使用してクラスターを削除するには AWS マネジメントコンソール、削除保護を無効にする必要があります。
**クラスターで削除保護が有効になっているかどうかを確認するには**
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. Clusters ナビゲーションボックスで、**[クラスター識別子]** 列にはクラスターとインスタンスの両方が表示されることに注意してください。インスタンスは、以下のスクリーンショットのように、クラスターの下に表示されます。
![\[イメージ: 既存のクラスターリンクとそれに対応するインスタンスリンクのリストを示すクラスターナビゲーションボックス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/clusters.png)
1. クラスターの名前を選択し、[**設定**] タブを選択します。[**クラスターの詳細**] セクションで、[**削除保護**] を見つけます。削除保護が有効化されている場合は、クラスターを変更して削除保護を無効にします。クラスターの変更については、「[Amazon DocumentDB クラスターの変更](db-cluster-modify.md)」を参照してください。
[**Deletion protection (削除保護)**] が無効化されると、クラスターを削除する準備が完了します。
**クラスターを削除するには**
1. ナビゲーションペインで **[Clusters]** (クラスター) を選択してください。
1. 例えば、クラスターの下に表示されている [**クラスター識別子**] 列を確認して、クラスターにインスタンスがあるかどうかを判断します。クラスターを削除する前に、そのすべてのインスタンスを削除する必要があります。詳細については、「[Amazon DocumentDB インスタンスの削除](db-instance-delete.md)」を参照してください。
1. クラスターにインスタンスがあるかどうかに応じて、次のいずれかの手順を実行します。
+ クラスターにインスタンスがない場合は、クラスター名の左側にあるボタンを選択し、[**アクション**] を選択します。ドロップダウンメニューから [**削除**] を選択します。[**Delete ( を削除)**] ダイアログボックスを完了したら、[**Delete (削除)**] を選択します。
+ クラスターに 1 つ以上のインスタンスがある場合は、次を行います。
1. ナビゲーションペインで **[Clusters]** (クラスター) を選択してください。
1. クラスター名の左側にあるチェックボックスを選択して、クラスターの各インスタンスを削除します。[**Actions (アクション)**] を選択して、[**Delete (削除)**] を選択します。[**Delete ( を削除)**] ダイアログボックスを完了したら、[**Delete (削除)**] を選択します。
最後のインスタンスを削除すると、クラスターも削除されます。インスタンスの削除については、「[Amazon DocumentDB インスタンスの削除](db-instance-delete.md)」を参照してください。
クラスターが削除されるまでに数分かかります。クラスターのステータスをモニタリングするには、「[Amazon DocumentDB クラスターのステータスのモニタリング](monitoring_docdb-cluster_status.md)」を参照してください。
------
#### [ Using the AWS CLI ]
インスタンスが関連付けられているクラスターを削除することはできません。クラスターに関連付けられているインスタンスを確認するには、`describe-db-clusters` コマンドを実行し、クラスターのすべてのインスタンスを削除します。次に、必要に応じてクラスターの削除保護を無効にし、最後にクラスターを削除します。
1. **最初に、クラスターのすべてのインスタンスを削除します。**
削除する必要があるインスタンスを決定するには、次のコマンドを実行します。
```
aws docdb describe-db-clusters \
--db-cluster-identifier sample-cluster \
--query 'DBClusters[*].[DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]'
```
このオペレーションによる出力は、次のようになります (JSON 形式)。
```
[
[
"sample-cluster",
[
"sample-instance-1",
"sample-instance-2"
]
]
]
```
削除するクラスターにインスタンスがある場合は、次に示すように、そのインスタンスを削除します。
```
aws docdb delete-db-instance \
--db-instance-identifier sample-instance
```
1. **次に、削除保護を無効にします。**
AWS CLI を使用してクラスターのすべてのインスタンスを削除しても、クラスターは削除されません。クラスターも削除する必要があるときには、削除保護が無効化されている場合にのみこれを行うことができます。
クラスターに削除保護が有効化されているかどうかを判断するには、次のコマンドを実行します。
**ヒント**
すべての Amazon DocumentDB クラスターの削除保護状態を確認するには、`--db-cluster-identifier` パラメータを省略します。
```
aws docdb describe-db-clusters \
--db-cluster-identifier sample-cluster \
--query 'DBClusters[*].[DBClusterIdentifier,DeletionProtection]'
```
このオペレーションによる出力は、次のようになります。
```
[
[
"sample-cluster",
"true"
]
]
```
削除保護が有効になっている場合、クラスターを変更して削除保護を無効にします。クラスターの削除保護を無効にするには、次のコマンドを実行します。
```
aws docdb modify-db-cluster \
--db-cluster-identifier sample-cluster \
--no-deletion-protection \
--apply-immediately
```
1. **最後に、クラスターを削除します。**
削除保護を無効にしたら、クラスターを削除する準備が整います。クラスターを削除するには、以下のパラメータを指定して `delete-db-cluster` オペレーションを使用します。
+ **--db-cluster-identifier** — 必須 削除するクラスターの識別子。
+ **--final-db-snapshot-identifier** - オプション。最終スナップショットを作成する場合は、最終スナップショットの名前を指定して、このパラメータを含める必要があります。`--final-db-snapshot-identifier` または `--skip-final-snapshot` のどちらかを含める必要があります。
命名に関する制約:
+ 1 − 63 個の英字、数字、またはハイフンで構成します。
+ 1 字目は英字である必要があります。
+ ハイフンで終わる、または 2 つのハイフンを連続して含めることはできません。
+ Amazon RDS、Amazon Neptune、Amazon DocumentDB のすべてのクラスターで AWS アカウント、リージョンごとに一意である必要があります。
+ **--skip-final-snapshot** - オプション。クラスターを削除する前に最終スナップショットを作成しない場合のみ、このパラメータを使用します。デフォルトでは、最終スナップショットを作成します。`--final-db-snapshot-identifier` または `--skip-final-snapshot` のどちらかを含める必要があります。
次の AWS CLI コードは、最終スナップショット`sample-cluster`を持つクラスターを削除します。クラスターに関連付けられるインスタンスがある場合、あるいは削除保護が有効化されている場合、このオペレーションは失敗します。
**Example**
Linux、macOS、Unix の場合:
```
aws docdb delete-db-cluster \
--db-cluster-identifier sample-cluster \
--final-db-snapshot-identifier sample-cluster-final-snapshot
```
Windows の場合:
```
aws docdb delete-db-cluster ^
--db-cluster-identifier sample-cluster ^
--final-db-snapshot-identifier sample-cluster-final-snapshot
```
**Example**
次の AWS CLI コードは、最終スナップショットを作成`sample-cluster`せずにクラスターを削除します。
Linux、macOS、Unix の場合:
```
aws docdb delete-db-cluster \
--db-cluster-identifier sample-cluster \
--skip-final-snapshot
```
Windows の場合:
```
aws docdb delete-db-cluster ^
--db-cluster-identifier sample-cluster ^
--skip-final-snapshot
```
`delete-db-cluster` オペレーションの出力は、削除するクラスターになります。
クラスターが削除されるまでに数分かかります。クラスターのステータスをモニタリングするには、「[クラスターのステータスのモニタリング](monitoring_docdb-cluster_status.md)」を参照してください。
------