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 { ModifyReplicationGroupMessage, ModifyReplicationGroupResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ModifyReplicationGroupCommand}. */ export interface ModifyReplicationGroupCommandInput extends ModifyReplicationGroupMessage { } /** * @public * * The output of {@link ModifyReplicationGroupCommand}. */ export interface ModifyReplicationGroupCommandOutput extends ModifyReplicationGroupResult, __MetadataBearer { } declare const ModifyReplicationGroupCommand_base: { new (input: ModifyReplicationGroupCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: ModifyReplicationGroupCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.

* * *

This operation is valid for Valkey or Redis OSS only.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ElastiCacheClient, ModifyReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import * // const { ElastiCacheClient, ModifyReplicationGroupCommand } = 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 = { // ModifyReplicationGroupMessage * ReplicationGroupId: "STRING_VALUE", // required * ReplicationGroupDescription: "STRING_VALUE", * PrimaryClusterId: "STRING_VALUE", * SnapshottingClusterId: "STRING_VALUE", * AutomaticFailoverEnabled: true || false, * MultiAZEnabled: true || false, * NodeGroupId: "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", * UserGroupIdsToAdd: [ // UserGroupIdList * "STRING_VALUE", * ], * UserGroupIdsToRemove: [ * "STRING_VALUE", * ], * RemoveUserGroups: true || false, * 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", * TransitEncryptionEnabled: true || false, * TransitEncryptionMode: "preferred" || "required", * ClusterMode: "enabled" || "disabled" || "compatible", * }; * const command = new ModifyReplicationGroupCommand(input); * const response = await client.send(command); * // { // ModifyReplicationGroupResult * // ReplicationGroup: { // ReplicationGroup * // ReplicationGroupId: "STRING_VALUE", * // Description: "STRING_VALUE", * // GlobalReplicationGroupInfo: { // GlobalReplicationGroupInfo * // GlobalReplicationGroupId: "STRING_VALUE", * // GlobalReplicationGroupMemberRole: "STRING_VALUE", * // }, * // Status: "STRING_VALUE", * // PendingModifiedValues: { // ReplicationGroupPendingModifiedValues * // PrimaryClusterId: "STRING_VALUE", * // AutomaticFailoverStatus: "enabled" || "disabled", * // Resharding: { // ReshardingStatus * // SlotMigration: { // SlotMigration * // ProgressPercentage: Number("double"), * // }, * // }, * // AuthTokenStatus: "SETTING" || "ROTATING", * // UserGroups: { // UserGroupsUpdateStatus * // UserGroupIdsToAdd: [ // UserGroupIdList * // "STRING_VALUE", * // ], * // UserGroupIdsToRemove: [ * // "STRING_VALUE", * // ], * // }, * // 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", * // ClusterMode: "enabled" || "disabled" || "compatible", * // }, * // MemberClusters: [ // ClusterIdList * // "STRING_VALUE", * // ], * // NodeGroups: [ // NodeGroupList * // { // NodeGroup * // NodeGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // PrimaryEndpoint: { // Endpoint * // Address: "STRING_VALUE", * // Port: Number("int"), * // }, * // ReaderEndpoint: { * // Address: "STRING_VALUE", * // Port: Number("int"), * // }, * // Slots: "STRING_VALUE", * // NodeGroupMembers: [ // NodeGroupMemberList * // { // NodeGroupMember * // CacheClusterId: "STRING_VALUE", * // CacheNodeId: "STRING_VALUE", * // ReadEndpoint: { * // Address: "STRING_VALUE", * // Port: Number("int"), * // }, * // PreferredAvailabilityZone: "STRING_VALUE", * // PreferredOutpostArn: "STRING_VALUE", * // CurrentRole: "STRING_VALUE", * // }, * // ], * // }, * // ], * // SnapshottingClusterId: "STRING_VALUE", * // AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling", * // MultiAZ: "enabled" || "disabled", * // ConfigurationEndpoint: "", * // SnapshotRetentionLimit: Number("int"), * // SnapshotWindow: "STRING_VALUE", * // ClusterEnabled: true || false, * // CacheNodeType: "STRING_VALUE", * // AuthTokenEnabled: true || false, * // AuthTokenLastModifiedDate: new Date("TIMESTAMP"), * // TransitEncryptionEnabled: true || false, * // AtRestEncryptionEnabled: true || false, * // MemberClustersOutpostArns: [ // ReplicationGroupOutpostArnList * // "STRING_VALUE", * // ], * // KmsKeyId: "STRING_VALUE", * // ARN: "STRING_VALUE", * // UserGroupIds: [ * // "STRING_VALUE", * // ], * // 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", * // }, * // ], * // ReplicationGroupCreateTime: new Date("TIMESTAMP"), * // DataTiering: "enabled" || "disabled", * // AutoMinorVersionUpgrade: true || false, * // NetworkType: "ipv4" || "ipv6" || "dual_stack", * // IpDiscovery: "ipv4" || "ipv6", * // TransitEncryptionMode: "preferred" || "required", * // ClusterMode: "enabled" || "disabled" || "compatible", * // Engine: "STRING_VALUE", * // }, * // }; * * ``` * * @param ModifyReplicationGroupCommandInput - {@link ModifyReplicationGroupCommandInput} * @returns {@link ModifyReplicationGroupCommandOutput} * @see {@link ModifyReplicationGroupCommandInput} for command's `input` shape. * @see {@link ModifyReplicationGroupCommandOutput} 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 InvalidKMSKeyFault} (client fault) *

The KMS key supplied is not valid.

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

The requested replication group is not in the available state.

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

The user group is not in an active state.

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

The specified replication group does not exist.

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

The user group was not found or does not exist

* * @throws {@link ElastiCacheServiceException} *

Base exception class for all service exceptions from ElastiCache service.

* * * @example ModifyReplicationGroup * ```javascript * // * const input = { * ApplyImmediately: true, * ReplicationGroupDescription: "Modified replication group", * ReplicationGroupId: "my-redis-rg", * SnapshotRetentionLimit: 30, * SnapshottingClusterId: "my-redis-rg-001" * }; * const command = new ModifyReplicationGroupCommand(input); * const response = await client.send(command); * /* response is * { * ReplicationGroup: { * AutomaticFailover: "enabled", * Description: "Modified replication group", * MemberClusters: [ * "my-redis-rg-001", * "my-redis-rg-002", * "my-redis-rg-003" * ], * NodeGroups: [ * { * NodeGroupId: "0001", * NodeGroupMembers: [ * { * CacheClusterId: "my-redis-rg-001", * CacheNodeId: "0001", * CurrentRole: "primary", * PreferredAvailabilityZone: "us-east-1b", * ReadEndpoint: { * Address: "my-redis-rg-001.abcdef.0001.use1.cache.amazonaws.com", * Port: 6379 * } * }, * { * CacheClusterId: "my-redis-rg-002", * CacheNodeId: "0001", * CurrentRole: "replica", * PreferredAvailabilityZone: "us-east-1a", * ReadEndpoint: { * Address: "my-redis-rg-002.abcdef.0001.use1.cache.amazonaws.com", * Port: 6379 * } * }, * { * CacheClusterId: "my-redis-rg-003", * CacheNodeId: "0001", * CurrentRole: "replica", * PreferredAvailabilityZone: "us-east-1c", * ReadEndpoint: { * Address: "my-redis-rg-003.abcdef.0001.use1.cache.amazonaws.com", * Port: 6379 * } * } * ], * PrimaryEndpoint: { * Address: "my-redis-rg.abcdef.ng.0001.use1.cache.amazonaws.com", * Port: 6379 * }, * Status: "available" * } * ], * PendingModifiedValues: { /* empty *\/ }, * ReplicationGroupId: "my-redis-rg", * SnapshottingClusterId: "my-redis-rg-002", * Status: "available" * } * } * *\/ * ``` * * @public */ export declare class ModifyReplicationGroupCommand extends ModifyReplicationGroupCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ModifyReplicationGroupMessage; output: ModifyReplicationGroupResult; }; sdk: { input: ModifyReplicationGroupCommandInput; output: ModifyReplicationGroupCommandOutput; }; }; }