Amazon DocumentDB クラスターの変更

クラスターを変更するには、クラスターが使用可能な状態である必要があります。停止しているクラスターを変更することはできません。クラスターが停止している場合は、まずクラスターを起動し、クラスターが使用可能になるまで待ってから、必要な変更を加えます。詳細については、「Amazon DocumentDB クラスターの停止と起動」を参照してください。

Using the AWS Management Console

コンソールを使用して特定の Amazon DocumentDB クラスターを変更するには、次の手順を使用します。

Amazon DocumentDB クラスターの変更

1. にサインインし AWS Management Console、https://console.aws.amazon.com/docdb で Amazon DocumentDB コンソールを開きます。

2. ナビゲーションペインで [クラスター] を選択します。

   ヒント

   画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン () を選択します。

3. クラスター名の左側にあるボタンを選択して、変更するクラスターを指定します。

4. [アクション] を選択してから、[変更] を選択します。

5. [クラスターの変更: <cluster-name>] ペインで、必要な変更を行います。次の分野で変更を行うことができます。

   • [クラスターの仕様] - クラスターの名前、セキュリティグループ、およびパスワード。

   • クラスターストレージ設定 — クラスターのデータストレージモード。標準設定と I/O 最適化設定のどちらかを選択します。

   • [クラスターオプション] -クラスターのポートおよびパラメータグループ。

   • [バックアップ] - クラスターの保持期間およびバックアップ保持期間。

   • [ログのエクスポート] - 監査ログまたはプロファイラーログのエクスポートを有効または無効にします。

   • [メンテナンス] - クラスターのメンテナンスウィンドウを設定します。

   • [削除保護] - クラスターで削除保護を有効または無効にします。削除保護は、デフォルトで有効になります。

6. 完了したら、[続行] を選択して変更の概要を表示します。

7. 変更に問題がなければ、[クラスターの変更] を選択してクラスターを変更できます。または、[戻る] を選択して変更を編集したり、[キャンセル] を選択して変更をキャンセルしたりすることもできます。

変更が適用されるまでに数分かかります。クラスターを使用できるのは、そのステータスが [available (使用可能)] であるときのみです。コンソールまたは AWS CLIを使用して、クラスターのステータスをモニタリングできます。詳細については、「Amazon DocumentDB クラスターのステータスのモニタリング」を参照してください。

Using the AWS CLI

指定したクラスターを modify-db-cluster で変更するには、 AWS CLIオペレーションを使用します。詳細については、[Amazon DocumentDB API リファレンス の ModifyDBCluster] を参照してください。

パラメータ

• --db-cluster-identifier — 必須 変更しようとしている Amazon DocumentDB クラスターの識別子。

• --backup-retention-period - オプション。自動バックアップを保管する日数。有効な値は、1 – 35 です。

• --storage-type - オプション。クラスターのストレージ設定。有効な値は standard (標準) または iopt1 (I/O 最適化) です。

• --db-cluster-parameter-group-name - オプション。クラスターに使用するクラスターパラメータグループの名前。

• --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 クラスターの削除」を参照してください。

• --apply-immediately または --no-apply-immediately − 今すぐ変更を適用するには、--apply-immediately を使用します。クラスターの次のメンテナンスウィンドウ時に変更するには、--no-apply-immediately を使用します。

次のコードは、クラスター 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": "<your-master-user-name>",
        "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 クラスターのステータスのモニタリング」を参照してください。