@aws-sdk/client-elasticache 3.315.0 → 3.316.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-cjs/ElastiCache.js +69 -910
- package/dist-es/ElastiCache.js +69 -910
- package/dist-types/ElastiCache.d.ts +82 -540
- package/dist-types/ts3.4/ElastiCache.d.ts +4 -1
- package/package.json +6 -6
|
@@ -65,868 +65,410 @@ import { RevokeCacheSecurityGroupIngressCommandInput, RevokeCacheSecurityGroupIn
|
|
|
65
65
|
import { StartMigrationCommandInput, StartMigrationCommandOutput } from "./commands/StartMigrationCommand";
|
|
66
66
|
import { TestFailoverCommandInput, TestFailoverCommandOutput } from "./commands/TestFailoverCommand";
|
|
67
67
|
import { ElastiCacheClient } from "./ElastiCacheClient";
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
* <p>Amazon ElastiCache is a web service that makes it easier to set up, operate,
|
|
72
|
-
* and scale a distributed cache in the cloud.</p>
|
|
73
|
-
* <p>With ElastiCache, customers get all of the benefits of a high-performance,
|
|
74
|
-
* in-memory cache with less of the administrative burden involved in launching and managing a distributed cache.
|
|
75
|
-
* The service makes setup, scaling,
|
|
76
|
-
* and cluster failure handling much simpler than in a self-managed cache deployment.</p>
|
|
77
|
-
* <p>In addition, through integration with Amazon CloudWatch,
|
|
78
|
-
* customers get enhanced visibility into the key performance statistics
|
|
79
|
-
* associated with their cache and can receive alarms if a part of their cache runs hot.</p>
|
|
80
|
-
*/
|
|
81
|
-
export declare class ElastiCache extends ElastiCacheClient {
|
|
82
|
-
/**
|
|
83
|
-
* @public
|
|
84
|
-
* <p>A tag is a key-value pair where the key and value are case-sensitive.
|
|
85
|
-
* You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group.
|
|
86
|
-
* For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html">Resource-level permissions</a>.</p>
|
|
87
|
-
* <p>
|
|
88
|
-
* For example, you can use cost-allocation tags to your ElastiCache resources,
|
|
89
|
-
* Amazon generates a cost allocation report as a comma-separated value (CSV) file
|
|
90
|
-
* with your usage and costs aggregated by your tags.
|
|
91
|
-
* You can apply tags that represent business categories (such as cost centers, application names, or owners)
|
|
92
|
-
* to organize your costs across multiple services.</p>
|
|
93
|
-
* <p>For more information,
|
|
94
|
-
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html">Using Cost Allocation Tags in Amazon ElastiCache</a>
|
|
95
|
-
* in the <i>ElastiCache User Guide</i>.</p>
|
|
68
|
+
export interface ElastiCache {
|
|
69
|
+
/**
|
|
70
|
+
* @see {@link AddTagsToResourceCommand}
|
|
96
71
|
*/
|
|
97
72
|
addTagsToResource(args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions): Promise<AddTagsToResourceCommandOutput>;
|
|
98
73
|
addTagsToResource(args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void): void;
|
|
99
74
|
addTagsToResource(args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void): void;
|
|
100
75
|
/**
|
|
101
|
-
* @
|
|
102
|
-
* <p>Allows network ingress to a cache
|
|
103
|
-
* security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2
|
|
104
|
-
* security groups are used as the authorization mechanism.</p>
|
|
105
|
-
* <note>
|
|
106
|
-
* <p>You cannot authorize ingress from an Amazon EC2 security group in one region to an
|
|
107
|
-
* ElastiCache cluster in another region.</p>
|
|
108
|
-
* </note>
|
|
76
|
+
* @see {@link AuthorizeCacheSecurityGroupIngressCommand}
|
|
109
77
|
*/
|
|
110
78
|
authorizeCacheSecurityGroupIngress(args: AuthorizeCacheSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions): Promise<AuthorizeCacheSecurityGroupIngressCommandOutput>;
|
|
111
79
|
authorizeCacheSecurityGroupIngress(args: AuthorizeCacheSecurityGroupIngressCommandInput, cb: (err: any, data?: AuthorizeCacheSecurityGroupIngressCommandOutput) => void): void;
|
|
112
80
|
authorizeCacheSecurityGroupIngress(args: AuthorizeCacheSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthorizeCacheSecurityGroupIngressCommandOutput) => void): void;
|
|
113
81
|
/**
|
|
114
|
-
* @
|
|
115
|
-
* <p>Apply the service update. For more information on service updates and applying them, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/applying-updates.html">Applying Service Updates</a>.</p>
|
|
82
|
+
* @see {@link BatchApplyUpdateActionCommand}
|
|
116
83
|
*/
|
|
117
84
|
batchApplyUpdateAction(args: BatchApplyUpdateActionCommandInput, options?: __HttpHandlerOptions): Promise<BatchApplyUpdateActionCommandOutput>;
|
|
118
85
|
batchApplyUpdateAction(args: BatchApplyUpdateActionCommandInput, cb: (err: any, data?: BatchApplyUpdateActionCommandOutput) => void): void;
|
|
119
86
|
batchApplyUpdateAction(args: BatchApplyUpdateActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchApplyUpdateActionCommandOutput) => void): void;
|
|
120
87
|
/**
|
|
121
|
-
* @
|
|
122
|
-
* <p>Stop the service update. For more information on service updates and stopping them, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/stopping-self-service-updates.html">Stopping Service Updates</a>.</p>
|
|
88
|
+
* @see {@link BatchStopUpdateActionCommand}
|
|
123
89
|
*/
|
|
124
90
|
batchStopUpdateAction(args: BatchStopUpdateActionCommandInput, options?: __HttpHandlerOptions): Promise<BatchStopUpdateActionCommandOutput>;
|
|
125
91
|
batchStopUpdateAction(args: BatchStopUpdateActionCommandInput, cb: (err: any, data?: BatchStopUpdateActionCommandOutput) => void): void;
|
|
126
92
|
batchStopUpdateAction(args: BatchStopUpdateActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchStopUpdateActionCommandOutput) => void): void;
|
|
127
93
|
/**
|
|
128
|
-
* @
|
|
129
|
-
* <p>Complete the migration of data.</p>
|
|
94
|
+
* @see {@link CompleteMigrationCommand}
|
|
130
95
|
*/
|
|
131
96
|
completeMigration(args: CompleteMigrationCommandInput, options?: __HttpHandlerOptions): Promise<CompleteMigrationCommandOutput>;
|
|
132
97
|
completeMigration(args: CompleteMigrationCommandInput, cb: (err: any, data?: CompleteMigrationCommandOutput) => void): void;
|
|
133
98
|
completeMigration(args: CompleteMigrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteMigrationCommandOutput) => void): void;
|
|
134
99
|
/**
|
|
135
|
-
* @
|
|
136
|
-
* <p>Makes a copy of an existing snapshot.</p>
|
|
137
|
-
* <note>
|
|
138
|
-
* <p>This operation is valid for Redis only.</p>
|
|
139
|
-
* </note>
|
|
140
|
-
* <important>
|
|
141
|
-
* <p>Users or groups that have permissions to use the <code>CopySnapshot</code> operation
|
|
142
|
-
* can create their own Amazon S3 buckets and copy snapshots to it.
|
|
143
|
-
* To control access to your snapshots, use an IAM policy to control who has the ability to use
|
|
144
|
-
* the <code>CopySnapshot</code> operation.
|
|
145
|
-
* For more information about using IAM to control the use of ElastiCache operations, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html">Exporting Snapshots</a>
|
|
146
|
-
* and <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html">Authentication & Access Control</a>.</p>
|
|
147
|
-
* </important>
|
|
148
|
-
* <p>You could receive the following error messages.</p>
|
|
149
|
-
* <p class="title">
|
|
150
|
-
* <b>Error Messages</b>
|
|
151
|
-
* </p>
|
|
152
|
-
* <ul>
|
|
153
|
-
* <li>
|
|
154
|
-
* <p>
|
|
155
|
-
* <b>Error Message:</b>
|
|
156
|
-
* The S3 bucket %s is outside of the region.</p>
|
|
157
|
-
* <p>
|
|
158
|
-
* <b>Solution:</b>
|
|
159
|
-
* Create an Amazon S3 bucket in the same region as your snapshot.
|
|
160
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
|
|
161
|
-
* </li>
|
|
162
|
-
* <li>
|
|
163
|
-
* <p>
|
|
164
|
-
* <b>Error Message:</b>
|
|
165
|
-
* The S3 bucket %s does not exist.</p>
|
|
166
|
-
* <p>
|
|
167
|
-
* <b>Solution:</b>
|
|
168
|
-
* Create an Amazon S3 bucket in the same region as your snapshot.
|
|
169
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
|
|
170
|
-
* </li>
|
|
171
|
-
* <li>
|
|
172
|
-
* <p>
|
|
173
|
-
* <b>Error Message:</b>
|
|
174
|
-
* The S3 bucket %s is not owned by the authenticated user.</p>
|
|
175
|
-
* <p>
|
|
176
|
-
* <b>Solution:</b>
|
|
177
|
-
* Create an Amazon S3 bucket in the same region as your snapshot.
|
|
178
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
|
|
179
|
-
* </li>
|
|
180
|
-
* <li>
|
|
181
|
-
* <p>
|
|
182
|
-
* <b>Error Message:</b>
|
|
183
|
-
* The authenticated user does not have sufficient permissions to perform the desired activity.</p>
|
|
184
|
-
* <p>
|
|
185
|
-
* <b>Solution:</b>
|
|
186
|
-
* Contact your system administrator to get the needed permissions.</p>
|
|
187
|
-
* </li>
|
|
188
|
-
* <li>
|
|
189
|
-
* <p>
|
|
190
|
-
* <b>Error Message:</b>
|
|
191
|
-
* The S3 bucket %s already contains an object with key %s.</p>
|
|
192
|
-
* <p>
|
|
193
|
-
* <b>Solution:</b>
|
|
194
|
-
* Give the <code>TargetSnapshotName</code> a new and unique value.
|
|
195
|
-
* If exporting a snapshot,
|
|
196
|
-
* you could alternatively create a new Amazon S3 bucket
|
|
197
|
-
* and use this same value for <code>TargetSnapshotName</code>.</p>
|
|
198
|
-
* </li>
|
|
199
|
-
* <li>
|
|
200
|
-
* <p>
|
|
201
|
-
* <b>Error Message: </b>
|
|
202
|
-
* ElastiCache has not been granted READ permissions %s on the S3 Bucket.</p>
|
|
203
|
-
* <p>
|
|
204
|
-
* <b>Solution:</b>
|
|
205
|
-
* Add List and Read permissions on the bucket.
|
|
206
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
|
|
207
|
-
* </li>
|
|
208
|
-
* <li>
|
|
209
|
-
* <p>
|
|
210
|
-
* <b>Error Message: </b>
|
|
211
|
-
* ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.</p>
|
|
212
|
-
* <p>
|
|
213
|
-
* <b>Solution:</b>
|
|
214
|
-
* Add Upload/Delete permissions on the bucket.
|
|
215
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
|
|
216
|
-
* </li>
|
|
217
|
-
* <li>
|
|
218
|
-
* <p>
|
|
219
|
-
* <b>Error Message: </b>
|
|
220
|
-
* ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.</p>
|
|
221
|
-
* <p>
|
|
222
|
-
* <b>Solution:</b>
|
|
223
|
-
* Add View Permissions on the bucket.
|
|
224
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
|
|
225
|
-
* </li>
|
|
226
|
-
* </ul>
|
|
100
|
+
* @see {@link CopySnapshotCommand}
|
|
227
101
|
*/
|
|
228
102
|
copySnapshot(args: CopySnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CopySnapshotCommandOutput>;
|
|
229
103
|
copySnapshot(args: CopySnapshotCommandInput, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void;
|
|
230
104
|
copySnapshot(args: CopySnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopySnapshotCommandOutput) => void): void;
|
|
231
105
|
/**
|
|
232
|
-
* @
|
|
233
|
-
* <p>Creates a cluster. All nodes in the
|
|
234
|
-
* cluster run the same protocol-compliant cache engine software, either Memcached
|
|
235
|
-
* or Redis.</p>
|
|
236
|
-
* <p>This operation is not supported for Redis (cluster mode enabled) clusters.</p>
|
|
106
|
+
* @see {@link CreateCacheClusterCommand}
|
|
237
107
|
*/
|
|
238
108
|
createCacheCluster(args: CreateCacheClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateCacheClusterCommandOutput>;
|
|
239
109
|
createCacheCluster(args: CreateCacheClusterCommandInput, cb: (err: any, data?: CreateCacheClusterCommandOutput) => void): void;
|
|
240
110
|
createCacheCluster(args: CreateCacheClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCacheClusterCommandOutput) => void): void;
|
|
241
111
|
/**
|
|
242
|
-
* @
|
|
243
|
-
* <p>Creates a new Amazon ElastiCache cache parameter group. An ElastiCache
|
|
244
|
-
* cache parameter group is a collection of parameters and their values that are applied to all of the nodes
|
|
245
|
-
* in any cluster or replication group using the CacheParameterGroup.</p>
|
|
246
|
-
* <p>A newly created CacheParameterGroup is an exact duplicate of the default parameter group
|
|
247
|
-
* for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can
|
|
248
|
-
* change the values of specific parameters. For more information, see:</p>
|
|
249
|
-
* <ul>
|
|
250
|
-
* <li>
|
|
251
|
-
* <p>
|
|
252
|
-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html">ModifyCacheParameterGroup</a> in the ElastiCache API Reference.</p>
|
|
253
|
-
* </li>
|
|
254
|
-
* <li>
|
|
255
|
-
* <p>
|
|
256
|
-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html">Parameters and Parameter Groups</a> in the ElastiCache User Guide.</p>
|
|
257
|
-
* </li>
|
|
258
|
-
* </ul>
|
|
112
|
+
* @see {@link CreateCacheParameterGroupCommand}
|
|
259
113
|
*/
|
|
260
114
|
createCacheParameterGroup(args: CreateCacheParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateCacheParameterGroupCommandOutput>;
|
|
261
115
|
createCacheParameterGroup(args: CreateCacheParameterGroupCommandInput, cb: (err: any, data?: CreateCacheParameterGroupCommandOutput) => void): void;
|
|
262
116
|
createCacheParameterGroup(args: CreateCacheParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCacheParameterGroupCommandOutput) => void): void;
|
|
263
117
|
/**
|
|
264
|
-
* @
|
|
265
|
-
* <p>Creates a new cache security group. Use a
|
|
266
|
-
* cache security group to control access to one or more clusters.</p>
|
|
267
|
-
* <p>Cache security groups are only used when you are creating a cluster outside of an Amazon
|
|
268
|
-
* Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache
|
|
269
|
-
* subnet group instead. For more information,
|
|
270
|
-
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html">CreateCacheSubnetGroup</a>.</p>
|
|
118
|
+
* @see {@link CreateCacheSecurityGroupCommand}
|
|
271
119
|
*/
|
|
272
120
|
createCacheSecurityGroup(args: CreateCacheSecurityGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateCacheSecurityGroupCommandOutput>;
|
|
273
121
|
createCacheSecurityGroup(args: CreateCacheSecurityGroupCommandInput, cb: (err: any, data?: CreateCacheSecurityGroupCommandOutput) => void): void;
|
|
274
122
|
createCacheSecurityGroup(args: CreateCacheSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCacheSecurityGroupCommandOutput) => void): void;
|
|
275
123
|
/**
|
|
276
|
-
* @
|
|
277
|
-
* <p>Creates a new cache subnet group.</p>
|
|
278
|
-
* <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p>
|
|
124
|
+
* @see {@link CreateCacheSubnetGroupCommand}
|
|
279
125
|
*/
|
|
280
126
|
createCacheSubnetGroup(args: CreateCacheSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateCacheSubnetGroupCommandOutput>;
|
|
281
127
|
createCacheSubnetGroup(args: CreateCacheSubnetGroupCommandInput, cb: (err: any, data?: CreateCacheSubnetGroupCommandOutput) => void): void;
|
|
282
128
|
createCacheSubnetGroup(args: CreateCacheSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCacheSubnetGroupCommandOutput) => void): void;
|
|
283
129
|
/**
|
|
284
|
-
* @
|
|
285
|
-
* <p>Global Datastore for Redis offers fully managed, fast,
|
|
286
|
-
* reliable and secure cross-region replication.
|
|
287
|
-
* Using Global Datastore for Redis, you can create cross-region
|
|
288
|
-
* read replica clusters for ElastiCache for Redis to enable low-latency reads
|
|
289
|
-
* and disaster recovery across regions. For more information,
|
|
290
|
-
*
|
|
291
|
-
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication Across Regions Using Global Datastore</a>. </p>
|
|
292
|
-
* <ul>
|
|
293
|
-
* <li>
|
|
294
|
-
* <p>The <b>GlobalReplicationGroupIdSuffix</b> is the name of the Global datastore.</p>
|
|
295
|
-
* </li>
|
|
296
|
-
* <li>
|
|
297
|
-
* <p>The <b>PrimaryReplicationGroupId</b> represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.</p>
|
|
298
|
-
* </li>
|
|
299
|
-
* </ul>
|
|
130
|
+
* @see {@link CreateGlobalReplicationGroupCommand}
|
|
300
131
|
*/
|
|
301
132
|
createGlobalReplicationGroup(args: CreateGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGlobalReplicationGroupCommandOutput>;
|
|
302
133
|
createGlobalReplicationGroup(args: CreateGlobalReplicationGroupCommandInput, cb: (err: any, data?: CreateGlobalReplicationGroupCommandOutput) => void): void;
|
|
303
134
|
createGlobalReplicationGroup(args: CreateGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalReplicationGroupCommandOutput) => void): void;
|
|
304
135
|
/**
|
|
305
|
-
* @
|
|
306
|
-
* <p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p>
|
|
307
|
-
* <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.</p>
|
|
308
|
-
* <p>A Redis (cluster mode disabled) replication group is a collection of clusters,
|
|
309
|
-
* where one of the clusters is a read/write primary and the others are read-only replicas.
|
|
310
|
-
* Writes to the primary are asynchronously propagated to the replicas.</p>
|
|
311
|
-
* <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups).
|
|
312
|
-
* Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
|
|
313
|
-
*
|
|
314
|
-
* </p>
|
|
315
|
-
* <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between
|
|
316
|
-
* 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase.
|
|
317
|
-
* Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see
|
|
318
|
-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html">Creating a Subnet Group</a>. For versions below 5.0.6,
|
|
319
|
-
* the limit is 250 per cluster.</p>
|
|
320
|
-
* <p>To request a limit increase, see
|
|
321
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">Amazon Service Limits</a>
|
|
322
|
-
* and choose the limit type <b>Nodes per cluster per instance type</b>. </p>
|
|
323
|
-
* <p>When a Redis (cluster mode disabled) replication group has been successfully created,
|
|
324
|
-
* you can add one or more read replicas to it, up to a total of 5 read replicas.
|
|
325
|
-
* If you need to increase or decrease the number of node groups (console: shards),
|
|
326
|
-
* you can avail yourself of ElastiCache for Redis' scaling. For more information,
|
|
327
|
-
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p>
|
|
328
|
-
* <note>
|
|
329
|
-
* <p>This operation is valid for Redis only.</p>
|
|
330
|
-
* </note>
|
|
136
|
+
* @see {@link CreateReplicationGroupCommand}
|
|
331
137
|
*/
|
|
332
138
|
createReplicationGroup(args: CreateReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateReplicationGroupCommandOutput>;
|
|
333
139
|
createReplicationGroup(args: CreateReplicationGroupCommandInput, cb: (err: any, data?: CreateReplicationGroupCommandOutput) => void): void;
|
|
334
140
|
createReplicationGroup(args: CreateReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationGroupCommandOutput) => void): void;
|
|
335
141
|
/**
|
|
336
|
-
* @
|
|
337
|
-
* <p>Creates a copy of an entire cluster or replication group at a
|
|
338
|
-
* specific moment in time.</p>
|
|
339
|
-
* <note>
|
|
340
|
-
* <p>This operation is valid for Redis only.</p>
|
|
341
|
-
* </note>
|
|
142
|
+
* @see {@link CreateSnapshotCommand}
|
|
342
143
|
*/
|
|
343
144
|
createSnapshot(args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CreateSnapshotCommandOutput>;
|
|
344
145
|
createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void;
|
|
345
146
|
createSnapshot(args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void;
|
|
346
147
|
/**
|
|
347
|
-
* @
|
|
348
|
-
* <p>For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>.</p>
|
|
148
|
+
* @see {@link CreateUserCommand}
|
|
349
149
|
*/
|
|
350
150
|
createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserCommandOutput>;
|
|
351
151
|
createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
|
|
352
152
|
createUser(args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
|
|
353
153
|
/**
|
|
354
|
-
* @
|
|
355
|
-
* <p>For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>
|
|
356
|
-
* </p>
|
|
154
|
+
* @see {@link CreateUserGroupCommand}
|
|
357
155
|
*/
|
|
358
156
|
createUserGroup(args: CreateUserGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserGroupCommandOutput>;
|
|
359
157
|
createUserGroup(args: CreateUserGroupCommandInput, cb: (err: any, data?: CreateUserGroupCommandOutput) => void): void;
|
|
360
158
|
createUserGroup(args: CreateUserGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserGroupCommandOutput) => void): void;
|
|
361
159
|
/**
|
|
362
|
-
* @
|
|
363
|
-
* <p>Decreases the number of node groups in a Global datastore</p>
|
|
160
|
+
* @see {@link DecreaseNodeGroupsInGlobalReplicationGroupCommand}
|
|
364
161
|
*/
|
|
365
162
|
decreaseNodeGroupsInGlobalReplicationGroup(args: DecreaseNodeGroupsInGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput>;
|
|
366
163
|
decreaseNodeGroupsInGlobalReplicationGroup(args: DecreaseNodeGroupsInGlobalReplicationGroupCommandInput, cb: (err: any, data?: DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void): void;
|
|
367
164
|
decreaseNodeGroupsInGlobalReplicationGroup(args: DecreaseNodeGroupsInGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void): void;
|
|
368
165
|
/**
|
|
369
|
-
* @
|
|
370
|
-
* <p>Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of
|
|
371
|
-
* replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation
|
|
372
|
-
* is performed with no cluster down time.</p>
|
|
166
|
+
* @see {@link DecreaseReplicaCountCommand}
|
|
373
167
|
*/
|
|
374
168
|
decreaseReplicaCount(args: DecreaseReplicaCountCommandInput, options?: __HttpHandlerOptions): Promise<DecreaseReplicaCountCommandOutput>;
|
|
375
169
|
decreaseReplicaCount(args: DecreaseReplicaCountCommandInput, cb: (err: any, data?: DecreaseReplicaCountCommandOutput) => void): void;
|
|
376
170
|
decreaseReplicaCount(args: DecreaseReplicaCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecreaseReplicaCountCommandOutput) => void): void;
|
|
377
171
|
/**
|
|
378
|
-
* @
|
|
379
|
-
* <p>Deletes a previously provisioned cluster.
|
|
380
|
-
* <code>DeleteCacheCluster</code> deletes all associated cache nodes, node endpoints and the
|
|
381
|
-
* cluster itself. When you receive a successful response from this operation,
|
|
382
|
-
* Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert
|
|
383
|
-
* this operation.</p>
|
|
384
|
-
* <p>This operation is not valid for:</p>
|
|
385
|
-
* <ul>
|
|
386
|
-
* <li>
|
|
387
|
-
* <p>Redis (cluster mode enabled) clusters</p>
|
|
388
|
-
* </li>
|
|
389
|
-
* <li>
|
|
390
|
-
* <p>Redis (cluster mode disabled) clusters</p>
|
|
391
|
-
* </li>
|
|
392
|
-
* <li>
|
|
393
|
-
* <p>A cluster that is the last read replica of a replication group</p>
|
|
394
|
-
* </li>
|
|
395
|
-
* <li>
|
|
396
|
-
* <p>A cluster that is the primary node of a replication group</p>
|
|
397
|
-
* </li>
|
|
398
|
-
* <li>
|
|
399
|
-
* <p>A node group (shard) that has Multi-AZ mode enabled</p>
|
|
400
|
-
* </li>
|
|
401
|
-
* <li>
|
|
402
|
-
* <p>A cluster from a Redis (cluster mode enabled) replication group</p>
|
|
403
|
-
* </li>
|
|
404
|
-
* <li>
|
|
405
|
-
* <p>A cluster that is not in the <code>available</code> state</p>
|
|
406
|
-
* </li>
|
|
407
|
-
* </ul>
|
|
172
|
+
* @see {@link DeleteCacheClusterCommand}
|
|
408
173
|
*/
|
|
409
174
|
deleteCacheCluster(args: DeleteCacheClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCacheClusterCommandOutput>;
|
|
410
175
|
deleteCacheCluster(args: DeleteCacheClusterCommandInput, cb: (err: any, data?: DeleteCacheClusterCommandOutput) => void): void;
|
|
411
176
|
deleteCacheCluster(args: DeleteCacheClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCacheClusterCommandOutput) => void): void;
|
|
412
177
|
/**
|
|
413
|
-
* @
|
|
414
|
-
* <p>Deletes the specified cache parameter
|
|
415
|
-
* group. You cannot delete a cache parameter group if it is associated with any cache
|
|
416
|
-
* clusters. You cannot delete the default cache parameter groups in your account.</p>
|
|
178
|
+
* @see {@link DeleteCacheParameterGroupCommand}
|
|
417
179
|
*/
|
|
418
180
|
deleteCacheParameterGroup(args: DeleteCacheParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCacheParameterGroupCommandOutput>;
|
|
419
181
|
deleteCacheParameterGroup(args: DeleteCacheParameterGroupCommandInput, cb: (err: any, data?: DeleteCacheParameterGroupCommandOutput) => void): void;
|
|
420
182
|
deleteCacheParameterGroup(args: DeleteCacheParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCacheParameterGroupCommandOutput) => void): void;
|
|
421
183
|
/**
|
|
422
|
-
* @
|
|
423
|
-
* <p>Deletes a cache security group.</p>
|
|
424
|
-
* <note>
|
|
425
|
-
* <p>You cannot delete a cache security group if it is associated with any clusters.</p>
|
|
426
|
-
* </note>
|
|
184
|
+
* @see {@link DeleteCacheSecurityGroupCommand}
|
|
427
185
|
*/
|
|
428
186
|
deleteCacheSecurityGroup(args: DeleteCacheSecurityGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCacheSecurityGroupCommandOutput>;
|
|
429
187
|
deleteCacheSecurityGroup(args: DeleteCacheSecurityGroupCommandInput, cb: (err: any, data?: DeleteCacheSecurityGroupCommandOutput) => void): void;
|
|
430
188
|
deleteCacheSecurityGroup(args: DeleteCacheSecurityGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCacheSecurityGroupCommandOutput) => void): void;
|
|
431
189
|
/**
|
|
432
|
-
* @
|
|
433
|
-
* <p>Deletes a cache subnet group.</p>
|
|
434
|
-
* <note>
|
|
435
|
-
* <p>You cannot delete a default cache subnet group or one that is associated with any clusters.</p>
|
|
436
|
-
* </note>
|
|
190
|
+
* @see {@link DeleteCacheSubnetGroupCommand}
|
|
437
191
|
*/
|
|
438
192
|
deleteCacheSubnetGroup(args: DeleteCacheSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCacheSubnetGroupCommandOutput>;
|
|
439
193
|
deleteCacheSubnetGroup(args: DeleteCacheSubnetGroupCommandInput, cb: (err: any, data?: DeleteCacheSubnetGroupCommandOutput) => void): void;
|
|
440
194
|
deleteCacheSubnetGroup(args: DeleteCacheSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCacheSubnetGroupCommandOutput) => void): void;
|
|
441
195
|
/**
|
|
442
|
-
* @
|
|
443
|
-
* <p>Deleting a Global datastore is a two-step process: </p>
|
|
444
|
-
* <ul>
|
|
445
|
-
* <li>
|
|
446
|
-
* <p>First, you must <a>DisassociateGlobalReplicationGroup</a> to remove the secondary clusters in the Global datastore.</p>
|
|
447
|
-
* </li>
|
|
448
|
-
* <li>
|
|
449
|
-
* <p>Once the Global datastore contains only the primary cluster, you can use the <code>DeleteGlobalReplicationGroup</code> API to delete the Global datastore while retainining the primary cluster using <code>RetainPrimaryReplicationGroup=true</code>.</p>
|
|
450
|
-
* </li>
|
|
451
|
-
* </ul>
|
|
452
|
-
* <p>Since the Global Datastore has only a primary cluster, you can delete the Global Datastore
|
|
453
|
-
* while retaining the primary by setting <code>RetainPrimaryReplicationGroup=true</code>. The primary cluster is never deleted when deleting a
|
|
454
|
-
* Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.</p>
|
|
455
|
-
* <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources;
|
|
456
|
-
* you cannot cancel or revert this operation.</p>
|
|
196
|
+
* @see {@link DeleteGlobalReplicationGroupCommand}
|
|
457
197
|
*/
|
|
458
198
|
deleteGlobalReplicationGroup(args: DeleteGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGlobalReplicationGroupCommandOutput>;
|
|
459
199
|
deleteGlobalReplicationGroup(args: DeleteGlobalReplicationGroupCommandInput, cb: (err: any, data?: DeleteGlobalReplicationGroupCommandOutput) => void): void;
|
|
460
200
|
deleteGlobalReplicationGroup(args: DeleteGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGlobalReplicationGroupCommandOutput) => void): void;
|
|
461
201
|
/**
|
|
462
|
-
* @
|
|
463
|
-
* <p>Deletes an existing replication group.
|
|
464
|
-
* By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas.
|
|
465
|
-
* If the replication group has only one primary,
|
|
466
|
-
* you can optionally delete only the read replicas, while retaining the primary by setting <code>RetainPrimaryCluster=true</code>.</p>
|
|
467
|
-
* <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources;
|
|
468
|
-
* you cannot cancel or revert this operation.</p>
|
|
469
|
-
* <note>
|
|
470
|
-
* <p>This operation is valid for Redis only.</p>
|
|
471
|
-
* </note>
|
|
202
|
+
* @see {@link DeleteReplicationGroupCommand}
|
|
472
203
|
*/
|
|
473
204
|
deleteReplicationGroup(args: DeleteReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteReplicationGroupCommandOutput>;
|
|
474
205
|
deleteReplicationGroup(args: DeleteReplicationGroupCommandInput, cb: (err: any, data?: DeleteReplicationGroupCommandOutput) => void): void;
|
|
475
206
|
deleteReplicationGroup(args: DeleteReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationGroupCommandOutput) => void): void;
|
|
476
207
|
/**
|
|
477
|
-
* @
|
|
478
|
-
* <p>Deletes an existing snapshot. When you receive a
|
|
479
|
-
* successful response from this operation, ElastiCache immediately begins deleting the snapshot;
|
|
480
|
-
* you cannot cancel or revert this operation.</p>
|
|
481
|
-
* <note>
|
|
482
|
-
* <p>This operation is valid for Redis only.</p>
|
|
483
|
-
* </note>
|
|
208
|
+
* @see {@link DeleteSnapshotCommand}
|
|
484
209
|
*/
|
|
485
210
|
deleteSnapshot(args: DeleteSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSnapshotCommandOutput>;
|
|
486
211
|
deleteSnapshot(args: DeleteSnapshotCommandInput, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void): void;
|
|
487
212
|
deleteSnapshot(args: DeleteSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotCommandOutput) => void): void;
|
|
488
213
|
/**
|
|
489
|
-
* @
|
|
490
|
-
* <p>For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
|
|
214
|
+
* @see {@link DeleteUserCommand}
|
|
491
215
|
*/
|
|
492
216
|
deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserCommandOutput>;
|
|
493
217
|
deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
|
|
494
218
|
deleteUser(args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
|
|
495
219
|
/**
|
|
496
|
-
* @
|
|
497
|
-
* <p>For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>. </p>
|
|
220
|
+
* @see {@link DeleteUserGroupCommand}
|
|
498
221
|
*/
|
|
499
222
|
deleteUserGroup(args: DeleteUserGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserGroupCommandOutput>;
|
|
500
223
|
deleteUserGroup(args: DeleteUserGroupCommandInput, cb: (err: any, data?: DeleteUserGroupCommandOutput) => void): void;
|
|
501
224
|
deleteUserGroup(args: DeleteUserGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserGroupCommandOutput) => void): void;
|
|
502
225
|
/**
|
|
503
|
-
* @
|
|
504
|
-
* <p>Returns information about all provisioned
|
|
505
|
-
* clusters if no cluster identifier is specified, or about a specific cache
|
|
506
|
-
* cluster if a cluster identifier is supplied.</p>
|
|
507
|
-
* <p>By default, abbreviated information about the clusters is returned. You can
|
|
508
|
-
* use the optional <i>ShowCacheNodeInfo</i> flag to retrieve detailed information about the
|
|
509
|
-
* cache nodes associated with the clusters. These details include the DNS address
|
|
510
|
-
* and port for the cache node endpoint.</p>
|
|
511
|
-
* <p>If the cluster is in the <i>creating</i> state, only cluster-level information is displayed
|
|
512
|
-
* until all of the nodes are successfully provisioned.</p>
|
|
513
|
-
* <p>If the cluster is in the <i>deleting</i> state, only cluster-level information is displayed.</p>
|
|
514
|
-
* <p>If cache nodes are currently being added to the cluster, node endpoint information
|
|
515
|
-
* and creation time for the additional nodes are not displayed until they are
|
|
516
|
-
* completely provisioned. When the cluster state is <i>available</i>, the cluster is
|
|
517
|
-
* ready for use.</p>
|
|
518
|
-
* <p>If cache nodes are currently being removed from the cluster, no endpoint information
|
|
519
|
-
* for the removed nodes is displayed.</p>
|
|
226
|
+
* @see {@link DescribeCacheClustersCommand}
|
|
520
227
|
*/
|
|
521
228
|
describeCacheClusters(args: DescribeCacheClustersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCacheClustersCommandOutput>;
|
|
522
229
|
describeCacheClusters(args: DescribeCacheClustersCommandInput, cb: (err: any, data?: DescribeCacheClustersCommandOutput) => void): void;
|
|
523
230
|
describeCacheClusters(args: DescribeCacheClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheClustersCommandOutput) => void): void;
|
|
524
231
|
/**
|
|
525
|
-
* @
|
|
526
|
-
* <p>Returns a list of the available cache
|
|
527
|
-
* engines and their versions.</p>
|
|
232
|
+
* @see {@link DescribeCacheEngineVersionsCommand}
|
|
528
233
|
*/
|
|
529
234
|
describeCacheEngineVersions(args: DescribeCacheEngineVersionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCacheEngineVersionsCommandOutput>;
|
|
530
235
|
describeCacheEngineVersions(args: DescribeCacheEngineVersionsCommandInput, cb: (err: any, data?: DescribeCacheEngineVersionsCommandOutput) => void): void;
|
|
531
236
|
describeCacheEngineVersions(args: DescribeCacheEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheEngineVersionsCommandOutput) => void): void;
|
|
532
237
|
/**
|
|
533
|
-
* @
|
|
534
|
-
* <p>Returns a list of cache parameter group
|
|
535
|
-
* descriptions. If a cache parameter group name is specified, the list contains only
|
|
536
|
-
* the descriptions for that group.</p>
|
|
238
|
+
* @see {@link DescribeCacheParameterGroupsCommand}
|
|
537
239
|
*/
|
|
538
240
|
describeCacheParameterGroups(args: DescribeCacheParameterGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCacheParameterGroupsCommandOutput>;
|
|
539
241
|
describeCacheParameterGroups(args: DescribeCacheParameterGroupsCommandInput, cb: (err: any, data?: DescribeCacheParameterGroupsCommandOutput) => void): void;
|
|
540
242
|
describeCacheParameterGroups(args: DescribeCacheParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheParameterGroupsCommandOutput) => void): void;
|
|
541
243
|
/**
|
|
542
|
-
* @
|
|
543
|
-
* <p>Returns the detailed parameter list for a
|
|
544
|
-
* particular cache parameter group.</p>
|
|
244
|
+
* @see {@link DescribeCacheParametersCommand}
|
|
545
245
|
*/
|
|
546
246
|
describeCacheParameters(args: DescribeCacheParametersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCacheParametersCommandOutput>;
|
|
547
247
|
describeCacheParameters(args: DescribeCacheParametersCommandInput, cb: (err: any, data?: DescribeCacheParametersCommandOutput) => void): void;
|
|
548
248
|
describeCacheParameters(args: DescribeCacheParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheParametersCommandOutput) => void): void;
|
|
549
249
|
/**
|
|
550
|
-
* @
|
|
551
|
-
* <p>Returns a list of cache security group
|
|
552
|
-
* descriptions. If a cache security group name is specified, the list contains only
|
|
553
|
-
* the description of that group. This applicable only when you have ElastiCache in Classic setup
|
|
554
|
-
* </p>
|
|
250
|
+
* @see {@link DescribeCacheSecurityGroupsCommand}
|
|
555
251
|
*/
|
|
556
252
|
describeCacheSecurityGroups(args: DescribeCacheSecurityGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCacheSecurityGroupsCommandOutput>;
|
|
557
253
|
describeCacheSecurityGroups(args: DescribeCacheSecurityGroupsCommandInput, cb: (err: any, data?: DescribeCacheSecurityGroupsCommandOutput) => void): void;
|
|
558
254
|
describeCacheSecurityGroups(args: DescribeCacheSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheSecurityGroupsCommandOutput) => void): void;
|
|
559
255
|
/**
|
|
560
|
-
* @
|
|
561
|
-
* <p>Returns a list of cache subnet group
|
|
562
|
-
* descriptions. If a subnet group name is specified, the list contains only the
|
|
563
|
-
* description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
|
|
564
|
-
* </p>
|
|
256
|
+
* @see {@link DescribeCacheSubnetGroupsCommand}
|
|
565
257
|
*/
|
|
566
258
|
describeCacheSubnetGroups(args: DescribeCacheSubnetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCacheSubnetGroupsCommandOutput>;
|
|
567
259
|
describeCacheSubnetGroups(args: DescribeCacheSubnetGroupsCommandInput, cb: (err: any, data?: DescribeCacheSubnetGroupsCommandOutput) => void): void;
|
|
568
260
|
describeCacheSubnetGroups(args: DescribeCacheSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheSubnetGroupsCommandOutput) => void): void;
|
|
569
261
|
/**
|
|
570
|
-
* @
|
|
571
|
-
* <p>Returns the default engine and
|
|
572
|
-
* system parameter information for the specified cache engine.</p>
|
|
262
|
+
* @see {@link DescribeEngineDefaultParametersCommand}
|
|
573
263
|
*/
|
|
574
264
|
describeEngineDefaultParameters(args: DescribeEngineDefaultParametersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEngineDefaultParametersCommandOutput>;
|
|
575
265
|
describeEngineDefaultParameters(args: DescribeEngineDefaultParametersCommandInput, cb: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void): void;
|
|
576
266
|
describeEngineDefaultParameters(args: DescribeEngineDefaultParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineDefaultParametersCommandOutput) => void): void;
|
|
577
267
|
/**
|
|
578
|
-
* @
|
|
579
|
-
* <p>Returns events related to clusters, cache
|
|
580
|
-
* security groups, and cache parameter groups. You can obtain events specific to a
|
|
581
|
-
* particular cluster, cache security group, or cache parameter group by providing
|
|
582
|
-
* the name as a parameter.</p>
|
|
583
|
-
* <p>By default, only the events occurring within the last hour are returned;
|
|
584
|
-
* however, you can retrieve up to 14 days' worth of events if necessary.</p>
|
|
268
|
+
* @see {@link DescribeEventsCommand}
|
|
585
269
|
*/
|
|
586
270
|
describeEvents(args: DescribeEventsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventsCommandOutput>;
|
|
587
271
|
describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
|
|
588
272
|
describeEvents(args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
|
|
589
273
|
/**
|
|
590
|
-
* @
|
|
591
|
-
* <p>Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. </p>
|
|
274
|
+
* @see {@link DescribeGlobalReplicationGroupsCommand}
|
|
592
275
|
*/
|
|
593
276
|
describeGlobalReplicationGroups(args: DescribeGlobalReplicationGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGlobalReplicationGroupsCommandOutput>;
|
|
594
277
|
describeGlobalReplicationGroups(args: DescribeGlobalReplicationGroupsCommandInput, cb: (err: any, data?: DescribeGlobalReplicationGroupsCommandOutput) => void): void;
|
|
595
278
|
describeGlobalReplicationGroups(args: DescribeGlobalReplicationGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalReplicationGroupsCommandOutput) => void): void;
|
|
596
279
|
/**
|
|
597
|
-
* @
|
|
598
|
-
* <p>Returns information about a particular
|
|
599
|
-
* replication group. If no identifier is specified, <code>DescribeReplicationGroups</code>
|
|
600
|
-
* returns information about all replication groups.</p>
|
|
601
|
-
* <note>
|
|
602
|
-
* <p>This operation is valid for Redis only.</p>
|
|
603
|
-
* </note>
|
|
280
|
+
* @see {@link DescribeReplicationGroupsCommand}
|
|
604
281
|
*/
|
|
605
282
|
describeReplicationGroups(args: DescribeReplicationGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeReplicationGroupsCommandOutput>;
|
|
606
283
|
describeReplicationGroups(args: DescribeReplicationGroupsCommandInput, cb: (err: any, data?: DescribeReplicationGroupsCommandOutput) => void): void;
|
|
607
284
|
describeReplicationGroups(args: DescribeReplicationGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationGroupsCommandOutput) => void): void;
|
|
608
285
|
/**
|
|
609
|
-
* @
|
|
610
|
-
* <p>Returns information about reserved cache
|
|
611
|
-
* nodes for this account, or about a specified reserved cache node.</p>
|
|
286
|
+
* @see {@link DescribeReservedCacheNodesCommand}
|
|
612
287
|
*/
|
|
613
288
|
describeReservedCacheNodes(args: DescribeReservedCacheNodesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeReservedCacheNodesCommandOutput>;
|
|
614
289
|
describeReservedCacheNodes(args: DescribeReservedCacheNodesCommandInput, cb: (err: any, data?: DescribeReservedCacheNodesCommandOutput) => void): void;
|
|
615
290
|
describeReservedCacheNodes(args: DescribeReservedCacheNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedCacheNodesCommandOutput) => void): void;
|
|
616
291
|
/**
|
|
617
|
-
* @
|
|
618
|
-
* <p>Lists available reserved cache
|
|
619
|
-
* node offerings.</p>
|
|
292
|
+
* @see {@link DescribeReservedCacheNodesOfferingsCommand}
|
|
620
293
|
*/
|
|
621
294
|
describeReservedCacheNodesOfferings(args: DescribeReservedCacheNodesOfferingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeReservedCacheNodesOfferingsCommandOutput>;
|
|
622
295
|
describeReservedCacheNodesOfferings(args: DescribeReservedCacheNodesOfferingsCommandInput, cb: (err: any, data?: DescribeReservedCacheNodesOfferingsCommandOutput) => void): void;
|
|
623
296
|
describeReservedCacheNodesOfferings(args: DescribeReservedCacheNodesOfferingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReservedCacheNodesOfferingsCommandOutput) => void): void;
|
|
624
297
|
/**
|
|
625
|
-
* @
|
|
626
|
-
* <p>Returns details of the service updates</p>
|
|
298
|
+
* @see {@link DescribeServiceUpdatesCommand}
|
|
627
299
|
*/
|
|
628
300
|
describeServiceUpdates(args: DescribeServiceUpdatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeServiceUpdatesCommandOutput>;
|
|
629
301
|
describeServiceUpdates(args: DescribeServiceUpdatesCommandInput, cb: (err: any, data?: DescribeServiceUpdatesCommandOutput) => void): void;
|
|
630
302
|
describeServiceUpdates(args: DescribeServiceUpdatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceUpdatesCommandOutput) => void): void;
|
|
631
303
|
/**
|
|
632
|
-
* @
|
|
633
|
-
* <p>Returns information about cluster or replication group snapshots.
|
|
634
|
-
* By default, <code>DescribeSnapshots</code> lists all of your snapshots; it can optionally
|
|
635
|
-
* describe a single snapshot, or just the snapshots associated with a particular cache
|
|
636
|
-
* cluster.</p>
|
|
637
|
-
* <note>
|
|
638
|
-
* <p>This operation is valid for Redis only.</p>
|
|
639
|
-
* </note>
|
|
304
|
+
* @see {@link DescribeSnapshotsCommand}
|
|
640
305
|
*/
|
|
641
306
|
describeSnapshots(args: DescribeSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSnapshotsCommandOutput>;
|
|
642
307
|
describeSnapshots(args: DescribeSnapshotsCommandInput, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void): void;
|
|
643
308
|
describeSnapshots(args: DescribeSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotsCommandOutput) => void): void;
|
|
644
309
|
/**
|
|
645
|
-
* @
|
|
646
|
-
* <p>Returns details of the update actions </p>
|
|
310
|
+
* @see {@link DescribeUpdateActionsCommand}
|
|
647
311
|
*/
|
|
648
312
|
describeUpdateActions(args: DescribeUpdateActionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUpdateActionsCommandOutput>;
|
|
649
313
|
describeUpdateActions(args: DescribeUpdateActionsCommandInput, cb: (err: any, data?: DescribeUpdateActionsCommandOutput) => void): void;
|
|
650
314
|
describeUpdateActions(args: DescribeUpdateActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUpdateActionsCommandOutput) => void): void;
|
|
651
315
|
/**
|
|
652
|
-
* @
|
|
653
|
-
* <p>Returns a list of user groups.</p>
|
|
316
|
+
* @see {@link DescribeUserGroupsCommand}
|
|
654
317
|
*/
|
|
655
318
|
describeUserGroups(args: DescribeUserGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserGroupsCommandOutput>;
|
|
656
319
|
describeUserGroups(args: DescribeUserGroupsCommandInput, cb: (err: any, data?: DescribeUserGroupsCommandOutput) => void): void;
|
|
657
320
|
describeUserGroups(args: DescribeUserGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserGroupsCommandOutput) => void): void;
|
|
658
321
|
/**
|
|
659
|
-
* @
|
|
660
|
-
* <p>Returns a list of users.</p>
|
|
322
|
+
* @see {@link DescribeUsersCommand}
|
|
661
323
|
*/
|
|
662
324
|
describeUsers(args: DescribeUsersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUsersCommandOutput>;
|
|
663
325
|
describeUsers(args: DescribeUsersCommandInput, cb: (err: any, data?: DescribeUsersCommandOutput) => void): void;
|
|
664
326
|
describeUsers(args: DescribeUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUsersCommandOutput) => void): void;
|
|
665
327
|
/**
|
|
666
|
-
* @
|
|
667
|
-
* <p>Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.</p>
|
|
328
|
+
* @see {@link DisassociateGlobalReplicationGroupCommand}
|
|
668
329
|
*/
|
|
669
330
|
disassociateGlobalReplicationGroup(args: DisassociateGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateGlobalReplicationGroupCommandOutput>;
|
|
670
331
|
disassociateGlobalReplicationGroup(args: DisassociateGlobalReplicationGroupCommandInput, cb: (err: any, data?: DisassociateGlobalReplicationGroupCommandOutput) => void): void;
|
|
671
332
|
disassociateGlobalReplicationGroup(args: DisassociateGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateGlobalReplicationGroupCommandOutput) => void): void;
|
|
672
333
|
/**
|
|
673
|
-
* @
|
|
674
|
-
* <p>Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.</p>
|
|
334
|
+
* @see {@link FailoverGlobalReplicationGroupCommand}
|
|
675
335
|
*/
|
|
676
336
|
failoverGlobalReplicationGroup(args: FailoverGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<FailoverGlobalReplicationGroupCommandOutput>;
|
|
677
337
|
failoverGlobalReplicationGroup(args: FailoverGlobalReplicationGroupCommandInput, cb: (err: any, data?: FailoverGlobalReplicationGroupCommandOutput) => void): void;
|
|
678
338
|
failoverGlobalReplicationGroup(args: FailoverGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverGlobalReplicationGroupCommandOutput) => void): void;
|
|
679
339
|
/**
|
|
680
|
-
* @
|
|
681
|
-
* <p>Increase the number of node groups in the Global datastore</p>
|
|
340
|
+
* @see {@link IncreaseNodeGroupsInGlobalReplicationGroupCommand}
|
|
682
341
|
*/
|
|
683
342
|
increaseNodeGroupsInGlobalReplicationGroup(args: IncreaseNodeGroupsInGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput>;
|
|
684
343
|
increaseNodeGroupsInGlobalReplicationGroup(args: IncreaseNodeGroupsInGlobalReplicationGroupCommandInput, cb: (err: any, data?: IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void): void;
|
|
685
344
|
increaseNodeGroupsInGlobalReplicationGroup(args: IncreaseNodeGroupsInGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput) => void): void;
|
|
686
345
|
/**
|
|
687
|
-
* @
|
|
688
|
-
* <p>Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of
|
|
689
|
-
* replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation
|
|
690
|
-
* is performed with no cluster down time.</p>
|
|
346
|
+
* @see {@link IncreaseReplicaCountCommand}
|
|
691
347
|
*/
|
|
692
348
|
increaseReplicaCount(args: IncreaseReplicaCountCommandInput, options?: __HttpHandlerOptions): Promise<IncreaseReplicaCountCommandOutput>;
|
|
693
349
|
increaseReplicaCount(args: IncreaseReplicaCountCommandInput, cb: (err: any, data?: IncreaseReplicaCountCommandOutput) => void): void;
|
|
694
350
|
increaseReplicaCount(args: IncreaseReplicaCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IncreaseReplicaCountCommandOutput) => void): void;
|
|
695
351
|
/**
|
|
696
|
-
* @
|
|
697
|
-
* <p>Lists all available node types that you
|
|
698
|
-
* can scale your Redis cluster's or replication group's current node type.</p>
|
|
699
|
-
* <p>When you use the <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code> operations to
|
|
700
|
-
* scale your cluster or replication group, the value of the <code>CacheNodeType</code> parameter
|
|
701
|
-
* must be one of the node types returned by this operation.</p>
|
|
352
|
+
* @see {@link ListAllowedNodeTypeModificationsCommand}
|
|
702
353
|
*/
|
|
703
354
|
listAllowedNodeTypeModifications(args: ListAllowedNodeTypeModificationsCommandInput, options?: __HttpHandlerOptions): Promise<ListAllowedNodeTypeModificationsCommandOutput>;
|
|
704
355
|
listAllowedNodeTypeModifications(args: ListAllowedNodeTypeModificationsCommandInput, cb: (err: any, data?: ListAllowedNodeTypeModificationsCommandOutput) => void): void;
|
|
705
356
|
listAllowedNodeTypeModifications(args: ListAllowedNodeTypeModificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAllowedNodeTypeModificationsCommandOutput) => void): void;
|
|
706
357
|
/**
|
|
707
|
-
* @
|
|
708
|
-
* <p>Lists all tags currently on a named resource.</p>
|
|
709
|
-
* <p> A tag is a key-value pair where the key and value are case-sensitive.
|
|
710
|
-
* You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group.
|
|
711
|
-
* For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html">Resource-level permissions</a>.</p>
|
|
712
|
-
* <p>If the cluster is not in the <i>available</i> state, <code>ListTagsForResource</code>
|
|
713
|
-
* returns an error.</p>
|
|
358
|
+
* @see {@link ListTagsForResourceCommand}
|
|
714
359
|
*/
|
|
715
360
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
716
361
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
717
362
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
718
363
|
/**
|
|
719
|
-
* @
|
|
720
|
-
* <p>Modifies the settings for a cluster. You
|
|
721
|
-
* can use this operation to change one or more cluster configuration parameters by
|
|
722
|
-
* specifying the parameters and the new values.</p>
|
|
364
|
+
* @see {@link ModifyCacheClusterCommand}
|
|
723
365
|
*/
|
|
724
366
|
modifyCacheCluster(args: ModifyCacheClusterCommandInput, options?: __HttpHandlerOptions): Promise<ModifyCacheClusterCommandOutput>;
|
|
725
367
|
modifyCacheCluster(args: ModifyCacheClusterCommandInput, cb: (err: any, data?: ModifyCacheClusterCommandOutput) => void): void;
|
|
726
368
|
modifyCacheCluster(args: ModifyCacheClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCacheClusterCommandOutput) => void): void;
|
|
727
369
|
/**
|
|
728
|
-
* @
|
|
729
|
-
* <p>Modifies the parameters of a cache
|
|
730
|
-
* parameter group. You can modify up to 20 parameters in a single request by submitting a
|
|
731
|
-
* list parameter name and value pairs.</p>
|
|
370
|
+
* @see {@link ModifyCacheParameterGroupCommand}
|
|
732
371
|
*/
|
|
733
372
|
modifyCacheParameterGroup(args: ModifyCacheParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyCacheParameterGroupCommandOutput>;
|
|
734
373
|
modifyCacheParameterGroup(args: ModifyCacheParameterGroupCommandInput, cb: (err: any, data?: ModifyCacheParameterGroupCommandOutput) => void): void;
|
|
735
374
|
modifyCacheParameterGroup(args: ModifyCacheParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCacheParameterGroupCommandOutput) => void): void;
|
|
736
375
|
/**
|
|
737
|
-
* @
|
|
738
|
-
* <p>Modifies an existing cache subnet group.</p>
|
|
376
|
+
* @see {@link ModifyCacheSubnetGroupCommand}
|
|
739
377
|
*/
|
|
740
378
|
modifyCacheSubnetGroup(args: ModifyCacheSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyCacheSubnetGroupCommandOutput>;
|
|
741
379
|
modifyCacheSubnetGroup(args: ModifyCacheSubnetGroupCommandInput, cb: (err: any, data?: ModifyCacheSubnetGroupCommandOutput) => void): void;
|
|
742
380
|
modifyCacheSubnetGroup(args: ModifyCacheSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyCacheSubnetGroupCommandOutput) => void): void;
|
|
743
381
|
/**
|
|
744
|
-
* @
|
|
745
|
-
* <p>Modifies the settings for a Global datastore.</p>
|
|
382
|
+
* @see {@link ModifyGlobalReplicationGroupCommand}
|
|
746
383
|
*/
|
|
747
384
|
modifyGlobalReplicationGroup(args: ModifyGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyGlobalReplicationGroupCommandOutput>;
|
|
748
385
|
modifyGlobalReplicationGroup(args: ModifyGlobalReplicationGroupCommandInput, cb: (err: any, data?: ModifyGlobalReplicationGroupCommandOutput) => void): void;
|
|
749
386
|
modifyGlobalReplicationGroup(args: ModifyGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyGlobalReplicationGroupCommandOutput) => void): void;
|
|
750
387
|
/**
|
|
751
|
-
* @
|
|
752
|
-
* <p>Modifies the settings for a replication group.</p>
|
|
753
|
-
* <ul>
|
|
754
|
-
* <li>
|
|
755
|
-
* <p>
|
|
756
|
-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/scaling-redis-cluster-mode-enabled.html">Scaling for Amazon ElastiCache for Redis (cluster mode enabled)</a>
|
|
757
|
-
* in the ElastiCache User Guide</p>
|
|
758
|
-
* </li>
|
|
759
|
-
* <li>
|
|
760
|
-
* <p>
|
|
761
|
-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html">ModifyReplicationGroupShardConfiguration</a>
|
|
762
|
-
* in the ElastiCache API Reference</p>
|
|
763
|
-
* </li>
|
|
764
|
-
* </ul>
|
|
765
|
-
* <note>
|
|
766
|
-
* <p>This operation is valid for Redis only.</p>
|
|
767
|
-
* </note>
|
|
388
|
+
* @see {@link ModifyReplicationGroupCommand}
|
|
768
389
|
*/
|
|
769
390
|
modifyReplicationGroup(args: ModifyReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyReplicationGroupCommandOutput>;
|
|
770
391
|
modifyReplicationGroup(args: ModifyReplicationGroupCommandInput, cb: (err: any, data?: ModifyReplicationGroupCommandOutput) => void): void;
|
|
771
392
|
modifyReplicationGroup(args: ModifyReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyReplicationGroupCommandOutput) => void): void;
|
|
772
393
|
/**
|
|
773
|
-
* @
|
|
774
|
-
* <p>Modifies a replication group's shards (node groups) by allowing you to
|
|
775
|
-
* add shards, remove shards, or rebalance the keyspaces among existing shards.</p>
|
|
394
|
+
* @see {@link ModifyReplicationGroupShardConfigurationCommand}
|
|
776
395
|
*/
|
|
777
396
|
modifyReplicationGroupShardConfiguration(args: ModifyReplicationGroupShardConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<ModifyReplicationGroupShardConfigurationCommandOutput>;
|
|
778
397
|
modifyReplicationGroupShardConfiguration(args: ModifyReplicationGroupShardConfigurationCommandInput, cb: (err: any, data?: ModifyReplicationGroupShardConfigurationCommandOutput) => void): void;
|
|
779
398
|
modifyReplicationGroupShardConfiguration(args: ModifyReplicationGroupShardConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyReplicationGroupShardConfigurationCommandOutput) => void): void;
|
|
780
399
|
/**
|
|
781
|
-
* @
|
|
782
|
-
* <p>Changes user password(s) and/or access string.</p>
|
|
400
|
+
* @see {@link ModifyUserCommand}
|
|
783
401
|
*/
|
|
784
402
|
modifyUser(args: ModifyUserCommandInput, options?: __HttpHandlerOptions): Promise<ModifyUserCommandOutput>;
|
|
785
403
|
modifyUser(args: ModifyUserCommandInput, cb: (err: any, data?: ModifyUserCommandOutput) => void): void;
|
|
786
404
|
modifyUser(args: ModifyUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyUserCommandOutput) => void): void;
|
|
787
405
|
/**
|
|
788
|
-
* @
|
|
789
|
-
* <p>Changes the list of users that belong to the user group.</p>
|
|
406
|
+
* @see {@link ModifyUserGroupCommand}
|
|
790
407
|
*/
|
|
791
408
|
modifyUserGroup(args: ModifyUserGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyUserGroupCommandOutput>;
|
|
792
409
|
modifyUserGroup(args: ModifyUserGroupCommandInput, cb: (err: any, data?: ModifyUserGroupCommandOutput) => void): void;
|
|
793
410
|
modifyUserGroup(args: ModifyUserGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyUserGroupCommandOutput) => void): void;
|
|
794
411
|
/**
|
|
795
|
-
* @
|
|
796
|
-
* <p>Allows you to purchase a reserved
|
|
797
|
-
* cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information,
|
|
798
|
-
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes.html">Managing Costs with Reserved Nodes</a> for Redis or
|
|
799
|
-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html">Managing Costs with Reserved Nodes</a> for Memcached.</p>
|
|
412
|
+
* @see {@link PurchaseReservedCacheNodesOfferingCommand}
|
|
800
413
|
*/
|
|
801
414
|
purchaseReservedCacheNodesOffering(args: PurchaseReservedCacheNodesOfferingCommandInput, options?: __HttpHandlerOptions): Promise<PurchaseReservedCacheNodesOfferingCommandOutput>;
|
|
802
415
|
purchaseReservedCacheNodesOffering(args: PurchaseReservedCacheNodesOfferingCommandInput, cb: (err: any, data?: PurchaseReservedCacheNodesOfferingCommandOutput) => void): void;
|
|
803
416
|
purchaseReservedCacheNodesOffering(args: PurchaseReservedCacheNodesOfferingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseReservedCacheNodesOfferingCommandOutput) => void): void;
|
|
804
417
|
/**
|
|
805
|
-
* @
|
|
806
|
-
* <p>Redistribute slots to ensure uniform distribution across existing shards in the cluster.</p>
|
|
418
|
+
* @see {@link RebalanceSlotsInGlobalReplicationGroupCommand}
|
|
807
419
|
*/
|
|
808
420
|
rebalanceSlotsInGlobalReplicationGroup(args: RebalanceSlotsInGlobalReplicationGroupCommandInput, options?: __HttpHandlerOptions): Promise<RebalanceSlotsInGlobalReplicationGroupCommandOutput>;
|
|
809
421
|
rebalanceSlotsInGlobalReplicationGroup(args: RebalanceSlotsInGlobalReplicationGroupCommandInput, cb: (err: any, data?: RebalanceSlotsInGlobalReplicationGroupCommandOutput) => void): void;
|
|
810
422
|
rebalanceSlotsInGlobalReplicationGroup(args: RebalanceSlotsInGlobalReplicationGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebalanceSlotsInGlobalReplicationGroupCommandOutput) => void): void;
|
|
811
423
|
/**
|
|
812
|
-
* @
|
|
813
|
-
* <p>Reboots some, or all, of the cache nodes
|
|
814
|
-
* within a provisioned cluster. This operation applies any modified cache parameter
|
|
815
|
-
* groups to the cluster. The reboot operation takes place as soon as possible, and
|
|
816
|
-
* results in a momentary outage to the cluster. During the reboot, the cluster
|
|
817
|
-
* status is set to REBOOTING.</p>
|
|
818
|
-
* <p>The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.</p>
|
|
819
|
-
* <p>When the reboot is complete, a cluster event is created.</p>
|
|
820
|
-
* <p>Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters.
|
|
821
|
-
* Rebooting is not supported on Redis (cluster mode enabled) clusters.</p>
|
|
822
|
-
* <p>If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied,
|
|
823
|
-
* see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes.rebooting.html">Rebooting a Cluster</a> for an alternate process.</p>
|
|
424
|
+
* @see {@link RebootCacheClusterCommand}
|
|
824
425
|
*/
|
|
825
426
|
rebootCacheCluster(args: RebootCacheClusterCommandInput, options?: __HttpHandlerOptions): Promise<RebootCacheClusterCommandOutput>;
|
|
826
427
|
rebootCacheCluster(args: RebootCacheClusterCommandInput, cb: (err: any, data?: RebootCacheClusterCommandOutput) => void): void;
|
|
827
428
|
rebootCacheCluster(args: RebootCacheClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootCacheClusterCommandOutput) => void): void;
|
|
828
429
|
/**
|
|
829
|
-
* @
|
|
830
|
-
* <p>Removes the tags identified by the <code>TagKeys</code>
|
|
831
|
-
* list from the named resource. A tag is a key-value pair where the key and value are case-sensitive.
|
|
832
|
-
* You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group.
|
|
833
|
-
* For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html">Resource-level permissions</a>.</p>
|
|
430
|
+
* @see {@link RemoveTagsFromResourceCommand}
|
|
834
431
|
*/
|
|
835
432
|
removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions): Promise<RemoveTagsFromResourceCommandOutput>;
|
|
836
433
|
removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void): void;
|
|
837
434
|
removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void): void;
|
|
838
435
|
/**
|
|
839
|
-
* @
|
|
840
|
-
* <p>Modifies the parameters of a cache
|
|
841
|
-
* parameter group to the engine or system default value. You can reset specific parameters
|
|
842
|
-
* by submitting a list of parameter names. To reset the entire cache parameter group,
|
|
843
|
-
* specify the <code>ResetAllParameters</code> and <code>CacheParameterGroupName</code> parameters.</p>
|
|
436
|
+
* @see {@link ResetCacheParameterGroupCommand}
|
|
844
437
|
*/
|
|
845
438
|
resetCacheParameterGroup(args: ResetCacheParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<ResetCacheParameterGroupCommandOutput>;
|
|
846
439
|
resetCacheParameterGroup(args: ResetCacheParameterGroupCommandInput, cb: (err: any, data?: ResetCacheParameterGroupCommandOutput) => void): void;
|
|
847
440
|
resetCacheParameterGroup(args: ResetCacheParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetCacheParameterGroupCommandOutput) => void): void;
|
|
848
441
|
/**
|
|
849
|
-
* @
|
|
850
|
-
* <p>Revokes ingress from a cache security group.
|
|
851
|
-
* Use this operation to disallow access from an Amazon EC2 security group
|
|
852
|
-
* that had been previously authorized.</p>
|
|
442
|
+
* @see {@link RevokeCacheSecurityGroupIngressCommand}
|
|
853
443
|
*/
|
|
854
444
|
revokeCacheSecurityGroupIngress(args: RevokeCacheSecurityGroupIngressCommandInput, options?: __HttpHandlerOptions): Promise<RevokeCacheSecurityGroupIngressCommandOutput>;
|
|
855
445
|
revokeCacheSecurityGroupIngress(args: RevokeCacheSecurityGroupIngressCommandInput, cb: (err: any, data?: RevokeCacheSecurityGroupIngressCommandOutput) => void): void;
|
|
856
446
|
revokeCacheSecurityGroupIngress(args: RevokeCacheSecurityGroupIngressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeCacheSecurityGroupIngressCommandOutput) => void): void;
|
|
857
447
|
/**
|
|
858
|
-
* @
|
|
859
|
-
* <p>Start the migration of data.</p>
|
|
448
|
+
* @see {@link StartMigrationCommand}
|
|
860
449
|
*/
|
|
861
450
|
startMigration(args: StartMigrationCommandInput, options?: __HttpHandlerOptions): Promise<StartMigrationCommandOutput>;
|
|
862
451
|
startMigration(args: StartMigrationCommandInput, cb: (err: any, data?: StartMigrationCommandOutput) => void): void;
|
|
863
452
|
startMigration(args: StartMigrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMigrationCommandOutput) => void): void;
|
|
864
453
|
/**
|
|
865
|
-
* @
|
|
866
|
-
* <p>Represents the input of a <code>TestFailover</code> operation which test automatic failover on
|
|
867
|
-
* a specified node group (called shard in the console) in a replication group (called cluster in the console).</p>
|
|
868
|
-
* <p>This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool
|
|
869
|
-
* for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API. </p>
|
|
870
|
-
* <p class="title">
|
|
871
|
-
* <b>Note the following</b>
|
|
872
|
-
* </p>
|
|
873
|
-
* <ul>
|
|
874
|
-
* <li>
|
|
875
|
-
* <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI)
|
|
876
|
-
* in any rolling 24-hour period.</p>
|
|
877
|
-
* </li>
|
|
878
|
-
* <li>
|
|
879
|
-
* <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p>
|
|
880
|
-
* <p> </p>
|
|
881
|
-
* </li>
|
|
882
|
-
* <li>
|
|
883
|
-
* <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group,
|
|
884
|
-
* the first node replacement must complete before a subsequent call can be made.</p>
|
|
885
|
-
* </li>
|
|
886
|
-
* <li>
|
|
887
|
-
* <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,
|
|
888
|
-
* the Amazon CLI, or the ElastiCache API.
|
|
889
|
-
* Look for the following automatic failover related events, listed here in order of occurrance:</p>
|
|
890
|
-
* <ol>
|
|
891
|
-
* <li>
|
|
892
|
-
* <p>Replication group message: <code>Test Failover API called for node group <node-group-id></code>
|
|
893
|
-
* </p>
|
|
894
|
-
* </li>
|
|
895
|
-
* <li>
|
|
896
|
-
* <p>Cache cluster message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>
|
|
897
|
-
* </p>
|
|
898
|
-
* </li>
|
|
899
|
-
* <li>
|
|
900
|
-
* <p>Replication group message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>
|
|
901
|
-
* </p>
|
|
902
|
-
* </li>
|
|
903
|
-
* <li>
|
|
904
|
-
* <p>Cache cluster message: <code>Recovering cache nodes <node-id></code>
|
|
905
|
-
* </p>
|
|
906
|
-
* </li>
|
|
907
|
-
* <li>
|
|
908
|
-
* <p>Cache cluster message: <code>Finished recovery for cache nodes <node-id></code>
|
|
909
|
-
* </p>
|
|
910
|
-
* </li>
|
|
911
|
-
* </ol>
|
|
912
|
-
* <p>For more information see:</p>
|
|
913
|
-
* <ul>
|
|
914
|
-
* <li>
|
|
915
|
-
* <p>
|
|
916
|
-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html">Viewing ElastiCache Events</a>
|
|
917
|
-
* in the <i>ElastiCache User Guide</i>
|
|
918
|
-
* </p>
|
|
919
|
-
* </li>
|
|
920
|
-
* <li>
|
|
921
|
-
* <p>
|
|
922
|
-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html">DescribeEvents</a> in the ElastiCache API Reference</p>
|
|
923
|
-
* </li>
|
|
924
|
-
* </ul>
|
|
925
|
-
* </li>
|
|
926
|
-
* </ul>
|
|
927
|
-
* <p>Also see, <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test">Testing Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>
|
|
454
|
+
* @see {@link TestFailoverCommand}
|
|
928
455
|
*/
|
|
929
456
|
testFailover(args: TestFailoverCommandInput, options?: __HttpHandlerOptions): Promise<TestFailoverCommandOutput>;
|
|
930
457
|
testFailover(args: TestFailoverCommandInput, cb: (err: any, data?: TestFailoverCommandOutput) => void): void;
|
|
931
458
|
testFailover(args: TestFailoverCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestFailoverCommandOutput) => void): void;
|
|
932
459
|
}
|
|
460
|
+
/**
|
|
461
|
+
* @public
|
|
462
|
+
* <fullname>Amazon ElastiCache</fullname>
|
|
463
|
+
* <p>Amazon ElastiCache is a web service that makes it easier to set up, operate,
|
|
464
|
+
* and scale a distributed cache in the cloud.</p>
|
|
465
|
+
* <p>With ElastiCache, customers get all of the benefits of a high-performance,
|
|
466
|
+
* in-memory cache with less of the administrative burden involved in launching and managing a distributed cache.
|
|
467
|
+
* The service makes setup, scaling,
|
|
468
|
+
* and cluster failure handling much simpler than in a self-managed cache deployment.</p>
|
|
469
|
+
* <p>In addition, through integration with Amazon CloudWatch,
|
|
470
|
+
* customers get enhanced visibility into the key performance statistics
|
|
471
|
+
* associated with their cache and can receive alarms if a part of their cache runs hot.</p>
|
|
472
|
+
*/
|
|
473
|
+
export declare class ElastiCache extends ElastiCacheClient implements ElastiCache {
|
|
474
|
+
}
|