Upgrading a Cluster’s Engine Version

    To upgrade a cluster’s engine version:

    • The cluster’s status must be available.

    • The cluster must be running an earlier engine version.

    The following procedure upgrades your cluster’s engine version to the latest version using the console. You have the option to upgrade immediately or during your cluster’s next maintenance window.

    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. In the list of clusters, choose the button to the left of the cluster that you want to upgrade. The status of the cluster must be available.

      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. When the confirmation window opens, choose one of the following:

      • Upgrade—To upgrade your cluster to the latest engine version according to the schedule chosen in the previous step.

      • Cancel—To cancel the cluster’s engine upgrade and continue with the cluster’s current engine version.

    Using the AWS CLI

    You can upgrade your cluster to a newer engine version using the AWS CLI and the operation with the following parameters.

    Parameters

    • --resource-identifier—Required. The ARN of the Amazon DocumentDB cluster that you are going to upgrade.

    • --opt-in-type—Required. The following values are permitted.

      • immediate—Apply the maintenance action immediately.

      • —Apply the maintenance action during the next maintenance window.

      • undo-opt-in—Cancel any existing next-maintenance opt-in requests.

    The following example upgrades the engine version of sample-cluster to version 4.0.0.

    For Linux, macOS, or Unix:

    For Windows:

    Output from this operation looks like the following.