前提条件 Amazon DocumentDB CloudFormation スタックを起動する Amazon DocumentDB クラスターにアクセスする終了保護と削除保護

Amazon DocumentDB での CloudFormation の使用についてのクイックスタート

このセクションには、 CloudFormation を使用して Amazon DocumentDB (MongoDB 互換) をすぐに使い始めるための手順やその他の情報が含まれています。Amazon DocumentDB について一般的な情報は、「Amazon DocumentDB (MongoDB 互換) とは」を参照してください。

これらの手順では AWS CloudFormation テンプレートを使用して、デフォルトの Amazon VPC でクラスターとインスタンスを作成します。これらのリソースを自分で作成する方法については、「Amazon DocumentDB の使用開始」を参照してください。

重要

このテンプレートで作成される CloudFormation スタックは、Amazon DocumentDB のリソース（例えば、クラスターやインスタンス）や Amazon Elastic Compute Cloud のリソース（例えば、サブネットグループ）など、複数のリソースを作成します。

これらのリソースの一部は無料利用枠のリソースではありません。料金情報については、「Amazon DocumentDB の料金」と「Amazon EC2 の料金」を参照してください。スタックを終了したら削除して、以降そのスタックの料金が発生しないようにできます。

この CloudFormation スタックは、チュートリアル専用に設計されています。このテンプレートを本番環境で使用する場合は、より厳格な IAM ポリシーとセキュリティを使用することをお勧めします。リソースのセキュリティについては「Amazon VPC セキュリティ」および「Amazon EC2 ネットワークとセキュリティ」を参照してください。

トピック

前提条件
Amazon DocumentDB CloudFormation スタックを起動する
Amazon DocumentDB クラスターにアクセスする
終了保護と削除保護

前提条件

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

デフォルトのAmazon VPC
必須の IAM アクセス許可

必須の IAM アクセス許可

以下のアクセス許可を使用すると、CloudFormation スタック用のリソースを作成できます。

AWS マネージドポリシー

AWSCloudFormationReadOnlyAccess
AmazonDocDBFullAccess

追加の IAM アクセス許可

以下のポリシーは、この CloudFormation スタックの作成と削除に必要な追加のアクセス許可の概要を示しています。

次の例では ユーザー入力プレースホルダー をリソースの情報で置き換えます。

Amazon EC2 キーペア

CloudFormation スタックを作成するリージョンで使用可能なキーペア (および PEM ファイル) が必要です。キーペアを作成する必要がある場合は、「Amazon EC2 ユーザーガイド」の「Amazon EC2 を使用したキーペアの作成」を参照してください。

Amazon DocumentDB CloudFormation スタックを起動する

このセクションでは、Amazon DocumentDB CloudFormation スタックを起動して設定する方法について説明します。

AWS マネジメントコンソールの https://console.aws.amazon.com/ にサインインします。

次の表に、各 AWS リージョン Amazon DocumentDB スタックテンプレートを示します。スタックを起動したい AWS リージョンの [スタックの起動] を選択します。

リージョン	テンプレートを表示	デザイナーで表示
米国東部 (オハイオ)	テンプレートを表示	デザイナーで表示
米国東部 (バージニア北部)	テンプレートを表示	デザイナーで表示
米国西部 (オレゴン）	テンプレートを表示	デザイナーで表示
アジアパシフィック (ムンバイ)	テンプレートを表示	デザイナーで表示
アジアパシフィック (ソウル)	テンプレートを表示	デザイナーで表示
アジアパシフィック (シンガポール)	テンプレートを表示	デザイナーで表示
アジアパシフィック (シドニー)	テンプレートを表示	デザイナーで表示
アジアパシフィック (東京)	テンプレートを表示	デザイナーで表示
カナダ (中部)	テンプレートを表示	デザイナーで表示
欧州 (フランクフルト)	テンプレートを表示	デザイナーで表示
欧州 (アイルランド)	テンプレートを表示	デザイナーで表示
欧州 (ロンドン)	テンプレートを表示	デザイナーで表示
欧州 (パリ)	テンプレートを表示	デザイナーで表示

[スタックの作成] - 選択した Amazon DocumentDB テンプレートについて説明します。すべてのスタックは、テンプレート - JSON または YAML ファイル - に基づいており、スタックに含めたい AWS リソースに関する設定が含まれています。上記の提供されたテンプレートからスタックを起動することを選択したので、テンプレートは、選択した AWS リージョンのための Amazon DocumentDB スタックを作成するように既に構成されています。

CloudFormation スタックを起動すると、Amazon DocumentDB クラスターの削除保護はデフォルトで無効になっています。クラスターの削除保護を有効にする場合は、次のステップを実行します。それ以外の場合は、[次へ] を選択して次のステップに進みます。

Amazon DocumentDB クラスターの削除保護を有効にするには
1. スタック作成 ページの右下隅から、デザイナーで表示 を選択します。
2. コンソールの CloudFormation Designer ページで、統合された JSON および YAML エディタを使用してテンプレートを変更します。Resources セクションまでスクロールし、次のように変更して DeletionProtection を含めます。CloudFormation Designer の使用方法の詳細については、「CloudFormation Designer とは」を参照してください。
  
  JSON:
```
"Resources": {
    "DBCluster": {
        "Type": "AWS::DocDB::DBCluster",
        "DeletionPolicy": "Delete",
        "Properties": {
            "DBClusterIdentifier": {
                "Ref": "DBClusterName"
            },
            "MasterUsername": {
                "Ref": "MasterUser"
            },
            "MasterUserPassword": { 
                "Ref": "MasterPassword"
            }, 
            "DeletionProtection": "true"
        }
    },
```
  YAML:
```
Resources:
  DBCluster:
    Type: 'AWS::DocDB::DBCluster'
    DeletionPolicy: Delete
    Properties:
      DBClusterIdentifier: !Ref DBClusterName
      MasterUsername: !Ref MasterUser
      MasterUserPassword: !Ref MasterPassword
      DeletionProtection: 'true'
```
3. ページの左上隅にある [スタックの作成] ( ) を選択して変更を保存し、これらの変更を有効にしてスタックを作成します。
4. 変更を保存すると、[スタックの作成] ページにリダイレクトされます。
5. [次へ] を選択して続行します。
[スタックの詳細をの指定] - テンプレートのスタック名とパラメータを入力します。パラメータはテンプレートで定義されます。パラメータを使用すると、スタックの作成時または更新時にカスタム値を入力できます。
- [スタック名] に、スタックの名前を入力するか、指定された名前を受け入れます。スタック名には、文字 (A～Z および a～z)、数字 (0～9)、およびダッシュ (-) を使用できます。
- [パラメータ] に、次の詳細を入力します。
  - DBClusterName - Amazon DocumentDB クラスターの名前を入力するか、表示された名前を受け入れます。
    
    クラスターの名前付けの制約:
    長さは [1 〜 63] 個の英字、数字、またはハイフンです。
    
    1 字目は英字である必要があります。
    
    ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。
    
    AWS アカウントごとに、リージョンごとに、Amazon RDS、Neptune、Amazon DocumentDB にわたるすべてのクラスターに対して一意である必要があります。
  - DBInstanceClass - ドロップダウンリストから、Amazon DocumentDB クラスターのインスタンスクラスを選択します。
  - DBInstanceName - Amazon DocumentDB インスタンスの名前を入力するか、提供された名前を受け入れます。
    
    インスタンスの名前付けの制約:
    長さは [1 〜 63] 個の英字、数字、またはハイフンです。
    
    1 字目は英字である必要があります。
    
    ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。
    
    AWS アカウントごとに、リージョンごとに、Amazon RDS、Neptune、Amazon DocumentDB のすべてのインスタンスで一意である必要があります。
  - マスターパスワード - データベース管理者アカウントのパスワード。
  - マスターユーザー - データベース管理者アカウントのユーザー名。MasterUser は英数字で始まる必要があり、英数字のみ使用できます。
[次へ] を選択して変更を保存し、続行します。
[スタックオプションの設定] - スタックのタグ、アクセス権限、および追加オプションを設定します。
- [タグ] - スタック内のリソースに適用するタグ（キーと値のペア）を指定します。スタックごとに最大 50 個の一意のタグを追加できます。
- [アクセス権限] - オプションです。IAM ロールを選択して、CloudFormation がスタック内のリソースを作成、変更、または削除できる方法を明示的に定義します。ロールを選択しない場合、CloudFormation はユーザー認証情報に基づいてアクセス許可を使用します。サービスロールを指定する前に、サービスロールを割り当てるアクセス許可 (iam:PassRole) があるかどうかを確認します iam:PassRole アクセス許可は、どのロールを使用できるかを指定します。
  
  注記
  サービスロールを指定すると、CloudFormation はスタックで実行されるすべてのオペレーションにそのロールを必ず使用します。このスタックでオペレーションを実行するアクセス許可を持つ他のユーザーは、割り当てるアクセス許可がない場合でも、このロールを使用できます。ユーザーが持つべきではないアクセス許可がロールに含まれる場合、ユーザーのアクセス許可を非意図的にエスカレーションできてしまいます。ロールが最小特権を付与することを確認します。
- [高度なオプション] - 以下の高度なオプションを設定することができます。
  - [スタックポリシー] - オプションです。スタックの更新中、意図しない更新から保護するリソースを定義します。デフォルトでは、スタックの更新時にすべてのリソースを更新できます。
    
    スタックポリシーを JSON として直接入力するか、スタックポリシーを含む JSON ファイルをアップロードすることができます。詳細については、「スタックのリソースが更新されないようにする」を参照してください。
  - [ロールバック構成] - オプションです。スタックの作成および更新時に CloudFormation がモニタリングする CloudWatch Logs アラームを指定します。オペレーションがアラームしきい値を超えると、CloudFormation はアラームしきい値をロールバックします。
  - [通知オプション] - オプションです。Simple Notification System (SNS) のトピックを指定します。
  - [スタック作成オプション] - オプションです。以下のオプションを指定できます。
    [失敗時のロールバック] - スタックの作成に失敗した場合、スタックをロールバックするかどうかを指定します。
    
    [タイムアウト] - スタック作成がタイムアウトするまでの時間 (分)です。
    
    [終了保護] - スタックが誤って削除されるのを防ぎます。
    
    注記
    CloudFormation の終了保護は、Amazon DocumentDB の削除保護の概念とは異なります。詳細については、「終了保護と削除保護」を参照してください。
[次へ] を選択して続行します。
[<stack-name> の確認] - スタックテンプレート、詳細、設定オプションを確認します。ページの下部にある quick-create link を開いて、これと同じ基本設定のスタックを作成することもできます。
- [作成] を選択してスタックを作成します。
- または、[変更セットの作成] を選択することもできます。変更セットは、スタックを作成する前に、このスタックがどのように設定されるかをプレビューするものです。これにより、変更セットを実行する前にさまざまな設定を調べることができます。

Amazon DocumentDB クラスターにアクセスする

CloudFormation スタックが完成したら、Amazon EC2 インスタンスを使用して Amazon DocumentDB クラスターに接続することができます。SSH を使用して Amazon EC2 インスタンスに接続する方法については、「Amazon EC2 ユーザーガイド」の「Linux インスタンスへの接続」を参照してください。

接続後、Amazon DocumentDB の使用に関する情報を含む、次のセクションを参照してください。

終了保護と削除保護

Amazon DocumentDB のベストプラクティスとして、削除保護と終了保護を有効にすることをお勧めします。CloudFormation の終了保護は、Amazon DocumentDB の削除保護機能とは明確に異なる機能です。

終了保護 - CloudFormation スタックの終了保護を有効にすることによって、スタックが誤って削除されるのを防ぐことができます。終了保護を有効にした状態でスタックを削除しようとすると、削除は失敗し、スタックは変更されません。CloudFormation を使用してスタックを作成すると、終了保護はデフォルトで無効になります。終了保護は、スタック作成時に有効にすることができます。詳細については、「CloudFormation スタックオプションの設定」を参照してください。
削除保護 - Amazon DocumentDB は、クラスターに対して削除保護を有効にする機能も提供します。削除保護が有効になっている Amazon DocumentDB クラスターを削除しようとすると、削除は失敗し、クラスターは変更されません。削除保護を有効にすると、Amazon DocumentDB AWS マネジメントコンソール、AWS CLI、およびCloudFormation から誤って削除されないように保護されます。Amazon DocumentDB クラスターの削除保護の有効化、および無効化の詳細については削除保護を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

入門ガイド

MongoDB との互換性

Amazon DocumentDB での CloudFormation の使用についての クイックスタート

重要