import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ModifyDBClusterMessage, ModifyDBClusterResult } from "../models/models_1"; import type { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ModifyDBClusterCommand}. */ export interface ModifyDBClusterCommandInput extends ModifyDBClusterMessage { } /** * @public * * The output of {@link ModifyDBClusterCommand}. */ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __MetadataBearer { } declare const ModifyDBClusterCommand_base: { new (input: ModifyDBClusterCommandInput): import("@smithy/core/client").CommandImpl; new (input: ModifyDBClusterCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RDSClient, ModifyDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import * // const { RDSClient, ModifyDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import * // import type { RDSClientConfig } from "@aws-sdk/client-rds"; * const config = {}; // type is RDSClientConfig * const client = new RDSClient(config); * const input = { // ModifyDBClusterMessage * DBClusterIdentifier: "STRING_VALUE", // required * NewDBClusterIdentifier: "STRING_VALUE", * ApplyImmediately: true || false, * BackupRetentionPeriod: Number("int"), * DBClusterParameterGroupName: "STRING_VALUE", * VpcSecurityGroupIds: [ // VpcSecurityGroupIdList * "STRING_VALUE", * ], * Port: Number("int"), * MasterUserPassword: "STRING_VALUE", * OptionGroupName: "STRING_VALUE", * PreferredBackupWindow: "STRING_VALUE", * PreferredMaintenanceWindow: "STRING_VALUE", * EnableIAMDatabaseAuthentication: true || false, * BacktrackWindow: Number("long"), * CloudwatchLogsExportConfiguration: { // CloudwatchLogsExportConfiguration * EnableLogTypes: [ // LogTypeList * "STRING_VALUE", * ], * DisableLogTypes: [ * "STRING_VALUE", * ], * }, * EngineVersion: "STRING_VALUE", * AllowMajorVersionUpgrade: true || false, * DBInstanceParameterGroupName: "STRING_VALUE", * Domain: "STRING_VALUE", * DomainIAMRoleName: "STRING_VALUE", * ScalingConfiguration: { // ScalingConfiguration * MinCapacity: Number("int"), * MaxCapacity: Number("int"), * AutoPause: true || false, * SecondsUntilAutoPause: Number("int"), * TimeoutAction: "STRING_VALUE", * SecondsBeforeTimeout: Number("int"), * }, * DeletionProtection: true || false, * EnableHttpEndpoint: true || false, * CopyTagsToSnapshot: true || false, * EnableGlobalWriteForwarding: true || false, * DBClusterInstanceClass: "STRING_VALUE", * AllocatedStorage: Number("int"), * StorageType: "STRING_VALUE", * Iops: Number("int"), * AutoMinorVersionUpgrade: true || false, * NetworkType: "STRING_VALUE", * ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfiguration * MinCapacity: Number("double"), * MaxCapacity: Number("double"), * SecondsUntilAutoPause: Number("int"), * }, * MonitoringInterval: Number("int"), * MonitoringRoleArn: "STRING_VALUE", * DatabaseInsightsMode: "standard" || "advanced", * EnablePerformanceInsights: true || false, * PerformanceInsightsKMSKeyId: "STRING_VALUE", * PerformanceInsightsRetentionPeriod: Number("int"), * ManageMasterUserPassword: true || false, * RotateMasterUserPassword: true || false, * EnableLocalWriteForwarding: true || false, * MasterUserSecretKmsKeyId: "STRING_VALUE", * EngineMode: "STRING_VALUE", * AllowEngineModeChange: true || false, * AwsBackupRecoveryPointArn: "STRING_VALUE", * EnableLimitlessDatabase: true || false, * CACertificateIdentifier: "STRING_VALUE", * MasterUserAuthenticationType: "password" || "iam-db-auth", * }; * const command = new ModifyDBClusterCommand(input); * const response = await client.send(command); * // { // ModifyDBClusterResult * // DBCluster: { // DBCluster * // AllocatedStorage: Number("int"), * // AvailabilityZones: [ // AvailabilityZones * // "STRING_VALUE", * // ], * // BackupRetentionPeriod: Number("int"), * // CharacterSetName: "STRING_VALUE", * // DatabaseName: "STRING_VALUE", * // DBClusterIdentifier: "STRING_VALUE", * // DBClusterParameterGroup: "STRING_VALUE", * // DBSubnetGroup: "STRING_VALUE", * // Status: "STRING_VALUE", * // PercentProgress: "STRING_VALUE", * // EarliestRestorableTime: new Date("TIMESTAMP"), * // Endpoint: "STRING_VALUE", * // ReaderEndpoint: "STRING_VALUE", * // CustomEndpoints: [ // StringList * // "STRING_VALUE", * // ], * // MultiAZ: true || false, * // Engine: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // LatestRestorableTime: new Date("TIMESTAMP"), * // Port: Number("int"), * // MasterUsername: "STRING_VALUE", * // DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships * // { // DBClusterOptionGroupStatus * // DBClusterOptionGroupName: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // PreferredBackupWindow: "STRING_VALUE", * // PreferredMaintenanceWindow: "STRING_VALUE", * // UpgradeRolloutOrder: "first" || "second" || "last", * // ReplicationSourceIdentifier: "STRING_VALUE", * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList * // "STRING_VALUE", * // ], * // StatusInfos: [ // DBClusterStatusInfoList * // { // DBClusterStatusInfo * // StatusType: "STRING_VALUE", * // Normal: true || false, * // Status: "STRING_VALUE", * // Message: "STRING_VALUE", * // }, * // ], * // DBClusterMembers: [ // DBClusterMemberList * // { // DBClusterMember * // DBInstanceIdentifier: "STRING_VALUE", * // IsClusterWriter: true || false, * // DBClusterParameterGroupStatus: "STRING_VALUE", * // PromotionTier: Number("int"), * // }, * // ], * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList * // { // VpcSecurityGroupMembership * // VpcSecurityGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // HostedZoneId: "STRING_VALUE", * // StorageEncrypted: true || false, * // StorageEncryptionType: "none" || "sse-kms" || "sse-rds", * // KmsKeyId: "STRING_VALUE", * // DbClusterResourceId: "STRING_VALUE", * // DBClusterArn: "STRING_VALUE", * // AssociatedRoles: [ // DBClusterRoles * // { // DBClusterRole * // RoleArn: "STRING_VALUE", * // Status: "STRING_VALUE", * // FeatureName: "STRING_VALUE", * // }, * // ], * // IAMDatabaseAuthenticationEnabled: true || false, * // CloneGroupId: "STRING_VALUE", * // ClusterCreateTime: new Date("TIMESTAMP"), * // EarliestBacktrackTime: new Date("TIMESTAMP"), * // BacktrackWindow: Number("long"), * // BacktrackConsumedChangeRecords: Number("long"), * // EnabledCloudwatchLogsExports: [ // LogTypeList * // "STRING_VALUE", * // ], * // Capacity: Number("int"), * // PendingModifiedValues: { // ClusterPendingModifiedValues * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports * // LogTypesToEnable: [ * // "STRING_VALUE", * // ], * // LogTypesToDisable: [ * // "STRING_VALUE", * // ], * // }, * // DBClusterIdentifier: "STRING_VALUE", * // MasterUserPassword: "STRING_VALUE", * // IAMDatabaseAuthenticationEnabled: true || false, * // EngineVersion: "STRING_VALUE", * // BackupRetentionPeriod: Number("int"), * // StorageType: "STRING_VALUE", * // AllocatedStorage: Number("int"), * // RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration * // InterconnectSubnetId: "STRING_VALUE", * // TransitGatewayMulticastDomainId: "STRING_VALUE", * // ReplicaMode: "open-read-only" || "mounted", * // }, * // Iops: Number("int"), * // CertificateDetails: { // CertificateDetails * // CAIdentifier: "STRING_VALUE", * // ValidTill: new Date("TIMESTAMP"), * // }, * // }, * // EngineMode: "STRING_VALUE", * // ScalingConfigurationInfo: { // ScalingConfigurationInfo * // MinCapacity: Number("int"), * // MaxCapacity: Number("int"), * // AutoPause: true || false, * // SecondsUntilAutoPause: Number("int"), * // TimeoutAction: "STRING_VALUE", * // SecondsBeforeTimeout: Number("int"), * // }, * // RdsCustomClusterConfiguration: { * // InterconnectSubnetId: "STRING_VALUE", * // TransitGatewayMulticastDomainId: "STRING_VALUE", * // ReplicaMode: "open-read-only" || "mounted", * // }, * // DBClusterInstanceClass: "STRING_VALUE", * // StorageType: "STRING_VALUE", * // Iops: Number("int"), * // StorageThroughput: Number("int"), * // IOOptimizedNextAllowedModificationTime: new Date("TIMESTAMP"), * // PubliclyAccessible: true || false, * // AutoMinorVersionUpgrade: true || false, * // DeletionProtection: true || false, * // HttpEndpointEnabled: true || false, * // ActivityStreamMode: "sync" || "async", * // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping", * // ActivityStreamKmsKeyId: "STRING_VALUE", * // ActivityStreamKinesisStreamName: "STRING_VALUE", * // CopyTagsToSnapshot: true || false, * // CrossAccountClone: true || false, * // DomainMemberships: [ // DomainMembershipList * // { // DomainMembership * // Domain: "STRING_VALUE", * // Status: "STRING_VALUE", * // FQDN: "STRING_VALUE", * // IAMRoleName: "STRING_VALUE", * // OU: "STRING_VALUE", * // AuthSecretArn: "STRING_VALUE", * // DnsIps: [ * // "STRING_VALUE", * // ], * // }, * // ], * // TagList: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // GlobalClusterIdentifier: "STRING_VALUE", * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", * // GlobalWriteForwardingRequested: true || false, * // NetworkType: "STRING_VALUE", * // AutomaticRestartTime: new Date("TIMESTAMP"), * // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo * // MinCapacity: Number("double"), * // MaxCapacity: Number("double"), * // SecondsUntilAutoPause: Number("int"), * // }, * // ServerlessV2PlatformVersion: "STRING_VALUE", * // MonitoringInterval: Number("int"), * // MonitoringRoleArn: "STRING_VALUE", * // DatabaseInsightsMode: "standard" || "advanced", * // PerformanceInsightsEnabled: true || false, * // PerformanceInsightsKMSKeyId: "STRING_VALUE", * // PerformanceInsightsRetentionPeriod: Number("int"), * // DBSystemId: "STRING_VALUE", * // MasterUserSecret: { // MasterUserSecret * // SecretArn: "STRING_VALUE", * // SecretStatus: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // }, * // LocalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "requested", * // AwsBackupRecoveryPointArn: "STRING_VALUE", * // LimitlessDatabase: { // LimitlessDatabase * // Status: "active" || "not-in-use" || "enabled" || "disabled" || "enabling" || "disabling" || "modifying-max-capacity" || "error", * // MinRequiredACU: Number("double"), * // }, * // ClusterScalabilityType: "standard" || "limitless", * // CertificateDetails: { * // CAIdentifier: "STRING_VALUE", * // ValidTill: new Date("TIMESTAMP"), * // }, * // EngineLifecycleSupport: "STRING_VALUE", * // VPCNetworkingEnabled: true || false, * // InternetAccessGatewayEnabled: true || false, * // }, * // }; * * ``` * * @param ModifyDBClusterCommandInput - {@link ModifyDBClusterCommandInput} * @returns {@link ModifyDBClusterCommandOutput} * @see {@link ModifyDBClusterCommandInput} for command's `input` shape. * @see {@link ModifyDBClusterCommandOutput} for command's `response` shape. * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape. * * @throws {@link DBClusterAlreadyExistsFault} (client fault) *

The user already has a DB cluster with the given identifier.

* * @throws {@link DBClusterNotFoundFault} (client fault) *

DBClusterIdentifier doesn't refer to an existing DB cluster.

* * @throws {@link DBClusterParameterGroupNotFoundFault} (client fault) *

DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

* * @throws {@link DBInstanceAlreadyExistsFault} (client fault) *

The user already has a DB instance with the given identifier.

* * @throws {@link DBParameterGroupNotFoundFault} (client fault) *

DBParameterGroupName doesn't refer to an existing DB parameter group.

* * @throws {@link DBSubnetGroupNotFoundFault} (client fault) *

DBSubnetGroupName doesn't refer to an existing DB subnet group.

* * @throws {@link DomainNotFoundFault} (client fault) *

Domain doesn't refer to an existing Active Directory domain.

* * @throws {@link InvalidDBClusterStateFault} (client fault) *

The requested operation can't be performed while the cluster is in this state.

* * @throws {@link InvalidDBInstanceStateFault} (client fault) *

The DB instance isn't in a valid state.

* * @throws {@link InvalidDBSecurityGroupStateFault} (client fault) *

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

* * @throws {@link InvalidDBSubnetGroupStateFault} (client fault) *

The DB subnet group cannot be deleted because it's in use.

* * @throws {@link InvalidGlobalClusterStateFault} (client fault) *

The global cluster is in an invalid state and can't perform the requested operation.

* * @throws {@link InvalidSubnet} (client fault) *

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

* * @throws {@link InvalidVPCNetworkStateFault} (client fault) *

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

* * @throws {@link KMSKeyNotAccessibleFault} (client fault) *

An error occurred accessing an Amazon Web Services KMS key.

* * @throws {@link NetworkTypeNotSupported} (client fault) *

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

* * @throws {@link OptionGroupNotFoundFault} (client fault) *

The specified option group could not be found.

* * @throws {@link StorageQuotaExceededFault} (client fault) *

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

* * @throws {@link StorageTypeNotAvailableFault} (client fault) *

The aurora-iopt1 storage type isn't available, because you modified the DB cluster to use this storage type less than one month ago.

* * @throws {@link StorageTypeNotSupportedFault} (client fault) *

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

* * @throws {@link VpcEncryptionControlViolationException} (client fault) *

The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.

* * @throws {@link RDSServiceException} *

Base exception class for all service exceptions from RDS service.

* * * @example To modify a DB cluster * ```javascript * // The following example changes the master user password for the DB cluster named cluster-2 and sets the backup retention period to 14 days. The ApplyImmediately parameter causes the changes to be made immediately, instead of waiting until the next maintenance window. * const input = { * ApplyImmediately: true, * BackupRetentionPeriod: 14, * DBClusterIdentifier: "cluster-2", * MasterUserPassword: "newpassword99" * }; * const command = new ModifyDBClusterCommand(input); * const response = await client.send(command); * /* response is * { * DBCluster: { * AllocatedStorage: 1, * AssociatedRoles: [], * AvailabilityZones: [ * "eu-central-1b", * "eu-central-1c", * "eu-central-1a" * ], * BackupRetentionPeriod: 14, * ClusterCreateTime: "2020-04-03T14:44:02.764Z", * CopyTagsToSnapshot: true, * CrossAccountClone: false, * DBClusterArn: "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2", * DBClusterIdentifier: "cluster-2", * DBClusterMembers: [ * { * DBClusterParameterGroupStatus: "in-sync", * DBInstanceIdentifier: "cluster-2-instance-1", * IsClusterWriter: true, * PromotionTier: 1 * } * ], * DBClusterParameterGroup: "default.aurora5.6", * DBSubnetGroup: "default-vpc-2305ca49", * DatabaseName: "", * DbClusterResourceId: "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE", * DeletionProtection: false, * DomainMemberships: [], * EarliestRestorableTime: "2020-06-03T02:07:29.637Z", * Endpoint: "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com", * Engine: "aurora", * EngineMode: "provisioned", * EngineVersion: "5.6.10a", * HostedZoneId: "Z1RLNU0EXAMPLE", * HttpEndpointEnabled: false, * IAMDatabaseAuthenticationEnabled: false, * KmsKeyId: "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6", * LatestRestorableTime: "2020-06-04T15:11:25.748Z", * MasterUsername: "admin", * MultiAZ: false, * Port: 3306, * PreferredBackupWindow: "01:55-02:25", * PreferredMaintenanceWindow: "thu:21:14-thu:21:44", * ReadReplicaIdentifiers: [], * ReaderEndpoint: "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com", * Status: "available", * StorageEncrypted: true, * VpcSecurityGroups: [ * { * Status: "active", * VpcSecurityGroupId: "sg-20a5c047" * } * ] * } * } * *\/ * ``` * * @public */ export declare class ModifyDBClusterCommand extends ModifyDBClusterCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ModifyDBClusterMessage; output: ModifyDBClusterResult; }; sdk: { input: ModifyDBClusterCommandInput; output: ModifyDBClusterCommandOutput; }; }; }