Amazon Neptune
User Guide (API Version 2017-11-29)

Modifying an Amazon Neptune DB Cluster

You can change the settings of a DB cluster to accomplish tasks such as changing its backup retention period or its database port. You can also modify DB instances in a DB cluster to accomplish tasks such as changing its DB instance class or enabling Performance Insights for it. This topic guides you through modifying a Neptune DB cluster and its DB instances, and describes the settings for each.

We recommend that you test any changes on a test DB cluster or DB instance before modifying a production DB cluster or DB instance, so that you fully understand the impact of each change. This is especially important when upgrading database versions.

Modify the DB Cluster

You can modify a DB cluster using the AWS Management Console, the AWS CLI, or the Neptune API.

Note

For Neptune, when you modify a DB cluster, only changes to the DB cluster identifier, IAM DB authentication, and New master password settings are affected by the Apply Immediately setting. All other modifications are applied immediately, regardless of the value of the Apply Immediately setting.

Modify a DB Cluster Using the AWS Management Console

To modify a DB cluster

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

  2. In the navigation pane, choose Clusters, and then select the DB cluster that you want to modify.

  3. Choose Actions, and then choose Modify cluster. The Modify DB cluster page appears.

  4. Change any of the settings that you want.

    Note

    In the AWS Management Console, some instance level changes only apply to the current DB instance, while others apply to the entire DB cluster. . To change a setting that modifies the entire DB cluster at the instance level in the AWS Management Console, follow the instructions in Modify a DB Instance in a DB Cluster.

  5. When all the changes are as you want them, choose Continue and check the summary of modifications.

  6. To apply the changes immediately, select Apply immediately.

  7. On the confirmation page, review your changes. If they are correct, choose Modify cluster to save your changes.

    Alternatively, choose Back to edit your changes, or choose Cancel to cancel your changes.

Modify a DB Instance in a DB Cluster

You can modify a DB instance in a DB cluster using the AWS Management Console, the AWS CLI, or the Neptune API.

When you modify a DB instance, you can apply the changes immediately. To apply changes immediately, you select the Apply Immediately option in the AWS Management Console, you use the --apply-immediately parameter when calling the AWS CLI, or you set the ApplyImmediately parameter to true when using the Neptune API.

If you don't choose to apply changes immediately, the changes are put into the pending modifications queue. During the next maintenance window, any pending changes in the queue are applied. If you choose to apply changes immediately, your new changes and any changes in the pending modifications queue are applied.

Important

If any of the pending modifications require downtime, choosing apply immediately can cause unexpected downtime for the DB instance. There is no downtime for the other DB instances in the DB cluster.

Modify a DB Instance in a DB Cluster Using the AWS Management Console

To modify a DB instance in a DB cluster

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

  2. In the navigation pane, choose Instances, and then select the DB instance that you want to modify.

  3. Choose Instance actions, and then choose Modify. The Modify DB Instance page appears.

  4. Change any of the settings that you want.

    Note

    Some settings apply to the entire DB cluster and must be changed at the cluster level. To change those settings, follow the instructions in Modify the DB Cluster.

    In the AWS Management Console, some instance level changes only apply to the current DB instance, while others apply to the entire DB cluster.

  5. When all the changes are as you want them, choose Continue and check the summary of modifications.

  6. To apply the changes immediately, select Apply immediately.

  7. On the confirmation page, review your changes. If they are correct, choose Modify DB Instance to save your changes.

    Alternatively, choose Back to edit your changes, or choose Cancel to cancel your changes.