import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ModifyDBClusterMessage, ModifyDBClusterResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @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(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database * configuration parameters by specifying these parameters and the new values in the * request.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DocDBClient, ModifyDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import * // const { DocDBClient, ModifyDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import * // import type { DocDBClientConfig } from "@aws-sdk/client-docdb"; * const config = {}; // type is DocDBClientConfig * const client = new DocDBClient(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", * PreferredBackupWindow: "STRING_VALUE", * PreferredMaintenanceWindow: "STRING_VALUE", * CloudwatchLogsExportConfiguration: { // CloudwatchLogsExportConfiguration * EnableLogTypes: [ // LogTypeList * "STRING_VALUE", * ], * DisableLogTypes: [ * "STRING_VALUE", * ], * }, * EngineVersion: "STRING_VALUE", * AllowMajorVersionUpgrade: true || false, * DeletionProtection: true || false, * StorageType: "STRING_VALUE", * ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfiguration * MinCapacity: Number("double"), * MaxCapacity: Number("double"), * }, * ManageMasterUserPassword: true || false, * MasterUserSecretKmsKeyId: "STRING_VALUE", * RotateMasterUserPassword: true || false, * NetworkType: "STRING_VALUE", * }; * const command = new ModifyDBClusterCommand(input); * const response = await client.send(command); * // { // ModifyDBClusterResult * // DBCluster: { // DBCluster * // AvailabilityZones: [ // AvailabilityZones * // "STRING_VALUE", * // ], * // BackupRetentionPeriod: Number("int"), * // 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", * // MultiAZ: true || false, * // Engine: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // LatestRestorableTime: new Date("TIMESTAMP"), * // Port: Number("int"), * // MasterUsername: "STRING_VALUE", * // PreferredBackupWindow: "STRING_VALUE", * // PreferredMaintenanceWindow: "STRING_VALUE", * // ReplicationSourceIdentifier: "STRING_VALUE", * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList * // "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, * // KmsKeyId: "STRING_VALUE", * // DbClusterResourceId: "STRING_VALUE", * // DBClusterArn: "STRING_VALUE", * // AssociatedRoles: [ // DBClusterRoles * // { // DBClusterRole * // RoleArn: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // CloneGroupId: "STRING_VALUE", * // ClusterCreateTime: new Date("TIMESTAMP"), * // EnabledCloudwatchLogsExports: [ // LogTypeList * // "STRING_VALUE", * // ], * // DeletionProtection: true || false, * // IOOptimizedNextAllowedModificationTime: new Date("TIMESTAMP"), * // StorageType: "STRING_VALUE", * // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo * // MinCapacity: Number("double"), * // MaxCapacity: Number("double"), * // }, * // MasterUserSecret: { // ClusterMasterUserSecret * // SecretArn: "STRING_VALUE", * // SecretStatus: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // }, * // NetworkType: "STRING_VALUE", * // }, * // }; * * ``` * * @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 DocDBClientResolvedConfig | config} for DocDBClient's `config` shape. * * @throws {@link DBClusterAlreadyExistsFault} (client fault) *

You already have a cluster with the given identifier.

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

* DBClusterIdentifier doesn't refer to an existing cluster.

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

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

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

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

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

The cluster isn't in a valid state.

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

The specified instance isn't in the available state. *

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

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

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

The subnet group can't be deleted because it's in use.

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

The requested subnet is not valid, or multiple subnets were requested that are not all * in a common virtual private cloud (VPC).

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

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

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

The network type is not supported by either DBSubnetGroup or the DB engine version.

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

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

* * @throws {@link DocDBServiceException} *

Base exception class for all service exceptions from DocDB service.

* * * @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; }; }; }