@aws-sdk/client-elasticache 3.386.0 → 3.388.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/README.md +17 -9
- package/dist-cjs/ElastiCache.js +2 -0
- package/dist-cjs/ElastiCacheClient.js +2 -2
- package/dist-cjs/commands/TestMigrationCommand.js +46 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/protocols/Aws_query.js +79 -2
- package/dist-es/ElastiCache.js +2 -0
- package/dist-es/ElastiCacheClient.js +2 -2
- package/dist-es/commands/TestMigrationCommand.js +42 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/protocols/Aws_query.js +75 -0
- package/dist-types/ElastiCache.d.ts +16 -9
- package/dist-types/ElastiCacheClient.d.ts +14 -13
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +23 -17
- package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +8 -6
- package/dist-types/commands/BatchApplyUpdateActionCommand.d.ts +3 -1
- package/dist-types/commands/BatchStopUpdateActionCommand.d.ts +3 -1
- package/dist-types/commands/CopySnapshotCommand.d.ts +54 -50
- package/dist-types/commands/CreateCacheClusterCommand.d.ts +19 -12
- package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +16 -10
- package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +10 -8
- package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +15 -7
- package/dist-types/commands/CreateGlobalReplicationGroupCommand.d.ts +10 -9
- package/dist-types/commands/CreateReplicationGroupCommand.d.ts +45 -31
- package/dist-types/commands/CreateSnapshotCommand.d.ts +11 -7
- package/dist-types/commands/CreateUserCommand.d.ts +5 -2
- package/dist-types/commands/CreateUserGroupCommand.d.ts +5 -2
- package/dist-types/commands/DecreaseReplicaCountCommand.d.ts +12 -9
- package/dist-types/commands/DeleteCacheClusterCommand.d.ts +10 -9
- package/dist-types/commands/DeleteCacheParameterGroupCommand.d.ts +7 -5
- package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +4 -2
- package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +4 -2
- package/dist-types/commands/DeleteGlobalReplicationGroupCommand.d.ts +14 -7
- package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +14 -10
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +5 -4
- package/dist-types/commands/DeleteUserCommand.d.ts +3 -1
- package/dist-types/commands/DeleteUserGroupCommand.d.ts +3 -1
- package/dist-types/commands/DescribeCacheClustersCommand.d.ts +13 -13
- package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts +4 -4
- package/dist-types/commands/DescribeCacheParametersCommand.d.ts +3 -3
- package/dist-types/commands/DescribeCacheSecurityGroupsCommand.d.ts +5 -5
- package/dist-types/commands/DescribeCacheSubnetGroupsCommand.d.ts +6 -5
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +2 -2
- package/dist-types/commands/DescribeEventsCommand.d.ts +5 -6
- package/dist-types/commands/DescribeGlobalReplicationGroupsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeReservedCacheNodesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeReservedCacheNodesOfferingsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateGlobalReplicationGroupCommand.d.ts +3 -1
- package/dist-types/commands/FailoverGlobalReplicationGroupCommand.d.ts +2 -1
- package/dist-types/commands/IncreaseReplicaCountCommand.d.ts +12 -9
- package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +6 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -10
- package/dist-types/commands/ModifyCacheClusterCommand.d.ts +12 -9
- package/dist-types/commands/ModifyCacheParameterGroupCommand.d.ts +6 -5
- package/dist-types/commands/ModifyCacheSubnetGroupCommand.d.ts +8 -4
- package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +14 -10
- package/dist-types/commands/ModifyReplicationGroupShardConfigurationCommand.d.ts +8 -7
- package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts +8 -6
- package/dist-types/commands/RebalanceSlotsInGlobalReplicationGroupCommand.d.ts +2 -1
- package/dist-types/commands/RebootCacheClusterCommand.d.ts +11 -10
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +13 -8
- package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts +8 -6
- package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts +6 -5
- package/dist-types/commands/TestFailoverCommand.d.ts +38 -21
- package/dist-types/commands/TestMigrationCommand.d.ts +210 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +9 -9
- package/dist-types/models/models_0.d.ts +1496 -1152
- package/dist-types/protocols/Aws_query.d.ts +9 -0
- package/dist-types/ts3.4/ElastiCache.d.ts +17 -0
- package/dist-types/ts3.4/ElastiCacheClient.d.ts +12 -3
- package/dist-types/ts3.4/commands/TestMigrationCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +7 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +12 -0
- package/package.json +29 -29
|
@@ -23,8 +23,8 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a copy of an entire cluster or replication group at a
|
|
27
|
-
*
|
|
26
|
+
* <p>Creates a copy of an entire cluster or replication group at a specific moment in
|
|
27
|
+
* time.</p>
|
|
28
28
|
* <note>
|
|
29
29
|
* <p>This operation is valid for Redis only.</p>
|
|
30
30
|
* </note>
|
|
@@ -136,20 +136,24 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
|
|
|
136
136
|
* <p>You attempted one of the following operations:</p>
|
|
137
137
|
* <ul>
|
|
138
138
|
* <li>
|
|
139
|
-
* <p>Creating a snapshot of a Redis cluster running on a
|
|
140
|
-
*
|
|
139
|
+
* <p>Creating a snapshot of a Redis cluster running on a
|
|
140
|
+
* <code>cache.t1.micro</code> cache node.</p>
|
|
141
141
|
* </li>
|
|
142
142
|
* <li>
|
|
143
|
-
* <p>Creating a snapshot of a cluster that is running Memcached rather than
|
|
143
|
+
* <p>Creating a snapshot of a cluster that is running Memcached rather than
|
|
144
|
+
* Redis.</p>
|
|
144
145
|
* </li>
|
|
145
146
|
* </ul>
|
|
146
147
|
* <p>Neither of these are supported by ElastiCache.</p>
|
|
147
148
|
*
|
|
148
149
|
* @throws {@link SnapshotQuotaExceededFault} (client fault)
|
|
149
|
-
* <p>The request cannot be processed because it would exceed the maximum number of
|
|
150
|
+
* <p>The request cannot be processed because it would exceed the maximum number of
|
|
151
|
+
* snapshots.</p>
|
|
150
152
|
*
|
|
151
153
|
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
152
|
-
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
154
|
+
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
155
|
+
* the allowed number of tags. The maximum number of tags permitted on a resource is
|
|
156
|
+
* 50.</p>
|
|
153
157
|
*
|
|
154
158
|
* @throws {@link ElastiCacheServiceException}
|
|
155
159
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -23,7 +23,8 @@ export interface CreateUserCommandOutput extends User, __MetadataBearer {
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see
|
|
26
|
+
* <p>For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see
|
|
27
|
+
* <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>.</p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
|
@@ -92,7 +93,9 @@ export interface CreateUserCommandOutput extends User, __MetadataBearer {
|
|
|
92
93
|
* <p>The specified service linked role (SLR) was not found.</p>
|
|
93
94
|
*
|
|
94
95
|
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
95
|
-
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
96
|
+
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
97
|
+
* the allowed number of tags. The maximum number of tags permitted on a resource is
|
|
98
|
+
* 50.</p>
|
|
96
99
|
*
|
|
97
100
|
* @throws {@link UserAlreadyExistsFault} (client fault)
|
|
98
101
|
* <p>A user with this ID already exists.</p>
|
|
@@ -23,7 +23,8 @@ export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBeare
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>For Redis engine version 6.0 onwards: Creates a Redis user group. For more
|
|
26
|
+
* <p>For Redis engine version 6.0 onwards: Creates a Redis user group. For more
|
|
27
|
+
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>
|
|
27
28
|
* </p>
|
|
28
29
|
* @example
|
|
29
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -89,7 +90,9 @@ export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBeare
|
|
|
89
90
|
* <p>The specified service linked role (SLR) was not found.</p>
|
|
90
91
|
*
|
|
91
92
|
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
92
|
-
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
93
|
+
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
94
|
+
* the allowed number of tags. The maximum number of tags permitted on a resource is
|
|
95
|
+
* 50.</p>
|
|
93
96
|
*
|
|
94
97
|
* @throws {@link UserGroupAlreadyExistsFault} (client fault)
|
|
95
98
|
* <p>The user group with this ID already exists.</p>
|
|
@@ -23,9 +23,10 @@ export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountR
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Dynamically decreases the number of replicas in a Redis (cluster mode disabled)
|
|
27
|
-
* replica nodes in one or more node groups (shards) of
|
|
28
|
-
* is performed with no
|
|
26
|
+
* <p>Dynamically decreases the number of replicas in a Redis (cluster mode disabled)
|
|
27
|
+
* replication group or the number of replica nodes in one or more node groups (shards) of
|
|
28
|
+
* a Redis (cluster mode enabled) replication group. This operation is performed with no
|
|
29
|
+
* cluster down time.</p>
|
|
29
30
|
* @example
|
|
30
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
32
|
* ```javascript
|
|
@@ -186,11 +187,12 @@ export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountR
|
|
|
186
187
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
187
188
|
*
|
|
188
189
|
* @throws {@link ClusterQuotaForCustomerExceededFault} (client fault)
|
|
189
|
-
* <p>The request cannot be processed because it would exceed the allowed number of clusters
|
|
190
|
+
* <p>The request cannot be processed because it would exceed the allowed number of clusters
|
|
191
|
+
* per customer.</p>
|
|
190
192
|
*
|
|
191
193
|
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
|
|
192
|
-
* <p>The requested cache node type is not available in the specified Availability Zone.
|
|
193
|
-
*
|
|
194
|
+
* <p>The requested cache node type is not available in the specified Availability Zone. For
|
|
195
|
+
* 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>
|
|
194
196
|
*
|
|
195
197
|
* @throws {@link InvalidCacheClusterStateFault} (client fault)
|
|
196
198
|
* <p>The requested cluster is not in the <code>available</code> state.</p>
|
|
@@ -208,11 +210,12 @@ export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountR
|
|
|
208
210
|
* <p>The VPC network is in an invalid state.</p>
|
|
209
211
|
*
|
|
210
212
|
* @throws {@link NodeGroupsPerReplicationGroupQuotaExceededFault} (client fault)
|
|
211
|
-
* <p>The request cannot be processed because it would exceed the maximum allowed number
|
|
212
|
-
*
|
|
213
|
+
* <p>The request cannot be processed because it would exceed the maximum allowed number of
|
|
214
|
+
* node groups (shards) in a single replication group. The default maximum is 90</p>
|
|
213
215
|
*
|
|
214
216
|
* @throws {@link NodeQuotaForCustomerExceededFault} (client fault)
|
|
215
|
-
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
217
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
218
|
+
* nodes per customer.</p>
|
|
216
219
|
*
|
|
217
220
|
* @throws {@link NoOperationFault} (client fault)
|
|
218
221
|
* <p>The operation was not performed because no changes were required.</p>
|
|
@@ -23,11 +23,10 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes a previously provisioned cluster.
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* this operation.</p>
|
|
26
|
+
* <p>Deletes a previously provisioned cluster. <code>DeleteCacheCluster</code> deletes all
|
|
27
|
+
* associated cache nodes, node endpoints and the cluster itself. When you receive a
|
|
28
|
+
* successful response from this operation, Amazon ElastiCache immediately begins deleting
|
|
29
|
+
* the cluster; you cannot cancel or revert this operation.</p>
|
|
31
30
|
* <p>This operation is not valid for:</p>
|
|
32
31
|
* <ul>
|
|
33
32
|
* <li>
|
|
@@ -206,17 +205,19 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
|
|
|
206
205
|
* <p>You attempted one of the following operations:</p>
|
|
207
206
|
* <ul>
|
|
208
207
|
* <li>
|
|
209
|
-
* <p>Creating a snapshot of a Redis cluster running on a
|
|
210
|
-
*
|
|
208
|
+
* <p>Creating a snapshot of a Redis cluster running on a
|
|
209
|
+
* <code>cache.t1.micro</code> cache node.</p>
|
|
211
210
|
* </li>
|
|
212
211
|
* <li>
|
|
213
|
-
* <p>Creating a snapshot of a cluster that is running Memcached rather than
|
|
212
|
+
* <p>Creating a snapshot of a cluster that is running Memcached rather than
|
|
213
|
+
* Redis.</p>
|
|
214
214
|
* </li>
|
|
215
215
|
* </ul>
|
|
216
216
|
* <p>Neither of these are supported by ElastiCache.</p>
|
|
217
217
|
*
|
|
218
218
|
* @throws {@link SnapshotQuotaExceededFault} (client fault)
|
|
219
|
-
* <p>The request cannot be processed because it would exceed the maximum number of
|
|
219
|
+
* <p>The request cannot be processed because it would exceed the maximum number of
|
|
220
|
+
* snapshots.</p>
|
|
220
221
|
*
|
|
221
222
|
* @throws {@link ElastiCacheServiceException}
|
|
222
223
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -23,9 +23,9 @@ export interface DeleteCacheParameterGroupCommandOutput extends __MetadataBearer
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes the specified cache parameter
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Deletes the specified cache parameter group. You cannot delete a cache parameter group
|
|
27
|
+
* if it is associated with any cache clusters. You cannot delete the default cache
|
|
28
|
+
* parameter groups in your account.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -48,10 +48,12 @@ export interface DeleteCacheParameterGroupCommandOutput extends __MetadataBearer
|
|
|
48
48
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
49
49
|
*
|
|
50
50
|
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
51
|
-
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
51
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
52
|
+
* group.</p>
|
|
52
53
|
*
|
|
53
54
|
* @throws {@link InvalidCacheParameterGroupStateFault} (client fault)
|
|
54
|
-
* <p>The current state of the cache parameter group does not allow the requested operation
|
|
55
|
+
* <p>The current state of the cache parameter group does not allow the requested operation
|
|
56
|
+
* to occur.</p>
|
|
55
57
|
*
|
|
56
58
|
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
57
59
|
* <p>Two or more incompatible parameters were specified.</p>
|
|
@@ -25,7 +25,8 @@ export interface DeleteCacheSecurityGroupCommandOutput extends __MetadataBearer
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes a cache security group.</p>
|
|
27
27
|
* <note>
|
|
28
|
-
* <p>You cannot delete a cache security group if it is associated with any
|
|
28
|
+
* <p>You cannot delete a cache security group if it is associated with any
|
|
29
|
+
* clusters.</p>
|
|
29
30
|
* </note>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -49,7 +50,8 @@ export interface DeleteCacheSecurityGroupCommandOutput extends __MetadataBearer
|
|
|
49
50
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
50
51
|
*
|
|
51
52
|
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
52
|
-
* <p>The requested cache security group name does not refer to an existing cache security
|
|
53
|
+
* <p>The requested cache security group name does not refer to an existing cache security
|
|
54
|
+
* group.</p>
|
|
53
55
|
*
|
|
54
56
|
* @throws {@link InvalidCacheSecurityGroupStateFault} (client fault)
|
|
55
57
|
* <p>The current state of the cache security group does not allow deletion.</p>
|
|
@@ -25,7 +25,8 @@ export interface DeleteCacheSubnetGroupCommandOutput extends __MetadataBearer {
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes a cache subnet group.</p>
|
|
27
27
|
* <note>
|
|
28
|
-
* <p>You cannot delete a default cache subnet group or one that is associated with any
|
|
28
|
+
* <p>You cannot delete a default cache subnet group or one that is associated with any
|
|
29
|
+
* clusters.</p>
|
|
29
30
|
* </note>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -52,7 +53,8 @@ export interface DeleteCacheSubnetGroupCommandOutput extends __MetadataBearer {
|
|
|
52
53
|
* <p>The requested cache subnet group is currently in use.</p>
|
|
53
54
|
*
|
|
54
55
|
* @throws {@link CacheSubnetGroupNotFoundFault} (client fault)
|
|
55
|
-
* <p>The requested cache subnet group name does not refer to an existing cache subnet
|
|
56
|
+
* <p>The requested cache subnet group name does not refer to an existing cache subnet
|
|
57
|
+
* group.</p>
|
|
56
58
|
*
|
|
57
59
|
* @throws {@link ElastiCacheServiceException}
|
|
58
60
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -26,17 +26,24 @@ export interface DeleteGlobalReplicationGroupCommandOutput extends DeleteGlobalR
|
|
|
26
26
|
* <p>Deleting a Global datastore is a two-step process: </p>
|
|
27
27
|
* <ul>
|
|
28
28
|
* <li>
|
|
29
|
-
* <p>First, you must <a>DisassociateGlobalReplicationGroup</a> to remove
|
|
29
|
+
* <p>First, you must <a>DisassociateGlobalReplicationGroup</a> to remove
|
|
30
|
+
* the secondary clusters in the Global datastore.</p>
|
|
30
31
|
* </li>
|
|
31
32
|
* <li>
|
|
32
|
-
* <p>Once the Global datastore contains only the primary cluster, you can use the
|
|
33
|
+
* <p>Once the Global datastore contains only the primary cluster, you can use the
|
|
34
|
+
* <code>DeleteGlobalReplicationGroup</code> API to delete the Global datastore
|
|
35
|
+
* while retainining the primary cluster using
|
|
36
|
+
* <code>RetainPrimaryReplicationGroup=true</code>.</p>
|
|
33
37
|
* </li>
|
|
34
38
|
* </ul>
|
|
35
|
-
* <p>Since the Global Datastore has only a primary cluster, you can delete the Global
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
39
|
+
* <p>Since the Global Datastore has only a primary cluster, you can delete the Global
|
|
40
|
+
* Datastore while retaining the primary by setting
|
|
41
|
+
* <code>RetainPrimaryReplicationGroup=true</code>. The primary cluster is never
|
|
42
|
+
* deleted when deleting a Global Datastore. It can only be deleted when it no longer is
|
|
43
|
+
* associated with any Global Datastore.</p>
|
|
44
|
+
* <p>When you receive a successful response from this operation, Amazon ElastiCache
|
|
45
|
+
* immediately begins deleting the selected resources; you cannot cancel or revert this
|
|
46
|
+
* operation.</p>
|
|
40
47
|
* @example
|
|
41
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
49
|
* ```javascript
|
|
@@ -23,12 +23,14 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes an existing replication group.
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
26
|
+
* <p>Deletes an existing replication group. By default, this operation deletes the entire
|
|
27
|
+
* replication group, including the primary/primaries and all of the read replicas. If the
|
|
28
|
+
* replication group has only one primary, you can optionally delete only the read
|
|
29
|
+
* replicas, while retaining the primary by setting
|
|
30
|
+
* <code>RetainPrimaryCluster=true</code>.</p>
|
|
31
|
+
* <p>When you receive a successful response from this operation, Amazon ElastiCache
|
|
32
|
+
* immediately begins deleting the selected resources; you cannot cancel or revert this
|
|
33
|
+
* operation.</p>
|
|
32
34
|
* <note>
|
|
33
35
|
* <p>This operation is valid for Redis only.</p>
|
|
34
36
|
* </note>
|
|
@@ -195,17 +197,19 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
|
|
|
195
197
|
* <p>You attempted one of the following operations:</p>
|
|
196
198
|
* <ul>
|
|
197
199
|
* <li>
|
|
198
|
-
* <p>Creating a snapshot of a Redis cluster running on a
|
|
199
|
-
*
|
|
200
|
+
* <p>Creating a snapshot of a Redis cluster running on a
|
|
201
|
+
* <code>cache.t1.micro</code> cache node.</p>
|
|
200
202
|
* </li>
|
|
201
203
|
* <li>
|
|
202
|
-
* <p>Creating a snapshot of a cluster that is running Memcached rather than
|
|
204
|
+
* <p>Creating a snapshot of a cluster that is running Memcached rather than
|
|
205
|
+
* Redis.</p>
|
|
203
206
|
* </li>
|
|
204
207
|
* </ul>
|
|
205
208
|
* <p>Neither of these are supported by ElastiCache.</p>
|
|
206
209
|
*
|
|
207
210
|
* @throws {@link SnapshotQuotaExceededFault} (client fault)
|
|
208
|
-
* <p>The request cannot be processed because it would exceed the maximum number of
|
|
211
|
+
* <p>The request cannot be processed because it would exceed the maximum number of
|
|
212
|
+
* snapshots.</p>
|
|
209
213
|
*
|
|
210
214
|
* @throws {@link ElastiCacheServiceException}
|
|
211
215
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -23,9 +23,9 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResult, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes an existing snapshot. When you receive a
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Deletes an existing snapshot. When you receive a successful response from this
|
|
27
|
+
* operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or
|
|
28
|
+
* revert this operation.</p>
|
|
29
29
|
* <note>
|
|
30
30
|
* <p>This operation is valid for Redis only.</p>
|
|
31
31
|
* </note>
|
|
@@ -110,7 +110,8 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResult, __Met
|
|
|
110
110
|
* <p>The value for a parameter is invalid.</p>
|
|
111
111
|
*
|
|
112
112
|
* @throws {@link InvalidSnapshotStateFault} (client fault)
|
|
113
|
-
* <p>The current state of the snapshot does not allow the requested operation to
|
|
113
|
+
* <p>The current state of the snapshot does not allow the requested operation to
|
|
114
|
+
* occur.</p>
|
|
114
115
|
*
|
|
115
116
|
* @throws {@link SnapshotNotFoundFault} (client fault)
|
|
116
117
|
* <p>The requested snapshot name does not refer to an existing snapshot.</p>
|
|
@@ -23,7 +23,9 @@ export interface DeleteUserCommandOutput extends User, __MetadataBearer {
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from
|
|
26
|
+
* <p>For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from
|
|
27
|
+
* all user groups and in turn removed from all replication groups. For more information,
|
|
28
|
+
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
|
|
27
29
|
* @example
|
|
28
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
31
|
* ```javascript
|
|
@@ -23,7 +23,9 @@ export interface DeleteUserGroupCommandOutput extends UserGroup, __MetadataBeare
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>For Redis engine version 6.0 onwards: Deletes a user group. The user group must first
|
|
26
|
+
* <p>For Redis engine version 6.0 onwards: Deletes a user group. The user group must first
|
|
27
|
+
* be disassociated from the replication group before it can be deleted. For more
|
|
28
|
+
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
|
|
27
29
|
* @example
|
|
28
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
31
|
* ```javascript
|
|
@@ -23,19 +23,19 @@ export interface DescribeCacheClustersCommandOutput extends CacheClusterMessage,
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about all provisioned
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* <p>If cache nodes are currently being added to the cluster, node endpoint information
|
|
37
|
-
*
|
|
38
|
-
*
|
|
26
|
+
* <p>Returns information about all provisioned clusters if no cluster identifier is
|
|
27
|
+
* specified, or about a specific cache cluster if a cluster identifier is supplied.</p>
|
|
28
|
+
* <p>By default, abbreviated information about the clusters is returned. You can use the
|
|
29
|
+
* optional <i>ShowCacheNodeInfo</i> flag to retrieve detailed information
|
|
30
|
+
* about the cache nodes associated with the clusters. These details include the DNS
|
|
31
|
+
* address and port for the cache node endpoint.</p>
|
|
32
|
+
* <p>If the cluster is in the <i>creating</i> state, only cluster-level
|
|
33
|
+
* information is displayed until all of the nodes are successfully provisioned.</p>
|
|
34
|
+
* <p>If the cluster is in the <i>deleting</i> state, only cluster-level
|
|
35
|
+
* information is displayed.</p>
|
|
36
|
+
* <p>If cache nodes are currently being added to the cluster, node endpoint information and
|
|
37
|
+
* creation time for the additional nodes are not displayed until they are completely
|
|
38
|
+
* provisioned. When the cluster state is <i>available</i>, the cluster is
|
|
39
39
|
* ready for use.</p>
|
|
40
40
|
* <p>If cache nodes are currently being removed from the cluster, no endpoint information
|
|
41
41
|
* for the removed nodes is displayed.</p>
|
|
@@ -23,8 +23,7 @@ export interface DescribeCacheEngineVersionsCommandOutput extends CacheEngineVer
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns a list of the available cache
|
|
27
|
-
* engines and their versions.</p>
|
|
26
|
+
* <p>Returns a list of the available cache engines and their versions.</p>
|
|
28
27
|
* @example
|
|
29
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
29
|
* ```javascript
|
|
@@ -23,9 +23,8 @@ export interface DescribeCacheParameterGroupsCommandOutput extends CacheParamete
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns a list of cache parameter group
|
|
27
|
-
*
|
|
28
|
-
* the descriptions for that group.</p>
|
|
26
|
+
* <p>Returns a list of cache parameter group descriptions. If a cache parameter group name
|
|
27
|
+
* is specified, the list contains only the descriptions for that group.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
|
@@ -61,7 +60,8 @@ export interface DescribeCacheParameterGroupsCommandOutput extends CacheParamete
|
|
|
61
60
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
62
61
|
*
|
|
63
62
|
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
64
|
-
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
63
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
64
|
+
* group.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
67
67
|
* <p>Two or more incompatible parameters were specified.</p>
|
|
@@ -23,8 +23,7 @@ export interface DescribeCacheParametersCommandOutput extends CacheParameterGrou
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the detailed parameter list for a
|
|
27
|
-
* particular cache parameter group.</p>
|
|
26
|
+
* <p>Returns the detailed parameter list for a particular cache parameter group.</p>
|
|
28
27
|
* @example
|
|
29
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
29
|
* ```javascript
|
|
@@ -83,7 +82,8 @@ export interface DescribeCacheParametersCommandOutput extends CacheParameterGrou
|
|
|
83
82
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
84
83
|
*
|
|
85
84
|
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
86
|
-
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
85
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
86
|
+
* group.</p>
|
|
87
87
|
*
|
|
88
88
|
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
89
89
|
* <p>Two or more incompatible parameters were specified.</p>
|
|
@@ -23,10 +23,9 @@ export interface DescribeCacheSecurityGroupsCommandOutput extends CacheSecurityG
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns a list of cache security group
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* </p>
|
|
26
|
+
* <p>Returns a list of cache security group descriptions. If a cache security group name is
|
|
27
|
+
* specified, the list contains only the description of that group. This applicable only
|
|
28
|
+
* when you have ElastiCache in Classic setup </p>
|
|
30
29
|
* @example
|
|
31
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
31
|
* ```javascript
|
|
@@ -68,7 +67,8 @@ export interface DescribeCacheSecurityGroupsCommandOutput extends CacheSecurityG
|
|
|
68
67
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
69
68
|
*
|
|
70
69
|
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
71
|
-
* <p>The requested cache security group name does not refer to an existing cache security
|
|
70
|
+
* <p>The requested cache security group name does not refer to an existing cache security
|
|
71
|
+
* group.</p>
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
74
74
|
* <p>Two or more incompatible parameters were specified.</p>
|
|
@@ -23,10 +23,10 @@ export interface DescribeCacheSubnetGroupsCommandOutput extends CacheSubnetGroup
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns a list of cache subnet group
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
26
|
+
* <p>Returns a list of cache subnet group descriptions. If a subnet group name is
|
|
27
|
+
* specified, the list contains only the description of that group. This is applicable only
|
|
28
|
+
* when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by
|
|
29
|
+
* default. </p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -78,7 +78,8 @@ export interface DescribeCacheSubnetGroupsCommandOutput extends CacheSubnetGroup
|
|
|
78
78
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link CacheSubnetGroupNotFoundFault} (client fault)
|
|
81
|
-
* <p>The requested cache subnet group name does not refer to an existing cache subnet
|
|
81
|
+
* <p>The requested cache subnet group name does not refer to an existing cache subnet
|
|
82
|
+
* group.</p>
|
|
82
83
|
*
|
|
83
84
|
* @throws {@link ElastiCacheServiceException}
|
|
84
85
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -23,8 +23,8 @@ export interface DescribeEngineDefaultParametersCommandOutput extends DescribeEn
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the default engine and
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns the default engine and system parameter information for the specified cache
|
|
27
|
+
* engine.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -23,12 +23,11 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns events related to clusters, cache
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* however, you can retrieve up to 14 days' worth of events if necessary.</p>
|
|
26
|
+
* <p>Returns events related to clusters, cache security groups, and cache parameter groups.
|
|
27
|
+
* You can obtain events specific to a particular cluster, cache security group, or cache
|
|
28
|
+
* parameter group by providing the name as a parameter.</p>
|
|
29
|
+
* <p>By default, only the events occurring within the last hour are returned; however, you
|
|
30
|
+
* can retrieve up to 14 days' worth of events if necessary.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -23,7 +23,8 @@ export interface DescribeGlobalReplicationGroupsCommandOutput extends DescribeGl
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about a particular global replication group. If no identifier is
|
|
26
|
+
* <p>Returns information about a particular global replication group. If no identifier is
|
|
27
|
+
* specified, returns information about all Global datastores. </p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
|
@@ -23,9 +23,9 @@ export interface DescribeReplicationGroupsCommandOutput extends ReplicationGroup
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about a particular
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Returns information about a particular replication group. If no identifier is
|
|
27
|
+
* specified, <code>DescribeReplicationGroups</code> returns information about all
|
|
28
|
+
* replication groups.</p>
|
|
29
29
|
* <note>
|
|
30
30
|
* <p>This operation is valid for Redis only.</p>
|
|
31
31
|
* </note>
|
|
@@ -23,8 +23,8 @@ export interface DescribeReservedCacheNodesCommandOutput extends ReservedCacheNo
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about reserved cache
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns information about reserved cache nodes for this account, or about a specified
|
|
27
|
+
* reserved cache node.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -23,8 +23,7 @@ export interface DescribeReservedCacheNodesOfferingsCommandOutput extends Reserv
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists available reserved cache
|
|
27
|
-
* node offerings.</p>
|
|
26
|
+
* <p>Lists available reserved cache node offerings.</p>
|
|
28
27
|
* @example
|
|
29
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
29
|
* ```javascript
|
|
@@ -23,8 +23,8 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsListMes
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about cluster or replication group snapshots.
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns information about cluster or replication group snapshots. By default,
|
|
27
|
+
* <code>DescribeSnapshots</code> lists all of your snapshots; it can optionally
|
|
28
28
|
* describe a single snapshot, or just the snapshots associated with a particular cache
|
|
29
29
|
* cluster.</p>
|
|
30
30
|
* <note>
|