@aws-sdk/client-elasticache 3.386.0 → 3.388.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -9
- package/dist-cjs/ElastiCache.js +2 -0
- package/dist-cjs/ElastiCacheClient.js +2 -2
- package/dist-cjs/commands/TestMigrationCommand.js +46 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/protocols/Aws_query.js +79 -2
- package/dist-es/ElastiCache.js +2 -0
- package/dist-es/ElastiCacheClient.js +2 -2
- package/dist-es/commands/TestMigrationCommand.js +42 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/protocols/Aws_query.js +75 -0
- package/dist-types/ElastiCache.d.ts +16 -9
- package/dist-types/ElastiCacheClient.d.ts +14 -13
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +23 -17
- package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +8 -6
- package/dist-types/commands/BatchApplyUpdateActionCommand.d.ts +3 -1
- package/dist-types/commands/BatchStopUpdateActionCommand.d.ts +3 -1
- package/dist-types/commands/CopySnapshotCommand.d.ts +54 -50
- package/dist-types/commands/CreateCacheClusterCommand.d.ts +19 -12
- package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +16 -10
- package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +10 -8
- package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +15 -7
- package/dist-types/commands/CreateGlobalReplicationGroupCommand.d.ts +10 -9
- package/dist-types/commands/CreateReplicationGroupCommand.d.ts +45 -31
- package/dist-types/commands/CreateSnapshotCommand.d.ts +11 -7
- package/dist-types/commands/CreateUserCommand.d.ts +5 -2
- package/dist-types/commands/CreateUserGroupCommand.d.ts +5 -2
- package/dist-types/commands/DecreaseReplicaCountCommand.d.ts +12 -9
- package/dist-types/commands/DeleteCacheClusterCommand.d.ts +10 -9
- package/dist-types/commands/DeleteCacheParameterGroupCommand.d.ts +7 -5
- package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +4 -2
- package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +4 -2
- package/dist-types/commands/DeleteGlobalReplicationGroupCommand.d.ts +14 -7
- package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +14 -10
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +5 -4
- package/dist-types/commands/DeleteUserCommand.d.ts +3 -1
- package/dist-types/commands/DeleteUserGroupCommand.d.ts +3 -1
- package/dist-types/commands/DescribeCacheClustersCommand.d.ts +13 -13
- package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts +4 -4
- package/dist-types/commands/DescribeCacheParametersCommand.d.ts +3 -3
- package/dist-types/commands/DescribeCacheSecurityGroupsCommand.d.ts +5 -5
- package/dist-types/commands/DescribeCacheSubnetGroupsCommand.d.ts +6 -5
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +2 -2
- package/dist-types/commands/DescribeEventsCommand.d.ts +5 -6
- package/dist-types/commands/DescribeGlobalReplicationGroupsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeReservedCacheNodesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeReservedCacheNodesOfferingsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateGlobalReplicationGroupCommand.d.ts +3 -1
- package/dist-types/commands/FailoverGlobalReplicationGroupCommand.d.ts +2 -1
- package/dist-types/commands/IncreaseReplicaCountCommand.d.ts +12 -9
- package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +6 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -10
- package/dist-types/commands/ModifyCacheClusterCommand.d.ts +12 -9
- package/dist-types/commands/ModifyCacheParameterGroupCommand.d.ts +6 -5
- package/dist-types/commands/ModifyCacheSubnetGroupCommand.d.ts +8 -4
- package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +14 -10
- package/dist-types/commands/ModifyReplicationGroupShardConfigurationCommand.d.ts +8 -7
- package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts +8 -6
- package/dist-types/commands/RebalanceSlotsInGlobalReplicationGroupCommand.d.ts +2 -1
- package/dist-types/commands/RebootCacheClusterCommand.d.ts +11 -10
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +13 -8
- package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts +8 -6
- package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts +6 -5
- package/dist-types/commands/TestFailoverCommand.d.ts +38 -21
- package/dist-types/commands/TestMigrationCommand.d.ts +210 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +9 -9
- package/dist-types/models/models_0.d.ts +1496 -1152
- package/dist-types/protocols/Aws_query.d.ts +9 -0
- package/dist-types/ts3.4/ElastiCache.d.ts +17 -0
- package/dist-types/ts3.4/ElastiCacheClient.d.ts +12 -3
- package/dist-types/ts3.4/commands/TestMigrationCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +7 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +12 -0
- package/package.json +29 -29
|
@@ -23,12 +23,12 @@ export interface AuthorizeCacheSecurityGroupIngressCommandOutput extends Authori
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Allows network ingress to a cache
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Allows network ingress to a cache security group. Applications using ElastiCache must
|
|
27
|
+
* be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization
|
|
28
|
+
* mechanism.</p>
|
|
29
29
|
* <note>
|
|
30
30
|
* <p>You cannot authorize ingress from an Amazon EC2 security group in one region to an
|
|
31
|
-
*
|
|
31
|
+
* ElastiCache cluster in another region.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -68,10 +68,12 @@ export interface AuthorizeCacheSecurityGroupIngressCommandOutput extends Authori
|
|
|
68
68
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link AuthorizationAlreadyExistsFault} (client fault)
|
|
71
|
-
* <p>The specified Amazon EC2 security group is already authorized for the specified cache
|
|
71
|
+
* <p>The specified Amazon EC2 security group is already authorized for the specified cache
|
|
72
|
+
* security group.</p>
|
|
72
73
|
*
|
|
73
74
|
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
74
|
-
* <p>The requested cache security group name does not refer to an existing cache security
|
|
75
|
+
* <p>The requested cache security group name does not refer to an existing cache security
|
|
76
|
+
* group.</p>
|
|
75
77
|
*
|
|
76
78
|
* @throws {@link InvalidCacheSecurityGroupStateFault} (client fault)
|
|
77
79
|
* <p>The current state of the cache security group does not allow deletion.</p>
|
|
@@ -23,7 +23,9 @@ export interface BatchApplyUpdateActionCommandOutput extends UpdateActionResults
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Apply the service update. For more information on service updates and applying them,
|
|
26
|
+
* <p>Apply the service update. For more information on service updates and applying them,
|
|
27
|
+
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/applying-updates.html">Applying Service
|
|
28
|
+
* Updates</a>.</p>
|
|
27
29
|
* @example
|
|
28
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
31
|
* ```javascript
|
|
@@ -23,7 +23,9 @@ export interface BatchStopUpdateActionCommandOutput extends UpdateActionResultsM
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Stop the service update. For more information on service updates and stopping them,
|
|
26
|
+
* <p>Stop the service update. For more information on service updates and stopping them,
|
|
27
|
+
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/stopping-self-service-updates.html">Stopping
|
|
28
|
+
* Service Updates</a>.</p>
|
|
27
29
|
* @example
|
|
28
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
31
|
* ```javascript
|
|
@@ -28,12 +28,13 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
|
|
|
28
28
|
* <p>This operation is valid for Redis only.</p>
|
|
29
29
|
* </note>
|
|
30
30
|
* <important>
|
|
31
|
-
* <p>Users or groups that have permissions to use the <code>CopySnapshot</code>
|
|
32
|
-
* can create their own Amazon S3 buckets and copy snapshots to it.
|
|
33
|
-
*
|
|
34
|
-
* the <code>CopySnapshot</code> operation.
|
|
35
|
-
*
|
|
36
|
-
*
|
|
31
|
+
* <p>Users or groups that have permissions to use the <code>CopySnapshot</code>
|
|
32
|
+
* operation can create their own Amazon S3 buckets and copy snapshots to it. To
|
|
33
|
+
* control access to your snapshots, use an IAM policy to control who has the ability
|
|
34
|
+
* to use the <code>CopySnapshot</code> operation. For more information about using IAM
|
|
35
|
+
* to control the use of ElastiCache operations, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html">Exporting
|
|
36
|
+
* Snapshots</a> and <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html">Authentication & Access
|
|
37
|
+
* Control</a>.</p>
|
|
37
38
|
* </important>
|
|
38
39
|
* <p>You could receive the following error messages.</p>
|
|
39
40
|
* <p class="title">
|
|
@@ -42,76 +43,75 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
|
|
|
42
43
|
* <ul>
|
|
43
44
|
* <li>
|
|
44
45
|
* <p>
|
|
45
|
-
* <b>Error Message:</b>
|
|
46
|
-
*
|
|
46
|
+
* <b>Error Message:</b> The S3 bucket %s is outside of
|
|
47
|
+
* the region.</p>
|
|
47
48
|
* <p>
|
|
48
|
-
* <b>Solution:</b>
|
|
49
|
-
* Create an Amazon S3
|
|
50
|
-
*
|
|
49
|
+
* <b>Solution:</b> Create an Amazon S3 bucket in the
|
|
50
|
+
* same region as your snapshot. 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
|
|
51
|
+
* Guide.</p>
|
|
51
52
|
* </li>
|
|
52
53
|
* <li>
|
|
53
54
|
* <p>
|
|
54
|
-
* <b>Error Message:</b>
|
|
55
|
-
*
|
|
55
|
+
* <b>Error Message:</b> The S3 bucket %s does not
|
|
56
|
+
* exist.</p>
|
|
56
57
|
* <p>
|
|
57
|
-
* <b>Solution:</b>
|
|
58
|
-
* Create an Amazon S3
|
|
59
|
-
*
|
|
58
|
+
* <b>Solution:</b> Create an Amazon S3 bucket in the
|
|
59
|
+
* same region as your snapshot. 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
|
|
60
|
+
* Guide.</p>
|
|
60
61
|
* </li>
|
|
61
62
|
* <li>
|
|
62
63
|
* <p>
|
|
63
|
-
* <b>Error Message:</b>
|
|
64
|
-
*
|
|
64
|
+
* <b>Error Message:</b> The S3 bucket %s is not owned
|
|
65
|
+
* by the authenticated user.</p>
|
|
65
66
|
* <p>
|
|
66
|
-
* <b>Solution:</b>
|
|
67
|
-
* Create an Amazon S3
|
|
68
|
-
*
|
|
67
|
+
* <b>Solution:</b> Create an Amazon S3 bucket in the
|
|
68
|
+
* same region as your snapshot. 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
|
|
69
|
+
* Guide.</p>
|
|
69
70
|
* </li>
|
|
70
71
|
* <li>
|
|
71
72
|
* <p>
|
|
72
|
-
* <b>Error Message:</b>
|
|
73
|
-
*
|
|
73
|
+
* <b>Error Message:</b> The authenticated user does
|
|
74
|
+
* not have sufficient permissions to perform the desired activity.</p>
|
|
74
75
|
* <p>
|
|
75
|
-
* <b>Solution:</b>
|
|
76
|
-
*
|
|
76
|
+
* <b>Solution:</b> Contact your system administrator
|
|
77
|
+
* to get the needed permissions.</p>
|
|
77
78
|
* </li>
|
|
78
79
|
* <li>
|
|
79
80
|
* <p>
|
|
80
|
-
* <b>Error Message:</b>
|
|
81
|
-
*
|
|
81
|
+
* <b>Error Message:</b> The S3 bucket %s already
|
|
82
|
+
* contains an object with key %s.</p>
|
|
82
83
|
* <p>
|
|
83
|
-
* <b>Solution:</b>
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* and use this same value for <code>TargetSnapshotName</code>.</p>
|
|
84
|
+
* <b>Solution:</b> Give the
|
|
85
|
+
* <code>TargetSnapshotName</code> a new and unique value. If exporting a
|
|
86
|
+
* snapshot, you could alternatively create a new Amazon S3 bucket and use this
|
|
87
|
+
* same value for <code>TargetSnapshotName</code>.</p>
|
|
88
88
|
* </li>
|
|
89
89
|
* <li>
|
|
90
90
|
* <p>
|
|
91
|
-
* <b>Error Message: </b>
|
|
92
|
-
*
|
|
91
|
+
* <b>Error Message: </b> ElastiCache has not been
|
|
92
|
+
* granted READ permissions %s on the S3 Bucket.</p>
|
|
93
93
|
* <p>
|
|
94
|
-
* <b>Solution:</b>
|
|
95
|
-
*
|
|
96
|
-
*
|
|
94
|
+
* <b>Solution:</b> Add List and Read permissions on
|
|
95
|
+
* the bucket. 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
|
|
96
|
+
* ElastiCache User Guide.</p>
|
|
97
97
|
* </li>
|
|
98
98
|
* <li>
|
|
99
99
|
* <p>
|
|
100
|
-
* <b>Error Message: </b>
|
|
101
|
-
*
|
|
100
|
+
* <b>Error Message: </b> ElastiCache has not been
|
|
101
|
+
* granted WRITE permissions %s on the S3 Bucket.</p>
|
|
102
102
|
* <p>
|
|
103
|
-
* <b>Solution:</b>
|
|
104
|
-
*
|
|
105
|
-
*
|
|
103
|
+
* <b>Solution:</b> Add Upload/Delete permissions on
|
|
104
|
+
* the bucket. 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
|
|
105
|
+
* ElastiCache User Guide.</p>
|
|
106
106
|
* </li>
|
|
107
107
|
* <li>
|
|
108
108
|
* <p>
|
|
109
|
-
* <b>Error Message: </b>
|
|
110
|
-
*
|
|
109
|
+
* <b>Error Message: </b> ElastiCache has not been
|
|
110
|
+
* granted READ_ACP permissions %s on the S3 Bucket.</p>
|
|
111
111
|
* <p>
|
|
112
|
-
* <b>Solution:</b>
|
|
113
|
-
*
|
|
114
|
-
*
|
|
112
|
+
* <b>Solution:</b> Add View Permissions on the bucket.
|
|
113
|
+
* 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
|
|
114
|
+
* ElastiCache User Guide.</p>
|
|
115
115
|
* </li>
|
|
116
116
|
* </ul>
|
|
117
117
|
* @example
|
|
@@ -204,7 +204,8 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
|
|
|
204
204
|
* <p>The value for a parameter is invalid.</p>
|
|
205
205
|
*
|
|
206
206
|
* @throws {@link InvalidSnapshotStateFault} (client fault)
|
|
207
|
-
* <p>The current state of the snapshot does not allow the requested operation to
|
|
207
|
+
* <p>The current state of the snapshot does not allow the requested operation to
|
|
208
|
+
* occur.</p>
|
|
208
209
|
*
|
|
209
210
|
* @throws {@link SnapshotAlreadyExistsFault} (client fault)
|
|
210
211
|
* <p>You already have a snapshot with the given name.</p>
|
|
@@ -213,10 +214,13 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
|
|
|
213
214
|
* <p>The requested snapshot name does not refer to an existing snapshot.</p>
|
|
214
215
|
*
|
|
215
216
|
* @throws {@link SnapshotQuotaExceededFault} (client fault)
|
|
216
|
-
* <p>The request cannot be processed because it would exceed the maximum number of
|
|
217
|
+
* <p>The request cannot be processed because it would exceed the maximum number of
|
|
218
|
+
* snapshots.</p>
|
|
217
219
|
*
|
|
218
220
|
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
219
|
-
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
221
|
+
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
222
|
+
* the allowed number of tags. The maximum number of tags permitted on a resource is
|
|
223
|
+
* 50.</p>
|
|
220
224
|
*
|
|
221
225
|
* @throws {@link ElastiCacheServiceException}
|
|
222
226
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -23,9 +23,8 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a cluster. All nodes in the
|
|
27
|
-
*
|
|
28
|
-
* or Redis.</p>
|
|
26
|
+
* <p>Creates a cluster. All nodes in the cluster run the same protocol-compliant cache
|
|
27
|
+
* engine software, either Memcached or Redis.</p>
|
|
29
28
|
* <p>This operation is not supported for Redis (cluster mode enabled) clusters.</p>
|
|
30
29
|
* @example
|
|
31
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -224,20 +223,24 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
|
|
|
224
223
|
* <p>You already have a cluster with the given identifier.</p>
|
|
225
224
|
*
|
|
226
225
|
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
227
|
-
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
226
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
227
|
+
* group.</p>
|
|
228
228
|
*
|
|
229
229
|
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
230
|
-
* <p>The requested cache security group name does not refer to an existing cache security
|
|
230
|
+
* <p>The requested cache security group name does not refer to an existing cache security
|
|
231
|
+
* group.</p>
|
|
231
232
|
*
|
|
232
233
|
* @throws {@link CacheSubnetGroupNotFoundFault} (client fault)
|
|
233
|
-
* <p>The requested cache subnet group name does not refer to an existing cache subnet
|
|
234
|
+
* <p>The requested cache subnet group name does not refer to an existing cache subnet
|
|
235
|
+
* group.</p>
|
|
234
236
|
*
|
|
235
237
|
* @throws {@link ClusterQuotaForCustomerExceededFault} (client fault)
|
|
236
|
-
* <p>The request cannot be processed because it would exceed the allowed number of clusters
|
|
238
|
+
* <p>The request cannot be processed because it would exceed the allowed number of clusters
|
|
239
|
+
* per customer.</p>
|
|
237
240
|
*
|
|
238
241
|
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
|
|
239
|
-
* <p>The requested cache node type is not available in the specified Availability Zone.
|
|
240
|
-
*
|
|
242
|
+
* <p>The requested cache node type is not available in the specified Availability Zone. For
|
|
243
|
+
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
|
|
241
244
|
*
|
|
242
245
|
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
243
246
|
* <p>Two or more incompatible parameters were specified.</p>
|
|
@@ -252,16 +255,20 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
|
|
|
252
255
|
* <p>The VPC network is in an invalid state.</p>
|
|
253
256
|
*
|
|
254
257
|
* @throws {@link NodeQuotaForClusterExceededFault} (client fault)
|
|
255
|
-
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
258
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
259
|
+
* nodes in a single cluster.</p>
|
|
256
260
|
*
|
|
257
261
|
* @throws {@link NodeQuotaForCustomerExceededFault} (client fault)
|
|
258
|
-
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
262
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
263
|
+
* nodes per customer.</p>
|
|
259
264
|
*
|
|
260
265
|
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
261
266
|
* <p>The specified replication group does not exist.</p>
|
|
262
267
|
*
|
|
263
268
|
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
264
|
-
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
269
|
+
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
270
|
+
* the allowed number of tags. The maximum number of tags permitted on a resource is
|
|
271
|
+
* 50.</p>
|
|
265
272
|
*
|
|
266
273
|
* @throws {@link ElastiCacheServiceException}
|
|
267
274
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -23,12 +23,13 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a new Amazon ElastiCache cache parameter group. An ElastiCache
|
|
27
|
-
*
|
|
28
|
-
* in any cluster or replication group using the CacheParameterGroup.</p>
|
|
29
|
-
* <p>A newly created CacheParameterGroup is an exact duplicate of the default parameter
|
|
30
|
-
* for the CacheParameterGroupFamily. To customize the newly created
|
|
31
|
-
* change the values of specific parameters. For more
|
|
26
|
+
* <p>Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter
|
|
27
|
+
* group is a collection of parameters and their values that are applied to all of the
|
|
28
|
+
* nodes in any cluster or replication group using the CacheParameterGroup.</p>
|
|
29
|
+
* <p>A newly created CacheParameterGroup is an exact duplicate of the default parameter
|
|
30
|
+
* group for the CacheParameterGroupFamily. To customize the newly created
|
|
31
|
+
* CacheParameterGroup you can change the values of specific parameters. For more
|
|
32
|
+
* information, see:</p>
|
|
32
33
|
* <ul>
|
|
33
34
|
* <li>
|
|
34
35
|
* <p>
|
|
@@ -36,7 +37,8 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
|
|
|
36
37
|
* </li>
|
|
37
38
|
* <li>
|
|
38
39
|
* <p>
|
|
39
|
-
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html">Parameters and
|
|
40
|
+
* <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html">Parameters and
|
|
41
|
+
* Parameter Groups</a> in the ElastiCache User Guide.</p>
|
|
40
42
|
* </li>
|
|
41
43
|
* </ul>
|
|
42
44
|
* @example
|
|
@@ -80,10 +82,12 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
|
|
|
80
82
|
* <p>A cache parameter group with the requested name already exists.</p>
|
|
81
83
|
*
|
|
82
84
|
* @throws {@link CacheParameterGroupQuotaExceededFault} (client fault)
|
|
83
|
-
* <p>The request cannot be processed because it would exceed the maximum number of cache
|
|
85
|
+
* <p>The request cannot be processed because it would exceed the maximum number of cache
|
|
86
|
+
* security groups.</p>
|
|
84
87
|
*
|
|
85
88
|
* @throws {@link InvalidCacheParameterGroupStateFault} (client fault)
|
|
86
|
-
* <p>The current state of the cache parameter group does not allow the requested operation
|
|
89
|
+
* <p>The current state of the cache parameter group does not allow the requested operation
|
|
90
|
+
* to occur.</p>
|
|
87
91
|
*
|
|
88
92
|
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
89
93
|
* <p>Two or more incompatible parameters were specified.</p>
|
|
@@ -92,7 +96,9 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
|
|
|
92
96
|
* <p>The value for a parameter is invalid.</p>
|
|
93
97
|
*
|
|
94
98
|
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
95
|
-
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
99
|
+
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
100
|
+
* the allowed number of tags. The maximum number of tags permitted on a resource is
|
|
101
|
+
* 50.</p>
|
|
96
102
|
*
|
|
97
103
|
* @throws {@link ElastiCacheServiceException}
|
|
98
104
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -23,12 +23,11 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a new cache security group. Use a
|
|
27
|
-
*
|
|
28
|
-
* <p>Cache security groups are only used when you are creating a cluster outside of an
|
|
29
|
-
* Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a
|
|
30
|
-
* subnet group instead. For more information,
|
|
31
|
-
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html">CreateCacheSubnetGroup</a>.</p>
|
|
26
|
+
* <p>Creates a new cache security group. Use a cache security group to control access to
|
|
27
|
+
* one or more clusters.</p>
|
|
28
|
+
* <p>Cache security groups are only used when you are creating a cluster outside of an
|
|
29
|
+
* Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a
|
|
30
|
+
* VPC, use a cache subnet group instead. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html">CreateCacheSubnetGroup</a>.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -75,7 +74,8 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri
|
|
|
75
74
|
* <p>A cache security group with the specified name already exists.</p>
|
|
76
75
|
*
|
|
77
76
|
* @throws {@link CacheSecurityGroupQuotaExceededFault} (client fault)
|
|
78
|
-
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
77
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
78
|
+
* security groups.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
81
81
|
* <p>Two or more incompatible parameters were specified.</p>
|
|
@@ -84,7 +84,9 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri
|
|
|
84
84
|
* <p>The value for a parameter is invalid.</p>
|
|
85
85
|
*
|
|
86
86
|
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
87
|
-
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
87
|
+
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
88
|
+
* the allowed number of tags. The maximum number of tags permitted on a resource is
|
|
89
|
+
* 50.</p>
|
|
88
90
|
*
|
|
89
91
|
* @throws {@link ElastiCacheServiceException}
|
|
90
92
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -24,7 +24,8 @@ export interface CreateCacheSubnetGroupCommandOutput extends CreateCacheSubnetGr
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Creates a new cache subnet group.</p>
|
|
27
|
-
* <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private
|
|
27
|
+
* <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private
|
|
28
|
+
* Cloud (Amazon VPC).</p>
|
|
28
29
|
* @example
|
|
29
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
31
|
* ```javascript
|
|
@@ -81,23 +82,30 @@ export interface CreateCacheSubnetGroupCommandOutput extends CreateCacheSubnetGr
|
|
|
81
82
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
82
83
|
*
|
|
83
84
|
* @throws {@link CacheSubnetGroupAlreadyExistsFault} (client fault)
|
|
84
|
-
* <p>The requested cache subnet group name is already in use by an existing cache subnet
|
|
85
|
+
* <p>The requested cache subnet group name is already in use by an existing cache subnet
|
|
86
|
+
* group.</p>
|
|
85
87
|
*
|
|
86
88
|
* @throws {@link CacheSubnetGroupQuotaExceededFault} (client fault)
|
|
87
|
-
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
89
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
90
|
+
* subnet groups.</p>
|
|
88
91
|
*
|
|
89
92
|
* @throws {@link CacheSubnetQuotaExceededFault} (client fault)
|
|
90
|
-
* <p>The request cannot be processed because it would exceed the allowed number of subnets
|
|
93
|
+
* <p>The request cannot be processed because it would exceed the allowed number of subnets
|
|
94
|
+
* in a cache subnet group.</p>
|
|
91
95
|
*
|
|
92
96
|
* @throws {@link InvalidSubnet} (client fault)
|
|
93
97
|
* <p>An invalid subnet identifier was specified.</p>
|
|
94
98
|
*
|
|
95
99
|
* @throws {@link SubnetNotAllowedFault} (client fault)
|
|
96
|
-
* <p>At least one subnet ID does not match the other subnet IDs. This mismatch typically
|
|
97
|
-
* user sets one subnet ID to a regional Availability Zone and a different
|
|
100
|
+
* <p>At least one subnet ID does not match the other subnet IDs. This mismatch typically
|
|
101
|
+
* occurs when a user sets one subnet ID to a regional Availability Zone and a different
|
|
102
|
+
* one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed
|
|
103
|
+
* on this service.</p>
|
|
98
104
|
*
|
|
99
105
|
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
100
|
-
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
106
|
+
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
107
|
+
* the allowed number of tags. The maximum number of tags permitted on a resource is
|
|
108
|
+
* 50.</p>
|
|
101
109
|
*
|
|
102
110
|
* @throws {@link ElastiCacheServiceException}
|
|
103
111
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
@@ -23,19 +23,20 @@ export interface CreateGlobalReplicationGroupCommandOutput extends CreateGlobalR
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Global Datastore for Redis offers fully managed, fast,
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication Across Regions Using Global Datastore</a>. </p>
|
|
26
|
+
* <p>Global Datastore for Redis offers fully managed, fast, reliable and secure
|
|
27
|
+
* cross-region replication. Using Global Datastore for Redis, you can create cross-region
|
|
28
|
+
* read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster
|
|
29
|
+
* recovery across regions. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication
|
|
30
|
+
* Across Regions Using Global Datastore</a>. </p>
|
|
33
31
|
* <ul>
|
|
34
32
|
* <li>
|
|
35
|
-
* <p>The <b>GlobalReplicationGroupIdSuffix</b> is the
|
|
33
|
+
* <p>The <b>GlobalReplicationGroupIdSuffix</b> is the
|
|
34
|
+
* name of the Global datastore.</p>
|
|
36
35
|
* </li>
|
|
37
36
|
* <li>
|
|
38
|
-
* <p>The <b>PrimaryReplicationGroupId</b> represents the
|
|
37
|
+
* <p>The <b>PrimaryReplicationGroupId</b> represents the
|
|
38
|
+
* name of the primary cluster that accepts writes and will replicate updates to
|
|
39
|
+
* the secondary cluster.</p>
|
|
39
40
|
* </li>
|
|
40
41
|
* </ul>
|
|
41
42
|
* @example
|
|
@@ -23,28 +23,34 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication
|
|
27
|
-
*
|
|
28
|
-
* <p>
|
|
29
|
-
*
|
|
26
|
+
* <p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication
|
|
27
|
+
* group.</p>
|
|
28
|
+
* <p>This API can be used to create a standalone regional replication group or a secondary
|
|
29
|
+
* replication group associated with a Global datastore.</p>
|
|
30
|
+
* <p>A Redis (cluster mode disabled) replication group is a collection of clusters, where
|
|
31
|
+
* one of the clusters is a read/write primary and the others are read-only replicas.
|
|
30
32
|
* Writes to the primary are asynchronously propagated to the replicas.</p>
|
|
31
|
-
* <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:
|
|
32
|
-
* Each shard has a primary node and up to 5 read-only replica nodes. The
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* the
|
|
40
|
-
*
|
|
41
|
-
* <a href="https://docs.aws.amazon.com/
|
|
42
|
-
*
|
|
33
|
+
* <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:
|
|
34
|
+
* node groups). Each shard has a primary node and up to 5 read-only replica nodes. The
|
|
35
|
+
* configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which
|
|
36
|
+
* is the maximum number or replicas allowed. </p>
|
|
37
|
+
* <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis
|
|
38
|
+
* engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node
|
|
39
|
+
* cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500
|
|
40
|
+
* shards (single primary and no replicas). Make sure there are enough available IP
|
|
41
|
+
* addresses to accommodate the increase. Common pitfalls include the subnets in the subnet
|
|
42
|
+
* group have too small a CIDR range or the subnets are shared and heavily used by other
|
|
43
|
+
* clusters. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html">Creating a Subnet
|
|
44
|
+
* Group</a>. For versions below 5.0.6, the limit is 250 per cluster.</p>
|
|
45
|
+
* <p>To request a limit increase, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">Amazon Service Limits</a> and
|
|
46
|
+
* choose the limit type <b>Nodes per cluster per instance
|
|
47
|
+
* type</b>. </p>
|
|
43
48
|
* <p>When a Redis (cluster mode disabled) replication group has been successfully created,
|
|
44
|
-
* you can add one or more read replicas to it, up to a total of 5 read replicas.
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
49
|
+
* you can add one or more read replicas to it, up to a total of 5 read replicas. If you
|
|
50
|
+
* need to increase or decrease the number of node groups (console: shards), you can avail
|
|
51
|
+
* yourself of ElastiCache for Redis' scaling. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling
|
|
52
|
+
* ElastiCache for Redis Clusters</a> in the <i>ElastiCache User
|
|
53
|
+
* Guide</i>.</p>
|
|
48
54
|
* <note>
|
|
49
55
|
* <p>This operation is valid for Redis only.</p>
|
|
50
56
|
* </note>
|
|
@@ -275,23 +281,27 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
|
|
|
275
281
|
* <p>The requested cluster ID does not refer to an existing cluster.</p>
|
|
276
282
|
*
|
|
277
283
|
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
278
|
-
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
284
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter
|
|
285
|
+
* group.</p>
|
|
279
286
|
*
|
|
280
287
|
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
281
|
-
* <p>The requested cache security group name does not refer to an existing cache security
|
|
288
|
+
* <p>The requested cache security group name does not refer to an existing cache security
|
|
289
|
+
* group.</p>
|
|
282
290
|
*
|
|
283
291
|
* @throws {@link CacheSubnetGroupNotFoundFault} (client fault)
|
|
284
|
-
* <p>The requested cache subnet group name does not refer to an existing cache subnet
|
|
292
|
+
* <p>The requested cache subnet group name does not refer to an existing cache subnet
|
|
293
|
+
* group.</p>
|
|
285
294
|
*
|
|
286
295
|
* @throws {@link ClusterQuotaForCustomerExceededFault} (client fault)
|
|
287
|
-
* <p>The request cannot be processed because it would exceed the allowed number of clusters
|
|
296
|
+
* <p>The request cannot be processed because it would exceed the allowed number of clusters
|
|
297
|
+
* per customer.</p>
|
|
288
298
|
*
|
|
289
299
|
* @throws {@link GlobalReplicationGroupNotFoundFault} (client fault)
|
|
290
300
|
* <p>The Global datastore does not exist</p>
|
|
291
301
|
*
|
|
292
302
|
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
|
|
293
|
-
* <p>The requested cache node type is not available in the specified Availability Zone.
|
|
294
|
-
*
|
|
303
|
+
* <p>The requested cache node type is not available in the specified Availability Zone. For
|
|
304
|
+
* more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
|
|
295
305
|
*
|
|
296
306
|
* @throws {@link InvalidCacheClusterStateFault} (client fault)
|
|
297
307
|
* <p>The requested cluster is not in the <code>available</code> state.</p>
|
|
@@ -312,20 +322,24 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
|
|
|
312
322
|
* <p>The VPC network is in an invalid state.</p>
|
|
313
323
|
*
|
|
314
324
|
* @throws {@link NodeGroupsPerReplicationGroupQuotaExceededFault} (client fault)
|
|
315
|
-
* <p>The request cannot be processed because it would exceed the maximum allowed number
|
|
316
|
-
*
|
|
325
|
+
* <p>The request cannot be processed because it would exceed the maximum allowed number of
|
|
326
|
+
* node groups (shards) in a single replication group. The default maximum is 90</p>
|
|
317
327
|
*
|
|
318
328
|
* @throws {@link NodeQuotaForClusterExceededFault} (client fault)
|
|
319
|
-
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
329
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
330
|
+
* nodes in a single cluster.</p>
|
|
320
331
|
*
|
|
321
332
|
* @throws {@link NodeQuotaForCustomerExceededFault} (client fault)
|
|
322
|
-
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
333
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache
|
|
334
|
+
* nodes per customer.</p>
|
|
323
335
|
*
|
|
324
336
|
* @throws {@link ReplicationGroupAlreadyExistsFault} (client fault)
|
|
325
337
|
* <p>The specified replication group already exists.</p>
|
|
326
338
|
*
|
|
327
339
|
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
328
|
-
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
340
|
+
* <p>The request cannot be processed because it would cause the resource to have more than
|
|
341
|
+
* the allowed number of tags. The maximum number of tags permitted on a resource is
|
|
342
|
+
* 50.</p>
|
|
329
343
|
*
|
|
330
344
|
* @throws {@link UserGroupNotFoundFault} (client fault)
|
|
331
345
|
* <p>The user group was not found or does not exist</p>
|