@aws-sdk/client-elasticache 3.288.0 → 3.290.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +72 -0
- package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +29 -0
- package/dist-types/commands/BatchApplyUpdateActionCommand.d.ts +7 -0
- package/dist-types/commands/BatchStopUpdateActionCommand.d.ts +7 -0
- package/dist-types/commands/CompleteMigrationCommand.d.ts +10 -0
- package/dist-types/commands/CopySnapshotCommand.d.ts +67 -0
- package/dist-types/commands/CreateCacheClusterCommand.d.ts +86 -0
- package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +41 -0
- package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +28 -0
- package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +66 -0
- package/dist-types/commands/CreateGlobalReplicationGroupCommand.d.ts +16 -0
- package/dist-types/commands/CreateReplicationGroupCommand.d.ts +153 -0
- package/dist-types/commands/CreateSnapshotCommand.d.ts +130 -0
- package/dist-types/commands/CreateUserCommand.d.ts +22 -0
- package/dist-types/commands/CreateUserGroupCommand.d.ts +25 -0
- package/dist-types/commands/DecreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +13 -0
- package/dist-types/commands/DecreaseReplicaCountCommand.d.ts +39 -0
- package/dist-types/commands/DeleteCacheClusterCommand.d.ts +72 -0
- package/dist-types/commands/DeleteCacheParameterGroupCommand.d.ts +24 -0
- package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +24 -0
- package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +18 -0
- package/dist-types/commands/DeleteGlobalReplicationGroupCommand.d.ts +10 -0
- package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +55 -0
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +56 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
- package/dist-types/commands/DeleteUserGroupCommand.d.ts +13 -0
- package/dist-types/commands/DescribeCacheClustersCommand.d.ts +52 -0
- package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts +100 -0
- package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts +32 -0
- package/dist-types/commands/DescribeCacheParametersCommand.d.ts +413 -0
- package/dist-types/commands/DescribeCacheSecurityGroupsCommand.d.ts +21 -0
- package/dist-types/commands/DescribeCacheSubnetGroupsCommand.d.ts +53 -0
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +621 -0
- package/dist-types/commands/DescribeEventsCommand.d.ts +56 -0
- package/dist-types/commands/DescribeGlobalReplicationGroupsCommand.d.ts +10 -0
- package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +73 -0
- package/dist-types/commands/DescribeReservedCacheNodesCommand.d.ts +21 -0
- package/dist-types/commands/DescribeReservedCacheNodesOfferingsCommand.d.ts +283 -0
- package/dist-types/commands/DescribeServiceUpdatesCommand.d.ts +10 -0
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +59 -0
- package/dist-types/commands/DescribeUpdateActionsCommand.d.ts +7 -0
- package/dist-types/commands/DescribeUserGroupsCommand.d.ts +10 -0
- package/dist-types/commands/DescribeUsersCommand.d.ts +10 -0
- package/dist-types/commands/DisassociateGlobalReplicationGroupCommand.d.ts +13 -0
- package/dist-types/commands/FailoverGlobalReplicationGroupCommand.d.ts +13 -0
- package/dist-types/commands/IncreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +10 -0
- package/dist-types/commands/IncreaseReplicaCountCommand.d.ts +39 -0
- package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +38 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +59 -0
- package/dist-types/commands/ModifyCacheClusterCommand.d.ts +75 -0
- package/dist-types/commands/ModifyCacheParameterGroupCommand.d.ts +42 -0
- package/dist-types/commands/ModifyCacheSubnetGroupCommand.d.ts +72 -0
- package/dist-types/commands/ModifyGlobalReplicationGroupCommand.d.ts +10 -0
- package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +124 -0
- package/dist-types/commands/ModifyReplicationGroupShardConfigurationCommand.d.ts +33 -0
- package/dist-types/commands/ModifyUserCommand.d.ts +16 -0
- package/dist-types/commands/ModifyUserGroupCommand.d.ts +25 -0
- package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts +30 -0
- package/dist-types/commands/RebalanceSlotsInGlobalReplicationGroupCommand.d.ts +10 -0
- package/dist-types/commands/RebootCacheClusterCommand.d.ts +51 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +79 -0
- package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts +33 -0
- package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts +29 -0
- package/dist-types/commands/StartMigrationCommand.d.ts +13 -0
- package/dist-types/commands/TestFailoverCommand.d.ts +29 -0
- package/package.json +30 -30
|
@@ -40,6 +40,78 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
|
|
|
40
40
|
* @see {@link AddTagsToResourceCommandOutput} for command's `response` shape.
|
|
41
41
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
42
42
|
*
|
|
43
|
+
* @throws {@link CacheClusterNotFoundFault} (client fault)
|
|
44
|
+
* <p>The requested cluster ID does not refer to an existing cluster.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
47
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
50
|
+
* <p>The requested cache security group name does not refer to an existing cache security group.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link CacheSubnetGroupNotFoundFault} (client fault)
|
|
53
|
+
* <p>The requested cache subnet group name does not refer to an existing cache subnet group.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link InvalidARNFault} (client fault)
|
|
56
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InvalidReplicationGroupStateFault} (client fault)
|
|
59
|
+
* <p>The requested replication group is not in the <code>available</code> state.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
62
|
+
* <p>The specified replication group does not exist.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ReservedCacheNodeNotFoundFault} (client fault)
|
|
65
|
+
* <p>The requested reserved cache node was not found.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link SnapshotNotFoundFault} (client fault)
|
|
68
|
+
* <p>The requested snapshot name does not refer to an existing snapshot.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
71
|
+
* <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link UserGroupNotFoundFault} (client fault)
|
|
74
|
+
* <p>The user group was not found or does not exist</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link UserNotFoundFault} (client fault)
|
|
77
|
+
* <p>The user does not exist or could not be found.</p>
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* @example AddTagsToResource
|
|
81
|
+
* ```javascript
|
|
82
|
+
* // Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.
|
|
83
|
+
* const input = {
|
|
84
|
+
* "ResourceName": "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster",
|
|
85
|
+
* "Tags": [
|
|
86
|
+
* {
|
|
87
|
+
* "Key": "APIVersion",
|
|
88
|
+
* "Value": "20150202"
|
|
89
|
+
* },
|
|
90
|
+
* {
|
|
91
|
+
* "Key": "Service",
|
|
92
|
+
* "Value": "ElastiCache"
|
|
93
|
+
* }
|
|
94
|
+
* ]
|
|
95
|
+
* };
|
|
96
|
+
* const command = new AddTagsToResourceCommand(input);
|
|
97
|
+
* const response = await client.send(command);
|
|
98
|
+
* /* response ==
|
|
99
|
+
* {
|
|
100
|
+
* "TagList": [
|
|
101
|
+
* {
|
|
102
|
+
* "Key": "APIVersion",
|
|
103
|
+
* "Value": "20150202"
|
|
104
|
+
* },
|
|
105
|
+
* {
|
|
106
|
+
* "Key": "Service",
|
|
107
|
+
* "Value": "ElastiCache"
|
|
108
|
+
* }
|
|
109
|
+
* ]
|
|
110
|
+
* }
|
|
111
|
+
* *\/
|
|
112
|
+
* // example id: addtagstoresource-1482430264385
|
|
113
|
+
* ```
|
|
114
|
+
*
|
|
43
115
|
*/
|
|
44
116
|
export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
45
117
|
readonly input: AddTagsToResourceCommandInput;
|
|
@@ -35,6 +35,35 @@ export interface AuthorizeCacheSecurityGroupIngressCommandOutput extends Authori
|
|
|
35
35
|
* @see {@link AuthorizeCacheSecurityGroupIngressCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link AuthorizationAlreadyExistsFault} (client fault)
|
|
39
|
+
* <p>The specified Amazon EC2 security group is already authorized for the specified cache security group.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
42
|
+
* <p>The requested cache security group name does not refer to an existing cache security group.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InvalidCacheSecurityGroupStateFault} (client fault)
|
|
45
|
+
* <p>The current state of the cache security group does not allow deletion.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
48
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
51
|
+
* <p>The value for a parameter is invalid.</p>
|
|
52
|
+
*
|
|
53
|
+
*
|
|
54
|
+
* @example AuthorizeCacheCacheSecurityGroupIngress
|
|
55
|
+
* ```javascript
|
|
56
|
+
* // Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2. Amazon EC2 security groups are used as the authorization mechanism.
|
|
57
|
+
* const input = {
|
|
58
|
+
* "CacheSecurityGroupName": "my-sec-grp",
|
|
59
|
+
* "EC2SecurityGroupName": "my-ec2-sec-grp",
|
|
60
|
+
* "EC2SecurityGroupOwnerId": "1234567890"
|
|
61
|
+
* };
|
|
62
|
+
* const command = new AuthorizeCacheSecurityGroupIngressCommand(input);
|
|
63
|
+
* await client.send(command);
|
|
64
|
+
* // example id: authorizecachecachesecuritygroupingress-1483046446206
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
38
67
|
*/
|
|
39
68
|
export declare class AuthorizeCacheSecurityGroupIngressCommand extends $Command<AuthorizeCacheSecurityGroupIngressCommandInput, AuthorizeCacheSecurityGroupIngressCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
40
69
|
readonly input: AuthorizeCacheSecurityGroupIngressCommandInput;
|
|
@@ -29,6 +29,13 @@ export interface BatchApplyUpdateActionCommandOutput extends UpdateActionResults
|
|
|
29
29
|
* @see {@link BatchApplyUpdateActionCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
33
|
+
* <p>The value for a parameter is invalid.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link ServiceUpdateNotFoundFault} (client fault)
|
|
36
|
+
* <p>The service update doesn't exist</p>
|
|
37
|
+
*
|
|
38
|
+
*
|
|
32
39
|
*/
|
|
33
40
|
export declare class BatchApplyUpdateActionCommand extends $Command<BatchApplyUpdateActionCommandInput, BatchApplyUpdateActionCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
34
41
|
readonly input: BatchApplyUpdateActionCommandInput;
|
|
@@ -29,6 +29,13 @@ export interface BatchStopUpdateActionCommandOutput extends UpdateActionResultsM
|
|
|
29
29
|
* @see {@link BatchStopUpdateActionCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
33
|
+
* <p>The value for a parameter is invalid.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link ServiceUpdateNotFoundFault} (client fault)
|
|
36
|
+
* <p>The service update doesn't exist</p>
|
|
37
|
+
*
|
|
38
|
+
*
|
|
32
39
|
*/
|
|
33
40
|
export declare class BatchStopUpdateActionCommand extends $Command<BatchStopUpdateActionCommandInput, BatchStopUpdateActionCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
34
41
|
readonly input: BatchStopUpdateActionCommandInput;
|
|
@@ -29,6 +29,16 @@ export interface CompleteMigrationCommandOutput extends CompleteMigrationRespons
|
|
|
29
29
|
* @see {@link CompleteMigrationCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidReplicationGroupStateFault} (client fault)
|
|
33
|
+
* <p>The requested replication group is not in the <code>available</code> state.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
36
|
+
* <p>The specified replication group does not exist.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link ReplicationGroupNotUnderMigrationFault} (client fault)
|
|
39
|
+
* <p>The designated replication group is not available for data migration.</p>
|
|
40
|
+
*
|
|
41
|
+
*
|
|
32
42
|
*/
|
|
33
43
|
export declare class CompleteMigrationCommand extends $Command<CompleteMigrationCommandInput, CompleteMigrationCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
34
44
|
readonly input: CompleteMigrationCommandInput;
|
|
@@ -119,6 +119,73 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
|
|
|
119
119
|
* @see {@link CopySnapshotCommandOutput} for command's `response` shape.
|
|
120
120
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
121
121
|
*
|
|
122
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
123
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
126
|
+
* <p>The value for a parameter is invalid.</p>
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link InvalidSnapshotStateFault} (client fault)
|
|
129
|
+
* <p>The current state of the snapshot does not allow the requested operation to occur.</p>
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link SnapshotAlreadyExistsFault} (client fault)
|
|
132
|
+
* <p>You already have a snapshot with the given name.</p>
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link SnapshotNotFoundFault} (client fault)
|
|
135
|
+
* <p>The requested snapshot name does not refer to an existing snapshot.</p>
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link SnapshotQuotaExceededFault} (client fault)
|
|
138
|
+
* <p>The request cannot be processed because it would exceed the maximum number of snapshots.</p>
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
141
|
+
* <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
|
|
142
|
+
*
|
|
143
|
+
*
|
|
144
|
+
* @example CopySnapshot
|
|
145
|
+
* ```javascript
|
|
146
|
+
* // Copies a snapshot to a specified name.
|
|
147
|
+
* const input = {
|
|
148
|
+
* "SourceSnapshotName": "my-snapshot",
|
|
149
|
+
* "TargetBucket": "",
|
|
150
|
+
* "TargetSnapshotName": "my-snapshot-copy"
|
|
151
|
+
* };
|
|
152
|
+
* const command = new CopySnapshotCommand(input);
|
|
153
|
+
* const response = await client.send(command);
|
|
154
|
+
* /* response ==
|
|
155
|
+
* {
|
|
156
|
+
* "Snapshot": {
|
|
157
|
+
* "AutoMinorVersionUpgrade": true,
|
|
158
|
+
* "CacheClusterCreateTime": "2016-12-21T22:24:04.955Z",
|
|
159
|
+
* "CacheClusterId": "my-redis4",
|
|
160
|
+
* "CacheNodeType": "cache.m3.large",
|
|
161
|
+
* "CacheParameterGroupName": "default.redis3.2",
|
|
162
|
+
* "CacheSubnetGroupName": "default",
|
|
163
|
+
* "Engine": "redis",
|
|
164
|
+
* "EngineVersion": "3.2.4",
|
|
165
|
+
* "NodeSnapshots": [
|
|
166
|
+
* {
|
|
167
|
+
* "CacheNodeCreateTime": "2016-12-21T22:24:04.955Z",
|
|
168
|
+
* "CacheNodeId": "0001",
|
|
169
|
+
* "CacheSize": "3 MB",
|
|
170
|
+
* "SnapshotCreateTime": "2016-12-28T07:00:52Z"
|
|
171
|
+
* }
|
|
172
|
+
* ],
|
|
173
|
+
* "NumCacheNodes": 1,
|
|
174
|
+
* "Port": 6379,
|
|
175
|
+
* "PreferredAvailabilityZone": "us-east-1c",
|
|
176
|
+
* "PreferredMaintenanceWindow": "tue:09:30-tue:10:30",
|
|
177
|
+
* "SnapshotName": "my-snapshot-copy",
|
|
178
|
+
* "SnapshotRetentionLimit": 7,
|
|
179
|
+
* "SnapshotSource": "manual",
|
|
180
|
+
* "SnapshotStatus": "creating",
|
|
181
|
+
* "SnapshotWindow": "07:00-08:00",
|
|
182
|
+
* "VpcId": "vpc-3820329f3"
|
|
183
|
+
* }
|
|
184
|
+
* }
|
|
185
|
+
* *\/
|
|
186
|
+
* // example id: copysnapshot-1482961393820
|
|
187
|
+
* ```
|
|
188
|
+
*
|
|
122
189
|
*/
|
|
123
190
|
export declare class CopySnapshotCommand extends $Command<CopySnapshotCommandInput, CopySnapshotCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
124
191
|
readonly input: CopySnapshotCommandInput;
|
|
@@ -32,6 +32,92 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
|
|
|
32
32
|
* @see {@link CreateCacheClusterCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link CacheClusterAlreadyExistsFault} (client fault)
|
|
36
|
+
* <p>You already have a cluster with the given identifier.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link CacheParameterGroupNotFoundFault} (client fault)
|
|
39
|
+
* <p>The requested cache parameter group name does not refer to an existing cache parameter group.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link CacheSecurityGroupNotFoundFault} (client fault)
|
|
42
|
+
* <p>The requested cache security group name does not refer to an existing cache security group.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link CacheSubnetGroupNotFoundFault} (client fault)
|
|
45
|
+
* <p>The requested cache subnet group name does not refer to an existing cache subnet group.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ClusterQuotaForCustomerExceededFault} (client fault)
|
|
48
|
+
* <p>The request cannot be processed because it would exceed the allowed number of clusters per customer.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InsufficientCacheClusterCapacityFault} (client fault)
|
|
51
|
+
* <p>The requested cache node type is not available in the specified Availability Zone.
|
|
52
|
+
* For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY">InsufficientCacheClusterCapacity</a> in the ElastiCache User Guide.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
55
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
58
|
+
* <p>The value for a parameter is invalid.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InvalidReplicationGroupStateFault} (client fault)
|
|
61
|
+
* <p>The requested replication group is not in the <code>available</code> state.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InvalidVPCNetworkStateFault} (client fault)
|
|
64
|
+
* <p>The VPC network is in an invalid state.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link NodeQuotaForClusterExceededFault} (client fault)
|
|
67
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link NodeQuotaForCustomerExceededFault} (client fault)
|
|
70
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache nodes per customer.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
73
|
+
* <p>The specified replication group does not exist.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
76
|
+
* <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @example CreateCacheCluster
|
|
80
|
+
* ```javascript
|
|
81
|
+
* // Creates a Memcached cluster with 2 nodes.
|
|
82
|
+
* const input = {
|
|
83
|
+
* "AZMode": "cross-az",
|
|
84
|
+
* "CacheClusterId": "my-memcached-cluster",
|
|
85
|
+
* "CacheNodeType": "cache.r3.large",
|
|
86
|
+
* "CacheSubnetGroupName": "default",
|
|
87
|
+
* "Engine": "memcached",
|
|
88
|
+
* "EngineVersion": "1.4.24",
|
|
89
|
+
* "NumCacheNodes": 2,
|
|
90
|
+
* "Port": 11211
|
|
91
|
+
* };
|
|
92
|
+
* const command = new CreateCacheClusterCommand(input);
|
|
93
|
+
* const response = await client.send(command);
|
|
94
|
+
* /* response ==
|
|
95
|
+
* {
|
|
96
|
+
* "CacheCluster": {
|
|
97
|
+
* "AutoMinorVersionUpgrade": true,
|
|
98
|
+
* "CacheClusterId": "my-memcached-cluster",
|
|
99
|
+
* "CacheClusterStatus": "creating",
|
|
100
|
+
* "CacheNodeType": "cache.r3.large",
|
|
101
|
+
* "CacheParameterGroup": {
|
|
102
|
+
* "CacheNodeIdsToReboot": [],
|
|
103
|
+
* "CacheParameterGroupName": "default.memcached1.4",
|
|
104
|
+
* "ParameterApplyStatus": "in-sync"
|
|
105
|
+
* },
|
|
106
|
+
* "CacheSecurityGroups": [],
|
|
107
|
+
* "CacheSubnetGroupName": "default",
|
|
108
|
+
* "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
|
|
109
|
+
* "Engine": "memcached",
|
|
110
|
+
* "EngineVersion": "1.4.24",
|
|
111
|
+
* "NumCacheNodes": 2,
|
|
112
|
+
* "PendingModifiedValues": {},
|
|
113
|
+
* "PreferredAvailabilityZone": "Multiple",
|
|
114
|
+
* "PreferredMaintenanceWindow": "wed:09:00-wed:10:00"
|
|
115
|
+
* }
|
|
116
|
+
* }
|
|
117
|
+
* *\/
|
|
118
|
+
* // example id: createcachecluster-1474994727381
|
|
119
|
+
* ```
|
|
120
|
+
*
|
|
35
121
|
*/
|
|
36
122
|
export declare class CreateCacheClusterCommand extends $Command<CreateCacheClusterCommandInput, CreateCacheClusterCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
37
123
|
readonly input: CreateCacheClusterCommandInput;
|
|
@@ -44,6 +44,47 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
|
|
|
44
44
|
* @see {@link CreateCacheParameterGroupCommandOutput} for command's `response` shape.
|
|
45
45
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
46
46
|
*
|
|
47
|
+
* @throws {@link CacheParameterGroupAlreadyExistsFault} (client fault)
|
|
48
|
+
* <p>A cache parameter group with the requested name already exists.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link CacheParameterGroupQuotaExceededFault} (client fault)
|
|
51
|
+
* <p>The request cannot be processed because it would exceed the maximum number of cache security groups.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InvalidCacheParameterGroupStateFault} (client fault)
|
|
54
|
+
* <p>The current state of the cache parameter group does not allow the requested operation to occur.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
57
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
60
|
+
* <p>The value for a parameter is invalid.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
63
|
+
* <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
|
|
64
|
+
*
|
|
65
|
+
*
|
|
66
|
+
* @example CreateCacheParameterGroup
|
|
67
|
+
* ```javascript
|
|
68
|
+
* // Creates the Amazon ElastiCache parameter group custom-redis2-8.
|
|
69
|
+
* const input = {
|
|
70
|
+
* "CacheParameterGroupFamily": "redis2.8",
|
|
71
|
+
* "CacheParameterGroupName": "custom-redis2-8",
|
|
72
|
+
* "Description": "Custom Redis 2.8 parameter group."
|
|
73
|
+
* };
|
|
74
|
+
* const command = new CreateCacheParameterGroupCommand(input);
|
|
75
|
+
* const response = await client.send(command);
|
|
76
|
+
* /* response ==
|
|
77
|
+
* {
|
|
78
|
+
* "CacheParameterGroup": {
|
|
79
|
+
* "CacheParameterGroupFamily": "redis2.8",
|
|
80
|
+
* "CacheParameterGroupName": "custom-redis2-8",
|
|
81
|
+
* "Description": "Custom Redis 2.8 parameter group."
|
|
82
|
+
* }
|
|
83
|
+
* }
|
|
84
|
+
* *\/
|
|
85
|
+
* // example id: createcacheparametergroup-1474997699362
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
47
88
|
*/
|
|
48
89
|
export declare class CreateCacheParameterGroupCommand extends $Command<CreateCacheParameterGroupCommandInput, CreateCacheParameterGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
49
90
|
readonly input: CreateCacheParameterGroupCommandInput;
|
|
@@ -34,6 +34,34 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri
|
|
|
34
34
|
* @see {@link CreateCacheSecurityGroupCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link CacheSecurityGroupAlreadyExistsFault} (client fault)
|
|
38
|
+
* <p>A cache security group with the specified name already exists.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link CacheSecurityGroupQuotaExceededFault} (client fault)
|
|
41
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache security groups.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
44
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
47
|
+
* <p>The value for a parameter is invalid.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
50
|
+
* <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
|
|
51
|
+
*
|
|
52
|
+
*
|
|
53
|
+
* @example CreateCacheSecurityGroup
|
|
54
|
+
* ```javascript
|
|
55
|
+
* // Creates an ElastiCache security group. ElastiCache security groups are only for clusters not running in an AWS VPC.
|
|
56
|
+
* const input = {
|
|
57
|
+
* "CacheSecurityGroupName": "my-cache-sec-grp",
|
|
58
|
+
* "Description": "Example ElastiCache security group."
|
|
59
|
+
* };
|
|
60
|
+
* const command = new CreateCacheSecurityGroupCommand(input);
|
|
61
|
+
* await client.send(command);
|
|
62
|
+
* // example id: createcachesecuritygroup-1483041506604
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
37
65
|
*/
|
|
38
66
|
export declare class CreateCacheSecurityGroupCommand extends $Command<CreateCacheSecurityGroupCommandInput, CreateCacheSecurityGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
39
67
|
readonly input: CreateCacheSecurityGroupCommandInput;
|
|
@@ -30,6 +30,72 @@ export interface CreateCacheSubnetGroupCommandOutput extends CreateCacheSubnetGr
|
|
|
30
30
|
* @see {@link CreateCacheSubnetGroupCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link CacheSubnetGroupAlreadyExistsFault} (client fault)
|
|
34
|
+
* <p>The requested cache subnet group name is already in use by an existing cache subnet group.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link CacheSubnetGroupQuotaExceededFault} (client fault)
|
|
37
|
+
* <p>The request cannot be processed because it would exceed the allowed number of cache subnet groups.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link CacheSubnetQuotaExceededFault} (client fault)
|
|
40
|
+
* <p>The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link InvalidSubnet} (client fault)
|
|
43
|
+
* <p>An invalid subnet identifier was specified.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link SubnetNotAllowedFault} (client fault)
|
|
46
|
+
* <p>At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a
|
|
47
|
+
* user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link TagQuotaPerResourceExceeded} (client fault)
|
|
50
|
+
* <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
|
|
51
|
+
*
|
|
52
|
+
*
|
|
53
|
+
* @example CreateCacheSubnet
|
|
54
|
+
* ```javascript
|
|
55
|
+
* // Creates a new cache subnet group.
|
|
56
|
+
* const input = {
|
|
57
|
+
* "CacheSubnetGroupDescription": "Sample subnet group",
|
|
58
|
+
* "CacheSubnetGroupName": "my-sn-grp2",
|
|
59
|
+
* "SubnetIds": [
|
|
60
|
+
* "subnet-6f28c982",
|
|
61
|
+
* "subnet-bcd382f3",
|
|
62
|
+
* "subnet-845b3e7c0"
|
|
63
|
+
* ]
|
|
64
|
+
* };
|
|
65
|
+
* const command = new CreateCacheSubnetGroupCommand(input);
|
|
66
|
+
* const response = await client.send(command);
|
|
67
|
+
* /* response ==
|
|
68
|
+
* {
|
|
69
|
+
* "CacheSubnetGroup": {
|
|
70
|
+
* "CacheSubnetGroupDescription": "My subnet group.",
|
|
71
|
+
* "CacheSubnetGroupName": "my-sn-grp",
|
|
72
|
+
* "Subnets": [
|
|
73
|
+
* {
|
|
74
|
+
* "SubnetAvailabilityZone": {
|
|
75
|
+
* "Name": "us-east-1a"
|
|
76
|
+
* },
|
|
77
|
+
* "SubnetIdentifier": "subnet-6f28c982"
|
|
78
|
+
* },
|
|
79
|
+
* {
|
|
80
|
+
* "SubnetAvailabilityZone": {
|
|
81
|
+
* "Name": "us-east-1c"
|
|
82
|
+
* },
|
|
83
|
+
* "SubnetIdentifier": "subnet-bcd382f3"
|
|
84
|
+
* },
|
|
85
|
+
* {
|
|
86
|
+
* "SubnetAvailabilityZone": {
|
|
87
|
+
* "Name": "us-east-1b"
|
|
88
|
+
* },
|
|
89
|
+
* "SubnetIdentifier": "subnet-845b3e7c0"
|
|
90
|
+
* }
|
|
91
|
+
* ],
|
|
92
|
+
* "VpcId": "vpc-91280df6"
|
|
93
|
+
* }
|
|
94
|
+
* }
|
|
95
|
+
* *\/
|
|
96
|
+
* // example id: createcachesubnet-1483042274558
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
33
99
|
*/
|
|
34
100
|
export declare class CreateCacheSubnetGroupCommand extends $Command<CreateCacheSubnetGroupCommandInput, CreateCacheSubnetGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
35
101
|
readonly input: CreateCacheSubnetGroupCommandInput;
|
|
@@ -43,6 +43,22 @@ export interface CreateGlobalReplicationGroupCommandOutput extends CreateGlobalR
|
|
|
43
43
|
* @see {@link CreateGlobalReplicationGroupCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @throws {@link GlobalReplicationGroupAlreadyExistsFault} (client fault)
|
|
47
|
+
* <p>The Global datastore name already exists.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
50
|
+
* <p>The value for a parameter is invalid.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link InvalidReplicationGroupStateFault} (client fault)
|
|
53
|
+
* <p>The requested replication group is not in the <code>available</code> state.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
56
|
+
* <p>The specified replication group does not exist.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
|
|
59
|
+
* <p>The specified service linked role (SLR) was not found.</p>
|
|
60
|
+
*
|
|
61
|
+
*
|
|
46
62
|
*/
|
|
47
63
|
export declare class CreateGlobalReplicationGroupCommand extends $Command<CreateGlobalReplicationGroupCommandInput, CreateGlobalReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
48
64
|
readonly input: CreateGlobalReplicationGroupCommandInput;
|