翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # Amazon DocumentDB クラスターの管理 Amazon DocumentDB クラスターを管理するには、適切な Amazon DocumentDB コントロールプレーンアクセス許可を持つ IAM ポリシーが必要です。これらのアクセス許可により、クラスターとインスタンスを作成、変更、削除できます。`AmazonDocDBFullAccess` ポリシーは、 Amazon DocumentDB クラスターを管理するために必要なすべてのアクセス許可を提供します。 以下のトピックでは、Amazon DocumentDB クラスターを操作するときのさまざまなタスクの実行方法を示します。これには、クラスターの作成、削除、変更、接続、表示が含まれます。 **Topics** + [クラスターについて](db-clusters-understanding.md) + [[クラスター設定]](db-cluster-parameters.md) + [クラスターのストレージ設定](db-cluster-storage-configs.md) + [クラスターのステータスの評価](db-cluster-status.md) + [クラスターのライフサイクル](db-cluster-life-cycle.md) + [クラスターのスケーリング](db-cluster-manage-performance.md) + [クラスターボリュームのクローン作成](db-cluster-cloning.md) + [クラスターの耐障害性について](db-cluster-fault-tolerance.md) # クラスターについて Amazon DocumentDB は、コンピューティングとストレージを分離し、データレプリケーションとバックアップをクラスターボリュームにオフロードします。クラスターボリュームは、3 つのアベイラビリティーゾーンにわたって 6 つの方法でデータをレプリケートする、耐久性、信頼性、可用性に優れたストレージレイヤーを提供します。レプリカにより、データの可用性と読み取りスケーリングが高まります。各クラスターは、最大 15 個のレプリカにスケールアップできます。 | 名詞 | 説明 | API オペレーション (動詞) | | --- | --- | --- | | クラスター | 1 つ以上のインスタンスと、これらのインスタンスのデータを管理する 1 つのクラスターストレージボリュームで構成されます。 | `create-db-cluster` `delete-db-cluster` `describe-db-clusters` `modify-db-cluster` | | インスタンス | クラスターストレージボリュームとのデータの読み取りと書き込みは、インスタンスを介して行われます。クラスターには、プライマリとレプリカの 2 種類のインスタンスがあります。クラスターには常に 1 つのプライマリインスタンスがあり、0 ～ 15 のレプリカを持つことができます。 | `create-db-instance` `delete-db-instance` `describe-db-instances` `modify-db-instance` `describe-orderable-db-instance-options` `reboot-db-instance` | | クラスターボリューム | 3 つのアベイラビリティーゾーンにまたがる仮想データベースストレージボリューム。各アベイラビリティーゾーンにはクラスターデータの 2 つのコピーが格納されます。 | 該当なし | | プライマリインスタンス | 読み取りと書き込みの両方のオペレーションをサポートし、クラスターボリュームに対するすべてのデータ変更を実行します。各クラスターには 1 つのプライマリインスタンスがあります。 | 該当なし | | レプリカインスタンス | 読み取りオペレーションのみをサポートします。各 Amazon DocumentDB クラスターには、プライマリインスタンスに加えて 15 個までのレプリカインスタンスを含めることができます。複数のレプリカが読み取りワークロードを分散します。別のアベイラビリティーゾーンにレプリカを配置することによって、データベースの可用性を高めることもできます。 | 該当なし | | クラスターエンドポイント | クラスターの現在のプライマリインスタンスに接続する Amazon DocumentDB クラスターのエンドポイント。Amazon DocumentDB クラスターごとに 1 つのクラスターエンドポイントと 1 つのプライマリインスタンスがあります。 | 該当なし | | リーダーエンドポイント | Amazon DocumentDB クラスターで利用できるレプリカの 1 つに接続する、そのクラスターのエンドポイント。各 Amazon DocumentDB クラスターには、リーダーエンドポイントがあります。複数のレプリカがある場合、リーダーエンドポイントは各接続リクエストを Amazon DocumentDB レプリカのいずれかにルーティングします。 | 該当なし | | インスタンスエンドポイント | 特定のインスタンスに接続する Amazon DocumentDB クラスターのインスタンス用のエンドポイント。クラスターの各インスタンスには、インスタンスタイプにかかわらず、独自のインスタンスエンドポイントがあります。 | 該当なし | # Amazon DocumentDB クラスターの設定 クラスターを作成または変更するときは、どのパラメータが変更不可能で、どのパラメータがクラスターの作成後に変更可能かを理解することが重要です。次の表に、クラスターに固有のすべての設定 (つまり、パラメータ) をリストします。表に示されているように、変更可能なものもあれば、そうでないものもあります。 **注記** これらの設定は、Amazon DocumentDB クラスターのパラメータグループおよびそのパラメータと混同しないでください。クラスターのパラメータグループの詳細については、「[Amazon DocumentDB クラスターパラメータグループの管理](cluster_parameter_groups.md)」を参照してください。 | パラメータ | 変更可能 | コメント | | --- | --- | --- | | DBClusterIdentifier | はい | 命名に関する制約: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/db-cluster-parameters.html) | | Engine | いいえ | docdb を指定してください。 | | BackupRetentionPeriod | はい | 1～35 日を指定する必要があります。 | | DBClusterParameterGroupName | はい | 命名に関する制約: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/db-cluster-parameters.html) | | DBSubnetGroupName | いいえ | クラスターが作成された後で、クラスターのサブネットを変更することはできません。 | | EngineVersion | いいえ | 値は 5.0.0 (デフォルト)、4.0.0、または 3.6.0 です。 | | KmsKeyId | いいえ | クラスターの暗号化を選択した場合、クラスターの暗号化に使用した AWS KMS キーを変更することはできません。 | | MasterUsername | いいえ | クラスターが作成された後で、`MasterUsername` を変更することはできません。 命名に関する制約: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/db-cluster-parameters.html) | | MasterUserPassword | はい | 制約: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/db-cluster-parameters.html) | | Port | はい | ポート番号は、クラスター内のすべてのインスタンスに適用されます。 | | PreferredBackupWindow | はい | | | PreferredMaintenanceWindow | あり | | | StorageEncrypted | なし | クラスターの暗号化を選択した場合は、暗号化を解除することはできません。 | | StorageType | はい | DB クラスターのストレージタイプ: 標準 (`standard`) または I/O 最適化 (`iopt1`)。 デフォルト: `standard` このパラメータは、`CreateDBCluster` と `ModifyDBCluster` で設定できます。 詳細については、「[Amazon DocumentDB クラスターストレージ設定](db-cluster-storage-configs.md)」を参照してください。 | | Tags | はい | | | VpcSecurityGroupIds | なし | クラスターが作成された後で、クラスターが存在する VPC を変更することはできません。 | # Amazon DocumentDB クラスターストレージ設定 Amazon DocumentDB 5.0 以降、インスタンスベースのクラスターは 2 つのストレージ設定タイプをサポートしています。 + **Amazon DocumentDB 標準ストレージ**: I/O 消費量が低から中レベルのお客様向けに設計されたオプションです。I/O コストが Amazon DocumentDB クラスター全体の 25% 未満になると予想される場合は、このタイプが適していると思われます。Amazon DocumentDB 標準ストレージ設定では、インスタンスとストレージの料金に加えて、リクエスト回数に応じて I/O 料金が請求されます。このため、請求額は使用量に応じてサイクルごとに異なります。設定は、お使いのアプリケーションの I/O 需要の変動に合わせて調整されます。 + **Amazon DocumentDB I/O 最適化ストレージ **: コストの予測可能性を優先するか、あるいは I/O 集約型アプリケーションを使用するお客様向けに設計されたオプションです。I/O 最適化設定は、I/O 集約型ワークロードを使用するお客様向けに、パフォーマンスの向上、スループットの向上、レイテンシーの低減を実現します。I/O コストが Amazon DocumentDB クラスターコスト全体の 25% を超えると予想される場合は、このオプションを選択いただくと価格パフォーマンスが向上します。Amazon DocumentDB I/O 最適化ストレージ設定では、I/O オペレーション回数に基づく従量課金は行われず、請求サイクルごとの請求額を確実に予想できます。この設定により、パフォーマンスを向上させながらコストを安定させることができます。 30 日に 1 回 のタイミングで、既存のデータベースクラスターを Amazon DocumentDB I/O 最適化ストレージに切り替えることができます。Amazon DocumentDB 標準ストレージにはタイミングを問わず随時切り替え可能です。ストレージ設定を I/O 最適化に変更する次の日付は、 `describe-db-clusters` コマンドを使用して、 AWS CLI またはクラスターの設定ページの AWS マネジメントコンソール を使用して追跡できます。 Amazon DocumentDB I/O 最適化設定を含む新しいデータベースクラスターを作成するか、あるいは [AWS マネジメントコンソール](https://console.aws.amazon.com/docdb/) 上での数回のクリック、もしくは [AWS Command Line Interface (AWS CLI)](https://aws.amazon.com/cli/) での 1 つのパラメータの変更、または [AWS SDK](https://aws.amazon.com/developer/tools/) の使用により既存のデータベースクラスターを変換することができます。ストレージ設定の変更中、または変更後にダウンタイムは発生せず、インスタンスの再起動の必要もありません。 ![\[イメージ: Amazon DocumentDB 標準ストレージと最適化ストレージとの違いを示す表。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/io-diagram-1.png) ## I/O 最適化クラスターの作成 ------ #### [ Using the AWS マネジメントコンソール ] AWS マネジメントコンソールを使用して I/O 最適化クラスターを作成または変更するには: 1. Amazon DocumentDB 管理コンソール内の **[クラスター]** で、**[作成]** を選択するか、もしくは必要なクラスターを選択して **[アクション]** を選択し、**[変更]** を選択します。 1. 新しいクラスターを作成する場合は、**[クラスタータイプ]** セクションで **[インスタンスベースのクラスター]** (デフォルトのオプションです) を選択してください。 ![\[イメージ: クラスタータイプのオプションを表示したコンソール画面のスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-cluster/cc-type.png) 1. **[設定]** セクションの **[クラスターストレージ設定]** で、**[Amazon DocumentDB I/O 最適化]** を選択します。 ![\[イメージ: クラスターストレージ設定オプションを表示したコンソール画面のスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/storage-config-1.png) 1. クラスターの作成または変更を完了したら、**[クラスターの作成]** または **[クラスターの変更]** を選択します。 クラスターの作成プロセスの詳細については、「[を使用したクラスターとプライマリインスタンスの作成 AWS マネジメントコンソール](db-cluster-create.md#db-cluster-create-con)」を参照してください。 クラスターの変更プロセスの詳細については、「[Amazon DocumentDB クラスターの変更](db-cluster-modify.md)」を参照してください。 ------ #### [ Using the AWS CLI ] AWS CLIを使用して I/O 最適化クラスターを作成するには: 次の例では*ユーザー入力プレースホルダー*をユーザー自身の情報で置き換えます。 Linux、macOS、Unix の場合: ``` aws docdb create-db-cluster \ --db-cluster-identifier sample-cluster \ --engine docdb \ --engine-version 5.0.0 \ --storage-type iopt1 \ --deletion-protection \ --master-username username \ --master-user-password password ``` Windows の場合: ``` aws docdb create-db-cluster ^ --db-cluster-identifier sample-cluster ^ --engine docdb ^ --engine-version 5.0.0 ^ --storage-type iopt1 ^ --deletion-protection ^ --master-username username ^ --master-user-password password ``` ------ ## 適切なストレージ設定を決定するためのコスト分析 Amazon DocumentDB では、データベースクラスターごとにストレージ設定を柔軟に選択できます。標準クラスターと I/O 最適化クラスターを適切に使い分けるため、Amazon DocumentDB のコストをクラスター単位で追跡できます。そのためには、既存のクラスターにタグを追加し、[AWS Billing and Cost Management ダッシュボード](https://aws.amazon.com/pricing/) で [コスト配分タグ付け] を有効にすることで、[AWS Cost Explorer Service](https://aws.amazon.com/aws-cost-management/aws-cost-explorer/) での個別のクラスターのコストを分析できます。コスト分析の詳細については、ブログ「[コスト配分タグの使用](https://aws.amazon.com/blogs/database/using-cost-allocation-tags-with-amazon-documentdb-with-mongodb-compatibility/)」を参照してください。 # クラスターのステータスの評価 クラスターのステータスは、 AWS マネジメントコンソール または を使用して判断できます AWS CLI。 ------ #### [ Using the AWS マネジメントコンソール ] 次の手順を使用して、 を使用して Amazon DocumentDB クラスターのステータスを確認します。 AWS マネジメントコンソール 1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。 1. ナビゲーションペインで **[Clusters]** (クラスター) を選択してください。 1. [**クラスター ID**] 列で、関心があるクラスターの名前を探します。次に、クラスターのステータスを確認するには、次に示すように行全体を参照して [**ステータス**] 列を見つけます。 ![\[アクティブなステータスを示しているサンプルクラスターのクラスターページのスクリーンショット。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cluster-status-con.png) ------ #### [ Using the AWS CLI ] `describe-db-clusters` オペレーション を使用して、 AWS CLIを使用した Amazon DocumentDB クラスターのステータスを確認します。 次のコードでは、クラスター `sample-cluster` のステータスを確認します。 Linux、macOS、Unix の場合: ``` aws docdb describe-db-clusters \ --db-cluster-identifier sample-cluster \ --query 'DBClusters[*].[DBClusterIdentifier,Status]' ``` Windows の場合: ``` aws docdb describe-db-clusters ^ --db-cluster-identifier sample-cluster ^ --query 'DBClusters[*].[DBClusterIdentifier,Status]' ``` このオペレーションによる出力は、次のようになります (JSON 形式)。 ``` [ [ "sample-cluster", "available" ] ] ``` ------ # 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)」を参照してください。 ------ # Amazon DocumentDB クラスターのスケーリング Amazon DocumentDB では、ニーズに応じてクラスターのストレージとコンピューティングをスケールできます。このセクションでは、ストレージのスケーリング、インスタンスのスケーリング、および読み取りのスケーリングを使用して、Amazon DocumentDB クラスターとインスタンスのパフォーマンスとスケーリングを管理する方法について説明します。 **Topics** + [ストレージのスケーリング](#db-cluster-manage-scaling-storage) + [インスタンスのスケーリング](#db-cluster-manage-scaling-instance) + [読み取りのスケーリング](#db-cluster-manage-scaling-reads) + [書き込みスケーリング](#db-cluster-manage-scaling-writes) ## ストレージのスケーリング Amazon DocumentDB ストレージは、クラスターボリューム内のデータに合わせて自動的にスケーリングします。データが増加すると、クラスターボリュームストレージは、10 GiB 単位で最大 128 TiB まで増加します。 ## インスタンスのスケーリング DB クラスター内の各 DB インスタンスの DB インスタンスクラスを変更することで、必要に応じて Amazon DocumentDB クラスターをスケーリングできます。Amazon DocumentDB では、Amazon DocumentDB 用に最適化されたいくつかのインスタンスクラスをサポートしています。 詳細については、「[Amazon DocumentDB インスタンスの変更](db-instance-modify.md)」を参照してください。 ## 読み取りのスケーリング Amazon DocumentDB クラスターの読み取りのスケーリングは、最大 15 個の Amazon DocumentDB レプリカをクラスター内に作成することで実現できます。各 Amazon DocumentDB レプリカは、最小限のレプリカラグでクラスターボリュームから同じデータを返します。通常、このラグはプライマリインスタンスが更新を書き込んだ後、100 ミリ秒を大幅に下回ります。読み取りトラフィックが増えたら、追加の Amazon DocumentDB レプリカを作成し、それらに直接接続することで DB クラスターの読み取りワークロードを分散できます。Amazon DocumentDB レプリカのインスタンスクラスは、プライマリイスタンスと同じものである必要はありません。 詳細については、「[クラスターへの Amazon DocumentDB インスタンスの追加](db-instance-add.md)」を参照してください。 Amazon DocumentDB でスケールを読み取る場合は、レプリカセットとしてクラスターに接続し、ドライバーに組み込まれている読み取り設定機能を使用してレプリカインスタンスに読み取りを分散することをお勧めします。詳細については、「[レプリカセットとしての Amazon DocumentDB に接続する](connect-to-replica-set.md)」を参照してください。 ## 書き込みスケーリング クラスターのプライマリインスタンスのサイズを増やすことで、Amazon DocumentDB クラスターの書き込み容量をスケールできます。このセクションでは、ニーズに応じてクラスターのプライマリインスタンスをスケーリングする 2 つの方法を示します。最初のオプションは、アプリケーションへの影響を最小限に抑えることを目指しますが、完了するにはより多くのステップが必要です。2 番目のオプションは、ステップ数が減るため、最適化で簡素化されますが、アプリケーションへの潜在的な影響が増えるというトレードオフを伴います。 アプリケーションに応じて、以下の最適なアプローチを選択できます。利用可能なインスタンスのサイズとコストの詳細については、「[Amazon DocumentDB の料金](https://aws.amazon.com/documentdb/pricing/)」を参照してください。 1. **高可用性とパフォーマンスのための最適化** - [レプリカセットモード](connect-to-replica-set.md) でクラスターに接続している場合 (推奨) は、プライマリインスタンスのスケーリング時に、次のプロセスを使用してアプリケーションへの影響を最小限に抑えることができます。この方法では、クラスターが高可用性以上に維持され、読み取りスケーリングターゲットが (インプレースで更新されずに) インスタンスとしてクラスターに追加されるため、影響が最小限に抑えられます。 1. より大きなインスタンスタイプの 1 つ以上のレプリカをクラスターに追加します (「[クラスターへの Amazon DocumentDB インスタンスの追加](db-instance-add.md)」を参照)。すべてのレプリカは、プライマリと同等以上のサイズのインスタンスタイプにすることをお勧めします。これにより、書き込みパフォーマンスが意図せずに低下して、より小さなインスタンスタイプにフェイルオーバーすることを回避できます。ほとんどのお客様にとって、これは、クラスター内のインスタンス数を一時的に 2 倍にし、スケーリングの完了後により小さなレプリカを削除することを意味します。 1. すべての新しいレプリカのフェイルオーバー層を優先度ゼロに設定し、より小さいインスタンスタイプのレプリカのフェイルオーバー優先度が最も高くなるようにします。詳細については、「[フェイルオーバーターゲットの制御](failover.md#failover-target_control)」を参照してください。 1. 手動フェイルオーバーを開始し、新しいレプリカの 1 つをプライマリインスタンスに昇格させます。詳細については、「[フェイルオーバーのテスト](failover.md#failover-testing)」を参照してください。 **注記** これに伴って、クラスターのダウンタイムが最大 30 秒発生します。このダウンタイムを見越した計画を立ててください。 1. 新しいプライマリより小さいインスタンスタイプのすべてのレプリカをクラスターから削除します。 1. すべてのインスタンスのフェイルオーバー層の設定を同じ優先度に戻します (通常、これは設定を 1 に戻すことを意味します)。 たとえば、クラスターに現在 3 つの `r5.large` インスタンス (1 つのプライマリと 2 つのレプリカ) が含まれていて、`r5.xlarge` インスタンスタイプにスケールするとします。これを行うには、まず 3 つの `r5.xlarge` レプリカインスタンスをクラスターに追加し、これらの新しい `r5.xlarge` レプリカのフェイルオーバー層をゼロに設定します。次に、手動フェイルオーバーを開始します (アプリケーションのダウンタイムを最大 30秒見込みます)。フェイルオーバーが完了したら、3 つすべての `r5.large` インスタンスをクラスターから削除し、クラスターが `r5.xlarge` インスタンスにスケールされた状態にします。 コストを最適化しやすいように、Amazon DocumentDB インスタンスは秒単位で課金されます。インスタンスの作成、変更、削除などの課金対象のステータス変更に続く 10 分間の料金が最小の請求額となります。詳細については、ベストプラクティスのドキュメントの「[コスト最適化](best_practices.md#best_practices-cost_optimization)」を参照してください。 1. **単純化のために最適化** — このアプローチは、シンプルさを最適化します。クラスターの拡張と縮小は行われませんが、読み取り容量が一時的に減少する可能性があります。 レプリカのインスタンスクラスを変更すると、そのインスタンスが数秒から 30 秒未満の短い期間、リクエストを処理しなくなる可能性があります。[レプリカセットモード](connect-to-replica-set.md)(推奨) でクラスターに接続している場合、スケーリング操作中に読み取りキャパシティが 1 つのレプリカ (例えば、3 ノードクラスタでは 66% の容量、4 ノードクラスタで 75% の容量など) が減少します。 1. クラスター内の 1 つのレプリカインスタンスをスケールします。詳細については、「[インスタンスクラスの管理](db-instance-classes.md)」を参照してください。 1. インスタンスが利用可能になるまで待ちます (「[Amazon DocumentDB インスタンスのステータスのモニタリング](monitoring_docdb-instance_status.md)」を参照)。 **注記** これに伴って、クラスターのダウンタイムが最大 30 秒発生します。このダウンタイムを見越した計画を立ててください。 1. すべてのレプリカインスタンスが 1 つずつスケールされるまで、手順 1 と 2 を実行します。 1. 手動フェイルオーバーを開始します。これにより、レプリカがプライマリインスタンスに昇格します。詳細については、「[Amazon DocumentDB フェイルオーバー](failover.md)」を参照してください。 **注記** これにより、クラスターのダウンタイムが最大 30 秒発生しますが、それよりも時間が短くなります。このダウンタイムを見越した計画を立ててください。 1. 前のプライマリ (現在はレプリカ) インスタンスをスケールします。 # Amazon DocumentDB クラスターのボリュームのクローン作成 Amazon DocumentDB クローン作成を使用すると、同じ Amazon DocumentDB クラスターボリュームを使用して、元のクラスターと同じデータを持つ新しいクラスターを作成できます。このプロセスは、高速で、費用効果が高いように設計されています。関連付けられたデータボリュームを持つ新しいクラスターは、*クローン* と呼ばれます。クローンの作成は、スナップショットの復元など、他の手法を使用してデータを物理的にコピーするよりも、高速かつスペース効率に優れています。 Amazon DocumentDB は、プロビジョニングされた Amazon DocumentDB クラスターからの Amazon DocumentDB プロビジョニングクローンの作成をサポートしています。作成元とは異なるデプロイ設定を使用してクローンを作成すると、作成元の Amazon DocumentDB エンジンの最新バージョンを使用してクローンが作成されます。 Amazon DocumentDB クラスターからクローンを作成すると、ソース Amazon DocumentDB クラスターを所有するのと同じアカウントである AWS アカウントにクローンが作成されます。 **Topics** + [Amazon DocumentDB のクローン作成の概要](#db-cloning-overview) + [Amazon DocumentDB クローン作成の制約事項](#db-cloning-limitations) + [Amazon DocumentDB のクローン作成の仕組み](#db-how-db-cloning-works) + [Amazon DocumentDB のクローンの作成](#db-creating-db-clone) ## Amazon DocumentDB のクローン作成の概要 Amazon DocumentDB では、クローン作成に、*コピーオンライトプロトコル* が使用されます。このメカニズムでは、初期クローンを作成するために使用する追加領域は最小限です。クローンが初期に作成されると、Amazon DocumentDB は、作成元 DB クラスターと新しい (クローンの) Amazon DocumentDB クラスターで使用されるデータのコピーを 1 つだけ保持します。追加のストレージは、作成元の Amazon DocumentDB クラスターまたは Amazon DocumentDB クラスターのクローンが (Amazon DocumentDB ストレージボリューム上の) データに変更を加えた場合にのみ割り当てられます。コピーオンライトプロトコルの詳細については、「[Amazon DocumentDB のクローン作成の仕組み](#db-how-db-cloning-works)」を参照してください。 Amazon DocumentDB のクローン作成は、データを破損の危険にさらすことなく、本番データを使用してテスト環境を迅速にセットアップする場合に特に役立ちます。クローンは、次のようなさまざまなタイプのアプリケーションに使用できます。 + 潜在的な変更 (スキーマの変更やパラメータグループの変更など) を試して、すべての影響を評価する。 + データのエクスポートや分析クエリの実行など、大量のワークロードを扱うオペレーションをクローン上で実行する。 + 開発、テスト、またはその他の目的のために、本番 DB クラスターのコピーを作成する。 同じ Amazon DocumentDB クラスターから複数のクローンを作成できます。また、別のクローンから複数のクローンを作成することもできます。 Amazon DocumentDB のクローンを作成したら、Amazon DocumentDB インスタンスの設定を作成元の Amazon DocumentDB クラスターとは異なる方法で行えます。例えば、開発用途のクローンは、作成元の Amazon DocumentDB クラスターと同じ高可用性要件を満たす必要がない場合があります。この場合、Amazon DocumentDB クラスターで使用される複数の DB インスタンスではなく、単一の Amazon DocumentDB インスタンスを使用するようにクローンを設定できます。 テスト、開発などの用途へのクローンの使用が終了したら、クローンを削除できます。 ## Amazon DocumentDB クローン作成の制約事項 Amazon DocumentDB のクローン作成には、現在、次の制約事項があります。 + AWS リージョンで許可される DB クラスターの最大数まで、必要な数のクローンを作成できます。ただし、クローンを 15 個作成すると、次のクローンはフルコピーになります。クローン作成オペレーションは、ポイントインタイムリカバリと同様に機能します。 + ソース Amazon DocumentDB クラスターとは異なる AWS リージョンにクローンを作成することはできません。 + DB インスタンスを持たない Amazon DocumentDB クラスターからクローンを作成することはできません。少なくとも 1 つの DB インスタンスを持つ Amazon DocumentDB クラスターのクローン作成のみが可能です。 + クローンは、Amazon DocumentDB クラスターとは異なる仮想プライベートクラウド (VPC) で作成できます。その場合、VPCのサブネットは同じアベイラビリティーゾーンにマッピングする必要があります。 ## Amazon DocumentDB のクローン作成の仕組み Amazon DocumentDB のクローン作成は Amazon DocumentDB クラスターのストレージレイヤーで動作します。これには、*コピーオンライト* プロトコルが使用されます。これは、Amazon DocumentDB ストレージボリュームをサポートする基盤となる耐久性の高いメディアという点で、高速かつスペース効率に優れています。Amazon DocumentDB クラスターボリュームの詳細については、「[Amazon DocumentDB クラスターの管理](db-clusters.md)」を参照してください。 **Topics** + [コピーオンライトプロトコルの理解](#db-copy-on-write-protocol) + [ソースクラスターボリュームの削除](#db-deleting-source-cluster-volume) ### コピーオンライトプロトコルの理解 Amazon DocumentDB クラスターでは、基盤となる Amazon DocumentDB ストレージボリュームのページにデータが格納されます。 例えば、次の図には、4 つのデータページ 1、2、3、4 を持つ Amazon DocumentDB クラスター (A) があります。クローン B が Amazon DocumentDB クラスターから作成されたとします。クローンが作成されても、データはコピーされません。クローンは、作成元の Amazon DocumentDB クラスターと同じページのセットを参照しています。 ![\[作成元のクラスター A とクローン B 用の Amazon DocumentDB クラスターボリューム (4 ページ)\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cloning-copy-on-write-protocol-1.png) クローンが作成されたとき、通常は追加のストレージは必要ありません。コピーオンライトプロトコルでは、ソースセグメントと同じ物理ストレージメディア上のセグメントを使用します。追加のストレージが必要になるのは、ソースセグメントの容量がクローンセグメント全体に対して十分でない場合のみです。この場合、ソースセグメントは別の物理デバイスにコピーされます。 次の図に、前述と同様にクラスター A とそのクローン B を使用して動作中のコピーオンライトプロトコルの例を示します。Amazon DocumentDB クラスター (A) に変更を加えて、ページ 1 に保持されているデータが変更されたとします。元のページ 1 に書き込む代わりに、Amazon DocumentDB は新しいページ 1[A] を作成します。クラスター (A) の Amazon DocumentDB クラスターボリュームは、1[A]、2、3、4 ページを参照していますが、クローン (B) は引き続き元のページを参照しています。 ![\[Amazon DocumentDB の作成元 DB クラスターボリュームとそのクローンのどちらにも変更が加えられた場合。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cloning-copy-on-write-protocol-2.png) クローンでは、ストレージボリュームのページ 4 に変更が加えられています。元のページ 4 に書き込む代わりに、Amazon DocumentDB は新しいページ 4[B] を作成します。クローンはページ 1、2、3、およびページ 4[B] を参照し、クラスター (A) は引き続き 1[A]、2、3、4 を参照しています。 ![\[Amazon DocumentDB の作成元 DB クラスターボリュームとそのクローンのどちらにも変更が加えられた場合。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cloning-copy-on-write-protocol-3.png) 時間が経過して作成元 Amazon DocumentDB クラスターボリュームとクローンの両方で追加の変更があると、その変更をキャプチャして保存するためにさらにストレージが必要になります。 ### ソースクラスターボリュームの削除 1 つ以上のクローンが関連付けられているソースクラスターボリュームを削除しても、そのクローンには影響しません。クローンは、ソースクラスターボリュームが前に所有していたページをポイントし続けます。 ## Amazon DocumentDB のクローンの作成 クローンは、ソース Amazon DocumentDB クラスターと同じ AWS アカウントに作成できます。これを行うには、 AWS マネジメントコンソール または AWS CLI と以下の手順を使用します。 Amazon DocumentDB のクローン作成を使用すると、プロビジョニングされた Amazon DocumentDB クラスターから Amazon DocumentDB クラスターのプロビジョニングクローンを作成できます。 ------ #### [ Using the AWS マネジメントコンソール ] AWS マネジメントコンソールを使用して Amazon DocumentDB クラスターのクローンを作成する手順を以下に示します。 1 つの Amazon DocumentDB インスタンスを持つ Amazon DocumentDB クラスターで AWS マネジメントコンソール 結果を使用してクローンを作成します。 これらの手順は、クローンを作成しているのと同じ AWS アカウントが所有する DB クラスターに適用されます。クロス AWS アカウントのクローン作成は Amazon DocumentDB ではサポートされていないため、DB クラスターは同じアカウントによって所有されている必要があります。 **を使用して、 AWS アカウントが所有する DB クラスターのクローンを作成するには AWS マネジメントコンソール** 1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。 1. ナビゲーションペインで **[Clusters]** (クラスター) を選択してください。 1. リストから Amazon DocumentDB クラスターを選択し、**[アクション]** で、**[クローンの作成]** を選択します。 ![\[クローンの作成には、まず Amazon DocumentDB クラスターを選択します。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cloning-create-clone-1.png) [クローンの作成] ページが開きます。そこで、**[クラスター識別子]**、**[インスタンスクラス]** などの Amazon DocumentDB クラスタークローンのオプションが設定できます。 1. **[設定]** セクションで、以下の手順を実行します。 1. **[DB クラスター識別子]** に、作成する Amazon DocumentDB クラスターのクローンに付ける名前を入力します。 1. **[インスタンス設定]** では、クローンとして作成された Amazon DocumentDB クラスターに適した **[インスタンスクラス]** を選択します。 ![\[クローンの作成には、まず Amazon DocumentDB クラスターを選択し、DB インスタンスのサイズを指定します。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cloning-create-clone-2.png) 1. **[ネットワーク設定]** では、ユースケースに適した**サブネットグループ**と、関連する VPC セキュリティグループを選択します。 1. **[保管時の暗号化]**では、作成元クラスター (クローンが作成されるクラスター) で暗号化が有効になっている場合、クローンとして作成されたクラスターでも暗号化が有効になっている必要があります。このシナリオに当てはまる場合、**[暗号化を有効にする]** オプションはグレー表示 (無効) になりますが、**[暗号化を有効にする]** オプションが選択されています。逆に、作成元クラスターで暗号化が有効になっていない場合は、**[暗号化を有効にする]** オプションが使用でき、暗号化を有効または無効にすることができます。 ![\[Amazon DocumentDB クラスタークローンのネットワーク設定と暗号化設定を指定します。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cloning-create-clone-3-nw-encryption.png) 1. エクスポートするログの種類を選択し (オプション)、クラスターへの接続に使用する特定のポートを入力し、クラスターの誤削除からの保護を有効にして (デフォルトで有効) 、新しいクラスタークローンの設定を完了します。 ![\[エクスポートするログのタイプ、クラスターへの接続に使用する特定のポート、およびクラスターの誤削除からの保護フォームをオプションで選択して、新しいクローンの設定を完了します。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/db-cloning-create-clone-4-log-options-del-prot-b.png) 1. Amazon DocumentDB クラスターのクローンのすべての設定の入力を完了します。Amazon DocumentDB クラスターとインスタンスの設定の詳細については、「[Amazon DocumentDB クラスターの管理](db-clusters.md)」を参照してください。 1. **[クローンを作成]** を選択して、選択した Amazon DocumentDB クラスターの Amazon DocumentDB クローンを起動します。 クローンが作成されると、コンソールの **[データベース]** セクションに他の Amazon DocumentDB クラスターとともに一覧表示され、現在の状態が表示されます。状態が [**使用可能**] の場合は、クローンはすぐに使用できます。 ------ #### [ Using the AWS CLI ] AWS CLI を使用して Amazon DocumentDB クラスターをクローンするには、いくつかのステップが必要です。 使用する`restore-db-cluster-to-point-in-time` AWS CLI コマンドは、Amazon DocumentDB インスタンスが 0 個の空の Amazon DocumentDB クラスターになります。つまり、このコマンドは Amazon DocumentDB クラスターのみを復元し、クラスターの DB インスタンスは復元しません。これは、クローンが使用可能になった後に別途行います。プロセスは 2 ステップで、次のとおりです。 1. [restore-db-cluster-to-point-in-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html) CLI コマンドを使用して、クローンを作成します。このコマンドで使用するパラメータで、作成する空の Amazon DocumentDB クラスター (クローン) の容量タイプなどの詳細が制御されます。 1. [create-db-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) CLI コマンドを使用して、クローン用の Amazon DocumentDB インスタンスを作成し、復元された Amazon DocumentDB クラスターに Amazon DocumentDB インスタンスを再作成します。 次のコマンドは、 AWS CLI が AWS リージョンをデフォルトとして設定されていることを前提としています。この方法では、`--region` の名前を各コマンドに入力する手間が省けます。詳細については、「[AWS CLIの設定](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)」を参照してください。また、以下の各 CLI コマンドで `--region` を指定することもできます。 **Topics** **クローンの作成** `[restore-db-cluster-to-point-in-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html)` CLI コマンドに渡す特定のパラメータは、さまざまです。渡す内容は、作成するクローンのタイプによって異なります。 次の手順に従い、プロビジョニングされた Amazon DocumentDB クラスターから Amazon DocumentDB プロビジョニングクローンを作成します。 **作成元 Amazon DocumentDB クラスターと同じエンジンモードのクローンを作成するには** + `[restore-db-cluster-to-point-in-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html)` CLI コマンドを使用して、次のパラメータに値を指定します。 + `--db-cluster-identifier` - クローン用の意味のある名前を選択します。[restore-db-cluster-to-point-in-time](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-cluster-to-point-in-time.html) CLI コマンド使用時に、クローンに名前を付けます。 + `--restore-type` - 出典 DB クラスターのクローンの作成に `copy-on-write` を使用します。このパラメータを指定しない場合、`restore-db-cluster-to-point-in-time` は、クローンを作成するのではなく、Amazon DocumentDB クラスターを復元します。`restore-type` のデフォルトは `full-copy` です。 + `--source-db-cluster-identifier` - クローンを作成する作成元 Amazon DocumentDB クラスターの名前を使用します。 + `--use-latest-restorable-time` - この値は、クローンの最新の復元可能なボリュームデータを指します。このパラメータは `restore-type copy-on-write` に必要ですが、一緒に `restore-to-time parameter` を使用することはできません。 次の例では、`my-source-cluster` という名前のクラスターから `my-clone` という名前のクローンを作成します。 Linux、macOS、Unix の場合: ``` aws docdb restore-db-cluster-to-point-in-time \ --source-db-cluster-identifier my-source-cluster \ --db-cluster-identifier my-clone \ --restore-type copy-on-write \ --use-latest-restorable-time ``` Windows の場合: ``` aws docdb restore-db-cluster-to-point-in-time ^ --source-db-cluster-identifier my-source-cluster ^ --db-cluster-identifier my-clone ^ --restore-type copy-on-write ^ --use-latest-restorable-time ``` このコマンドは、クローンの詳細を含む JSON オブジェクトを返します。クローンの DB インスタンスを作成する前に、作成した DB クラスターのクローンが使用可能であることを確認します。詳細については、下記の「ステータスの確認とクローンの詳細の取得」をご参照ください。 **ステータスの確認とクローンの詳細の取得** 次のコマンドを使用して、新しく作成した空の DB クラスターのステータスが確認できます。 ``` $ aws docdb describe-db-clusters --db-cluster-identifier my-clone --query '*[].[Status]' --output text ``` または、次の AWS CLI クエリを使用して、クローンの DB インスタンスを作成するために必要なステータスやその他の値を取得できます。 Linux、macOS、Unix の場合: ``` aws docdb describe-db-clusters --db-cluster-identifier my-clone \ --query '*[].{Status:Status,Engine:Engine,EngineVersion:EngineVersion}' ``` Windows の場合: ``` aws docdb describe-db-clusters --db-cluster-identifier my-clone ^ --query "*[].{Status:Status,Engine:Engine,EngineVersion:EngineVersion}" ``` このクエリにより、以下のような出力が返されます。 ``` [ { "Status": "available", "Engine": "docdb", "EngineVersion": "4.0.0", } ] ``` **クローン用の Amazon DocumentDB インスタンスの作成** クローン用の DB インスタンスを作成するには、[create-db-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) CLI コマンドを使用します。 `--db-instance-class` パラメータは、プロビジョニングされた Amazon DocumentDB クラスターにのみ使用されます。 Linux、macOS、Unix の場合: ``` aws docdb create-db-instance \ --db-instance-identifier my-new-db \ --db-cluster-identifier my-clone \ --db-instance-class db.r5.4xlarge \ --engine docdb ``` Windows の場合: ``` aws docdb create-db-instance ^ --db-instance-identifier my-new-db ^ --db-cluster-identifier my-clone ^ --db-instance-class db.r5.4xlarge ^ --engine docdb ``` **クローン作成に使用するパラメータ** 次の表は `restore-db-cluster-to-point-in-time` を使用して Amazon DocumentDB クラスターのクローンを作成する際に使用されるさまざまなパラメータをまとめたものです。 | パラメータ | 説明 | | --- | --- | | --source-db-cluster-identifier | クローンを作成する作成元 Amazon DocumentDB クラスターの名前を使用します。 | | --db-cluster-identifier | クローン用に意味のある名前を選択します。` restore-db-cluster-to-point-in-time` コマンドでクローンの名前を付けます。次に、この名前を `create-db-instance` コマンドに渡します。 | | --restore-type | `--restore-type` として `copy-on-write` を指定すると、作成元 Amazon DocumentDB クラスターを復元するのではなく、作成元 DB クラスターのクローンを作成します。 | | --use-latest-restorable-time | この値は、クローンの最新の復元可能なボリュームデータを指します。 | ------ # Amazon DocumentDB クラスターの耐障害性について理解する Amazon DocumentDB クラスターは、耐障害性を持つように設計されています。各クラスターのボリュームは 1 つの で複数のアベイラビリティーゾーンにまたがり AWS リージョン、各アベイラビリティーゾーンにはクラスターのボリュームデータのコピーが含まれます。この機能は、クラスターがデータ喪失なしでアベイラビリティーゾーンの障害に耐えることができ、発生するのはサービスの短時間の中断のみであることを意味します。 クラスターのプライマリインスタンスが失敗した場合、Amazon DocumentDB は以下のいずれかの方法で、新しいプライマリインスタンスに自動的にフェイルオーバーします。 + 既存の Amazon DocumentDB レプリカを新しいプライマリインスタンスに昇格し、昇格されたレプリカの置き換えを作成する。レプリカインスタンスへのフェイルオーバーは、通常 30 秒未満で完了します。この期間中、読み取りおよび書き込みオペレーションが短時間中断することがあります。DB クラスターの可用性を高めるために、複数のアベイラビリティーゾーン内で少なくとも 1 つ以上の Amazon DocumentDB レプリカを作成することをお勧めします。 + 新しいプライマリインスタンスを作成する。これは、クラスター内にレプリカ・インスタンスがなく、完了までに数分かかる場合のみ発生します。 クラスターに 1 つ以上の Amazon DocumentDB レプリカがある場合は、障害発生中に 1 つの Amazon DocumentDB レプリカがプライマリインスタンスに昇格されます。障害イベントによって短い中断が発生し、その間例外によって読み取りと書き込みオペレーションが失敗します。ただし、一般的なサービスの復元時間は 120 秒未満であり、多くの場合 60 秒未満で復元されます。DB クラスターの可用性を高めるために、複数のアベイラビリティーゾーン内で少なくとも 1 つ以上の Amazon DocumentDB レプリカを作成することをお勧めします。 各レプリカに優先度を割り当てることで、Amazon DocumentDB レプリカがプライマリインスタンスに昇格される順序をカスタマイズできます。優先度の範囲は、最も高い 0 から最も低い 15 までです。プライマリインスタンスが失敗した場合、最も高い優先度の Amazon DocumentDB レプリカが、新しいプライマリインスタンスに昇格します。Amazon DocumentDB レプリカの優先度はいつでも変更できます。優先度を変更しても、フェイルオーバーはトリガーされません。`modify-db-instance` オペレーションで、`--promotion-tier` パラメータを使用できます。インスタンスのフェイルオーバー優先度のカスタマイズの詳細については、「[Amazon DocumentDB フェイルオーバー](failover.md)」を参照してください。 複数の Amazon DocumentDB レプリカで同じ優先度を共有でき、その場合は昇格階層が発生します。複数の Amazon DocumentDB レプリカで同じ優先度を共有する場合、最大サイズのレプリカがプライマリに昇格します。複数の Amazon DocumentDB レプリカで同じ優先度とサイズを共有する場合、昇格階層の任意のレプリカが昇格します。 クラスターに Amazon DocumentDB レプリカが含まれていない場合、障害イベントの発生時にプライマリインスタンスが再作成されます。障害イベントによって中断が発生し、その間例外によって読み取りと書き込みオペレーションが失敗します。新しいプライマリインスタンスが再作成されると、サービスが回復します。これは、通常は 10 分未満で行われます。Amazon DocumentDB レプリカのプライマリインスタンスへの昇格は、新しいプライマリインスタンスの作成よりもはるかに短時間で実行されます。