@aws-sdk/client-elasticache 3.288.0 → 3.289.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.
Files changed (39) hide show
  1. package/dist-types/commands/AddTagsToResourceCommand.d.ts +35 -0
  2. package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +13 -0
  3. package/dist-types/commands/CopySnapshotCommand.d.ts +45 -0
  4. package/dist-types/commands/CreateCacheClusterCommand.d.ts +42 -0
  5. package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +22 -0
  6. package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +12 -0
  7. package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +46 -0
  8. package/dist-types/commands/CreateReplicationGroupCommand.d.ts +93 -0
  9. package/dist-types/commands/CreateSnapshotCommand.d.ts +89 -0
  10. package/dist-types/commands/DeleteCacheClusterCommand.d.ts +40 -0
  11. package/dist-types/commands/DeleteCacheParameterGroupCommand.d.ts +11 -0
  12. package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +11 -0
  13. package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +11 -0
  14. package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +23 -0
  15. package/dist-types/commands/DeleteSnapshotCommand.d.ts +43 -0
  16. package/dist-types/commands/DescribeCacheClustersCommand.d.ts +42 -0
  17. package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts +99 -0
  18. package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts +22 -0
  19. package/dist-types/commands/DescribeCacheParametersCommand.d.ts +403 -0
  20. package/dist-types/commands/DescribeCacheSecurityGroupsCommand.d.ts +11 -0
  21. package/dist-types/commands/DescribeCacheSubnetGroupsCommand.d.ts +49 -0
  22. package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +614 -0
  23. package/dist-types/commands/DescribeEventsCommand.d.ts +49 -0
  24. package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +63 -0
  25. package/dist-types/commands/DescribeReservedCacheNodesCommand.d.ts +11 -0
  26. package/dist-types/commands/DescribeReservedCacheNodesOfferingsCommand.d.ts +273 -0
  27. package/dist-types/commands/DescribeSnapshotsCommand.d.ts +46 -0
  28. package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +25 -0
  29. package/dist-types/commands/ListTagsForResourceCommand.d.ts +25 -0
  30. package/dist-types/commands/ModifyCacheClusterCommand.d.ts +40 -0
  31. package/dist-types/commands/ModifyCacheParameterGroupCommand.d.ts +26 -0
  32. package/dist-types/commands/ModifyCacheSubnetGroupCommand.d.ts +55 -0
  33. package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +74 -0
  34. package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts +11 -0
  35. package/dist-types/commands/RebootCacheClusterCommand.d.ts +44 -0
  36. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +42 -0
  37. package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts +17 -0
  38. package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts +13 -0
  39. package/package.json +30 -30
@@ -34,6 +34,69 @@ export interface DescribeReplicationGroupsCommandOutput extends ReplicationGroup
34
34
  * @see {@link DescribeReplicationGroupsCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
36
36
  *
37
+ * @example DescribeReplicationGroups
38
+ * ```javascript
39
+ * // Returns information about the replication group myreplgroup.
40
+ * const input = {};
41
+ * const command = new DescribeReplicationGroupsCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "Marker": "",
46
+ * "ReplicationGroups": [
47
+ * {
48
+ * "AutomaticFailover": "enabled",
49
+ * "Description": "Test cluster",
50
+ * "MemberClusters": [
51
+ * "clustered-redis-0001-001",
52
+ * "clustered-redis-0001-002",
53
+ * "clustered-redis-0002-001",
54
+ * "clustered-redis-0002-002"
55
+ * ],
56
+ * "NodeGroups": [
57
+ * {
58
+ * "NodeGroupId": "0001",
59
+ * "NodeGroupMembers": [
60
+ * {
61
+ * "CacheClusterId": "clustered-redis-0001-001",
62
+ * "CacheNodeId": "0001",
63
+ * "PreferredAvailabilityZone": "us-east-1e"
64
+ * },
65
+ * {
66
+ * "CacheClusterId": "clustered-redis-0001-002",
67
+ * "CacheNodeId": "0001",
68
+ * "PreferredAvailabilityZone": "us-east-1c"
69
+ * }
70
+ * ],
71
+ * "Status": "available"
72
+ * },
73
+ * {
74
+ * "NodeGroupId": "0002",
75
+ * "NodeGroupMembers": [
76
+ * {
77
+ * "CacheClusterId": "clustered-redis-0002-001",
78
+ * "CacheNodeId": "0001",
79
+ * "PreferredAvailabilityZone": "us-east-1c"
80
+ * },
81
+ * {
82
+ * "CacheClusterId": "clustered-redis-0002-002",
83
+ * "CacheNodeId": "0001",
84
+ * "PreferredAvailabilityZone": "us-east-1b"
85
+ * }
86
+ * ],
87
+ * "Status": "available"
88
+ * }
89
+ * ],
90
+ * "PendingModifiedValues": {},
91
+ * "ReplicationGroupId": "clustered-redis",
92
+ * "Status": "available"
93
+ * }
94
+ * ]
95
+ * }
96
+ * *\/
97
+ * // example id: describereplicationgroups-1481742639427
98
+ * ```
99
+ *
37
100
  */
38
101
  export declare class DescribeReplicationGroupsCommand extends $Command<DescribeReplicationGroupsCommandInput, DescribeReplicationGroupsCommandOutput, ElastiCacheClientResolvedConfig> {
39
102
  readonly input: DescribeReplicationGroupsCommandInput;
@@ -30,6 +30,17 @@ export interface DescribeReservedCacheNodesCommandOutput extends ReservedCacheNo
30
30
  * @see {@link DescribeReservedCacheNodesCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
32
32
  *
33
+ * @example DescribeReservedCacheNodes
34
+ * ```javascript
35
+ * // Returns information about reserved cache nodes for this account, or about a specified reserved cache node. If the account has no reserved cache nodes, the operation returns an empty list, as shown here.
36
+ * const input = {
37
+ * "MaxRecords": 25
38
+ * };
39
+ * const command = new DescribeReservedCacheNodesCommand(input);
40
+ * await client.send(command);
41
+ * // example id: describereservedcachenodes-1481742348045
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DescribeReservedCacheNodesCommand extends $Command<DescribeReservedCacheNodesCommandInput, DescribeReservedCacheNodesCommandOutput, ElastiCacheClientResolvedConfig> {
35
46
  readonly input: DescribeReservedCacheNodesCommandInput;
@@ -30,6 +30,279 @@ export interface DescribeReservedCacheNodesOfferingsCommandOutput extends Reserv
30
30
  * @see {@link DescribeReservedCacheNodesOfferingsCommandOutput} for command's `response` shape.
31
31
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
32
32
  *
33
+ * @example DescribeReseredCacheNodeOfferings
34
+ * ```javascript
35
+ * // Lists available reserved cache node offerings.
36
+ * const input = {
37
+ * "MaxRecords": 20
38
+ * };
39
+ * const command = new DescribeReservedCacheNodesOfferingsCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Marker": "1ef01f5b-433f-94ff-a530-61a56bfc8e7a",
44
+ * "ReservedCacheNodesOfferings": [
45
+ * {
46
+ * "CacheNodeType": "cache.m1.small",
47
+ * "Duration": 94608000,
48
+ * "FixedPrice": 157,
49
+ * "OfferingType": "Medium Utilization",
50
+ * "ProductDescription": "memcached",
51
+ * "RecurringCharges": [],
52
+ * "ReservedCacheNodesOfferingId": "0167633d-37f6-4222-b872-b1f22eb79ba4",
53
+ * "UsagePrice": 0.017
54
+ * },
55
+ * {
56
+ * "CacheNodeType": "cache.m4.xlarge",
57
+ * "Duration": 94608000,
58
+ * "FixedPrice": 1248,
59
+ * "OfferingType": "Heavy Utilization",
60
+ * "ProductDescription": "redis",
61
+ * "RecurringCharges": [
62
+ * {
63
+ * "RecurringChargeAmount": 0.077,
64
+ * "RecurringChargeFrequency": "Hourly"
65
+ * }
66
+ * ],
67
+ * "ReservedCacheNodesOfferingId": "02c04e13-baca-4e71-9ceb-620eed94827d",
68
+ * "UsagePrice": 0
69
+ * },
70
+ * {
71
+ * "CacheNodeType": "cache.m2.4xlarge",
72
+ * "Duration": 94608000,
73
+ * "FixedPrice": 2381,
74
+ * "OfferingType": "Medium Utilization",
75
+ * "ProductDescription": "memcached",
76
+ * "RecurringCharges": [],
77
+ * "ReservedCacheNodesOfferingId": "02e1755e-76e8-48e3-8d82-820a5726a458",
78
+ * "UsagePrice": 0.276
79
+ * },
80
+ * {
81
+ * "CacheNodeType": "cache.m1.small",
82
+ * "Duration": 94608000,
83
+ * "FixedPrice": 188,
84
+ * "OfferingType": "Heavy Utilization",
85
+ * "ProductDescription": "redis",
86
+ * "RecurringCharges": [
87
+ * {
88
+ * "RecurringChargeAmount": 0.013,
89
+ * "RecurringChargeFrequency": "Hourly"
90
+ * }
91
+ * ],
92
+ * "ReservedCacheNodesOfferingId": "03315215-7b87-421a-a3dd-785021e4113f",
93
+ * "UsagePrice": 0
94
+ * },
95
+ * {
96
+ * "CacheNodeType": "cache.m4.10xlarge",
97
+ * "Duration": 31536000,
98
+ * "FixedPrice": 6158,
99
+ * "OfferingType": "Heavy Utilization",
100
+ * "ProductDescription": "redis",
101
+ * "RecurringCharges": [
102
+ * {
103
+ * "RecurringChargeAmount": 1.125,
104
+ * "RecurringChargeFrequency": "Hourly"
105
+ * }
106
+ * ],
107
+ * "ReservedCacheNodesOfferingId": "05ffbb44-2ace-4476-a2a5-8ec99f866fb3",
108
+ * "UsagePrice": 0
109
+ * },
110
+ * {
111
+ * "CacheNodeType": "cache.m1.small",
112
+ * "Duration": 31536000,
113
+ * "FixedPrice": 101,
114
+ * "OfferingType": "Medium Utilization",
115
+ * "ProductDescription": "redis",
116
+ * "RecurringCharges": [],
117
+ * "ReservedCacheNodesOfferingId": "065c71ae-4a4e-4f1e-bebf-37525f4c6cb2",
118
+ * "UsagePrice": 0.023
119
+ * },
120
+ * {
121
+ * "CacheNodeType": "cache.m1.medium",
122
+ * "Duration": 94608000,
123
+ * "FixedPrice": 314,
124
+ * "OfferingType": "Medium Utilization",
125
+ * "ProductDescription": "memcached",
126
+ * "RecurringCharges": [],
127
+ * "ReservedCacheNodesOfferingId": "06774b12-7f5e-48c1-907a-f286c63f327d",
128
+ * "UsagePrice": 0.034
129
+ * },
130
+ * {
131
+ * "CacheNodeType": "cache.m2.xlarge",
132
+ * "Duration": 31536000,
133
+ * "FixedPrice": 163,
134
+ * "OfferingType": "Light Utilization",
135
+ * "ProductDescription": "memcached",
136
+ * "RecurringCharges": [],
137
+ * "ReservedCacheNodesOfferingId": "0924ac6b-847f-4761-ba6b-4290b2adf719",
138
+ * "UsagePrice": 0.137
139
+ * },
140
+ * {
141
+ * "CacheNodeType": "cache.m2.xlarge",
142
+ * "Duration": 94608000,
143
+ * "FixedPrice": 719,
144
+ * "OfferingType": "Heavy Utilization",
145
+ * "ProductDescription": "redis",
146
+ * "RecurringCharges": [
147
+ * {
148
+ * "RecurringChargeAmount": 0.049,
149
+ * "RecurringChargeFrequency": "Hourly"
150
+ * }
151
+ * ],
152
+ * "ReservedCacheNodesOfferingId": "09eeb126-69b6-4d3f-8f94-ca3510629f53",
153
+ * "UsagePrice": 0
154
+ * },
155
+ * {
156
+ * "CacheNodeType": "cache.r3.2xlarge",
157
+ * "Duration": 94608000,
158
+ * "FixedPrice": 4132,
159
+ * "OfferingType": "Heavy Utilization",
160
+ * "ProductDescription": "redis",
161
+ * "RecurringCharges": [
162
+ * {
163
+ * "RecurringChargeAmount": 0.182,
164
+ * "RecurringChargeFrequency": "Hourly"
165
+ * }
166
+ * ],
167
+ * "ReservedCacheNodesOfferingId": "0a516ad8-557f-4310-9dd0-2448c2ff4d62",
168
+ * "UsagePrice": 0
169
+ * },
170
+ * {
171
+ * "CacheNodeType": "cache.c1.xlarge",
172
+ * "Duration": 94608000,
173
+ * "FixedPrice": 875,
174
+ * "OfferingType": "Light Utilization",
175
+ * "ProductDescription": "memcached",
176
+ * "RecurringCharges": [],
177
+ * "ReservedCacheNodesOfferingId": "0b0c1cc5-2177-4150-95d7-c67ec34dcb19",
178
+ * "UsagePrice": 0.363
179
+ * },
180
+ * {
181
+ * "CacheNodeType": "cache.m4.10xlarge",
182
+ * "Duration": 94608000,
183
+ * "FixedPrice": 12483,
184
+ * "OfferingType": "Heavy Utilization",
185
+ * "ProductDescription": "memcached",
186
+ * "RecurringCharges": [
187
+ * {
188
+ * "RecurringChargeAmount": 0.76,
189
+ * "RecurringChargeFrequency": "Hourly"
190
+ * }
191
+ * ],
192
+ * "ReservedCacheNodesOfferingId": "0c2b139b-1cff-43d0-8fba-0c753f9b1950",
193
+ * "UsagePrice": 0
194
+ * },
195
+ * {
196
+ * "CacheNodeType": "cache.c1.xlarge",
197
+ * "Duration": 31536000,
198
+ * "FixedPrice": 1620,
199
+ * "OfferingType": "Heavy Utilization",
200
+ * "ProductDescription": "memcached",
201
+ * "RecurringCharges": [
202
+ * {
203
+ * "RecurringChargeAmount": 0.207,
204
+ * "RecurringChargeFrequency": "Hourly"
205
+ * }
206
+ * ],
207
+ * "ReservedCacheNodesOfferingId": "0c52115b-38cb-47a2-8dbc-e02e40b6a13f",
208
+ * "UsagePrice": 0
209
+ * },
210
+ * {
211
+ * "CacheNodeType": "cache.m2.4xlarge",
212
+ * "Duration": 94608000,
213
+ * "FixedPrice": 2381,
214
+ * "OfferingType": "Medium Utilization",
215
+ * "ProductDescription": "redis",
216
+ * "RecurringCharges": [],
217
+ * "ReservedCacheNodesOfferingId": "12fcb19c-5416-4e1d-934f-28f1e2cb8599",
218
+ * "UsagePrice": 0.276
219
+ * },
220
+ * {
221
+ * "CacheNodeType": "cache.m4.xlarge",
222
+ * "Duration": 31536000,
223
+ * "FixedPrice": 616,
224
+ * "OfferingType": "Heavy Utilization",
225
+ * "ProductDescription": "memcached",
226
+ * "RecurringCharges": [
227
+ * {
228
+ * "RecurringChargeAmount": 0.112,
229
+ * "RecurringChargeFrequency": "Hourly"
230
+ * }
231
+ * ],
232
+ * "ReservedCacheNodesOfferingId": "13af20ad-914d-4d8b-9763-fa2e565f3549",
233
+ * "UsagePrice": 0
234
+ * },
235
+ * {
236
+ * "CacheNodeType": "cache.r3.8xlarge",
237
+ * "Duration": 94608000,
238
+ * "FixedPrice": 16528,
239
+ * "OfferingType": "Heavy Utilization",
240
+ * "ProductDescription": "memcached",
241
+ * "RecurringCharges": [
242
+ * {
243
+ * "RecurringChargeAmount": 0.729,
244
+ * "RecurringChargeFrequency": "Hourly"
245
+ * }
246
+ * ],
247
+ * "ReservedCacheNodesOfferingId": "14da3d3f-b526-4dbf-b09b-355578b2a576",
248
+ * "UsagePrice": 0
249
+ * },
250
+ * {
251
+ * "CacheNodeType": "cache.m1.medium",
252
+ * "Duration": 94608000,
253
+ * "FixedPrice": 140,
254
+ * "OfferingType": "Light Utilization",
255
+ * "ProductDescription": "redis",
256
+ * "RecurringCharges": [],
257
+ * "ReservedCacheNodesOfferingId": "15d7018c-71fb-4717-8409-4bdcdca18da7",
258
+ * "UsagePrice": 0.052
259
+ * },
260
+ * {
261
+ * "CacheNodeType": "cache.m4.4xlarge",
262
+ * "Duration": 94608000,
263
+ * "FixedPrice": 4993,
264
+ * "OfferingType": "Heavy Utilization",
265
+ * "ProductDescription": "memcached",
266
+ * "RecurringCharges": [
267
+ * {
268
+ * "RecurringChargeAmount": 0.304,
269
+ * "RecurringChargeFrequency": "Hourly"
270
+ * }
271
+ * ],
272
+ * "ReservedCacheNodesOfferingId": "1ae7ec5f-a76e-49b6-822b-629b1768a13a",
273
+ * "UsagePrice": 0
274
+ * },
275
+ * {
276
+ * "CacheNodeType": "cache.m3.2xlarge",
277
+ * "Duration": 31536000,
278
+ * "FixedPrice": 1772,
279
+ * "OfferingType": "Heavy Utilization",
280
+ * "ProductDescription": "redis",
281
+ * "RecurringCharges": [
282
+ * {
283
+ * "RecurringChargeAmount": 0.25,
284
+ * "RecurringChargeFrequency": "Hourly"
285
+ * }
286
+ * ],
287
+ * "ReservedCacheNodesOfferingId": "1d31242b-3925-48d1-b882-ce03204e6013",
288
+ * "UsagePrice": 0
289
+ * },
290
+ * {
291
+ * "CacheNodeType": "cache.t1.micro",
292
+ * "Duration": 31536000,
293
+ * "FixedPrice": 54,
294
+ * "OfferingType": "Medium Utilization",
295
+ * "ProductDescription": "memcached",
296
+ * "RecurringCharges": [],
297
+ * "ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a",
298
+ * "UsagePrice": 0.008
299
+ * }
300
+ * ]
301
+ * }
302
+ * *\/
303
+ * // example id: describereseredcachenodeofferings-1481742869998
304
+ * ```
305
+ *
33
306
  */
34
307
  export declare class DescribeReservedCacheNodesOfferingsCommand extends $Command<DescribeReservedCacheNodesOfferingsCommandInput, DescribeReservedCacheNodesOfferingsCommandOutput, ElastiCacheClientResolvedConfig> {
35
308
  readonly input: DescribeReservedCacheNodesOfferingsCommandInput;
@@ -35,6 +35,52 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsListMes
35
35
  * @see {@link DescribeSnapshotsCommandOutput} for command's `response` shape.
36
36
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
37
37
  *
38
+ * @example DescribeSnapshots
39
+ * ```javascript
40
+ * // Returns information about the snapshot mysnapshot. By default.
41
+ * const input = {
42
+ * "SnapshotName": "snapshot-20161212"
43
+ * };
44
+ * const command = new DescribeSnapshotsCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "Marker": "",
49
+ * "Snapshots": [
50
+ * {
51
+ * "AutoMinorVersionUpgrade": true,
52
+ * "CacheClusterCreateTime": "2016-12-21T22:27:12.543Z",
53
+ * "CacheClusterId": "my-redis5",
54
+ * "CacheNodeType": "cache.m3.large",
55
+ * "CacheParameterGroupName": "default.redis3.2",
56
+ * "CacheSubnetGroupName": "default",
57
+ * "Engine": "redis",
58
+ * "EngineVersion": "3.2.4",
59
+ * "NodeSnapshots": [
60
+ * {
61
+ * "CacheNodeCreateTime": "2016-12-21T22:27:12.543Z",
62
+ * "CacheNodeId": "0001",
63
+ * "CacheSize": "3 MB",
64
+ * "SnapshotCreateTime": "2016-12-21T22:30:26Z"
65
+ * }
66
+ * ],
67
+ * "NumCacheNodes": 1,
68
+ * "Port": 6379,
69
+ * "PreferredAvailabilityZone": "us-east-1c",
70
+ * "PreferredMaintenanceWindow": "fri:05:30-fri:06:30",
71
+ * "SnapshotName": "snapshot-20161212",
72
+ * "SnapshotRetentionLimit": 7,
73
+ * "SnapshotSource": "manual",
74
+ * "SnapshotStatus": "available",
75
+ * "SnapshotWindow": "10:00-11:00",
76
+ * "VpcId": "vpc-91280df6"
77
+ * }
78
+ * ]
79
+ * }
80
+ * *\/
81
+ * // example id: describesnapshots-1481743399584
82
+ * ```
83
+ *
38
84
  */
39
85
  export declare class DescribeSnapshotsCommand extends $Command<DescribeSnapshotsCommandInput, DescribeSnapshotsCommandOutput, ElastiCacheClientResolvedConfig> {
40
86
  readonly input: DescribeSnapshotsCommandInput;
@@ -33,6 +33,31 @@ export interface ListAllowedNodeTypeModificationsCommandOutput extends AllowedNo
33
33
  * @see {@link ListAllowedNodeTypeModificationsCommandOutput} for command's `response` shape.
34
34
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
35
35
  *
36
+ * @example ListAllowedNodeTypeModifications
37
+ * ```javascript
38
+ * // Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.
39
+ * const input = {
40
+ * "ReplicationGroupId": "myreplgroup"
41
+ * };
42
+ * const command = new ListAllowedNodeTypeModificationsCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "ScaleUpModifications": [
47
+ * "cache.m4.10xlarge",
48
+ * "cache.m4.2xlarge",
49
+ * "cache.m4.4xlarge",
50
+ * "cache.m4.xlarge",
51
+ * "cache.r3.2xlarge",
52
+ * "cache.r3.4xlarge",
53
+ * "cache.r3.8xlarge",
54
+ * "cache.r3.xlarge"
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: listallowednodetypemodifications-1481748494872
59
+ * ```
60
+ *
36
61
  */
37
62
  export declare class ListAllowedNodeTypeModificationsCommand extends $Command<ListAllowedNodeTypeModificationsCommandInput, ListAllowedNodeTypeModificationsCommandOutput, ElastiCacheClientResolvedConfig> {
38
63
  readonly input: ListAllowedNodeTypeModificationsCommandInput;
@@ -34,6 +34,31 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
34
34
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
35
35
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
36
36
  *
37
+ * @example ListTagsForResource
38
+ * ```javascript
39
+ * // Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.
40
+ * const input = {
41
+ * "ResourceName": "arn:aws:elasticache:us-west-2:<my-account-id>:cluster:mycluster"
42
+ * };
43
+ * const command = new ListTagsForResourceCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "TagList": [
48
+ * {
49
+ * "Key": "APIVersion",
50
+ * "Value": "20150202"
51
+ * },
52
+ * {
53
+ * "Key": "Service",
54
+ * "Value": "ElastiCache"
55
+ * }
56
+ * ]
57
+ * }
58
+ * *\/
59
+ * // example id: listtagsforresource-1481748784584
60
+ * ```
61
+ *
37
62
  */
38
63
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ElastiCacheClientResolvedConfig> {
39
64
  readonly input: ListTagsForResourceCommandInput;
@@ -31,6 +31,46 @@ export interface ModifyCacheClusterCommandOutput extends ModifyCacheClusterResul
31
31
  * @see {@link ModifyCacheClusterCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
33
33
  *
34
+ * @example ModifyCacheCluster
35
+ * ```javascript
36
+ * // Copies a snapshot to a specified name.
37
+ * const input = {
38
+ * "ApplyImmediately": true,
39
+ * "CacheClusterId": "redis-cluster",
40
+ * "SnapshotRetentionLimit": 14
41
+ * };
42
+ * const command = new ModifyCacheClusterCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "CacheCluster": {
47
+ * "AutoMinorVersionUpgrade": true,
48
+ * "CacheClusterCreateTime": "2016-12-22T16:27:56.078Z",
49
+ * "CacheClusterId": "redis-cluster",
50
+ * "CacheClusterStatus": "available",
51
+ * "CacheNodeType": "cache.r3.large",
52
+ * "CacheParameterGroup": {
53
+ * "CacheNodeIdsToReboot": [],
54
+ * "CacheParameterGroupName": "default.redis3.2",
55
+ * "ParameterApplyStatus": "in-sync"
56
+ * },
57
+ * "CacheSecurityGroups": [],
58
+ * "CacheSubnetGroupName": "default",
59
+ * "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
60
+ * "Engine": "redis",
61
+ * "EngineVersion": "3.2.4",
62
+ * "NumCacheNodes": 1,
63
+ * "PendingModifiedValues": {},
64
+ * "PreferredAvailabilityZone": "us-east-1e",
65
+ * "PreferredMaintenanceWindow": "fri:09:00-fri:10:00",
66
+ * "SnapshotRetentionLimit": 14,
67
+ * "SnapshotWindow": "07:00-08:00"
68
+ * }
69
+ * }
70
+ * *\/
71
+ * // example id: modifycachecluster-1482962725919
72
+ * ```
73
+ *
34
74
  */
35
75
  export declare class ModifyCacheClusterCommand extends $Command<ModifyCacheClusterCommandInput, ModifyCacheClusterCommandOutput, ElastiCacheClientResolvedConfig> {
36
76
  readonly input: ModifyCacheClusterCommandInput;
@@ -31,6 +31,32 @@ export interface ModifyCacheParameterGroupCommandOutput extends CacheParameterGr
31
31
  * @see {@link ModifyCacheParameterGroupCommandOutput} for command's `response` shape.
32
32
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
33
33
  *
34
+ * @example ModifyCacheParameterGroup
35
+ * ```javascript
36
+ * // Modifies one or more parameter values in the specified parameter group. You cannot modify any default parameter group.
37
+ * const input = {
38
+ * "CacheParameterGroupName": "custom-mem1-4",
39
+ * "ParameterNameValues": [
40
+ * {
41
+ * "ParameterName": "binding_protocol",
42
+ * "ParameterValue": "ascii"
43
+ * },
44
+ * {
45
+ * "ParameterName": "chunk_size",
46
+ * "ParameterValue": "96"
47
+ * }
48
+ * ]
49
+ * };
50
+ * const command = new ModifyCacheParameterGroupCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "CacheParameterGroupName": "custom-mem1-4"
55
+ * }
56
+ * *\/
57
+ * // example id: modifycacheparametergroup-1482966746787
58
+ * ```
59
+ *
34
60
  */
35
61
  export declare class ModifyCacheParameterGroupCommand extends $Command<ModifyCacheParameterGroupCommandInput, ModifyCacheParameterGroupCommandOutput, ElastiCacheClientResolvedConfig> {
36
62
  readonly input: ModifyCacheParameterGroupCommandInput;
@@ -29,6 +29,61 @@ export interface ModifyCacheSubnetGroupCommandOutput extends ModifyCacheSubnetGr
29
29
  * @see {@link ModifyCacheSubnetGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
31
31
  *
32
+ * @example ModifyCacheSubnetGroup
33
+ * ```javascript
34
+ * // Modifies an existing ElastiCache subnet group.
35
+ * const input = {
36
+ * "CacheSubnetGroupName": "my-sn-grp",
37
+ * "SubnetIds": [
38
+ * "subnet-bcde2345"
39
+ * ]
40
+ * };
41
+ * const command = new ModifyCacheSubnetGroupCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "CacheSubnetGroup": {
46
+ * "CacheSubnetGroupDescription": "My subnet group.",
47
+ * "CacheSubnetGroupName": "my-sn-grp",
48
+ * "Subnets": [
49
+ * {
50
+ * "SubnetAvailabilityZone": {
51
+ * "Name": "us-east-1c"
52
+ * },
53
+ * "SubnetIdentifier": "subnet-a1b2c3d4"
54
+ * },
55
+ * {
56
+ * "SubnetAvailabilityZone": {
57
+ * "Name": "us-east-1e"
58
+ * },
59
+ * "SubnetIdentifier": "subnet-1a2b3c4d"
60
+ * },
61
+ * {
62
+ * "SubnetAvailabilityZone": {
63
+ * "Name": "us-east-1e"
64
+ * },
65
+ * "SubnetIdentifier": "subnet-bcde2345"
66
+ * },
67
+ * {
68
+ * "SubnetAvailabilityZone": {
69
+ * "Name": "us-east-1c"
70
+ * },
71
+ * "SubnetIdentifier": "subnet-1234abcd"
72
+ * },
73
+ * {
74
+ * "SubnetAvailabilityZone": {
75
+ * "Name": "us-east-1b"
76
+ * },
77
+ * "SubnetIdentifier": "subnet-abcd1234"
78
+ * }
79
+ * ],
80
+ * "VpcId": "vpc-91280df6"
81
+ * }
82
+ * }
83
+ * *\/
84
+ * // example id: modifycachesubnetgroup-1483043446226
85
+ * ```
86
+ *
32
87
  */
33
88
  export declare class ModifyCacheSubnetGroupCommand extends $Command<ModifyCacheSubnetGroupCommandInput, ModifyCacheSubnetGroupCommandOutput, ElastiCacheClientResolvedConfig> {
34
89
  readonly input: ModifyCacheSubnetGroupCommandInput;