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

Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

This operation only applies to Aurora global database clusters.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RDSClient, ModifyGlobalClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import * // const { RDSClient, ModifyGlobalClusterCommand } = 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 = { // ModifyGlobalClusterMessage * GlobalClusterIdentifier: "STRING_VALUE", // required * NewGlobalClusterIdentifier: "STRING_VALUE", * DeletionProtection: true || false, * EngineVersion: "STRING_VALUE", * AllowMajorVersionUpgrade: true || false, * }; * const command = new ModifyGlobalClusterCommand(input); * const response = await client.send(command); * // { // ModifyGlobalClusterResult * // GlobalCluster: { // GlobalCluster * // GlobalClusterIdentifier: "STRING_VALUE", * // GlobalClusterResourceId: "STRING_VALUE", * // GlobalClusterArn: "STRING_VALUE", * // Status: "STRING_VALUE", * // Engine: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // EngineLifecycleSupport: "STRING_VALUE", * // DatabaseName: "STRING_VALUE", * // StorageEncrypted: true || false, * // StorageEncryptionType: "none" || "sse-kms" || "sse-rds", * // DeletionProtection: true || false, * // GlobalClusterMembers: [ // GlobalClusterMemberList * // { // GlobalClusterMember * // DBClusterArn: "STRING_VALUE", * // Readers: [ // ReadersArnList * // "STRING_VALUE", * // ], * // IsWriter: true || false, * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", * // SynchronizationStatus: "connected" || "pending-resync", * // }, * // ], * // Endpoint: "STRING_VALUE", * // FailoverState: { // FailoverState * // Status: "pending" || "failing-over" || "cancelling", * // FromDbClusterArn: "STRING_VALUE", * // ToDbClusterArn: "STRING_VALUE", * // IsDataLossAllowed: true || false, * // }, * // TagList: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // }, * // }; * * ``` * * @param ModifyGlobalClusterCommandInput - {@link ModifyGlobalClusterCommandInput} * @returns {@link ModifyGlobalClusterCommandOutput} * @see {@link ModifyGlobalClusterCommandInput} for command's `input` shape. * @see {@link ModifyGlobalClusterCommandOutput} for command's `response` shape. * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape. * * @throws {@link GlobalClusterAlreadyExistsFault} (client fault) *

The GlobalClusterIdentifier already exists. Specify a new global database identifier (unique name) to create a new global database cluster or to rename an existing one.

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

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

* * @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 InvalidGlobalClusterStateFault} (client fault) *

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

* * @throws {@link RDSServiceException} *

Base exception class for all service exceptions from RDS service.

* * * @example To modify a global database cluster * ```javascript * // The following example enables deletion protection for an Aurora MySQL-based global database cluster. * const input = { * DeletionProtection: true, * GlobalClusterIdentifier: "myglobalcluster" * }; * const command = new ModifyGlobalClusterCommand(input); * const response = await client.send(command); * /* response is * { * GlobalCluster: { * DeletionProtection: true, * Engine: "aurora-mysql", * EngineVersion: "5.7.mysql_aurora.2.07.2", * GlobalClusterArn: "arn:aws:rds::123456789012:global-cluster:myglobalcluster", * GlobalClusterIdentifier: "myglobalcluster", * GlobalClusterMembers: [], * GlobalClusterResourceId: "cluster-f0e523bfe07aabb", * Status: "available", * StorageEncrypted: false * } * } * *\/ * ``` * * @public */ export declare class ModifyGlobalClusterCommand extends ModifyGlobalClusterCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ModifyGlobalClusterMessage; output: ModifyGlobalClusterResult; }; sdk: { input: ModifyGlobalClusterCommandInput; output: ModifyGlobalClusterCommandOutput; }; }; }