Modifying an Amazon DocumentDB Instance

    To modify a specific Amazon DocumentDB instance using the console, complete the following steps.

    1. Sign in to the AWS Management Console, and open the Amazon DocumentDB console at https://console.aws.amazon.com/docdb.

    2. In the navigation pane, choose Clusters .

      Tip

      If you don’t see the navigation pane on the left side of your screen, choose the menu icon () in the upper-left corner of the page.

    3. In the Clusters navigation box, you’ll see the column Cluster Identifier. Your instances are listed under clusters, similar to the screenshot below.

      Modifying an Instance - 图2

    5. In the Modify instance: <instance-name> pane, make the changes that you want. You can make the following changes:

      • Instance specifications — The instance identifier and class. Instance identifier naming constraints:

        • Instance identifier — Enter a name that is unique for all instances owned by your AWS account in the current region. The instance identifier must contain [1—63] alphanumeric characters or hyphens, have a letter as the first character, and cannot end with a hyphen or contain two consecutive hyphens.

        • Instance class — From the drop-down menu, select an instance class for your Amazon DocumentDB instance. For more information, see .

      • Failover — During failover, the instance with the highest promotion tier will be promoted to primary. For more information, see Amazon DocumentDB Failover.

      • Maintenance — The maintenance window in which pending modifications or patches are applied to instances in the cluster.

    6. When you have finished, choose Continue to see a summary of your changes.

    It takes a few minutes for your changes to be applied. You can use the instance only when its status is available. You can monitor the instance’s status using the console or AWS CLI. For more information, see .

    Using the AWS CLI

    To modify a specific Amazon DocumentDB instance using the AWS CLI, use the with the following parameters. For more information, see . The following code modifies the instance class to db.r5.large for the instance sample-instance.

    Parameters

    • — Required. The identifier for the instance to be modified.

    • --apply-immediately or --no-apply-immediately — Optional. Specifies whether this modification should be applied immediately or wait until the next maintenance window. If this parameter is omitted, the modification is performed during the next maintenance window.

    For Linux, macOS, or Unix:

    For Windows:

    It takes a few minutes for your modifications to be applied. You can use the instance only when its status is available. You can monitor the instance’s status using the AWS Management Console or AWS CLI. For more information, see Monitoring an Amazon DocumentDB Instance’s Status.