import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient"; import type { ModifyCacheClusterMessage, ModifyCacheClusterResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ModifyCacheClusterCommand}. */ export interface ModifyCacheClusterCommandInput extends ModifyCacheClusterMessage { } /** * @public * * The output of {@link ModifyCacheClusterCommand}. */ export interface ModifyCacheClusterCommandOutput extends ModifyCacheClusterResult, __MetadataBearer { } declare const ModifyCacheClusterCommand_base: { new (input: ModifyCacheClusterCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: ModifyCacheClusterCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Modifies the settings for a cluster. You can use this operation to change one or more * cluster configuration parameters by specifying the parameters and the new values.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ElastiCacheClient, ModifyCacheClusterCommand } from "@aws-sdk/client-elasticache"; // ES Modules import * // const { ElastiCacheClient, ModifyCacheClusterCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import * // import type { ElastiCacheClientConfig } from "@aws-sdk/client-elasticache"; * const config = {}; // type is ElastiCacheClientConfig * const client = new ElastiCacheClient(config); * const input = { // ModifyCacheClusterMessage * CacheClusterId: "STRING_VALUE", // required * NumCacheNodes: Number("int"), * CacheNodeIdsToRemove: [ // CacheNodeIdsList * "STRING_VALUE", * ], * AZMode: "single-az" || "cross-az", * NewAvailabilityZones: [ // PreferredAvailabilityZoneList * "STRING_VALUE", * ], * CacheSecurityGroupNames: [ // CacheSecurityGroupNameList * "STRING_VALUE", * ], * SecurityGroupIds: [ // SecurityGroupIdsList * "STRING_VALUE", * ], * PreferredMaintenanceWindow: "STRING_VALUE", * NotificationTopicArn: "STRING_VALUE", * CacheParameterGroupName: "STRING_VALUE", * NotificationTopicStatus: "STRING_VALUE", * ApplyImmediately: true || false, * Engine: "STRING_VALUE", * EngineVersion: "STRING_VALUE", * AutoMinorVersionUpgrade: true || false, * SnapshotRetentionLimit: Number("int"), * SnapshotWindow: "STRING_VALUE", * CacheNodeType: "STRING_VALUE", * AuthToken: "STRING_VALUE", * AuthTokenUpdateStrategy: "SET" || "ROTATE" || "DELETE", * LogDeliveryConfigurations: [ // LogDeliveryConfigurationRequestList * { // LogDeliveryConfigurationRequest * LogType: "slow-log" || "engine-log", * DestinationType: "cloudwatch-logs" || "kinesis-firehose", * DestinationDetails: { // DestinationDetails * CloudWatchLogsDetails: { // CloudWatchLogsDestinationDetails * LogGroup: "STRING_VALUE", * }, * KinesisFirehoseDetails: { // KinesisFirehoseDestinationDetails * DeliveryStream: "STRING_VALUE", * }, * }, * LogFormat: "text" || "json", * Enabled: true || false, * }, * ], * IpDiscovery: "ipv4" || "ipv6", * ScaleConfig: { // ScaleConfig * ScalePercentage: Number("int"), * ScaleIntervalMinutes: Number("int"), * }, * }; * const command = new ModifyCacheClusterCommand(input); * const response = await client.send(command); * // { // ModifyCacheClusterResult * // CacheCluster: { // CacheCluster * // CacheClusterId: "STRING_VALUE", * // ConfigurationEndpoint: { // Endpoint * // Address: "STRING_VALUE", * // Port: Number("int"), * // }, * // ClientDownloadLandingPage: "STRING_VALUE", * // CacheNodeType: "STRING_VALUE", * // Engine: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // CacheClusterStatus: "STRING_VALUE", * // NumCacheNodes: Number("int"), * // PreferredAvailabilityZone: "STRING_VALUE", * // PreferredOutpostArn: "STRING_VALUE", * // CacheClusterCreateTime: new Date("TIMESTAMP"), * // PreferredMaintenanceWindow: "STRING_VALUE", * // PendingModifiedValues: { // PendingModifiedValues * // NumCacheNodes: Number("int"), * // CacheNodeIdsToRemove: [ // CacheNodeIdsList * // "STRING_VALUE", * // ], * // EngineVersion: "STRING_VALUE", * // CacheNodeType: "STRING_VALUE", * // AuthTokenStatus: "SETTING" || "ROTATING", * // LogDeliveryConfigurations: [ // PendingLogDeliveryConfigurationList * // { // PendingLogDeliveryConfiguration * // LogType: "slow-log" || "engine-log", * // DestinationType: "cloudwatch-logs" || "kinesis-firehose", * // DestinationDetails: { // DestinationDetails * // CloudWatchLogsDetails: { // CloudWatchLogsDestinationDetails * // LogGroup: "STRING_VALUE", * // }, * // KinesisFirehoseDetails: { // KinesisFirehoseDestinationDetails * // DeliveryStream: "STRING_VALUE", * // }, * // }, * // LogFormat: "text" || "json", * // }, * // ], * // TransitEncryptionEnabled: true || false, * // TransitEncryptionMode: "preferred" || "required", * // ScaleConfig: { // ScaleConfig * // ScalePercentage: Number("int"), * // ScaleIntervalMinutes: Number("int"), * // }, * // }, * // NotificationConfiguration: { // NotificationConfiguration * // TopicArn: "STRING_VALUE", * // TopicStatus: "STRING_VALUE", * // }, * // CacheSecurityGroups: [ // CacheSecurityGroupMembershipList * // { // CacheSecurityGroupMembership * // CacheSecurityGroupName: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // CacheParameterGroup: { // CacheParameterGroupStatus * // CacheParameterGroupName: "STRING_VALUE", * // ParameterApplyStatus: "STRING_VALUE", * // CacheNodeIdsToReboot: [ * // "STRING_VALUE", * // ], * // }, * // CacheSubnetGroupName: "STRING_VALUE", * // CacheNodes: [ // CacheNodeList * // { // CacheNode * // CacheNodeId: "STRING_VALUE", * // CacheNodeStatus: "STRING_VALUE", * // CacheNodeCreateTime: new Date("TIMESTAMP"), * // Endpoint: { * // Address: "STRING_VALUE", * // Port: Number("int"), * // }, * // ParameterGroupStatus: "STRING_VALUE", * // SourceCacheNodeId: "STRING_VALUE", * // CustomerAvailabilityZone: "STRING_VALUE", * // CustomerOutpostArn: "STRING_VALUE", * // }, * // ], * // AutoMinorVersionUpgrade: true || false, * // SecurityGroups: [ // SecurityGroupMembershipList * // { // SecurityGroupMembership * // SecurityGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // ReplicationGroupId: "STRING_VALUE", * // SnapshotRetentionLimit: Number("int"), * // SnapshotWindow: "STRING_VALUE", * // AuthTokenEnabled: true || false, * // AuthTokenLastModifiedDate: new Date("TIMESTAMP"), * // TransitEncryptionEnabled: true || false, * // AtRestEncryptionEnabled: true || false, * // ARN: "STRING_VALUE", * // ReplicationGroupLogDeliveryEnabled: true || false, * // LogDeliveryConfigurations: [ // LogDeliveryConfigurationList * // { // LogDeliveryConfiguration * // LogType: "slow-log" || "engine-log", * // DestinationType: "cloudwatch-logs" || "kinesis-firehose", * // DestinationDetails: { * // CloudWatchLogsDetails: { * // LogGroup: "STRING_VALUE", * // }, * // KinesisFirehoseDetails: { * // DeliveryStream: "STRING_VALUE", * // }, * // }, * // LogFormat: "text" || "json", * // Status: "active" || "enabling" || "modifying" || "disabling" || "error", * // Message: "STRING_VALUE", * // }, * // ], * // NetworkType: "ipv4" || "ipv6" || "dual_stack", * // IpDiscovery: "ipv4" || "ipv6", * // TransitEncryptionMode: "preferred" || "required", * // }, * // }; * * ``` * * @param ModifyCacheClusterCommandInput - {@link ModifyCacheClusterCommandInput} * @returns {@link ModifyCacheClusterCommandOutput} * @see {@link ModifyCacheClusterCommandInput} for command's `input` shape. * @see {@link ModifyCacheClusterCommandOutput} for command's `response` shape. * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link CacheClusterNotFoundFault} (client fault) *

The requested cluster ID does not refer to an existing cluster.

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

The requested cache parameter group name does not refer to an existing cache parameter * group.

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

The requested cache security group name does not refer to an existing cache security * group.

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

The requested cache node type is not available in the specified Availability Zone. For * more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

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

The requested cluster is not in the available state.

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

The current state of the cache security group does not allow deletion.

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

Two or more incompatible parameters were specified.

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

The value for a parameter is invalid.

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

The VPC network is in an invalid state.

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

The request cannot be processed because it would exceed the allowed number of cache * nodes in a single cluster.

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

The request cannot be processed because it would exceed the allowed number of cache * nodes per customer.

* * @throws {@link ElastiCacheServiceException} *

Base exception class for all service exceptions from ElastiCache service.

* * * @example ModifyCacheCluster * ```javascript * // Copies a snapshot to a specified name. * const input = { * ApplyImmediately: true, * CacheClusterId: "redis-cluster", * SnapshotRetentionLimit: 14 * }; * const command = new ModifyCacheClusterCommand(input); * const response = await client.send(command); * /* response is * { * CacheCluster: { * AutoMinorVersionUpgrade: true, * CacheClusterCreateTime: "2016-12-22T16:27:56.078Z", * CacheClusterId: "redis-cluster", * CacheClusterStatus: "available", * CacheNodeType: "cache.r3.large", * CacheParameterGroup: { * CacheNodeIdsToReboot: [], * CacheParameterGroupName: "default.redis3.2", * ParameterApplyStatus: "in-sync" * }, * CacheSecurityGroups: [], * CacheSubnetGroupName: "default", * ClientDownloadLandingPage: "https://console.aws.amazon.com/elasticache/home#client-download:", * Engine: "redis", * EngineVersion: "3.2.4", * NumCacheNodes: 1, * PendingModifiedValues: { /* empty *\/ }, * PreferredAvailabilityZone: "us-east-1e", * PreferredMaintenanceWindow: "fri:09:00-fri:10:00", * SnapshotRetentionLimit: 14, * SnapshotWindow: "07:00-08:00" * } * } * *\/ * ``` * * @public */ export declare class ModifyCacheClusterCommand extends ModifyCacheClusterCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ModifyCacheClusterMessage; output: ModifyCacheClusterResult; }; sdk: { input: ModifyCacheClusterCommandInput; output: ModifyCacheClusterCommandOutput; }; }; }