ModifyDBInstanceCommand

Suggest an Edit

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, ModifyDBInstanceCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, ModifyDBInstanceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // ModifyDBInstanceMessage
  DBInstanceIdentifier: "STRING_VALUE", // required
  DBInstanceClass: "STRING_VALUE",
  ApplyImmediately: true || false,
  PreferredMaintenanceWindow: "STRING_VALUE",
  AutoMinorVersionUpgrade: true || false,
  NewDBInstanceIdentifier: "STRING_VALUE",
  CACertificateIdentifier: "STRING_VALUE",
  CopyTagsToSnapshot: true || false,
  PromotionTier: Number("int"),
  EnablePerformanceInsights: true || false,
  PerformanceInsightsKMSKeyId: "STRING_VALUE",
  CertificateRotationRestart: true || false,
};
const command = new ModifyDBInstanceCommand(input);
const response = await client.send(command);
// { // ModifyDBInstanceResult
//   DBInstance: { // DBInstance
//     DBInstanceIdentifier: "STRING_VALUE",
//     DBInstanceClass: "STRING_VALUE",
//     Engine: "STRING_VALUE",
//     DBInstanceStatus: "STRING_VALUE",
//     Endpoint: { // Endpoint
//       Address: "STRING_VALUE",
//       Port: Number("int"),
//       HostedZoneId: "STRING_VALUE",
//     },
//     InstanceCreateTime: new Date("TIMESTAMP"),
//     PreferredBackupWindow: "STRING_VALUE",
//     BackupRetentionPeriod: Number("int"),
//     VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
//       { // VpcSecurityGroupMembership
//         VpcSecurityGroupId: "STRING_VALUE",
//         Status: "STRING_VALUE",
//       },
//     ],
//     AvailabilityZone: "STRING_VALUE",
//     DBSubnetGroup: { // DBSubnetGroup
//       DBSubnetGroupName: "STRING_VALUE",
//       DBSubnetGroupDescription: "STRING_VALUE",
//       VpcId: "STRING_VALUE",
//       SubnetGroupStatus: "STRING_VALUE",
//       Subnets: [ // SubnetList
//         { // Subnet
//           SubnetIdentifier: "STRING_VALUE",
//           SubnetAvailabilityZone: { // AvailabilityZone
//             Name: "STRING_VALUE",
//           },
//           SubnetStatus: "STRING_VALUE",
//         },
//       ],
//       DBSubnetGroupArn: "STRING_VALUE",
//     },
//     PreferredMaintenanceWindow: "STRING_VALUE",
//     PendingModifiedValues: { // PendingModifiedValues
//       DBInstanceClass: "STRING_VALUE",
//       AllocatedStorage: Number("int"),
//       MasterUserPassword: "STRING_VALUE",
//       Port: Number("int"),
//       BackupRetentionPeriod: Number("int"),
//       MultiAZ: true || false,
//       EngineVersion: "STRING_VALUE",
//       LicenseModel: "STRING_VALUE",
//       Iops: Number("int"),
//       DBInstanceIdentifier: "STRING_VALUE",
//       StorageType: "STRING_VALUE",
//       CACertificateIdentifier: "STRING_VALUE",
//       DBSubnetGroupName: "STRING_VALUE",
//       PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
//         LogTypesToEnable: [ // LogTypeList
//           "STRING_VALUE",
//         ],
//         LogTypesToDisable: [
//           "STRING_VALUE",
//         ],
//       },
//     },
//     LatestRestorableTime: new Date("TIMESTAMP"),
//     EngineVersion: "STRING_VALUE",
//     AutoMinorVersionUpgrade: true || false,
//     PubliclyAccessible: true || false,
//     StatusInfos: [ // DBInstanceStatusInfoList
//       { // DBInstanceStatusInfo
//         StatusType: "STRING_VALUE",
//         Normal: true || false,
//         Status: "STRING_VALUE",
//         Message: "STRING_VALUE",
//       },
//     ],
//     DBClusterIdentifier: "STRING_VALUE",
//     StorageEncrypted: true || false,
//     KmsKeyId: "STRING_VALUE",
//     DbiResourceId: "STRING_VALUE",
//     CACertificateIdentifier: "STRING_VALUE",
//     CopyTagsToSnapshot: true || false,
//     PromotionTier: Number("int"),
//     DBInstanceArn: "STRING_VALUE",
//     EnabledCloudwatchLogsExports: [
//       "STRING_VALUE",
//     ],
//     CertificateDetails: { // CertificateDetails
//       CAIdentifier: "STRING_VALUE",
//       ValidTill: new Date("TIMESTAMP"),
//     },
//     PerformanceInsightsEnabled: true || false,
//     PerformanceInsightsKMSKeyId: "STRING_VALUE",
//   },
// };

ModifyDBInstanceCommand Input

See ModifyDBInstanceCommandInput for more details

Parameter
Type
Description
DBInstanceIdentifier
Required
string | undefined

The instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

ApplyImmediately
boolean | undefined

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

AutoMinorVersionUpgrade
boolean | undefined

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

CACertificateIdentifier
string | undefined

Indicates the certificate that needs to be associated with the instance.

CertificateRotationRestart
boolean | undefined

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates  and Encrypting Data in Transit  in the Amazon DocumentDB Developer Guide.

CopyTagsToSnapshot
boolean | undefined

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

DBInstanceClass
string | undefined

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

EnablePerformanceInsights
boolean | undefined

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .

NewDBInstanceIdentifier
string | undefined

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

PerformanceInsightsKMSKeyId
string | undefined

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

PreferredMaintenanceWindow
string | undefined

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Must be at least 30 minutes.

PromotionTier
number | undefined

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

ModifyDBInstanceCommand Output

See ModifyDBInstanceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DBInstance
DBInstance | undefined

Detailed information about an instance.

Throws

Name
Fault
Details
AuthorizationNotFoundFault
client

The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

CertificateNotFoundFault
client

CertificateIdentifier doesn't refer to an existing certificate.

DBInstanceAlreadyExistsFault
client

You already have a instance with the given identifier.

DBInstanceNotFoundFault
client

DBInstanceIdentifier doesn't refer to an existing instance.

DBParameterGroupNotFoundFault
client

DBParameterGroupName doesn't refer to an existing parameter group.

DBSecurityGroupNotFoundFault
client

DBSecurityGroupName doesn't refer to an existing security group.

DBUpgradeDependencyFailureFault
client

The upgrade failed because a resource that the depends on can't be modified.

InsufficientDBInstanceCapacityFault
client

The specified instance class isn't available in the specified Availability Zone.

InvalidDBInstanceStateFault
client

The specified instance isn't in the available state.

InvalidDBSecurityGroupStateFault
client

The state of the security group doesn't allow deletion.

InvalidVPCNetworkStateFault
client

The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

StorageQuotaExceededFault
client

The request would cause you to exceed the allowed amount of storage available across all instances.

StorageTypeNotSupportedFault
client

Storage of the specified StorageType can't be associated with the DB instance.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.