@aws-sdk/client-elasticache 3.288.0 → 3.290.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +72 -0
- package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +29 -0
- package/dist-types/commands/BatchApplyUpdateActionCommand.d.ts +7 -0
- package/dist-types/commands/BatchStopUpdateActionCommand.d.ts +7 -0
- package/dist-types/commands/CompleteMigrationCommand.d.ts +10 -0
- package/dist-types/commands/CopySnapshotCommand.d.ts +67 -0
- package/dist-types/commands/CreateCacheClusterCommand.d.ts +86 -0
- package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +41 -0
- package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +28 -0
- package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +66 -0
- package/dist-types/commands/CreateGlobalReplicationGroupCommand.d.ts +16 -0
- package/dist-types/commands/CreateReplicationGroupCommand.d.ts +153 -0
- package/dist-types/commands/CreateSnapshotCommand.d.ts +130 -0
- package/dist-types/commands/CreateUserCommand.d.ts +22 -0
- package/dist-types/commands/CreateUserGroupCommand.d.ts +25 -0
- package/dist-types/commands/DecreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +13 -0
- package/dist-types/commands/DecreaseReplicaCountCommand.d.ts +39 -0
- package/dist-types/commands/DeleteCacheClusterCommand.d.ts +72 -0
- package/dist-types/commands/DeleteCacheParameterGroupCommand.d.ts +24 -0
- package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +24 -0
- package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +18 -0
- package/dist-types/commands/DeleteGlobalReplicationGroupCommand.d.ts +10 -0
- package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +55 -0
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +56 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
- package/dist-types/commands/DeleteUserGroupCommand.d.ts +13 -0
- package/dist-types/commands/DescribeCacheClustersCommand.d.ts +52 -0
- package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts +100 -0
- package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts +32 -0
- package/dist-types/commands/DescribeCacheParametersCommand.d.ts +413 -0
- package/dist-types/commands/DescribeCacheSecurityGroupsCommand.d.ts +21 -0
- package/dist-types/commands/DescribeCacheSubnetGroupsCommand.d.ts +53 -0
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +621 -0
- package/dist-types/commands/DescribeEventsCommand.d.ts +56 -0
- package/dist-types/commands/DescribeGlobalReplicationGroupsCommand.d.ts +10 -0
- package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +73 -0
- package/dist-types/commands/DescribeReservedCacheNodesCommand.d.ts +21 -0
- package/dist-types/commands/DescribeReservedCacheNodesOfferingsCommand.d.ts +283 -0
- package/dist-types/commands/DescribeServiceUpdatesCommand.d.ts +10 -0
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +59 -0
- package/dist-types/commands/DescribeUpdateActionsCommand.d.ts +7 -0
- package/dist-types/commands/DescribeUserGroupsCommand.d.ts +10 -0
- package/dist-types/commands/DescribeUsersCommand.d.ts +10 -0
- package/dist-types/commands/DisassociateGlobalReplicationGroupCommand.d.ts +13 -0
- package/dist-types/commands/FailoverGlobalReplicationGroupCommand.d.ts +13 -0
- package/dist-types/commands/IncreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +10 -0
- package/dist-types/commands/IncreaseReplicaCountCommand.d.ts +39 -0
- package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +38 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +59 -0
- package/dist-types/commands/ModifyCacheClusterCommand.d.ts +75 -0
- package/dist-types/commands/ModifyCacheParameterGroupCommand.d.ts +42 -0
- package/dist-types/commands/ModifyCacheSubnetGroupCommand.d.ts +72 -0
- package/dist-types/commands/ModifyGlobalReplicationGroupCommand.d.ts +10 -0
- package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +124 -0
- package/dist-types/commands/ModifyReplicationGroupShardConfigurationCommand.d.ts +33 -0
- package/dist-types/commands/ModifyUserCommand.d.ts +16 -0
- package/dist-types/commands/ModifyUserGroupCommand.d.ts +25 -0
- package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts +30 -0
- package/dist-types/commands/RebalanceSlotsInGlobalReplicationGroupCommand.d.ts +10 -0
- package/dist-types/commands/RebootCacheClusterCommand.d.ts +51 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +79 -0
- package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts +33 -0
- package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts +29 -0
- package/dist-types/commands/StartMigrationCommand.d.ts +13 -0
- package/dist-types/commands/TestFailoverCommand.d.ts +29 -0
- package/package.json +30 -30
|
@@ -33,6 +33,44 @@ export interface ListAllowedNodeTypeModificationsCommandOutput extends AllowedNo
|
|
|
33
33
|
* @see {@link ListAllowedNodeTypeModificationsCommandOutput} for command's `response` shape.
|
|
34
34
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
35
35
|
*
|
|
36
|
+
* @throws {@link CacheClusterNotFoundFault} (client fault)
|
|
37
|
+
* <p>The requested cluster ID does not refer to an existing cluster.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
40
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
43
|
+
* <p>The value for a parameter is invalid.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
46
|
+
* <p>The specified replication group does not exist.</p>
|
|
47
|
+
*
|
|
48
|
+
*
|
|
49
|
+
* @example ListAllowedNodeTypeModifications
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "ReplicationGroupId": "myreplgroup"
|
|
54
|
+
* };
|
|
55
|
+
* const command = new ListAllowedNodeTypeModificationsCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* /* response ==
|
|
58
|
+
* {
|
|
59
|
+
* "ScaleUpModifications": [
|
|
60
|
+
* "cache.m4.10xlarge",
|
|
61
|
+
* "cache.m4.2xlarge",
|
|
62
|
+
* "cache.m4.4xlarge",
|
|
63
|
+
* "cache.m4.xlarge",
|
|
64
|
+
* "cache.r3.2xlarge",
|
|
65
|
+
* "cache.r3.4xlarge",
|
|
66
|
+
* "cache.r3.8xlarge",
|
|
67
|
+
* "cache.r3.xlarge"
|
|
68
|
+
* ]
|
|
69
|
+
* }
|
|
70
|
+
* *\/
|
|
71
|
+
* // example id: listallowednodetypemodifications-1481748494872
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
36
74
|
*/
|
|
37
75
|
export declare class ListAllowedNodeTypeModificationsCommand extends $Command<ListAllowedNodeTypeModificationsCommandInput, ListAllowedNodeTypeModificationsCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
38
76
|
readonly input: ListAllowedNodeTypeModificationsCommandInput;
|
|
@@ -34,6 +34,65 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
|
|
|
34
34
|
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link CacheClusterNotFoundFault} (client fault)
|
|
38
|
+
* <p>The requested cluster ID does not refer to an existing cluster.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
41
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
44
|
+
* <p>The requested cache security group name does not refer to an existing cache security group.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link CacheSubnetGroupNotFoundFault} (client fault)
|
|
47
|
+
* <p>The requested cache subnet group name does not refer to an existing cache subnet group.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InvalidARNFault} (client fault)
|
|
50
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link InvalidReplicationGroupStateFault} (client fault)
|
|
53
|
+
* <p>The requested replication group is not in the <code>available</code> state.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
56
|
+
* <p>The specified replication group does not exist.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ReservedCacheNodeNotFoundFault} (client fault)
|
|
59
|
+
* <p>The requested reserved cache node was not found.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link SnapshotNotFoundFault} (client fault)
|
|
62
|
+
* <p>The requested snapshot name does not refer to an existing snapshot.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link UserGroupNotFoundFault} (client fault)
|
|
65
|
+
* <p>The user group was not found or does not exist</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link UserNotFoundFault} (client fault)
|
|
68
|
+
* <p>The user does not exist or could not be found.</p>
|
|
69
|
+
*
|
|
70
|
+
*
|
|
71
|
+
* @example ListTagsForResource
|
|
72
|
+
* ```javascript
|
|
73
|
+
* // Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.
|
|
74
|
+
* const input = {
|
|
75
|
+
* "ResourceName": "arn:aws:elasticache:us-west-2:<my-account-id>:cluster:mycluster"
|
|
76
|
+
* };
|
|
77
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
78
|
+
* const response = await client.send(command);
|
|
79
|
+
* /* response ==
|
|
80
|
+
* {
|
|
81
|
+
* "TagList": [
|
|
82
|
+
* {
|
|
83
|
+
* "Key": "APIVersion",
|
|
84
|
+
* "Value": "20150202"
|
|
85
|
+
* },
|
|
86
|
+
* {
|
|
87
|
+
* "Key": "Service",
|
|
88
|
+
* "Value": "ElastiCache"
|
|
89
|
+
* }
|
|
90
|
+
* ]
|
|
91
|
+
* }
|
|
92
|
+
* *\/
|
|
93
|
+
* // example id: listtagsforresource-1481748784584
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
37
96
|
*/
|
|
38
97
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
39
98
|
readonly input: ListTagsForResourceCommandInput;
|
|
@@ -31,6 +31,81 @@ export interface ModifyCacheClusterCommandOutput extends ModifyCacheClusterResul
|
|
|
31
31
|
* @see {@link ModifyCacheClusterCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link CacheClusterNotFoundFault} (client fault)
|
|
35
|
+
* <p>The requested cluster ID does not refer to an existing cluster.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
38
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
41
|
+
* <p>The requested cache security group name does not refer to an existing cache security group.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
|
|
44
|
+
* <p>The requested cache node type is not available in the specified Availability Zone.
|
|
45
|
+
* For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidCacheClusterStateFault} (client fault)
|
|
48
|
+
* <p>The requested cluster is not in the <code>available</code> state.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InvalidCacheSecurityGroupStateFault} (client fault)
|
|
51
|
+
* <p>The current state of the cache security group does not allow deletion.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
54
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
57
|
+
* <p>The value for a parameter is invalid.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InvalidVPCNetworkStateFault} (client fault)
|
|
60
|
+
* <p>The VPC network is in an invalid state.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link NodeQuotaForClusterExceededFault} (client fault)
|
|
63
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link NodeQuotaForCustomerExceededFault} (client fault)
|
|
66
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache nodes per customer.</p>
|
|
67
|
+
*
|
|
68
|
+
*
|
|
69
|
+
* @example ModifyCacheCluster
|
|
70
|
+
* ```javascript
|
|
71
|
+
* // Copies a snapshot to a specified name.
|
|
72
|
+
* const input = {
|
|
73
|
+
* "ApplyImmediately": true,
|
|
74
|
+
* "CacheClusterId": "redis-cluster",
|
|
75
|
+
* "SnapshotRetentionLimit": 14
|
|
76
|
+
* };
|
|
77
|
+
* const command = new ModifyCacheClusterCommand(input);
|
|
78
|
+
* const response = await client.send(command);
|
|
79
|
+
* /* response ==
|
|
80
|
+
* {
|
|
81
|
+
* "CacheCluster": {
|
|
82
|
+
* "AutoMinorVersionUpgrade": true,
|
|
83
|
+
* "CacheClusterCreateTime": "2016-12-22T16:27:56.078Z",
|
|
84
|
+
* "CacheClusterId": "redis-cluster",
|
|
85
|
+
* "CacheClusterStatus": "available",
|
|
86
|
+
* "CacheNodeType": "cache.r3.large",
|
|
87
|
+
* "CacheParameterGroup": {
|
|
88
|
+
* "CacheNodeIdsToReboot": [],
|
|
89
|
+
* "CacheParameterGroupName": "default.redis3.2",
|
|
90
|
+
* "ParameterApplyStatus": "in-sync"
|
|
91
|
+
* },
|
|
92
|
+
* "CacheSecurityGroups": [],
|
|
93
|
+
* "CacheSubnetGroupName": "default",
|
|
94
|
+
* "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
|
|
95
|
+
* "Engine": "redis",
|
|
96
|
+
* "EngineVersion": "3.2.4",
|
|
97
|
+
* "NumCacheNodes": 1,
|
|
98
|
+
* "PendingModifiedValues": {},
|
|
99
|
+
* "PreferredAvailabilityZone": "us-east-1e",
|
|
100
|
+
* "PreferredMaintenanceWindow": "fri:09:00-fri:10:00",
|
|
101
|
+
* "SnapshotRetentionLimit": 14,
|
|
102
|
+
* "SnapshotWindow": "07:00-08:00"
|
|
103
|
+
* }
|
|
104
|
+
* }
|
|
105
|
+
* *\/
|
|
106
|
+
* // example id: modifycachecluster-1482962725919
|
|
107
|
+
* ```
|
|
108
|
+
*
|
|
34
109
|
*/
|
|
35
110
|
export declare class ModifyCacheClusterCommand extends $Command<ModifyCacheClusterCommandInput, ModifyCacheClusterCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
36
111
|
readonly input: ModifyCacheClusterCommandInput;
|
|
@@ -31,6 +31,48 @@ export interface ModifyCacheParameterGroupCommandOutput extends CacheParameterGr
|
|
|
31
31
|
* @see {@link ModifyCacheParameterGroupCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
35
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InvalidCacheParameterGroupStateFault} (client fault)
|
|
38
|
+
* <p>The current state of the cache parameter group does not allow the requested operation to occur.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InvalidGlobalReplicationGroupStateFault} (client fault)
|
|
41
|
+
* <p>The Global datastore is not available or in primary-only state.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
44
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
47
|
+
* <p>The value for a parameter is invalid.</p>
|
|
48
|
+
*
|
|
49
|
+
*
|
|
50
|
+
* @example ModifyCacheParameterGroup
|
|
51
|
+
* ```javascript
|
|
52
|
+
* // Modifies one or more parameter values in the specified parameter group. You cannot modify any default parameter group.
|
|
53
|
+
* const input = {
|
|
54
|
+
* "CacheParameterGroupName": "custom-mem1-4",
|
|
55
|
+
* "ParameterNameValues": [
|
|
56
|
+
* {
|
|
57
|
+
* "ParameterName": "binding_protocol",
|
|
58
|
+
* "ParameterValue": "ascii"
|
|
59
|
+
* },
|
|
60
|
+
* {
|
|
61
|
+
* "ParameterName": "chunk_size",
|
|
62
|
+
* "ParameterValue": "96"
|
|
63
|
+
* }
|
|
64
|
+
* ]
|
|
65
|
+
* };
|
|
66
|
+
* const command = new ModifyCacheParameterGroupCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* /* response ==
|
|
69
|
+
* {
|
|
70
|
+
* "CacheParameterGroupName": "custom-mem1-4"
|
|
71
|
+
* }
|
|
72
|
+
* *\/
|
|
73
|
+
* // example id: modifycacheparametergroup-1482966746787
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
34
76
|
*/
|
|
35
77
|
export declare class ModifyCacheParameterGroupCommand extends $Command<ModifyCacheParameterGroupCommandInput, ModifyCacheParameterGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
36
78
|
readonly input: ModifyCacheParameterGroupCommandInput;
|
|
@@ -29,6 +29,78 @@ export interface ModifyCacheSubnetGroupCommandOutput extends ModifyCacheSubnetGr
|
|
|
29
29
|
* @see {@link ModifyCacheSubnetGroupCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link CacheSubnetGroupNotFoundFault} (client fault)
|
|
33
|
+
* <p>The requested cache subnet group name does not refer to an existing cache subnet group.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link CacheSubnetQuotaExceededFault} (client fault)
|
|
36
|
+
* <p>The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidSubnet} (client fault)
|
|
39
|
+
* <p>An invalid subnet identifier was specified.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link SubnetInUse} (client fault)
|
|
42
|
+
* <p>The requested subnet is being used by another cache subnet group.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link SubnetNotAllowedFault} (client fault)
|
|
45
|
+
* <p>At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a
|
|
46
|
+
* user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.</p>
|
|
47
|
+
*
|
|
48
|
+
*
|
|
49
|
+
* @example ModifyCacheSubnetGroup
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // Modifies an existing ElastiCache subnet group.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "CacheSubnetGroupName": "my-sn-grp",
|
|
54
|
+
* "SubnetIds": [
|
|
55
|
+
* "subnet-bcde2345"
|
|
56
|
+
* ]
|
|
57
|
+
* };
|
|
58
|
+
* const command = new ModifyCacheSubnetGroupCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* /* response ==
|
|
61
|
+
* {
|
|
62
|
+
* "CacheSubnetGroup": {
|
|
63
|
+
* "CacheSubnetGroupDescription": "My subnet group.",
|
|
64
|
+
* "CacheSubnetGroupName": "my-sn-grp",
|
|
65
|
+
* "Subnets": [
|
|
66
|
+
* {
|
|
67
|
+
* "SubnetAvailabilityZone": {
|
|
68
|
+
* "Name": "us-east-1c"
|
|
69
|
+
* },
|
|
70
|
+
* "SubnetIdentifier": "subnet-a1b2c3d4"
|
|
71
|
+
* },
|
|
72
|
+
* {
|
|
73
|
+
* "SubnetAvailabilityZone": {
|
|
74
|
+
* "Name": "us-east-1e"
|
|
75
|
+
* },
|
|
76
|
+
* "SubnetIdentifier": "subnet-1a2b3c4d"
|
|
77
|
+
* },
|
|
78
|
+
* {
|
|
79
|
+
* "SubnetAvailabilityZone": {
|
|
80
|
+
* "Name": "us-east-1e"
|
|
81
|
+
* },
|
|
82
|
+
* "SubnetIdentifier": "subnet-bcde2345"
|
|
83
|
+
* },
|
|
84
|
+
* {
|
|
85
|
+
* "SubnetAvailabilityZone": {
|
|
86
|
+
* "Name": "us-east-1c"
|
|
87
|
+
* },
|
|
88
|
+
* "SubnetIdentifier": "subnet-1234abcd"
|
|
89
|
+
* },
|
|
90
|
+
* {
|
|
91
|
+
* "SubnetAvailabilityZone": {
|
|
92
|
+
* "Name": "us-east-1b"
|
|
93
|
+
* },
|
|
94
|
+
* "SubnetIdentifier": "subnet-abcd1234"
|
|
95
|
+
* }
|
|
96
|
+
* ],
|
|
97
|
+
* "VpcId": "vpc-91280df6"
|
|
98
|
+
* }
|
|
99
|
+
* }
|
|
100
|
+
* *\/
|
|
101
|
+
* // example id: modifycachesubnetgroup-1483043446226
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
32
104
|
*/
|
|
33
105
|
export declare class ModifyCacheSubnetGroupCommand extends $Command<ModifyCacheSubnetGroupCommandInput, ModifyCacheSubnetGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
34
106
|
readonly input: ModifyCacheSubnetGroupCommandInput;
|
|
@@ -29,6 +29,16 @@ export interface ModifyGlobalReplicationGroupCommandOutput extends ModifyGlobalR
|
|
|
29
29
|
* @see {@link ModifyGlobalReplicationGroupCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link GlobalReplicationGroupNotFoundFault} (client fault)
|
|
33
|
+
* <p>The Global datastore does not exist</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidGlobalReplicationGroupStateFault} (client fault)
|
|
36
|
+
* <p>The Global datastore is not available or in primary-only state.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
39
|
+
* <p>The value for a parameter is invalid.</p>
|
|
40
|
+
*
|
|
41
|
+
*
|
|
32
42
|
*/
|
|
33
43
|
export declare class ModifyGlobalReplicationGroupCommand extends $Command<ModifyGlobalReplicationGroupCommandInput, ModifyGlobalReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
34
44
|
readonly input: ModifyGlobalReplicationGroupCommandInput;
|
|
@@ -44,6 +44,130 @@ export interface ModifyReplicationGroupCommandOutput extends ModifyReplicationGr
|
|
|
44
44
|
* @see {@link ModifyReplicationGroupCommandOutput} for command's `response` shape.
|
|
45
45
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
46
46
|
*
|
|
47
|
+
* @throws {@link CacheClusterNotFoundFault} (client fault)
|
|
48
|
+
* <p>The requested cluster ID does not refer to an existing cluster.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
51
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
54
|
+
* <p>The requested cache security group name does not refer to an existing cache security group.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
|
|
57
|
+
* <p>The requested cache node type is not available in the specified Availability Zone.
|
|
58
|
+
* For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InvalidCacheClusterStateFault} (client fault)
|
|
61
|
+
* <p>The requested cluster is not in the <code>available</code> state.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InvalidCacheSecurityGroupStateFault} (client fault)
|
|
64
|
+
* <p>The current state of the cache security group does not allow deletion.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InvalidKMSKeyFault} (client fault)
|
|
67
|
+
* <p>The KMS key supplied is not valid.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
70
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
73
|
+
* <p>The value for a parameter is invalid.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InvalidReplicationGroupStateFault} (client fault)
|
|
76
|
+
* <p>The requested replication group is not in the <code>available</code> state.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InvalidUserGroupStateFault} (client fault)
|
|
79
|
+
* <p>The user group is not in an active state.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InvalidVPCNetworkStateFault} (client fault)
|
|
82
|
+
* <p>The VPC network is in an invalid state.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link NodeQuotaForClusterExceededFault} (client fault)
|
|
85
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link NodeQuotaForCustomerExceededFault} (client fault)
|
|
88
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache nodes per customer.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
91
|
+
* <p>The specified replication group does not exist.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link UserGroupNotFoundFault} (client fault)
|
|
94
|
+
* <p>The user group was not found or does not exist</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @example ModifyReplicationGroup
|
|
98
|
+
* ```javascript
|
|
99
|
+
* //
|
|
100
|
+
* const input = {
|
|
101
|
+
* "ApplyImmediately": true,
|
|
102
|
+
* "ReplicationGroupDescription": "Modified replication group",
|
|
103
|
+
* "ReplicationGroupId": "my-redis-rg",
|
|
104
|
+
* "SnapshotRetentionLimit": 30,
|
|
105
|
+
* "SnapshottingClusterId": "my-redis-rg-001"
|
|
106
|
+
* };
|
|
107
|
+
* const command = new ModifyReplicationGroupCommand(input);
|
|
108
|
+
* const response = await client.send(command);
|
|
109
|
+
* /* response ==
|
|
110
|
+
* {
|
|
111
|
+
* "ReplicationGroup": {
|
|
112
|
+
* "AutomaticFailover": "enabled",
|
|
113
|
+
* "Description": "Modified replication group",
|
|
114
|
+
* "MemberClusters": [
|
|
115
|
+
* "my-redis-rg-001",
|
|
116
|
+
* "my-redis-rg-002",
|
|
117
|
+
* "my-redis-rg-003"
|
|
118
|
+
* ],
|
|
119
|
+
* "NodeGroups": [
|
|
120
|
+
* {
|
|
121
|
+
* "NodeGroupId": "0001",
|
|
122
|
+
* "NodeGroupMembers": [
|
|
123
|
+
* {
|
|
124
|
+
* "CacheClusterId": "my-redis-rg-001",
|
|
125
|
+
* "CacheNodeId": "0001",
|
|
126
|
+
* "CurrentRole": "primary",
|
|
127
|
+
* "PreferredAvailabilityZone": "us-east-1b",
|
|
128
|
+
* "ReadEndpoint": {
|
|
129
|
+
* "Address": "my-redis-rg-001.abcdef.0001.use1.cache.amazonaws.com",
|
|
130
|
+
* "Port": 6379
|
|
131
|
+
* }
|
|
132
|
+
* },
|
|
133
|
+
* {
|
|
134
|
+
* "CacheClusterId": "my-redis-rg-002",
|
|
135
|
+
* "CacheNodeId": "0001",
|
|
136
|
+
* "CurrentRole": "replica",
|
|
137
|
+
* "PreferredAvailabilityZone": "us-east-1a",
|
|
138
|
+
* "ReadEndpoint": {
|
|
139
|
+
* "Address": "my-redis-rg-002.abcdef.0001.use1.cache.amazonaws.com",
|
|
140
|
+
* "Port": 6379
|
|
141
|
+
* }
|
|
142
|
+
* },
|
|
143
|
+
* {
|
|
144
|
+
* "CacheClusterId": "my-redis-rg-003",
|
|
145
|
+
* "CacheNodeId": "0001",
|
|
146
|
+
* "CurrentRole": "replica",
|
|
147
|
+
* "PreferredAvailabilityZone": "us-east-1c",
|
|
148
|
+
* "ReadEndpoint": {
|
|
149
|
+
* "Address": "my-redis-rg-003.abcdef.0001.use1.cache.amazonaws.com",
|
|
150
|
+
* "Port": 6379
|
|
151
|
+
* }
|
|
152
|
+
* }
|
|
153
|
+
* ],
|
|
154
|
+
* "PrimaryEndpoint": {
|
|
155
|
+
* "Address": "my-redis-rg.abcdef.ng.0001.use1.cache.amazonaws.com",
|
|
156
|
+
* "Port": 6379
|
|
157
|
+
* },
|
|
158
|
+
* "Status": "available"
|
|
159
|
+
* }
|
|
160
|
+
* ],
|
|
161
|
+
* "PendingModifiedValues": {},
|
|
162
|
+
* "ReplicationGroupId": "my-redis-rg",
|
|
163
|
+
* "SnapshottingClusterId": "my-redis-rg-002",
|
|
164
|
+
* "Status": "available"
|
|
165
|
+
* }
|
|
166
|
+
* }
|
|
167
|
+
* *\/
|
|
168
|
+
* // example id: modifyreplicationgroup-1483039689581
|
|
169
|
+
* ```
|
|
170
|
+
*
|
|
47
171
|
*/
|
|
48
172
|
export declare class ModifyReplicationGroupCommand extends $Command<ModifyReplicationGroupCommandInput, ModifyReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
49
173
|
readonly input: ModifyReplicationGroupCommandInput;
|
|
@@ -30,6 +30,39 @@ export interface ModifyReplicationGroupShardConfigurationCommandOutput extends M
|
|
|
30
30
|
* @see {@link ModifyReplicationGroupShardConfigurationCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
|
|
34
|
+
* <p>The requested cache node type is not available in the specified Availability Zone.
|
|
35
|
+
* For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InvalidCacheClusterStateFault} (client fault)
|
|
38
|
+
* <p>The requested cluster is not in the <code>available</code> state.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InvalidKMSKeyFault} (client fault)
|
|
41
|
+
* <p>The KMS key supplied is not valid.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
44
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
47
|
+
* <p>The value for a parameter is invalid.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InvalidReplicationGroupStateFault} (client fault)
|
|
50
|
+
* <p>The requested replication group is not in the <code>available</code> state.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link InvalidVPCNetworkStateFault} (client fault)
|
|
53
|
+
* <p>The VPC network is in an invalid state.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link NodeGroupsPerReplicationGroupQuotaExceededFault} (client fault)
|
|
56
|
+
* <p>The request cannot be processed because it would exceed the maximum allowed number
|
|
57
|
+
* of node groups (shards) in a single replication group. The default maximum is 90</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link NodeQuotaForCustomerExceededFault} (client fault)
|
|
60
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache nodes per customer.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
63
|
+
* <p>The specified replication group does not exist.</p>
|
|
64
|
+
*
|
|
65
|
+
*
|
|
33
66
|
*/
|
|
34
67
|
export declare class ModifyReplicationGroupShardConfigurationCommand extends $Command<ModifyReplicationGroupShardConfigurationCommandInput, ModifyReplicationGroupShardConfigurationCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
35
68
|
readonly input: ModifyReplicationGroupShardConfigurationCommandInput;
|
|
@@ -29,6 +29,22 @@ export interface ModifyUserCommandOutput extends User, __MetadataBearer {
|
|
|
29
29
|
* @see {@link ModifyUserCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
33
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
36
|
+
* <p>The value for a parameter is invalid.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidUserStateFault} (client fault)
|
|
39
|
+
* <p>The user is not in active state.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
|
|
42
|
+
* <p>The specified service linked role (SLR) was not found.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link UserNotFoundFault} (client fault)
|
|
45
|
+
* <p>The user does not exist or could not be found.</p>
|
|
46
|
+
*
|
|
47
|
+
*
|
|
32
48
|
*/
|
|
33
49
|
export declare class ModifyUserCommand extends $Command<ModifyUserCommandInput, ModifyUserCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
34
50
|
readonly input: ModifyUserCommandInput;
|
|
@@ -29,6 +29,31 @@ export interface ModifyUserGroupCommandOutput extends UserGroup, __MetadataBeare
|
|
|
29
29
|
* @see {@link ModifyUserGroupCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link DefaultUserRequired} (client fault)
|
|
33
|
+
* <p>You must add default user to a user group.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link DuplicateUserNameFault} (client fault)
|
|
36
|
+
* <p>A user with this username already exists.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
39
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
42
|
+
* <p>The value for a parameter is invalid.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InvalidUserGroupStateFault} (client fault)
|
|
45
|
+
* <p>The user group is not in an active state.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
|
|
48
|
+
* <p>The specified service linked role (SLR) was not found.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link UserGroupNotFoundFault} (client fault)
|
|
51
|
+
* <p>The user group was not found or does not exist</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link UserNotFoundFault} (client fault)
|
|
54
|
+
* <p>The user does not exist or could not be found.</p>
|
|
55
|
+
*
|
|
56
|
+
*
|
|
32
57
|
*/
|
|
33
58
|
export declare class ModifyUserGroupCommand extends $Command<ModifyUserGroupCommandInput, ModifyUserGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
34
59
|
readonly input: ModifyUserGroupCommandInput;
|
|
@@ -32,6 +32,36 @@ export interface PurchaseReservedCacheNodesOfferingCommandOutput extends Purchas
|
|
|
32
32
|
* @see {@link PurchaseReservedCacheNodesOfferingCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
36
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
39
|
+
* <p>The value for a parameter is invalid.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link ReservedCacheNodeAlreadyExistsFault} (client fault)
|
|
42
|
+
* <p>You already have a reservation with the given identifier.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link ReservedCacheNodeQuotaExceededFault} (client fault)
|
|
45
|
+
* <p>The request cannot be processed because it would exceed the user's cache node quota.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ReservedCacheNodesOfferingNotFoundFault} (client fault)
|
|
48
|
+
* <p>The requested cache node offering does not exist.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
51
|
+
* <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
|
|
52
|
+
*
|
|
53
|
+
*
|
|
54
|
+
* @example PurchaseReservedCacheNodesOfferings
|
|
55
|
+
* ```javascript
|
|
56
|
+
* // Allows you to purchase a reserved cache node offering.
|
|
57
|
+
* const input = {
|
|
58
|
+
* "ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a"
|
|
59
|
+
* };
|
|
60
|
+
* const command = new PurchaseReservedCacheNodesOfferingCommand(input);
|
|
61
|
+
* await client.send(command);
|
|
62
|
+
* // example id: purchasereservedcachenodesofferings-1483040798484
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
35
65
|
*/
|
|
36
66
|
export declare class PurchaseReservedCacheNodesOfferingCommand extends $Command<PurchaseReservedCacheNodesOfferingCommandInput, PurchaseReservedCacheNodesOfferingCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
37
67
|
readonly input: PurchaseReservedCacheNodesOfferingCommandInput;
|
|
@@ -29,6 +29,16 @@ export interface RebalanceSlotsInGlobalReplicationGroupCommandOutput extends Reb
|
|
|
29
29
|
* @see {@link RebalanceSlotsInGlobalReplicationGroupCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link GlobalReplicationGroupNotFoundFault} (client fault)
|
|
33
|
+
* <p>The Global datastore does not exist</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidGlobalReplicationGroupStateFault} (client fault)
|
|
36
|
+
* <p>The Global datastore is not available or in primary-only state.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
39
|
+
* <p>The value for a parameter is invalid.</p>
|
|
40
|
+
*
|
|
41
|
+
*
|
|
32
42
|
*/
|
|
33
43
|
export declare class RebalanceSlotsInGlobalReplicationGroupCommand extends $Command<RebalanceSlotsInGlobalReplicationGroupCommandInput, RebalanceSlotsInGlobalReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
34
44
|
readonly input: RebalanceSlotsInGlobalReplicationGroupCommandInput;
|