@aws-sdk/client-elasticache 3.287.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.
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +35 -0
- package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +13 -0
- package/dist-types/commands/CopySnapshotCommand.d.ts +45 -0
- package/dist-types/commands/CreateCacheClusterCommand.d.ts +42 -0
- package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +22 -0
- package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +12 -0
- package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +46 -0
- package/dist-types/commands/CreateReplicationGroupCommand.d.ts +93 -0
- package/dist-types/commands/CreateSnapshotCommand.d.ts +89 -0
- package/dist-types/commands/DeleteCacheClusterCommand.d.ts +40 -0
- package/dist-types/commands/DeleteCacheParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +11 -0
- package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +11 -0
- package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +23 -0
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +43 -0
- package/dist-types/commands/DescribeCacheClustersCommand.d.ts +42 -0
- package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts +99 -0
- package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts +22 -0
- package/dist-types/commands/DescribeCacheParametersCommand.d.ts +403 -0
- package/dist-types/commands/DescribeCacheSecurityGroupsCommand.d.ts +11 -0
- package/dist-types/commands/DescribeCacheSubnetGroupsCommand.d.ts +49 -0
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +614 -0
- package/dist-types/commands/DescribeEventsCommand.d.ts +49 -0
- package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +63 -0
- package/dist-types/commands/DescribeReservedCacheNodesCommand.d.ts +11 -0
- package/dist-types/commands/DescribeReservedCacheNodesOfferingsCommand.d.ts +273 -0
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +46 -0
- package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +25 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +25 -0
- package/dist-types/commands/ModifyCacheClusterCommand.d.ts +40 -0
- package/dist-types/commands/ModifyCacheParameterGroupCommand.d.ts +26 -0
- package/dist-types/commands/ModifyCacheSubnetGroupCommand.d.ts +55 -0
- package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +74 -0
- package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts +11 -0
- package/dist-types/commands/RebootCacheClusterCommand.d.ts +44 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +42 -0
- package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts +17 -0
- package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts +13 -0
- package/package.json +30 -30
|
@@ -40,6 +40,41 @@ 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
|
+
* @example AddTagsToResource
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "ResourceName": "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster",
|
|
48
|
+
* "Tags": [
|
|
49
|
+
* {
|
|
50
|
+
* "Key": "APIVersion",
|
|
51
|
+
* "Value": "20150202"
|
|
52
|
+
* },
|
|
53
|
+
* {
|
|
54
|
+
* "Key": "Service",
|
|
55
|
+
* "Value": "ElastiCache"
|
|
56
|
+
* }
|
|
57
|
+
* ]
|
|
58
|
+
* };
|
|
59
|
+
* const command = new AddTagsToResourceCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* /* response ==
|
|
62
|
+
* {
|
|
63
|
+
* "TagList": [
|
|
64
|
+
* {
|
|
65
|
+
* "Key": "APIVersion",
|
|
66
|
+
* "Value": "20150202"
|
|
67
|
+
* },
|
|
68
|
+
* {
|
|
69
|
+
* "Key": "Service",
|
|
70
|
+
* "Value": "ElastiCache"
|
|
71
|
+
* }
|
|
72
|
+
* ]
|
|
73
|
+
* }
|
|
74
|
+
* *\/
|
|
75
|
+
* // example id: addtagstoresource-1482430264385
|
|
76
|
+
* ```
|
|
77
|
+
*
|
|
43
78
|
*/
|
|
44
79
|
export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
45
80
|
readonly input: AddTagsToResourceCommandInput;
|
|
@@ -35,6 +35,19 @@ 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
|
+
* @example AuthorizeCacheCacheSecurityGroupIngress
|
|
39
|
+
* ```javascript
|
|
40
|
+
* // 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.
|
|
41
|
+
* const input = {
|
|
42
|
+
* "CacheSecurityGroupName": "my-sec-grp",
|
|
43
|
+
* "EC2SecurityGroupName": "my-ec2-sec-grp",
|
|
44
|
+
* "EC2SecurityGroupOwnerId": "1234567890"
|
|
45
|
+
* };
|
|
46
|
+
* const command = new AuthorizeCacheSecurityGroupIngressCommand(input);
|
|
47
|
+
* await client.send(command);
|
|
48
|
+
* // example id: authorizecachecachesecuritygroupingress-1483046446206
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
38
51
|
*/
|
|
39
52
|
export declare class AuthorizeCacheSecurityGroupIngressCommand extends $Command<AuthorizeCacheSecurityGroupIngressCommandInput, AuthorizeCacheSecurityGroupIngressCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
40
53
|
readonly input: AuthorizeCacheSecurityGroupIngressCommandInput;
|
|
@@ -119,6 +119,51 @@ 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
|
+
* @example CopySnapshot
|
|
123
|
+
* ```javascript
|
|
124
|
+
* // Copies a snapshot to a specified name.
|
|
125
|
+
* const input = {
|
|
126
|
+
* "SourceSnapshotName": "my-snapshot",
|
|
127
|
+
* "TargetBucket": "",
|
|
128
|
+
* "TargetSnapshotName": "my-snapshot-copy"
|
|
129
|
+
* };
|
|
130
|
+
* const command = new CopySnapshotCommand(input);
|
|
131
|
+
* const response = await client.send(command);
|
|
132
|
+
* /* response ==
|
|
133
|
+
* {
|
|
134
|
+
* "Snapshot": {
|
|
135
|
+
* "AutoMinorVersionUpgrade": true,
|
|
136
|
+
* "CacheClusterCreateTime": "2016-12-21T22:24:04.955Z",
|
|
137
|
+
* "CacheClusterId": "my-redis4",
|
|
138
|
+
* "CacheNodeType": "cache.m3.large",
|
|
139
|
+
* "CacheParameterGroupName": "default.redis3.2",
|
|
140
|
+
* "CacheSubnetGroupName": "default",
|
|
141
|
+
* "Engine": "redis",
|
|
142
|
+
* "EngineVersion": "3.2.4",
|
|
143
|
+
* "NodeSnapshots": [
|
|
144
|
+
* {
|
|
145
|
+
* "CacheNodeCreateTime": "2016-12-21T22:24:04.955Z",
|
|
146
|
+
* "CacheNodeId": "0001",
|
|
147
|
+
* "CacheSize": "3 MB",
|
|
148
|
+
* "SnapshotCreateTime": "2016-12-28T07:00:52Z"
|
|
149
|
+
* }
|
|
150
|
+
* ],
|
|
151
|
+
* "NumCacheNodes": 1,
|
|
152
|
+
* "Port": 6379,
|
|
153
|
+
* "PreferredAvailabilityZone": "us-east-1c",
|
|
154
|
+
* "PreferredMaintenanceWindow": "tue:09:30-tue:10:30",
|
|
155
|
+
* "SnapshotName": "my-snapshot-copy",
|
|
156
|
+
* "SnapshotRetentionLimit": 7,
|
|
157
|
+
* "SnapshotSource": "manual",
|
|
158
|
+
* "SnapshotStatus": "creating",
|
|
159
|
+
* "SnapshotWindow": "07:00-08:00",
|
|
160
|
+
* "VpcId": "vpc-3820329f3"
|
|
161
|
+
* }
|
|
162
|
+
* }
|
|
163
|
+
* *\/
|
|
164
|
+
* // example id: copysnapshot-1482961393820
|
|
165
|
+
* ```
|
|
166
|
+
*
|
|
122
167
|
*/
|
|
123
168
|
export declare class CopySnapshotCommand extends $Command<CopySnapshotCommandInput, CopySnapshotCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
124
169
|
readonly input: CopySnapshotCommandInput;
|
|
@@ -32,6 +32,48 @@ 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
|
+
* @example CreateCacheCluster
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // Creates a Memcached cluster with 2 nodes.
|
|
38
|
+
* const input = {
|
|
39
|
+
* "AZMode": "cross-az",
|
|
40
|
+
* "CacheClusterId": "my-memcached-cluster",
|
|
41
|
+
* "CacheNodeType": "cache.r3.large",
|
|
42
|
+
* "CacheSubnetGroupName": "default",
|
|
43
|
+
* "Engine": "memcached",
|
|
44
|
+
* "EngineVersion": "1.4.24",
|
|
45
|
+
* "NumCacheNodes": 2,
|
|
46
|
+
* "Port": 11211
|
|
47
|
+
* };
|
|
48
|
+
* const command = new CreateCacheClusterCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* /* response ==
|
|
51
|
+
* {
|
|
52
|
+
* "CacheCluster": {
|
|
53
|
+
* "AutoMinorVersionUpgrade": true,
|
|
54
|
+
* "CacheClusterId": "my-memcached-cluster",
|
|
55
|
+
* "CacheClusterStatus": "creating",
|
|
56
|
+
* "CacheNodeType": "cache.r3.large",
|
|
57
|
+
* "CacheParameterGroup": {
|
|
58
|
+
* "CacheNodeIdsToReboot": [],
|
|
59
|
+
* "CacheParameterGroupName": "default.memcached1.4",
|
|
60
|
+
* "ParameterApplyStatus": "in-sync"
|
|
61
|
+
* },
|
|
62
|
+
* "CacheSecurityGroups": [],
|
|
63
|
+
* "CacheSubnetGroupName": "default",
|
|
64
|
+
* "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
|
|
65
|
+
* "Engine": "memcached",
|
|
66
|
+
* "EngineVersion": "1.4.24",
|
|
67
|
+
* "NumCacheNodes": 2,
|
|
68
|
+
* "PendingModifiedValues": {},
|
|
69
|
+
* "PreferredAvailabilityZone": "Multiple",
|
|
70
|
+
* "PreferredMaintenanceWindow": "wed:09:00-wed:10:00"
|
|
71
|
+
* }
|
|
72
|
+
* }
|
|
73
|
+
* *\/
|
|
74
|
+
* // example id: createcachecluster-1474994727381
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
35
77
|
*/
|
|
36
78
|
export declare class CreateCacheClusterCommand extends $Command<CreateCacheClusterCommandInput, CreateCacheClusterCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
37
79
|
readonly input: CreateCacheClusterCommandInput;
|
|
@@ -44,6 +44,28 @@ 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
|
+
* @example CreateCacheParameterGroup
|
|
48
|
+
* ```javascript
|
|
49
|
+
* // Creates the Amazon ElastiCache parameter group custom-redis2-8.
|
|
50
|
+
* const input = {
|
|
51
|
+
* "CacheParameterGroupFamily": "redis2.8",
|
|
52
|
+
* "CacheParameterGroupName": "custom-redis2-8",
|
|
53
|
+
* "Description": "Custom Redis 2.8 parameter group."
|
|
54
|
+
* };
|
|
55
|
+
* const command = new CreateCacheParameterGroupCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* /* response ==
|
|
58
|
+
* {
|
|
59
|
+
* "CacheParameterGroup": {
|
|
60
|
+
* "CacheParameterGroupFamily": "redis2.8",
|
|
61
|
+
* "CacheParameterGroupName": "custom-redis2-8",
|
|
62
|
+
* "Description": "Custom Redis 2.8 parameter group."
|
|
63
|
+
* }
|
|
64
|
+
* }
|
|
65
|
+
* *\/
|
|
66
|
+
* // example id: createcacheparametergroup-1474997699362
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
47
69
|
*/
|
|
48
70
|
export declare class CreateCacheParameterGroupCommand extends $Command<CreateCacheParameterGroupCommandInput, CreateCacheParameterGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
49
71
|
readonly input: CreateCacheParameterGroupCommandInput;
|
|
@@ -34,6 +34,18 @@ 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
|
+
* @example CreateCacheSecurityGroup
|
|
38
|
+
* ```javascript
|
|
39
|
+
* // Creates an ElastiCache security group. ElastiCache security groups are only for clusters not running in an AWS VPC.
|
|
40
|
+
* const input = {
|
|
41
|
+
* "CacheSecurityGroupName": "my-cache-sec-grp",
|
|
42
|
+
* "Description": "Example ElastiCache security group."
|
|
43
|
+
* };
|
|
44
|
+
* const command = new CreateCacheSecurityGroupCommand(input);
|
|
45
|
+
* await client.send(command);
|
|
46
|
+
* // example id: createcachesecuritygroup-1483041506604
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
37
49
|
*/
|
|
38
50
|
export declare class CreateCacheSecurityGroupCommand extends $Command<CreateCacheSecurityGroupCommandInput, CreateCacheSecurityGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
39
51
|
readonly input: CreateCacheSecurityGroupCommandInput;
|
|
@@ -30,6 +30,52 @@ 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
|
+
* @example CreateCacheSubnet
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // Creates a new cache subnet group.
|
|
36
|
+
* const input = {
|
|
37
|
+
* "CacheSubnetGroupDescription": "Sample subnet group",
|
|
38
|
+
* "CacheSubnetGroupName": "my-sn-grp2",
|
|
39
|
+
* "SubnetIds": [
|
|
40
|
+
* "subnet-6f28c982",
|
|
41
|
+
* "subnet-bcd382f3",
|
|
42
|
+
* "subnet-845b3e7c0"
|
|
43
|
+
* ]
|
|
44
|
+
* };
|
|
45
|
+
* const command = new CreateCacheSubnetGroupCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* /* response ==
|
|
48
|
+
* {
|
|
49
|
+
* "CacheSubnetGroup": {
|
|
50
|
+
* "CacheSubnetGroupDescription": "My subnet group.",
|
|
51
|
+
* "CacheSubnetGroupName": "my-sn-grp",
|
|
52
|
+
* "Subnets": [
|
|
53
|
+
* {
|
|
54
|
+
* "SubnetAvailabilityZone": {
|
|
55
|
+
* "Name": "us-east-1a"
|
|
56
|
+
* },
|
|
57
|
+
* "SubnetIdentifier": "subnet-6f28c982"
|
|
58
|
+
* },
|
|
59
|
+
* {
|
|
60
|
+
* "SubnetAvailabilityZone": {
|
|
61
|
+
* "Name": "us-east-1c"
|
|
62
|
+
* },
|
|
63
|
+
* "SubnetIdentifier": "subnet-bcd382f3"
|
|
64
|
+
* },
|
|
65
|
+
* {
|
|
66
|
+
* "SubnetAvailabilityZone": {
|
|
67
|
+
* "Name": "us-east-1b"
|
|
68
|
+
* },
|
|
69
|
+
* "SubnetIdentifier": "subnet-845b3e7c0"
|
|
70
|
+
* }
|
|
71
|
+
* ],
|
|
72
|
+
* "VpcId": "vpc-91280df6"
|
|
73
|
+
* }
|
|
74
|
+
* }
|
|
75
|
+
* *\/
|
|
76
|
+
* // example id: createcachesubnet-1483042274558
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
33
79
|
*/
|
|
34
80
|
export declare class CreateCacheSubnetGroupCommand extends $Command<CreateCacheSubnetGroupCommandInput, CreateCacheSubnetGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
35
81
|
readonly input: CreateCacheSubnetGroupCommandInput;
|
|
@@ -53,6 +53,99 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
|
|
|
53
53
|
* @see {@link CreateReplicationGroupCommandOutput} for command's `response` shape.
|
|
54
54
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
55
55
|
*
|
|
56
|
+
* @example CreateCacheReplicationGroup
|
|
57
|
+
* ```javascript
|
|
58
|
+
* // Creates a Redis replication group with 3 nodes.
|
|
59
|
+
* const input = {
|
|
60
|
+
* "AutomaticFailoverEnabled": true,
|
|
61
|
+
* "CacheNodeType": "cache.m3.medium",
|
|
62
|
+
* "Engine": "redis",
|
|
63
|
+
* "EngineVersion": "2.8.24",
|
|
64
|
+
* "NumCacheClusters": 3,
|
|
65
|
+
* "ReplicationGroupDescription": "A Redis replication group.",
|
|
66
|
+
* "ReplicationGroupId": "my-redis-rg",
|
|
67
|
+
* "SnapshotRetentionLimit": 30
|
|
68
|
+
* };
|
|
69
|
+
* const command = new CreateReplicationGroupCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* /* response ==
|
|
72
|
+
* {
|
|
73
|
+
* "ReplicationGroup": {
|
|
74
|
+
* "AutomaticFailover": "enabling",
|
|
75
|
+
* "Description": "A Redis replication group.",
|
|
76
|
+
* "MemberClusters": [
|
|
77
|
+
* "my-redis-rg-001",
|
|
78
|
+
* "my-redis-rg-002",
|
|
79
|
+
* "my-redis-rg-003"
|
|
80
|
+
* ],
|
|
81
|
+
* "PendingModifiedValues": {},
|
|
82
|
+
* "ReplicationGroupId": "my-redis-rg",
|
|
83
|
+
* "SnapshottingClusterId": "my-redis-rg-002",
|
|
84
|
+
* "Status": "creating"
|
|
85
|
+
* }
|
|
86
|
+
* }
|
|
87
|
+
* *\/
|
|
88
|
+
* // example id: createcachereplicationgroup-1474998730655
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
91
|
+
* @example CreateReplicationGroup
|
|
92
|
+
* ```javascript
|
|
93
|
+
* // Creates a Redis (cluster mode enabled) replication group with two shards. One shard has one read replica node and the other shard has two read replicas.
|
|
94
|
+
* const input = {
|
|
95
|
+
* "AutoMinorVersionUpgrade": true,
|
|
96
|
+
* "CacheNodeType": "cache.m3.medium",
|
|
97
|
+
* "CacheParameterGroupName": "default.redis3.2.cluster.on",
|
|
98
|
+
* "Engine": "redis",
|
|
99
|
+
* "EngineVersion": "3.2.4",
|
|
100
|
+
* "NodeGroupConfiguration": [
|
|
101
|
+
* {
|
|
102
|
+
* "PrimaryAvailabilityZone": "us-east-1c",
|
|
103
|
+
* "ReplicaAvailabilityZones": [
|
|
104
|
+
* "us-east-1b"
|
|
105
|
+
* ],
|
|
106
|
+
* "ReplicaCount": 1,
|
|
107
|
+
* "Slots": "0-8999"
|
|
108
|
+
* },
|
|
109
|
+
* {
|
|
110
|
+
* "PrimaryAvailabilityZone": "us-east-1a",
|
|
111
|
+
* "ReplicaAvailabilityZones": [
|
|
112
|
+
* "us-east-1a",
|
|
113
|
+
* "us-east-1c"
|
|
114
|
+
* ],
|
|
115
|
+
* "ReplicaCount": 2,
|
|
116
|
+
* "Slots": "9000-16383"
|
|
117
|
+
* }
|
|
118
|
+
* ],
|
|
119
|
+
* "NumNodeGroups": 2,
|
|
120
|
+
* "ReplicationGroupDescription": "A multi-sharded replication group",
|
|
121
|
+
* "ReplicationGroupId": "clustered-redis-rg",
|
|
122
|
+
* "SnapshotRetentionLimit": 8
|
|
123
|
+
* };
|
|
124
|
+
* const command = new CreateReplicationGroupCommand(input);
|
|
125
|
+
* const response = await client.send(command);
|
|
126
|
+
* /* response ==
|
|
127
|
+
* {
|
|
128
|
+
* "ReplicationGroup": {
|
|
129
|
+
* "AutomaticFailover": "enabled",
|
|
130
|
+
* "Description": "Sharded replication group",
|
|
131
|
+
* "MemberClusters": [
|
|
132
|
+
* "rc-rg3-0001-001",
|
|
133
|
+
* "rc-rg3-0001-002",
|
|
134
|
+
* "rc-rg3-0002-001",
|
|
135
|
+
* "rc-rg3-0002-002",
|
|
136
|
+
* "rc-rg3-0002-003"
|
|
137
|
+
* ],
|
|
138
|
+
* "PendingModifiedValues": {},
|
|
139
|
+
* "ReplicationGroupId": "clustered-redis-rg",
|
|
140
|
+
* "SnapshotRetentionLimit": 8,
|
|
141
|
+
* "SnapshotWindow": "05:30-06:30",
|
|
142
|
+
* "Status": "creating"
|
|
143
|
+
* }
|
|
144
|
+
* }
|
|
145
|
+
* *\/
|
|
146
|
+
* // example id: createreplicationgroup-1483657035585
|
|
147
|
+
* ```
|
|
148
|
+
*
|
|
56
149
|
*/
|
|
57
150
|
export declare class CreateReplicationGroupCommand extends $Command<CreateReplicationGroupCommandInput, CreateReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
58
151
|
readonly input: CreateReplicationGroupCommandInput;
|
|
@@ -33,6 +33,95 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
|
|
|
33
33
|
* @see {@link CreateSnapshotCommandOutput} for command's `response` shape.
|
|
34
34
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
35
35
|
*
|
|
36
|
+
* @example CreateSnapshot - NonClustered Redis, no read-replicas
|
|
37
|
+
* ```javascript
|
|
38
|
+
* // Creates a snapshot of a non-clustered Redis cluster that has only one node.
|
|
39
|
+
* const input = {
|
|
40
|
+
* "CacheClusterId": "onenoderedis",
|
|
41
|
+
* "SnapshotName": "snapshot-1"
|
|
42
|
+
* };
|
|
43
|
+
* const command = new CreateSnapshotCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* /* response ==
|
|
46
|
+
* {
|
|
47
|
+
* "Snapshot": {
|
|
48
|
+
* "AutoMinorVersionUpgrade": true,
|
|
49
|
+
* "CacheClusterCreateTime": "2017-02-03T15:43:36.278Z",
|
|
50
|
+
* "CacheClusterId": "onenoderedis",
|
|
51
|
+
* "CacheNodeType": "cache.m3.medium",
|
|
52
|
+
* "CacheParameterGroupName": "default.redis3.2",
|
|
53
|
+
* "CacheSubnetGroupName": "default",
|
|
54
|
+
* "Engine": "redis",
|
|
55
|
+
* "EngineVersion": "3.2.4",
|
|
56
|
+
* "NodeSnapshots": [
|
|
57
|
+
* {
|
|
58
|
+
* "CacheNodeCreateTime": "2017-02-03T15:43:36.278Z",
|
|
59
|
+
* "CacheNodeId": "0001",
|
|
60
|
+
* "CacheSize": ""
|
|
61
|
+
* }
|
|
62
|
+
* ],
|
|
63
|
+
* "NumCacheNodes": 1,
|
|
64
|
+
* "Port": 6379,
|
|
65
|
+
* "PreferredAvailabilityZone": "us-west-2c",
|
|
66
|
+
* "PreferredMaintenanceWindow": "sat:08:00-sat:09:00",
|
|
67
|
+
* "SnapshotName": "snapshot-1",
|
|
68
|
+
* "SnapshotRetentionLimit": 1,
|
|
69
|
+
* "SnapshotSource": "manual",
|
|
70
|
+
* "SnapshotStatus": "creating",
|
|
71
|
+
* "SnapshotWindow": "00:00-01:00",
|
|
72
|
+
* "VpcId": "vpc-73c3cd17"
|
|
73
|
+
* }
|
|
74
|
+
* }
|
|
75
|
+
* *\/
|
|
76
|
+
* // example id: createsnapshot-1474999681024
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
79
|
+
* @example CreateSnapshot-clustered Redis
|
|
80
|
+
* ```javascript
|
|
81
|
+
* // Creates a snapshot of a clustered Redis cluster that has 2 shards, each with a primary and 4 read-replicas.
|
|
82
|
+
* const input = {
|
|
83
|
+
* "ReplicationGroupId": "clusteredredis",
|
|
84
|
+
* "SnapshotName": "snapshot-2x5"
|
|
85
|
+
* };
|
|
86
|
+
* const command = new CreateSnapshotCommand(input);
|
|
87
|
+
* const response = await client.send(command);
|
|
88
|
+
* /* response ==
|
|
89
|
+
* {
|
|
90
|
+
* "Snapshot": {
|
|
91
|
+
* "AutoMinorVersionUpgrade": true,
|
|
92
|
+
* "AutomaticFailover": "enabled",
|
|
93
|
+
* "CacheNodeType": "cache.m3.medium",
|
|
94
|
+
* "CacheParameterGroupName": "default.redis3.2.cluster.on",
|
|
95
|
+
* "CacheSubnetGroupName": "default",
|
|
96
|
+
* "Engine": "redis",
|
|
97
|
+
* "EngineVersion": "3.2.4",
|
|
98
|
+
* "NodeSnapshots": [
|
|
99
|
+
* {
|
|
100
|
+
* "CacheSize": "",
|
|
101
|
+
* "NodeGroupId": "0001"
|
|
102
|
+
* },
|
|
103
|
+
* {
|
|
104
|
+
* "CacheSize": "",
|
|
105
|
+
* "NodeGroupId": "0002"
|
|
106
|
+
* }
|
|
107
|
+
* ],
|
|
108
|
+
* "NumNodeGroups": 2,
|
|
109
|
+
* "Port": 6379,
|
|
110
|
+
* "PreferredMaintenanceWindow": "mon:09:30-mon:10:30",
|
|
111
|
+
* "ReplicationGroupDescription": "Redis cluster with 2 shards.",
|
|
112
|
+
* "ReplicationGroupId": "clusteredredis",
|
|
113
|
+
* "SnapshotName": "snapshot-2x5",
|
|
114
|
+
* "SnapshotRetentionLimit": 1,
|
|
115
|
+
* "SnapshotSource": "manual",
|
|
116
|
+
* "SnapshotStatus": "creating",
|
|
117
|
+
* "SnapshotWindow": "12:00-13:00",
|
|
118
|
+
* "VpcId": "vpc-73c3cd17"
|
|
119
|
+
* }
|
|
120
|
+
* }
|
|
121
|
+
* *\/
|
|
122
|
+
* // example id: createsnapshot-clustered-redis-1486144841758
|
|
123
|
+
* ```
|
|
124
|
+
*
|
|
36
125
|
*/
|
|
37
126
|
export declare class CreateSnapshotCommand extends $Command<CreateSnapshotCommandInput, CreateSnapshotCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
38
127
|
readonly input: CreateSnapshotCommandInput;
|
|
@@ -57,6 +57,46 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
|
|
|
57
57
|
* @see {@link DeleteCacheClusterCommandOutput} for command's `response` shape.
|
|
58
58
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
59
59
|
*
|
|
60
|
+
* @example DeleteCacheCluster
|
|
61
|
+
* ```javascript
|
|
62
|
+
* // Deletes an Amazon ElastiCache cluster.
|
|
63
|
+
* const input = {
|
|
64
|
+
* "CacheClusterId": "my-memcached"
|
|
65
|
+
* };
|
|
66
|
+
* const command = new DeleteCacheClusterCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* /* response ==
|
|
69
|
+
* {
|
|
70
|
+
* "CacheCluster": {
|
|
71
|
+
* "AutoMinorVersionUpgrade": true,
|
|
72
|
+
* "CacheClusterCreateTime": "2016-12-22T16:05:17.314Z",
|
|
73
|
+
* "CacheClusterId": "my-memcached",
|
|
74
|
+
* "CacheClusterStatus": "deleting",
|
|
75
|
+
* "CacheNodeType": "cache.r3.large",
|
|
76
|
+
* "CacheParameterGroup": {
|
|
77
|
+
* "CacheNodeIdsToReboot": [],
|
|
78
|
+
* "CacheParameterGroupName": "default.memcached1.4",
|
|
79
|
+
* "ParameterApplyStatus": "in-sync"
|
|
80
|
+
* },
|
|
81
|
+
* "CacheSecurityGroups": [],
|
|
82
|
+
* "CacheSubnetGroupName": "default",
|
|
83
|
+
* "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
|
|
84
|
+
* "ConfigurationEndpoint": {
|
|
85
|
+
* "Address": "my-memcached2.ameaqx.cfg.use1.cache.amazonaws.com",
|
|
86
|
+
* "Port": 11211
|
|
87
|
+
* },
|
|
88
|
+
* "Engine": "memcached",
|
|
89
|
+
* "EngineVersion": "1.4.24",
|
|
90
|
+
* "NumCacheNodes": 2,
|
|
91
|
+
* "PendingModifiedValues": {},
|
|
92
|
+
* "PreferredAvailabilityZone": "Multiple",
|
|
93
|
+
* "PreferredMaintenanceWindow": "tue:07:30-tue:08:30"
|
|
94
|
+
* }
|
|
95
|
+
* }
|
|
96
|
+
* *\/
|
|
97
|
+
* // example id: deletecachecluster-1475010605291
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
60
100
|
*/
|
|
61
101
|
export declare class DeleteCacheClusterCommand extends $Command<DeleteCacheClusterCommandInput, DeleteCacheClusterCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
62
102
|
readonly input: DeleteCacheClusterCommandInput;
|
|
@@ -31,6 +31,17 @@ export interface DeleteCacheParameterGroupCommandOutput extends __MetadataBearer
|
|
|
31
31
|
* @see {@link DeleteCacheParameterGroupCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example DeleteCacheParameterGroup
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // Deletes the Amazon ElastiCache parameter group custom-mem1-4.
|
|
37
|
+
* const input = {
|
|
38
|
+
* "CacheParameterGroupName": "custom-mem1-4"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteCacheParameterGroupCommand(input);
|
|
41
|
+
* await client.send(command);
|
|
42
|
+
* // example id: deletecacheparametergroup-1475010933957
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
34
45
|
*/
|
|
35
46
|
export declare class DeleteCacheParameterGroupCommand extends $Command<DeleteCacheParameterGroupCommandInput, DeleteCacheParameterGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
36
47
|
readonly input: DeleteCacheParameterGroupCommandInput;
|
|
@@ -32,6 +32,17 @@ export interface DeleteCacheSecurityGroupCommandOutput extends __MetadataBearer
|
|
|
32
32
|
* @see {@link DeleteCacheSecurityGroupCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example DeleteCacheSecurityGroup
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // Deletes a cache security group.
|
|
38
|
+
* const input = {
|
|
39
|
+
* "CacheSecurityGroupName": "my-sec-group"
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteCacheSecurityGroupCommand(input);
|
|
42
|
+
* await client.send(command);
|
|
43
|
+
* // example id: deletecachesecuritygroup-1483046967507
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
35
46
|
*/
|
|
36
47
|
export declare class DeleteCacheSecurityGroupCommand extends $Command<DeleteCacheSecurityGroupCommandInput, DeleteCacheSecurityGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
37
48
|
readonly input: DeleteCacheSecurityGroupCommandInput;
|
|
@@ -32,6 +32,17 @@ export interface DeleteCacheSubnetGroupCommandOutput extends __MetadataBearer {
|
|
|
32
32
|
* @see {@link DeleteCacheSubnetGroupCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example DeleteCacheSubnetGroup
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // Deletes the Amazon ElastiCache subnet group my-subnet-group.
|
|
38
|
+
* const input = {
|
|
39
|
+
* "CacheSubnetGroupName": "my-subnet-group"
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteCacheSubnetGroupCommand(input);
|
|
42
|
+
* await client.send(command);
|
|
43
|
+
* // example id: deletecachesubnetgroup-1475011431325
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
35
46
|
*/
|
|
36
47
|
export declare class DeleteCacheSubnetGroupCommand extends $Command<DeleteCacheSubnetGroupCommandInput, DeleteCacheSubnetGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
37
48
|
readonly input: DeleteCacheSubnetGroupCommandInput;
|
|
@@ -37,6 +37,29 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
|
|
|
37
37
|
* @see {@link DeleteReplicationGroupCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @example DeleteReplicationGroup
|
|
41
|
+
* ```javascript
|
|
42
|
+
* // Deletes the Amazon ElastiCache replication group my-redis-rg.
|
|
43
|
+
* const input = {
|
|
44
|
+
* "ReplicationGroupId": "my-redis-rg",
|
|
45
|
+
* "RetainPrimaryCluster": false
|
|
46
|
+
* };
|
|
47
|
+
* const command = new DeleteReplicationGroupCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* /* response ==
|
|
50
|
+
* {
|
|
51
|
+
* "ReplicationGroup": {
|
|
52
|
+
* "AutomaticFailover": "disabled",
|
|
53
|
+
* "Description": "simple redis cluster",
|
|
54
|
+
* "PendingModifiedValues": {},
|
|
55
|
+
* "ReplicationGroupId": "my-redis-rg",
|
|
56
|
+
* "Status": "deleting"
|
|
57
|
+
* }
|
|
58
|
+
* }
|
|
59
|
+
* *\/
|
|
60
|
+
* // example id: deletereplicationgroup-1475011641804
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
40
63
|
*/
|
|
41
64
|
export declare class DeleteReplicationGroupCommand extends $Command<DeleteReplicationGroupCommandInput, DeleteReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
42
65
|
readonly input: DeleteReplicationGroupCommandInput;
|
|
@@ -34,6 +34,49 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResult, __Met
|
|
|
34
34
|
* @see {@link DeleteSnapshotCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @example DeleteSnapshot
|
|
38
|
+
* ```javascript
|
|
39
|
+
* // Deletes the Redis snapshot snapshot-20160822.
|
|
40
|
+
* const input = {
|
|
41
|
+
* "SnapshotName": "snapshot-20161212"
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeleteSnapshotCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* /* response ==
|
|
46
|
+
* {
|
|
47
|
+
* "Snapshot": {
|
|
48
|
+
* "AutoMinorVersionUpgrade": true,
|
|
49
|
+
* "CacheClusterCreateTime": "2016-12-21T22:27:12.543Z",
|
|
50
|
+
* "CacheClusterId": "my-redis5",
|
|
51
|
+
* "CacheNodeType": "cache.m3.large",
|
|
52
|
+
* "CacheParameterGroupName": "default.redis3.2",
|
|
53
|
+
* "CacheSubnetGroupName": "default",
|
|
54
|
+
* "Engine": "redis",
|
|
55
|
+
* "EngineVersion": "3.2.4",
|
|
56
|
+
* "NodeSnapshots": [
|
|
57
|
+
* {
|
|
58
|
+
* "CacheNodeCreateTime": "2016-12-21T22:27:12.543Z",
|
|
59
|
+
* "CacheNodeId": "0001",
|
|
60
|
+
* "CacheSize": "3 MB",
|
|
61
|
+
* "SnapshotCreateTime": "2016-12-21T22:30:26Z"
|
|
62
|
+
* }
|
|
63
|
+
* ],
|
|
64
|
+
* "NumCacheNodes": 1,
|
|
65
|
+
* "Port": 6379,
|
|
66
|
+
* "PreferredAvailabilityZone": "us-east-1c",
|
|
67
|
+
* "PreferredMaintenanceWindow": "fri:05:30-fri:06:30",
|
|
68
|
+
* "SnapshotName": "snapshot-20161212",
|
|
69
|
+
* "SnapshotRetentionLimit": 7,
|
|
70
|
+
* "SnapshotSource": "manual",
|
|
71
|
+
* "SnapshotStatus": "deleting",
|
|
72
|
+
* "SnapshotWindow": "10:00-11:00",
|
|
73
|
+
* "VpcId": "vpc-91280df6"
|
|
74
|
+
* }
|
|
75
|
+
* }
|
|
76
|
+
* *\/
|
|
77
|
+
* // example id: deletesnapshot-1475011945779
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
37
80
|
*/
|
|
38
81
|
export declare class DeleteSnapshotCommand extends $Command<DeleteSnapshotCommandInput, DeleteSnapshotCommandOutput, ElastiCacheClientResolvedConfig> {
|
|
39
82
|
readonly input: DeleteSnapshotCommandInput;
|