UNPKG

176 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class ElastiCache extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: ElastiCache.Types.ClientConfiguration)
14 config: Config & ElastiCache.Types.ClientConfiguration;
15 /**
16 * Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs. When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
17 */
18 addTagsToResource(params: ElastiCache.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
19 /**
20 * Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs. When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
21 */
22 addTagsToResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
23 /**
24 * Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
25 */
26 authorizeCacheSecurityGroupIngress(params: ElastiCache.Types.AuthorizeCacheSecurityGroupIngressMessage, callback?: (err: AWSError, data: ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult, AWSError>;
27 /**
28 * Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
29 */
30 authorizeCacheSecurityGroupIngress(callback?: (err: AWSError, data: ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult, AWSError>;
31 /**
32 * Makes a copy of an existing snapshot. This operation is valid for Redis only. Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication &amp; Access Control. You could receive the following error messages. Error Messages Error Message: The S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s is not owned by the authenticated user. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The authenticated user does not have sufficient permissions to perform the desired activity. Solution: Contact your system administrator to get the needed permissions. Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName. Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
33 */
34 copySnapshot(params: ElastiCache.Types.CopySnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.CopySnapshotResult) => void): Request<ElastiCache.Types.CopySnapshotResult, AWSError>;
35 /**
36 * Makes a copy of an existing snapshot. This operation is valid for Redis only. Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication &amp; Access Control. You could receive the following error messages. Error Messages Error Message: The S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s is not owned by the authenticated user. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The authenticated user does not have sufficient permissions to perform the desired activity. Solution: Contact your system administrator to get the needed permissions. Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName. Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
37 */
38 copySnapshot(callback?: (err: AWSError, data: ElastiCache.Types.CopySnapshotResult) => void): Request<ElastiCache.Types.CopySnapshotResult, AWSError>;
39 /**
40 * Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters.
41 */
42 createCacheCluster(params: ElastiCache.Types.CreateCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheClusterResult) => void): Request<ElastiCache.Types.CreateCacheClusterResult, AWSError>;
43 /**
44 * Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters.
45 */
46 createCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheClusterResult) => void): Request<ElastiCache.Types.CreateCacheClusterResult, AWSError>;
47 /**
48 * Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see: ModifyCacheParameterGroup in the ElastiCache API Reference. Parameters and Parameter Groups in the ElastiCache User Guide.
49 */
50 createCacheParameterGroup(params: ElastiCache.Types.CreateCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheParameterGroupResult) => void): Request<ElastiCache.Types.CreateCacheParameterGroupResult, AWSError>;
51 /**
52 * Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see: ModifyCacheParameterGroup in the ElastiCache API Reference. Parameters and Parameter Groups in the ElastiCache User Guide.
53 */
54 createCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheParameterGroupResult) => void): Request<ElastiCache.Types.CreateCacheParameterGroupResult, AWSError>;
55 /**
56 * Creates a new cache security group. Use a cache security group to control access to one or more clusters. Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
57 */
58 createCacheSecurityGroup(params: ElastiCache.Types.CreateCacheSecurityGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSecurityGroupResult) => void): Request<ElastiCache.Types.CreateCacheSecurityGroupResult, AWSError>;
59 /**
60 * Creates a new cache security group. Use a cache security group to control access to one or more clusters. Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
61 */
62 createCacheSecurityGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSecurityGroupResult) => void): Request<ElastiCache.Types.CreateCacheSecurityGroupResult, AWSError>;
63 /**
64 * Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
65 */
66 createCacheSubnetGroup(params: ElastiCache.Types.CreateCacheSubnetGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSubnetGroupResult) => void): Request<ElastiCache.Types.CreateCacheSubnetGroupResult, AWSError>;
67 /**
68 * Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
69 */
70 createCacheSubnetGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSubnetGroupResult) => void): Request<ElastiCache.Types.CreateCacheSubnetGroupResult, AWSError>;
71 /**
72 * Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards). When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide. This operation is valid for Redis only.
73 */
74 createReplicationGroup(params: ElastiCache.Types.CreateReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateReplicationGroupResult) => void): Request<ElastiCache.Types.CreateReplicationGroupResult, AWSError>;
75 /**
76 * Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards). When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide. This operation is valid for Redis only.
77 */
78 createReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateReplicationGroupResult) => void): Request<ElastiCache.Types.CreateReplicationGroupResult, AWSError>;
79 /**
80 * Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Redis only.
81 */
82 createSnapshot(params: ElastiCache.Types.CreateSnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateSnapshotResult) => void): Request<ElastiCache.Types.CreateSnapshotResult, AWSError>;
83 /**
84 * Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Redis only.
85 */
86 createSnapshot(callback?: (err: AWSError, data: ElastiCache.Types.CreateSnapshotResult) => void): Request<ElastiCache.Types.CreateSnapshotResult, AWSError>;
87 /**
88 * Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
89 */
90 decreaseReplicaCount(params: ElastiCache.Types.DecreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request<ElastiCache.Types.DecreaseReplicaCountResult, AWSError>;
91 /**
92 * Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
93 */
94 decreaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request<ElastiCache.Types.DecreaseReplicaCountResult, AWSError>;
95 /**
96 * Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation. This operation cannot be used to delete a cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled) replication group. This operation is not valid for Redis (cluster mode enabled) clusters.
97 */
98 deleteCacheCluster(params: ElastiCache.Types.DeleteCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request<ElastiCache.Types.DeleteCacheClusterResult, AWSError>;
99 /**
100 * Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation. This operation cannot be used to delete a cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled) replication group. This operation is not valid for Redis (cluster mode enabled) clusters.
101 */
102 deleteCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request<ElastiCache.Types.DeleteCacheClusterResult, AWSError>;
103 /**
104 * Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
105 */
106 deleteCacheParameterGroup(params: ElastiCache.Types.DeleteCacheParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
107 /**
108 * Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
109 */
110 deleteCacheParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
111 /**
112 * Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters.
113 */
114 deleteCacheSecurityGroup(params: ElastiCache.Types.DeleteCacheSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
115 /**
116 * Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters.
117 */
118 deleteCacheSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
119 /**
120 * Deletes a cache subnet group. You cannot delete a cache subnet group if it is associated with any clusters.
121 */
122 deleteCacheSubnetGroup(params: ElastiCache.Types.DeleteCacheSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
123 /**
124 * Deletes a cache subnet group. You cannot delete a cache subnet group if it is associated with any clusters.
125 */
126 deleteCacheSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
127 /**
128 * Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. This operation is valid for Redis only.
129 */
130 deleteReplicationGroup(params: ElastiCache.Types.DeleteReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteReplicationGroupResult, AWSError>;
131 /**
132 * Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. This operation is valid for Redis only.
133 */
134 deleteReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteReplicationGroupResult, AWSError>;
135 /**
136 * Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Redis only.
137 */
138 deleteSnapshot(params: ElastiCache.Types.DeleteSnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request<ElastiCache.Types.DeleteSnapshotResult, AWSError>;
139 /**
140 * Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Redis only.
141 */
142 deleteSnapshot(callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request<ElastiCache.Types.DeleteSnapshotResult, AWSError>;
143 /**
144 * Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
145 */
146 describeCacheClusters(params: ElastiCache.Types.DescribeCacheClustersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
147 /**
148 * Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
149 */
150 describeCacheClusters(callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
151 /**
152 * Returns a list of the available cache engines and their versions.
153 */
154 describeCacheEngineVersions(params: ElastiCache.Types.DescribeCacheEngineVersionsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request<ElastiCache.Types.CacheEngineVersionMessage, AWSError>;
155 /**
156 * Returns a list of the available cache engines and their versions.
157 */
158 describeCacheEngineVersions(callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request<ElastiCache.Types.CacheEngineVersionMessage, AWSError>;
159 /**
160 * Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
161 */
162 describeCacheParameterGroups(params: ElastiCache.Types.DescribeCacheParameterGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request<ElastiCache.Types.CacheParameterGroupsMessage, AWSError>;
163 /**
164 * Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
165 */
166 describeCacheParameterGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request<ElastiCache.Types.CacheParameterGroupsMessage, AWSError>;
167 /**
168 * Returns the detailed parameter list for a particular cache parameter group.
169 */
170 describeCacheParameters(params: ElastiCache.Types.DescribeCacheParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request<ElastiCache.Types.CacheParameterGroupDetails, AWSError>;
171 /**
172 * Returns the detailed parameter list for a particular cache parameter group.
173 */
174 describeCacheParameters(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request<ElastiCache.Types.CacheParameterGroupDetails, AWSError>;
175 /**
176 * Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.
177 */
178 describeCacheSecurityGroups(params: ElastiCache.Types.DescribeCacheSecurityGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request<ElastiCache.Types.CacheSecurityGroupMessage, AWSError>;
179 /**
180 * Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.
181 */
182 describeCacheSecurityGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request<ElastiCache.Types.CacheSecurityGroupMessage, AWSError>;
183 /**
184 * Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
185 */
186 describeCacheSubnetGroups(params: ElastiCache.Types.DescribeCacheSubnetGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request<ElastiCache.Types.CacheSubnetGroupMessage, AWSError>;
187 /**
188 * Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
189 */
190 describeCacheSubnetGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request<ElastiCache.Types.CacheSubnetGroupMessage, AWSError>;
191 /**
192 * Returns the default engine and system parameter information for the specified cache engine.
193 */
194 describeEngineDefaultParameters(params: ElastiCache.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request<ElastiCache.Types.DescribeEngineDefaultParametersResult, AWSError>;
195 /**
196 * Returns the default engine and system parameter information for the specified cache engine.
197 */
198 describeEngineDefaultParameters(callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request<ElastiCache.Types.DescribeEngineDefaultParametersResult, AWSError>;
199 /**
200 * Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
201 */
202 describeEvents(params: ElastiCache.Types.DescribeEventsMessage, callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request<ElastiCache.Types.EventsMessage, AWSError>;
203 /**
204 * Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
205 */
206 describeEvents(callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request<ElastiCache.Types.EventsMessage, AWSError>;
207 /**
208 * Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. This operation is valid for Redis only.
209 */
210 describeReplicationGroups(params: ElastiCache.Types.DescribeReplicationGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
211 /**
212 * Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. This operation is valid for Redis only.
213 */
214 describeReplicationGroups(callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
215 /**
216 * Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
217 */
218 describeReservedCacheNodes(params: ElastiCache.Types.DescribeReservedCacheNodesMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request<ElastiCache.Types.ReservedCacheNodeMessage, AWSError>;
219 /**
220 * Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
221 */
222 describeReservedCacheNodes(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request<ElastiCache.Types.ReservedCacheNodeMessage, AWSError>;
223 /**
224 * Lists available reserved cache node offerings.
225 */
226 describeReservedCacheNodesOfferings(params: ElastiCache.Types.DescribeReservedCacheNodesOfferingsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request<ElastiCache.Types.ReservedCacheNodesOfferingMessage, AWSError>;
227 /**
228 * Lists available reserved cache node offerings.
229 */
230 describeReservedCacheNodesOfferings(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request<ElastiCache.Types.ReservedCacheNodesOfferingMessage, AWSError>;
231 /**
232 * Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Redis only.
233 */
234 describeSnapshots(params: ElastiCache.Types.DescribeSnapshotsMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request<ElastiCache.Types.DescribeSnapshotsListMessage, AWSError>;
235 /**
236 * Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Redis only.
237 */
238 describeSnapshots(callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request<ElastiCache.Types.DescribeSnapshotsListMessage, AWSError>;
239 /**
240 * Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
241 */
242 increaseReplicaCount(params: ElastiCache.Types.IncreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request<ElastiCache.Types.IncreaseReplicaCountResult, AWSError>;
243 /**
244 * Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
245 */
246 increaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request<ElastiCache.Types.IncreaseReplicaCountResult, AWSError>;
247 /**
248 * Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to. When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
249 */
250 listAllowedNodeTypeModifications(params: ElastiCache.Types.ListAllowedNodeTypeModificationsMessage, callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request<ElastiCache.Types.AllowedNodeTypeModificationsMessage, AWSError>;
251 /**
252 * Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to. When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
253 */
254 listAllowedNodeTypeModifications(callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request<ElastiCache.Types.AllowedNodeTypeModificationsMessage, AWSError>;
255 /**
256 * Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs. If the cluster is not in the available state, ListTagsForResource returns an error. You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.
257 */
258 listTagsForResource(params: ElastiCache.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
259 /**
260 * Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs. If the cluster is not in the available state, ListTagsForResource returns an error. You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.
261 */
262 listTagsForResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
263 /**
264 * Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
265 */
266 modifyCacheCluster(params: ElastiCache.Types.ModifyCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request<ElastiCache.Types.ModifyCacheClusterResult, AWSError>;
267 /**
268 * Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
269 */
270 modifyCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request<ElastiCache.Types.ModifyCacheClusterResult, AWSError>;
271 /**
272 * Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
273 */
274 modifyCacheParameterGroup(params: ElastiCache.Types.ModifyCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
275 /**
276 * Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
277 */
278 modifyCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
279 /**
280 * Modifies an existing cache subnet group.
281 */
282 modifyCacheSubnetGroup(params: ElastiCache.Types.ModifyCacheSubnetGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request<ElastiCache.Types.ModifyCacheSubnetGroupResult, AWSError>;
283 /**
284 * Modifies an existing cache subnet group.
285 */
286 modifyCacheSubnetGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request<ElastiCache.Types.ModifyCacheSubnetGroupResult, AWSError>;
287 /**
288 * Modifies the settings for a replication group. For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see: Scaling for Amazon ElastiCache for Redis—Redis (cluster mode enabled) in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Redis only.
289 */
290 modifyReplicationGroup(params: ElastiCache.Types.ModifyReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupResult, AWSError>;
291 /**
292 * Modifies the settings for a replication group. For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see: Scaling for Amazon ElastiCache for Redis—Redis (cluster mode enabled) in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Redis only.
293 */
294 modifyReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupResult, AWSError>;
295 /**
296 * Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.
297 */
298 modifyReplicationGroupShardConfiguration(params: ElastiCache.Types.ModifyReplicationGroupShardConfigurationMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult, AWSError>;
299 /**
300 * Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.
301 */
302 modifyReplicationGroupShardConfiguration(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult, AWSError>;
303 /**
304 * Allows you to purchase a reserved cache node offering.
305 */
306 purchaseReservedCacheNodesOffering(params: ElastiCache.Types.PurchaseReservedCacheNodesOfferingMessage, callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request<ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult, AWSError>;
307 /**
308 * Allows you to purchase a reserved cache node offering.
309 */
310 purchaseReservedCacheNodesOffering(callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request<ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult, AWSError>;
311 /**
312 * Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
313 */
314 rebootCacheCluster(params: ElastiCache.Types.RebootCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request<ElastiCache.Types.RebootCacheClusterResult, AWSError>;
315 /**
316 * Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
317 */
318 rebootCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request<ElastiCache.Types.RebootCacheClusterResult, AWSError>;
319 /**
320 * Removes the tags identified by the TagKeys list from the named resource.
321 */
322 removeTagsFromResource(params: ElastiCache.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
323 /**
324 * Removes the tags identified by the TagKeys list from the named resource.
325 */
326 removeTagsFromResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
327 /**
328 * Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
329 */
330 resetCacheParameterGroup(params: ElastiCache.Types.ResetCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
331 /**
332 * Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
333 */
334 resetCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
335 /**
336 * Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
337 */
338 revokeCacheSecurityGroupIngress(params: ElastiCache.Types.RevokeCacheSecurityGroupIngressMessage, callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.RevokeCacheSecurityGroupIngressResult, AWSError>;
339 /**
340 * Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
341 */
342 revokeCacheSecurityGroupIngress(callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.RevokeCacheSecurityGroupIngressResult, AWSError>;
343 /**
344 * Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console). Note the following A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period. If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently. If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made. To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance: Replication group message: Test Failover API called for node group &lt;node-group-id&gt; Cache cluster message: Failover from master node &lt;primary-node-id&gt; to replica node &lt;node-id&gt; completed Replication group message: Failover from master node &lt;primary-node-id&gt; to replica node &lt;node-id&gt; completed Cache cluster message: Recovering cache nodes &lt;node-id&gt; Cache cluster message: Finished recovery for cache nodes &lt;node-id&gt; For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.
345 */
346 testFailover(params: ElastiCache.Types.TestFailoverMessage, callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request<ElastiCache.Types.TestFailoverResult, AWSError>;
347 /**
348 * Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console). Note the following A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period. If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently. If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made. To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance: Replication group message: Test Failover API called for node group &lt;node-group-id&gt; Cache cluster message: Failover from master node &lt;primary-node-id&gt; to replica node &lt;node-id&gt; completed Replication group message: Failover from master node &lt;primary-node-id&gt; to replica node &lt;node-id&gt; completed Cache cluster message: Recovering cache nodes &lt;node-id&gt; Cache cluster message: Finished recovery for cache nodes &lt;node-id&gt; For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.
349 */
350 testFailover(callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request<ElastiCache.Types.TestFailoverResult, AWSError>;
351 /**
352 * Waits for the cacheClusterAvailable state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is available.
353 */
354 waitFor(state: "cacheClusterAvailable", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
355 /**
356 * Waits for the cacheClusterAvailable state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is available.
357 */
358 waitFor(state: "cacheClusterAvailable", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
359 /**
360 * Waits for the cacheClusterDeleted state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is deleted.
361 */
362 waitFor(state: "cacheClusterDeleted", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
363 /**
364 * Waits for the cacheClusterDeleted state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is deleted.
365 */
366 waitFor(state: "cacheClusterDeleted", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
367 /**
368 * Waits for the replicationGroupAvailable state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is available.
369 */
370 waitFor(state: "replicationGroupAvailable", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
371 /**
372 * Waits for the replicationGroupAvailable state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is available.
373 */
374 waitFor(state: "replicationGroupAvailable", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
375 /**
376 * Waits for the replicationGroupDeleted state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is deleted.
377 */
378 waitFor(state: "replicationGroupDeleted", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
379 /**
380 * Waits for the replicationGroupDeleted state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is deleted.
381 */
382 waitFor(state: "replicationGroupDeleted", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
383}
384declare namespace ElastiCache {
385 export type AZMode = "single-az"|"cross-az"|string;
386 export interface AddTagsToResourceMessage {
387 /**
388 * The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
389 */
390 ResourceName: String;
391 /**
392 * A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
393 */
394 Tags: TagList;
395 }
396 export type AllowedNodeGroupId = string;
397 export interface AllowedNodeTypeModificationsMessage {
398 /**
399 * A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
400 */
401 ScaleUpModifications?: NodeTypeList;
402 }
403 export interface AuthorizeCacheSecurityGroupIngressMessage {
404 /**
405 * The cache security group that allows network ingress.
406 */
407 CacheSecurityGroupName: String;
408 /**
409 * The Amazon EC2 security group to be authorized for ingress to the cache security group.
410 */
411 EC2SecurityGroupName: String;
412 /**
413 * The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
414 */
415 EC2SecurityGroupOwnerId: String;
416 }
417 export interface AuthorizeCacheSecurityGroupIngressResult {
418 CacheSecurityGroup?: CacheSecurityGroup;
419 }
420 export type AutomaticFailoverStatus = "enabled"|"disabled"|"enabling"|"disabling"|string;
421 export interface AvailabilityZone {
422 /**
423 * The name of the Availability Zone.
424 */
425 Name?: String;
426 }
427 export type AvailabilityZonesList = String[];
428 export type Boolean = boolean;
429 export type BooleanOptional = boolean;
430 export interface CacheCluster {
431 /**
432 * The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
433 */
434 CacheClusterId?: String;
435 /**
436 * Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it. Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
437 */
438 ConfigurationEndpoint?: Endpoint;
439 /**
440 * The URL of the web page where you can download the latest ElastiCache client library.
441 */
442 ClientDownloadLandingPage?: String;
443 /**
444 * The name of the compute and memory capacity node type for the cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis
445 */
446 CacheNodeType?: String;
447 /**
448 * The name of the cache engine (memcached or redis) to be used for this cluster.
449 */
450 Engine?: String;
451 /**
452 * The version of the cache engine that is used in this cluster.
453 */
454 EngineVersion?: String;
455 /**
456 * The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.
457 */
458 CacheClusterStatus?: String;
459 /**
460 * The number of cache nodes in the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
461 */
462 NumCacheNodes?: IntegerOptional;
463 /**
464 * The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
465 */
466 PreferredAvailabilityZone?: String;
467 /**
468 * The date and time when the cluster was created.
469 */
470 CacheClusterCreateTime?: TStamp;
471 /**
472 * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
473 */
474 PreferredMaintenanceWindow?: String;
475 PendingModifiedValues?: PendingModifiedValues;
476 /**
477 * Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
478 */
479 NotificationConfiguration?: NotificationConfiguration;
480 /**
481 * A list of cache security group elements, composed of name and status sub-elements.
482 */
483 CacheSecurityGroups?: CacheSecurityGroupMembershipList;
484 /**
485 * Status of the cache parameter group.
486 */
487 CacheParameterGroup?: CacheParameterGroupStatus;
488 /**
489 * The name of the cache subnet group associated with the cluster.
490 */
491 CacheSubnetGroupName?: String;
492 /**
493 * A list of cache nodes that are members of the cluster.
494 */
495 CacheNodes?: CacheNodeList;
496 /**
497 * This parameter is currently disabled.
498 */
499 AutoMinorVersionUpgrade?: Boolean;
500 /**
501 * A list of VPC Security Groups associated with the cluster.
502 */
503 SecurityGroups?: SecurityGroupMembershipList;
504 /**
505 * The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
506 */
507 ReplicationGroupId?: String;
508 /**
509 * The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
510 */
511 SnapshotRetentionLimit?: IntegerOptional;
512 /**
513 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: 05:00-09:00
514 */
515 SnapshotWindow?: String;
516 /**
517 * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false
518 */
519 AuthTokenEnabled?: BooleanOptional;
520 /**
521 * A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false
522 */
523 TransitEncryptionEnabled?: BooleanOptional;
524 /**
525 * A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false
526 */
527 AtRestEncryptionEnabled?: BooleanOptional;
528 }
529 export type CacheClusterList = CacheCluster[];
530 export interface CacheClusterMessage {
531 /**
532 * Provides an identifier to allow retrieval of paginated results.
533 */
534 Marker?: String;
535 /**
536 * A list of clusters. Each item in the list contains detailed information about one cluster.
537 */
538 CacheClusters?: CacheClusterList;
539 }
540 export interface CacheEngineVersion {
541 /**
542 * The name of the cache engine.
543 */
544 Engine?: String;
545 /**
546 * The version number of the cache engine.
547 */
548 EngineVersion?: String;
549 /**
550 * The name of the cache parameter group family associated with this cache engine. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0
551 */
552 CacheParameterGroupFamily?: String;
553 /**
554 * The description of the cache engine.
555 */
556 CacheEngineDescription?: String;
557 /**
558 * The description of the cache engine version.
559 */
560 CacheEngineVersionDescription?: String;
561 }
562 export type CacheEngineVersionList = CacheEngineVersion[];
563 export interface CacheEngineVersionMessage {
564 /**
565 * Provides an identifier to allow retrieval of paginated results.
566 */
567 Marker?: String;
568 /**
569 * A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.
570 */
571 CacheEngineVersions?: CacheEngineVersionList;
572 }
573 export interface CacheNode {
574 /**
575 * The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
576 */
577 CacheNodeId?: String;
578 /**
579 * The current state of this cache node.
580 */
581 CacheNodeStatus?: String;
582 /**
583 * The date and time when the cache node was created.
584 */
585 CacheNodeCreateTime?: TStamp;
586 /**
587 * The hostname for connecting to this cache node.
588 */
589 Endpoint?: Endpoint;
590 /**
591 * The status of the parameter group applied to this cache node.
592 */
593 ParameterGroupStatus?: String;
594 /**
595 * The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.
596 */
597 SourceCacheNodeId?: String;
598 /**
599 * The Availability Zone where this node was created and now resides.
600 */
601 CustomerAvailabilityZone?: String;
602 }
603 export type CacheNodeIdsList = String[];
604 export type CacheNodeList = CacheNode[];
605 export interface CacheNodeTypeSpecificParameter {
606 /**
607 * The name of the parameter.
608 */
609 ParameterName?: String;
610 /**
611 * A description of the parameter.
612 */
613 Description?: String;
614 /**
615 * The source of the parameter value.
616 */
617 Source?: String;
618 /**
619 * The valid data type for the parameter.
620 */
621 DataType?: String;
622 /**
623 * The valid range of values for the parameter.
624 */
625 AllowedValues?: String;
626 /**
627 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
628 */
629 IsModifiable?: Boolean;
630 /**
631 * The earliest cache engine version to which the parameter can apply.
632 */
633 MinimumEngineVersion?: String;
634 /**
635 * A list of cache node types and their corresponding values for this parameter.
636 */
637 CacheNodeTypeSpecificValues?: CacheNodeTypeSpecificValueList;
638 /**
639 * Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
640 */
641 ChangeType?: ChangeType;
642 }
643 export type CacheNodeTypeSpecificParametersList = CacheNodeTypeSpecificParameter[];
644 export interface CacheNodeTypeSpecificValue {
645 /**
646 * The cache node type for which this value applies.
647 */
648 CacheNodeType?: String;
649 /**
650 * The value for the cache node type.
651 */
652 Value?: String;
653 }
654 export type CacheNodeTypeSpecificValueList = CacheNodeTypeSpecificValue[];
655 export interface CacheParameterGroup {
656 /**
657 * The name of the cache parameter group.
658 */
659 CacheParameterGroupName?: String;
660 /**
661 * The name of the cache parameter group family that this cache parameter group is compatible with. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0
662 */
663 CacheParameterGroupFamily?: String;
664 /**
665 * The description for this cache parameter group.
666 */
667 Description?: String;
668 }
669 export interface CacheParameterGroupDetails {
670 /**
671 * Provides an identifier to allow retrieval of paginated results.
672 */
673 Marker?: String;
674 /**
675 * A list of Parameter instances.
676 */
677 Parameters?: ParametersList;
678 /**
679 * A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
680 */
681 CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList;
682 }
683 export type CacheParameterGroupList = CacheParameterGroup[];
684 export interface CacheParameterGroupNameMessage {
685 /**
686 * The name of the cache parameter group.
687 */
688 CacheParameterGroupName?: String;
689 }
690 export interface CacheParameterGroupStatus {
691 /**
692 * The name of the cache parameter group.
693 */
694 CacheParameterGroupName?: String;
695 /**
696 * The status of parameter updates.
697 */
698 ParameterApplyStatus?: String;
699 /**
700 * A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
701 */
702 CacheNodeIdsToReboot?: CacheNodeIdsList;
703 }
704 export interface CacheParameterGroupsMessage {
705 /**
706 * Provides an identifier to allow retrieval of paginated results.
707 */
708 Marker?: String;
709 /**
710 * A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
711 */
712 CacheParameterGroups?: CacheParameterGroupList;
713 }
714 export interface CacheSecurityGroup {
715 /**
716 * The AWS account ID of the cache security group owner.
717 */
718 OwnerId?: String;
719 /**
720 * The name of the cache security group.
721 */
722 CacheSecurityGroupName?: String;
723 /**
724 * The description of the cache security group.
725 */
726 Description?: String;
727 /**
728 * A list of Amazon EC2 security groups that are associated with this cache security group.
729 */
730 EC2SecurityGroups?: EC2SecurityGroupList;
731 }
732 export interface CacheSecurityGroupMembership {
733 /**
734 * The name of the cache security group.
735 */
736 CacheSecurityGroupName?: String;
737 /**
738 * The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
739 */
740 Status?: String;
741 }
742 export type CacheSecurityGroupMembershipList = CacheSecurityGroupMembership[];
743 export interface CacheSecurityGroupMessage {
744 /**
745 * Provides an identifier to allow retrieval of paginated results.
746 */
747 Marker?: String;
748 /**
749 * A list of cache security groups. Each element in the list contains detailed information about one group.
750 */
751 CacheSecurityGroups?: CacheSecurityGroups;
752 }
753 export type CacheSecurityGroupNameList = String[];
754 export type CacheSecurityGroups = CacheSecurityGroup[];
755 export interface CacheSubnetGroup {
756 /**
757 * The name of the cache subnet group.
758 */
759 CacheSubnetGroupName?: String;
760 /**
761 * The description of the cache subnet group.
762 */
763 CacheSubnetGroupDescription?: String;
764 /**
765 * The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
766 */
767 VpcId?: String;
768 /**
769 * A list of subnets associated with the cache subnet group.
770 */
771 Subnets?: SubnetList;
772 }
773 export interface CacheSubnetGroupMessage {
774 /**
775 * Provides an identifier to allow retrieval of paginated results.
776 */
777 Marker?: String;
778 /**
779 * A list of cache subnet groups. Each element in the list contains detailed information about one group.
780 */
781 CacheSubnetGroups?: CacheSubnetGroups;
782 }
783 export type CacheSubnetGroups = CacheSubnetGroup[];
784 export type ChangeType = "immediate"|"requires-reboot"|string;
785 export type ClusterIdList = String[];
786 export interface ConfigureShard {
787 /**
788 * The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.
789 */
790 NodeGroupId: AllowedNodeGroupId;
791 /**
792 * The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with. The minimum number of replicas in a shard or replication group is: Redis (cluster mode disabled) If Multi-AZ with Automatic Failover is enabled: 1 If Multi-AZ with Automatic Failover is not enable: 0 Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
793 */
794 NewReplicaCount: Integer;
795 /**
796 * A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.
797 */
798 PreferredAvailabilityZones?: PreferredAvailabilityZoneList;
799 }
800 export interface CopySnapshotMessage {
801 /**
802 * The name of an existing snapshot from which to make a copy.
803 */
804 SourceSnapshotName: String;
805 /**
806 * A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
807 */
808 TargetSnapshotName: String;
809 /**
810 * The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide. For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
811 */
812 TargetBucket?: String;
813 }
814 export interface CopySnapshotResult {
815 Snapshot?: Snapshot;
816 }
817 export interface CreateCacheClusterMessage {
818 /**
819 * The node group (shard) identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 20 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens.
820 */
821 CacheClusterId: String;
822 /**
823 * The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group. If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones. This parameter is only valid if the Engine parameter is redis.
824 */
825 ReplicationGroupId?: String;
826 /**
827 * Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. This parameter is only supported for Memcached clusters. If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
828 */
829 AZMode?: AZMode;
830 /**
831 * The EC2 Availability Zone in which the cluster is created. All nodes belonging to this Memcached cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones. Default: System chosen Availability Zone.
832 */
833 PreferredAvailabilityZone?: String;
834 /**
835 * A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important. This option is only supported on Memcached. If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheNodes. If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones.
836 */
837 PreferredAvailabilityZones?: PreferredAvailabilityZoneList;
838 /**
839 * The initial number of cache nodes that the cluster has. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20. If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
840 */
841 NumCacheNodes?: IntegerOptional;
842 /**
843 * The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis
844 */
845 CacheNodeType?: String;
846 /**
847 * The name of the cache engine to be used for this cluster. Valid values for this parameter are: memcached | redis
848 */
849 Engine?: String;
850 /**
851 * The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
852 */
853 EngineVersion?: String;
854 /**
855 * The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.
856 */
857 CacheParameterGroupName?: String;
858 /**
859 * The name of the subnet group to be used for the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
860 */
861 CacheSubnetGroupName?: String;
862 /**
863 * A list of security group names to associate with this cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
864 */
865 CacheSecurityGroupNames?: CacheSecurityGroupNameList;
866 /**
867 * One or more VPC security groups associated with the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
868 */
869 SecurityGroupIds?: SecurityGroupIdsList;
870 /**
871 * A list of cost allocation tags to be added to this resource.
872 */
873 Tags?: TagList;
874 /**
875 * A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas. This parameter is only valid if the Engine parameter is redis. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
876 */
877 SnapshotArns?: SnapshotArnsList;
878 /**
879 * The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created. This parameter is only valid if the Engine parameter is redis.
880 */
881 SnapshotName?: String;
882 /**
883 * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
884 */
885 PreferredMaintenanceWindow?: String;
886 /**
887 * The port number on which each of the cache nodes accepts connections.
888 */
889 Port?: IntegerOptional;
890 /**
891 * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner.
892 */
893 NotificationTopicArn?: String;
894 /**
895 * This parameter is currently disabled.
896 */
897 AutoMinorVersionUpgrade?: BooleanOptional;
898 /**
899 * The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted. This parameter is only valid if the Engine parameter is redis. Default: 0 (i.e., automatic backups are disabled for this cache cluster).
900 */
901 SnapshotRetentionLimit?: IntegerOptional;
902 /**
903 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. This parameter is only valid if the Engine parameter is redis.
904 */
905 SnapshotWindow?: String;
906 /**
907 * Reserved parameter. The password used to access a password protected server. Password constraints: Must be only printable ASCII characters. Must be at least 16 characters and no more than 128 characters in length. Cannot contain any of the following characters: '/', '"', or '@'. For more information, see AUTH password at http://redis.io/commands/AUTH.
908 */
909 AuthToken?: String;
910 }
911 export interface CreateCacheClusterResult {
912 CacheCluster?: CacheCluster;
913 }
914 export interface CreateCacheParameterGroupMessage {
915 /**
916 * A user-specified name for the cache parameter group.
917 */
918 CacheParameterGroupName: String;
919 /**
920 * The name of the cache parameter group family that the cache parameter group can be used with. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0
921 */
922 CacheParameterGroupFamily: String;
923 /**
924 * A user-specified description for the cache parameter group.
925 */
926 Description: String;
927 }
928 export interface CreateCacheParameterGroupResult {
929 CacheParameterGroup?: CacheParameterGroup;
930 }
931 export interface CreateCacheSecurityGroupMessage {
932 /**
933 * A name for the cache security group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default". Example: mysecuritygroup
934 */
935 CacheSecurityGroupName: String;
936 /**
937 * A description for the cache security group.
938 */
939 Description: String;
940 }
941 export interface CreateCacheSecurityGroupResult {
942 CacheSecurityGroup?: CacheSecurityGroup;
943 }
944 export interface CreateCacheSubnetGroupMessage {
945 /**
946 * A name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup
947 */
948 CacheSubnetGroupName: String;
949 /**
950 * A description for the cache subnet group.
951 */
952 CacheSubnetGroupDescription: String;
953 /**
954 * A list of VPC subnet IDs for the cache subnet group.
955 */
956 SubnetIds: SubnetIdentifierList;
957 }
958 export interface CreateCacheSubnetGroupResult {
959 CacheSubnetGroup?: CacheSubnetGroup;
960 }
961 export interface CreateReplicationGroupMessage {
962 /**
963 * The replication group identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 20 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens.
964 */
965 ReplicationGroupId: String;
966 /**
967 * A user-created description for the replication group.
968 */
969 ReplicationGroupDescription: String;
970 /**
971 * The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available. This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.
972 */
973 PrimaryClusterId?: String;
974 /**
975 * Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. Default: false Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types.
976 */
977 AutomaticFailoverEnabled?: BooleanOptional;
978 /**
979 * The number of clusters this replication group initially has. This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6. The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
980 */
981 NumCacheClusters?: IntegerOptional;
982 /**
983 * A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead. If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheClusters. Default: system chosen Availability Zones.
984 */
985 PreferredCacheClusterAZs?: AvailabilityZonesList;
986 /**
987 * An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1. Default: 1
988 */
989 NumNodeGroups?: IntegerOptional;
990 /**
991 * An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
992 */
993 ReplicasPerNodeGroup?: IntegerOptional;
994 /**
995 * A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots. If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file, you must configure each node group (shard) using this parameter because you must specify the slots for each node group.
996 */
997 NodeGroupConfiguration?: NodeGroupConfigurationList;
998 /**
999 * The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis
1000 */
1001 CacheNodeType?: String;
1002 /**
1003 * The name of the cache engine to be used for the clusters in this replication group.
1004 */
1005 Engine?: String;
1006 /**
1007 * The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
1008 */
1009 EngineVersion?: String;
1010 /**
1011 * The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2. To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
1012 */
1013 CacheParameterGroupName?: String;
1014 /**
1015 * The name of the cache subnet group to be used for the replication group. If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
1016 */
1017 CacheSubnetGroupName?: String;
1018 /**
1019 * A list of cache security group names to associate with this replication group.
1020 */
1021 CacheSecurityGroupNames?: CacheSecurityGroupNameList;
1022 /**
1023 * One or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
1024 */
1025 SecurityGroupIds?: SecurityGroupIdsList;
1026 /**
1027 * A list of cost allocation tags to be added to this resource. A tag is a key-value pair.
1028 */
1029 Tags?: TagList;
1030 /**
1031 * A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
1032 */
1033 SnapshotArns?: SnapshotArnsList;
1034 /**
1035 * The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
1036 */
1037 SnapshotName?: String;
1038 /**
1039 * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
1040 */
1041 PreferredMaintenanceWindow?: String;
1042 /**
1043 * The port number on which each member of the replication group accepts connections.
1044 */
1045 Port?: IntegerOptional;
1046 /**
1047 * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner.
1048 */
1049 NotificationTopicArn?: String;
1050 /**
1051 * This parameter is currently disabled.
1052 */
1053 AutoMinorVersionUpgrade?: BooleanOptional;
1054 /**
1055 * The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. Default: 0 (i.e., automatic backups are disabled for this cluster).
1056 */
1057 SnapshotRetentionLimit?: IntegerOptional;
1058 /**
1059 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
1060 */
1061 SnapshotWindow?: String;
1062 /**
1063 * Reserved parameter. The password used to access a password protected server. AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. Password constraints: Must be only printable ASCII characters. Must be at least 16 characters and no more than 128 characters in length. Cannot contain any of the following characters: '/', '"', or '@'. For more information, see AUTH password at http://redis.io/commands/AUTH.
1064 */
1065 AuthToken?: String;
1066 /**
1067 * A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6 or 4.x, and the cluster is being created in an Amazon VPC. If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
1068 */
1069 TransitEncryptionEnabled?: BooleanOptional;
1070 /**
1071 * A flag that enables encryption at rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false
1072 */
1073 AtRestEncryptionEnabled?: BooleanOptional;
1074 }
1075 export interface CreateReplicationGroupResult {
1076 ReplicationGroup?: ReplicationGroup;
1077 }
1078 export interface CreateSnapshotMessage {
1079 /**
1080 * The identifier of an existing replication group. The snapshot is created from this replication group.
1081 */
1082 ReplicationGroupId?: String;
1083 /**
1084 * The identifier of an existing cluster. The snapshot is created from this cluster.
1085 */
1086 CacheClusterId?: String;
1087 /**
1088 * A name for the snapshot being created.
1089 */
1090 SnapshotName: String;
1091 }
1092 export interface CreateSnapshotResult {
1093 Snapshot?: Snapshot;
1094 }
1095 export interface DecreaseReplicaCountMessage {
1096 /**
1097 * The id of the replication group from which you want to remove replica nodes.
1098 */
1099 ReplicationGroupId: String;
1100 /**
1101 * The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups. The minimum number of replicas in a shard or replication group is: Redis (cluster mode disabled) If Multi-AZ with Automatic Failover is enabled: 1 If Multi-AZ with Automatic Failover is not enabled: 0 Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
1102 */
1103 NewReplicaCount?: IntegerOptional;
1104 /**
1105 * A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
1106 */
1107 ReplicaConfiguration?: ReplicaConfigurationList;
1108 /**
1109 * A list of the node ids to remove from the replication group or node group (shard).
1110 */
1111 ReplicasToRemove?: RemoveReplicasList;
1112 /**
1113 * If True, the number of replica nodes is decreased immediately. If False, the number of replica nodes is decreased during the next maintenance window.
1114 */
1115 ApplyImmediately: Boolean;
1116 }
1117 export interface DecreaseReplicaCountResult {
1118 ReplicationGroup?: ReplicationGroup;
1119 }
1120 export interface DeleteCacheClusterMessage {
1121 /**
1122 * The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
1123 */
1124 CacheClusterId: String;
1125 /**
1126 * The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.
1127 */
1128 FinalSnapshotIdentifier?: String;
1129 }
1130 export interface DeleteCacheClusterResult {
1131 CacheCluster?: CacheCluster;
1132 }
1133 export interface DeleteCacheParameterGroupMessage {
1134 /**
1135 * The name of the cache parameter group to delete. The specified cache security group must not be associated with any clusters.
1136 */
1137 CacheParameterGroupName: String;
1138 }
1139 export interface DeleteCacheSecurityGroupMessage {
1140 /**
1141 * The name of the cache security group to delete. You cannot delete the default security group.
1142 */
1143 CacheSecurityGroupName: String;
1144 }
1145 export interface DeleteCacheSubnetGroupMessage {
1146 /**
1147 * The name of the cache subnet group to delete. Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
1148 */
1149 CacheSubnetGroupName: String;
1150 }
1151 export interface DeleteReplicationGroupMessage {
1152 /**
1153 * The identifier for the cluster to be deleted. This parameter is not case sensitive.
1154 */
1155 ReplicationGroupId: String;
1156 /**
1157 * If set to true, all of the read replicas are deleted, but the primary node is retained.
1158 */
1159 RetainPrimaryCluster?: BooleanOptional;
1160 /**
1161 * The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
1162 */
1163 FinalSnapshotIdentifier?: String;
1164 }
1165 export interface DeleteReplicationGroupResult {
1166 ReplicationGroup?: ReplicationGroup;
1167 }
1168 export interface DeleteSnapshotMessage {
1169 /**
1170 * The name of the snapshot to be deleted.
1171 */
1172 SnapshotName: String;
1173 }
1174 export interface DeleteSnapshotResult {
1175 Snapshot?: Snapshot;
1176 }
1177 export interface DescribeCacheClustersMessage {
1178 /**
1179 * The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.
1180 */
1181 CacheClusterId?: String;
1182 /**
1183 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1184 */
1185 MaxRecords?: IntegerOptional;
1186 /**
1187 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1188 */
1189 Marker?: String;
1190 /**
1191 * An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
1192 */
1193 ShowCacheNodeInfo?: BooleanOptional;
1194 /**
1195 * An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.
1196 */
1197 ShowCacheClustersNotInReplicationGroups?: BooleanOptional;
1198 }
1199 export interface DescribeCacheEngineVersionsMessage {
1200 /**
1201 * The cache engine to return. Valid values: memcached | redis
1202 */
1203 Engine?: String;
1204 /**
1205 * The cache engine version to return. Example: 1.4.14
1206 */
1207 EngineVersion?: String;
1208 /**
1209 * The name of a specific cache parameter group family to return details for. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0 Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
1210 */
1211 CacheParameterGroupFamily?: String;
1212 /**
1213 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1214 */
1215 MaxRecords?: IntegerOptional;
1216 /**
1217 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1218 */
1219 Marker?: String;
1220 /**
1221 * If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
1222 */
1223 DefaultOnly?: Boolean;
1224 }
1225 export interface DescribeCacheParameterGroupsMessage {
1226 /**
1227 * The name of a specific cache parameter group to return details for.
1228 */
1229 CacheParameterGroupName?: String;
1230 /**
1231 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1232 */
1233 MaxRecords?: IntegerOptional;
1234 /**
1235 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1236 */
1237 Marker?: String;
1238 }
1239 export interface DescribeCacheParametersMessage {
1240 /**
1241 * The name of a specific cache parameter group to return details for.
1242 */
1243 CacheParameterGroupName: String;
1244 /**
1245 * The parameter types to return. Valid values: user | system | engine-default
1246 */
1247 Source?: String;
1248 /**
1249 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1250 */
1251 MaxRecords?: IntegerOptional;
1252 /**
1253 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1254 */
1255 Marker?: String;
1256 }
1257 export interface DescribeCacheSecurityGroupsMessage {
1258 /**
1259 * The name of the cache security group to return details for.
1260 */
1261 CacheSecurityGroupName?: String;
1262 /**
1263 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1264 */
1265 MaxRecords?: IntegerOptional;
1266 /**
1267 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1268 */
1269 Marker?: String;
1270 }
1271 export interface DescribeCacheSubnetGroupsMessage {
1272 /**
1273 * The name of the cache subnet group to return details for.
1274 */
1275 CacheSubnetGroupName?: String;
1276 /**
1277 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1278 */
1279 MaxRecords?: IntegerOptional;
1280 /**
1281 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1282 */
1283 Marker?: String;
1284 }
1285 export interface DescribeEngineDefaultParametersMessage {
1286 /**
1287 * The name of the cache parameter group family. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0
1288 */
1289 CacheParameterGroupFamily: String;
1290 /**
1291 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1292 */
1293 MaxRecords?: IntegerOptional;
1294 /**
1295 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1296 */
1297 Marker?: String;
1298 }
1299 export interface DescribeEngineDefaultParametersResult {
1300 EngineDefaults?: EngineDefaults;
1301 }
1302 export interface DescribeEventsMessage {
1303 /**
1304 * The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
1305 */
1306 SourceIdentifier?: String;
1307 /**
1308 * The event source to retrieve events for. If no value is specified, all events are returned.
1309 */
1310 SourceType?: SourceType;
1311 /**
1312 * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
1313 */
1314 StartTime?: TStamp;
1315 /**
1316 * The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
1317 */
1318 EndTime?: TStamp;
1319 /**
1320 * The number of minutes worth of events to retrieve.
1321 */
1322 Duration?: IntegerOptional;
1323 /**
1324 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1325 */
1326 MaxRecords?: IntegerOptional;
1327 /**
1328 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1329 */
1330 Marker?: String;
1331 }
1332 export interface DescribeReplicationGroupsMessage {
1333 /**
1334 * The identifier for the replication group to be described. This parameter is not case sensitive. If you do not specify this parameter, information about all replication groups is returned.
1335 */
1336 ReplicationGroupId?: String;
1337 /**
1338 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1339 */
1340 MaxRecords?: IntegerOptional;
1341 /**
1342 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1343 */
1344 Marker?: String;
1345 }
1346 export interface DescribeReservedCacheNodesMessage {
1347 /**
1348 * The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
1349 */
1350 ReservedCacheNodeId?: String;
1351 /**
1352 * The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
1353 */
1354 ReservedCacheNodesOfferingId?: String;
1355 /**
1356 * The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis
1357 */
1358 CacheNodeType?: String;
1359 /**
1360 * The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
1361 */
1362 Duration?: String;
1363 /**
1364 * The product description filter value. Use this parameter to show only those reservations matching the specified product description.
1365 */
1366 ProductDescription?: String;
1367 /**
1368 * The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"
1369 */
1370 OfferingType?: String;
1371 /**
1372 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1373 */
1374 MaxRecords?: IntegerOptional;
1375 /**
1376 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1377 */
1378 Marker?: String;
1379 }
1380 export interface DescribeReservedCacheNodesOfferingsMessage {
1381 /**
1382 * The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
1383 */
1384 ReservedCacheNodesOfferingId?: String;
1385 /**
1386 * The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis
1387 */
1388 CacheNodeType?: String;
1389 /**
1390 * Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration. Valid Values: 1 | 3 | 31536000 | 94608000
1391 */
1392 Duration?: String;
1393 /**
1394 * The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
1395 */
1396 ProductDescription?: String;
1397 /**
1398 * The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"
1399 */
1400 OfferingType?: String;
1401 /**
1402 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
1403 */
1404 MaxRecords?: IntegerOptional;
1405 /**
1406 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1407 */
1408 Marker?: String;
1409 }
1410 export interface DescribeSnapshotsListMessage {
1411 /**
1412 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1413 */
1414 Marker?: String;
1415 /**
1416 * A list of snapshots. Each item in the list contains detailed information about one snapshot.
1417 */
1418 Snapshots?: SnapshotList;
1419 }
1420 export interface DescribeSnapshotsMessage {
1421 /**
1422 * A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
1423 */
1424 ReplicationGroupId?: String;
1425 /**
1426 * A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
1427 */
1428 CacheClusterId?: String;
1429 /**
1430 * A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
1431 */
1432 SnapshotName?: String;
1433 /**
1434 * If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
1435 */
1436 SnapshotSource?: String;
1437 /**
1438 * An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1439 */
1440 Marker?: String;
1441 /**
1442 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 50 Constraints: minimum 20; maximum 50.
1443 */
1444 MaxRecords?: IntegerOptional;
1445 /**
1446 * A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
1447 */
1448 ShowNodeGroupConfig?: BooleanOptional;
1449 }
1450 export type Double = number;
1451 export interface EC2SecurityGroup {
1452 /**
1453 * The status of the Amazon EC2 security group.
1454 */
1455 Status?: String;
1456 /**
1457 * The name of the Amazon EC2 security group.
1458 */
1459 EC2SecurityGroupName?: String;
1460 /**
1461 * The AWS account ID of the Amazon EC2 security group owner.
1462 */
1463 EC2SecurityGroupOwnerId?: String;
1464 }
1465 export type EC2SecurityGroupList = EC2SecurityGroup[];
1466 export interface Endpoint {
1467 /**
1468 * The DNS hostname of the cache node.
1469 */
1470 Address?: String;
1471 /**
1472 * The port number that the cache engine is listening on.
1473 */
1474 Port?: Integer;
1475 }
1476 export interface EngineDefaults {
1477 /**
1478 * Specifies the name of the cache parameter group family to which the engine default parameters apply. Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0
1479 */
1480 CacheParameterGroupFamily?: String;
1481 /**
1482 * Provides an identifier to allow retrieval of paginated results.
1483 */
1484 Marker?: String;
1485 /**
1486 * Contains a list of engine default parameters.
1487 */
1488 Parameters?: ParametersList;
1489 /**
1490 * A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
1491 */
1492 CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList;
1493 }
1494 export interface Event {
1495 /**
1496 * The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
1497 */
1498 SourceIdentifier?: String;
1499 /**
1500 * Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
1501 */
1502 SourceType?: SourceType;
1503 /**
1504 * The text of the event.
1505 */
1506 Message?: String;
1507 /**
1508 * The date and time when the event occurred.
1509 */
1510 Date?: TStamp;
1511 }
1512 export type EventList = Event[];
1513 export interface EventsMessage {
1514 /**
1515 * Provides an identifier to allow retrieval of paginated results.
1516 */
1517 Marker?: String;
1518 /**
1519 * A list of events. Each element in the list contains detailed information about one event.
1520 */
1521 Events?: EventList;
1522 }
1523 export interface IncreaseReplicaCountMessage {
1524 /**
1525 * The id of the replication group to which you want to add replica nodes.
1526 */
1527 ReplicationGroupId: String;
1528 /**
1529 * The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
1530 */
1531 NewReplicaCount?: IntegerOptional;
1532 /**
1533 * A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
1534 */
1535 ReplicaConfiguration?: ReplicaConfigurationList;
1536 /**
1537 * If True, the number of replica nodes is increased immediately. If False, the number of replica nodes is increased during the next maintenance window.
1538 */
1539 ApplyImmediately: Boolean;
1540 }
1541 export interface IncreaseReplicaCountResult {
1542 ReplicationGroup?: ReplicationGroup;
1543 }
1544 export type Integer = number;
1545 export type IntegerOptional = number;
1546 export type KeyList = String[];
1547 export interface ListAllowedNodeTypeModificationsMessage {
1548 /**
1549 * The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to. You must provide a value for either the CacheClusterId or the ReplicationGroupId.
1550 */
1551 CacheClusterId?: String;
1552 /**
1553 * The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to. You must provide a value for either the CacheClusterId or the ReplicationGroupId.
1554 */
1555 ReplicationGroupId?: String;
1556 }
1557 export interface ListTagsForResourceMessage {
1558 /**
1559 * The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
1560 */
1561 ResourceName: String;
1562 }
1563 export interface ModifyCacheClusterMessage {
1564 /**
1565 * The cluster identifier. This value is stored as a lowercase string.
1566 */
1567 CacheClusterId: String;
1568 /**
1569 * The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled. If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20. Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately). A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.
1570 */
1571 NumCacheNodes?: IntegerOptional;
1572 /**
1573 * A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.
1574 */
1575 CacheNodeIdsToRemove?: CacheNodeIdsList;
1576 /**
1577 * Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones. Valid values: single-az | cross-az. This option is only supported for Memcached clusters. You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes are located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.
1578 */
1579 AZMode?: AZMode;
1580 /**
1581 * The list of Availability Zones where the new Memcached cache nodes are created. This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request. This option is only supported on Memcached clusters. Scenarios: Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes. Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node. Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations. The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached. Impact of new add/remove requests upon pending requests Scenario-1 Pending Action: Delete New Request: Delete Result: The new delete, pending or immediate, replaces the pending delete. Scenario-2 Pending Action: Delete New Request: Create Result: The new create, pending or immediate, replaces the pending delete. Scenario-3 Pending Action: Create New Request: Delete Result: The new delete, pending or immediate, replaces the pending create. Scenario-4 Pending Action: Create New Request: Create Result: The new create is added to the pending create. Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
1582 */
1583 NewAvailabilityZones?: PreferredAvailabilityZoneList;
1584 /**
1585 * A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible. You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
1586 */
1587 CacheSecurityGroupNames?: CacheSecurityGroupNameList;
1588 /**
1589 * Specifies the VPC Security Groups associated with the cluster. This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
1590 */
1591 SecurityGroupIds?: SecurityGroupIdsList;
1592 /**
1593 * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
1594 */
1595 PreferredMaintenanceWindow?: String;
1596 /**
1597 * The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the cluster owner.
1598 */
1599 NotificationTopicArn?: String;
1600 /**
1601 * The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
1602 */
1603 CacheParameterGroupName?: String;
1604 /**
1605 * The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. Valid values: active | inactive
1606 */
1607 NotificationTopicStatus?: String;
1608 /**
1609 * If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. Valid values: true | false Default: false
1610 */
1611 ApplyImmediately?: Boolean;
1612 /**
1613 * The upgraded version of the cache engine to be run on the cache nodes. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
1614 */
1615 EngineVersion?: String;
1616 /**
1617 * This parameter is currently disabled.
1618 */
1619 AutoMinorVersionUpgrade?: BooleanOptional;
1620 /**
1621 * The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
1622 */
1623 SnapshotRetentionLimit?: IntegerOptional;
1624 /**
1625 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
1626 */
1627 SnapshotWindow?: String;
1628 /**
1629 * A valid cache node type that you want to scale this cluster up to.
1630 */
1631 CacheNodeType?: String;
1632 }
1633 export interface ModifyCacheClusterResult {
1634 CacheCluster?: CacheCluster;
1635 }
1636 export interface ModifyCacheParameterGroupMessage {
1637 /**
1638 * The name of the cache parameter group to modify.
1639 */
1640 CacheParameterGroupName: String;
1641 /**
1642 * An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
1643 */
1644 ParameterNameValues: ParameterNameValueList;
1645 }
1646 export interface ModifyCacheSubnetGroupMessage {
1647 /**
1648 * The name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup
1649 */
1650 CacheSubnetGroupName: String;
1651 /**
1652 * A description of the cache subnet group.
1653 */
1654 CacheSubnetGroupDescription?: String;
1655 /**
1656 * The EC2 subnet IDs for the cache subnet group.
1657 */
1658 SubnetIds?: SubnetIdentifierList;
1659 }
1660 export interface ModifyCacheSubnetGroupResult {
1661 CacheSubnetGroup?: CacheSubnetGroup;
1662 }
1663 export interface ModifyReplicationGroupMessage {
1664 /**
1665 * The identifier of the replication group to modify.
1666 */
1667 ReplicationGroupId: String;
1668 /**
1669 * A description for the replication group. Maximum length is 255 characters.
1670 */
1671 ReplicationGroupDescription?: String;
1672 /**
1673 * For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.
1674 */
1675 PrimaryClusterId?: String;
1676 /**
1677 * The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.
1678 */
1679 SnapshottingClusterId?: String;
1680 /**
1681 * Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. Valid values: true | false Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types.
1682 */
1683 AutomaticFailoverEnabled?: BooleanOptional;
1684 /**
1685 * A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible. This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.
1686 */
1687 CacheSecurityGroupNames?: CacheSecurityGroupNameList;
1688 /**
1689 * Specifies the VPC Security Groups associated with the clusters in the replication group. This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
1690 */
1691 SecurityGroupIds?: SecurityGroupIdsList;
1692 /**
1693 * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
1694 */
1695 PreferredMaintenanceWindow?: String;
1696 /**
1697 * The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the replication group owner.
1698 */
1699 NotificationTopicArn?: String;
1700 /**
1701 * The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
1702 */
1703 CacheParameterGroupName?: String;
1704 /**
1705 * The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active. Valid values: active | inactive
1706 */
1707 NotificationTopicStatus?: String;
1708 /**
1709 * If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group. If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Valid values: true | false Default: false
1710 */
1711 ApplyImmediately?: Boolean;
1712 /**
1713 * The upgraded version of the cache engine to be run on the clusters in the replication group. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.
1714 */
1715 EngineVersion?: String;
1716 /**
1717 * This parameter is currently disabled.
1718 */
1719 AutoMinorVersionUpgrade?: BooleanOptional;
1720 /**
1721 * The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
1722 */
1723 SnapshotRetentionLimit?: IntegerOptional;
1724 /**
1725 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId. Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
1726 */
1727 SnapshotWindow?: String;
1728 /**
1729 * A valid cache node type that you want to scale this replication group to.
1730 */
1731 CacheNodeType?: String;
1732 /**
1733 * Deprecated. This parameter is not used.
1734 */
1735 NodeGroupId?: String;
1736 }
1737 export interface ModifyReplicationGroupResult {
1738 ReplicationGroup?: ReplicationGroup;
1739 }
1740 export interface ModifyReplicationGroupShardConfigurationMessage {
1741 /**
1742 * The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
1743 */
1744 ReplicationGroupId: String;
1745 /**
1746 * The number of node groups (shards) that results from the modification of the shard configuration.
1747 */
1748 NodeGroupCount: Integer;
1749 /**
1750 * Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. Value: true
1751 */
1752 ApplyImmediately: Boolean;
1753 /**
1754 * Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you. You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).
1755 */
1756 ReshardingConfiguration?: ReshardingConfigurationList;
1757 /**
1758 * If the value of NodeGroupCount is less than the current number of node groups (shards), the NodeGroupsToRemove or NodeGroupsToRetain is a required list of node group ids to remove from or retain in the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
1759 */
1760 NodeGroupsToRemove?: NodeGroupsToRemoveList;
1761 /**
1762 * If the value of NodeGroupCount is less than the current number of node groups (shards), the NodeGroupsToRemove or NodeGroupsToRetain is a required list of node group ids to remove from or retain in the cluster. ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.
1763 */
1764 NodeGroupsToRetain?: NodeGroupsToRetainList;
1765 }
1766 export interface ModifyReplicationGroupShardConfigurationResult {
1767 ReplicationGroup?: ReplicationGroup;
1768 }
1769 export interface NodeGroup {
1770 /**
1771 * The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.
1772 */
1773 NodeGroupId?: String;
1774 /**
1775 * The current state of this replication group - creating, available, etc.
1776 */
1777 Status?: String;
1778 /**
1779 * The endpoint of the primary node in this node group (shard).
1780 */
1781 PrimaryEndpoint?: Endpoint;
1782 /**
1783 * The keyspace for this node group (shard).
1784 */
1785 Slots?: String;
1786 /**
1787 * A list containing information about individual nodes within the node group (shard).
1788 */
1789 NodeGroupMembers?: NodeGroupMemberList;
1790 }
1791 export interface NodeGroupConfiguration {
1792 /**
1793 * The 4-digit id for the node group these configuration values apply to.
1794 */
1795 NodeGroupId?: AllowedNodeGroupId;
1796 /**
1797 * A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey. Example: "0-3999"
1798 */
1799 Slots?: String;
1800 /**
1801 * The number of read replica nodes in this node group (shard).
1802 */
1803 ReplicaCount?: IntegerOptional;
1804 /**
1805 * The Availability Zone where the primary node of this node group (shard) is launched.
1806 */
1807 PrimaryAvailabilityZone?: String;
1808 /**
1809 * A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
1810 */
1811 ReplicaAvailabilityZones?: AvailabilityZonesList;
1812 }
1813 export type NodeGroupConfigurationList = NodeGroupConfiguration[];
1814 export type NodeGroupList = NodeGroup[];
1815 export interface NodeGroupMember {
1816 /**
1817 * The ID of the cluster to which the node belongs.
1818 */
1819 CacheClusterId?: String;
1820 /**
1821 * The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
1822 */
1823 CacheNodeId?: String;
1824 /**
1825 * The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
1826 */
1827 ReadEndpoint?: Endpoint;
1828 /**
1829 * The name of the Availability Zone in which the node is located.
1830 */
1831 PreferredAvailabilityZone?: String;
1832 /**
1833 * The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
1834 */
1835 CurrentRole?: String;
1836 }
1837 export type NodeGroupMemberList = NodeGroupMember[];
1838 export type NodeGroupsToRemoveList = AllowedNodeGroupId[];
1839 export type NodeGroupsToRetainList = AllowedNodeGroupId[];
1840 export interface NodeSnapshot {
1841 /**
1842 * A unique identifier for the source cluster.
1843 */
1844 CacheClusterId?: String;
1845 /**
1846 * A unique identifier for the source node group (shard).
1847 */
1848 NodeGroupId?: String;
1849 /**
1850 * The cache node identifier for the node in the source cluster.
1851 */
1852 CacheNodeId?: String;
1853 /**
1854 * The configuration for the source node group (shard).
1855 */
1856 NodeGroupConfiguration?: NodeGroupConfiguration;
1857 /**
1858 * The size of the cache on the source cache node.
1859 */
1860 CacheSize?: String;
1861 /**
1862 * The date and time when the cache node was created in the source cluster.
1863 */
1864 CacheNodeCreateTime?: TStamp;
1865 /**
1866 * The date and time when the source node's metadata and cache data set was obtained for the snapshot.
1867 */
1868 SnapshotCreateTime?: TStamp;
1869 }
1870 export type NodeSnapshotList = NodeSnapshot[];
1871 export type NodeTypeList = String[];
1872 export interface NotificationConfiguration {
1873 /**
1874 * The Amazon Resource Name (ARN) that identifies the topic.
1875 */
1876 TopicArn?: String;
1877 /**
1878 * The current state of the topic.
1879 */
1880 TopicStatus?: String;
1881 }
1882 export interface Parameter {
1883 /**
1884 * The name of the parameter.
1885 */
1886 ParameterName?: String;
1887 /**
1888 * The value of the parameter.
1889 */
1890 ParameterValue?: String;
1891 /**
1892 * A description of the parameter.
1893 */
1894 Description?: String;
1895 /**
1896 * The source of the parameter.
1897 */
1898 Source?: String;
1899 /**
1900 * The valid data type for the parameter.
1901 */
1902 DataType?: String;
1903 /**
1904 * The valid range of values for the parameter.
1905 */
1906 AllowedValues?: String;
1907 /**
1908 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
1909 */
1910 IsModifiable?: Boolean;
1911 /**
1912 * The earliest cache engine version to which the parameter can apply.
1913 */
1914 MinimumEngineVersion?: String;
1915 /**
1916 * Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
1917 */
1918 ChangeType?: ChangeType;
1919 }
1920 export interface ParameterNameValue {
1921 /**
1922 * The name of the parameter.
1923 */
1924 ParameterName?: String;
1925 /**
1926 * The value of the parameter.
1927 */
1928 ParameterValue?: String;
1929 }
1930 export type ParameterNameValueList = ParameterNameValue[];
1931 export type ParametersList = Parameter[];
1932 export type PendingAutomaticFailoverStatus = "enabled"|"disabled"|string;
1933 export interface PendingModifiedValues {
1934 /**
1935 * The new number of cache nodes for the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
1936 */
1937 NumCacheNodes?: IntegerOptional;
1938 /**
1939 * A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
1940 */
1941 CacheNodeIdsToRemove?: CacheNodeIdsList;
1942 /**
1943 * The new cache engine version that the cluster runs.
1944 */
1945 EngineVersion?: String;
1946 /**
1947 * The cache node type that this cluster or replication group is scaled to.
1948 */
1949 CacheNodeType?: String;
1950 }
1951 export type PreferredAvailabilityZoneList = String[];
1952 export interface PurchaseReservedCacheNodesOfferingMessage {
1953 /**
1954 * The ID of the reserved cache node offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
1955 */
1956 ReservedCacheNodesOfferingId: String;
1957 /**
1958 * A customer-specified identifier to track this reservation. The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation. Example: myreservationID
1959 */
1960 ReservedCacheNodeId?: String;
1961 /**
1962 * The number of cache node instances to reserve. Default: 1
1963 */
1964 CacheNodeCount?: IntegerOptional;
1965 }
1966 export interface PurchaseReservedCacheNodesOfferingResult {
1967 ReservedCacheNode?: ReservedCacheNode;
1968 }
1969 export interface RebootCacheClusterMessage {
1970 /**
1971 * The cluster identifier. This parameter is stored as a lowercase string.
1972 */
1973 CacheClusterId: String;
1974 /**
1975 * A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
1976 */
1977 CacheNodeIdsToReboot: CacheNodeIdsList;
1978 }
1979 export interface RebootCacheClusterResult {
1980 CacheCluster?: CacheCluster;
1981 }
1982 export interface RecurringCharge {
1983 /**
1984 * The monetary amount of the recurring charge.
1985 */
1986 RecurringChargeAmount?: Double;
1987 /**
1988 * The frequency of the recurring charge.
1989 */
1990 RecurringChargeFrequency?: String;
1991 }
1992 export type RecurringChargeList = RecurringCharge[];
1993 export type RemoveReplicasList = String[];
1994 export interface RemoveTagsFromResourceMessage {
1995 /**
1996 * The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
1997 */
1998 ResourceName: String;
1999 /**
2000 * A list of TagKeys identifying the tags you want removed from the named resource.
2001 */
2002 TagKeys: KeyList;
2003 }
2004 export type ReplicaConfigurationList = ConfigureShard[];
2005 export interface ReplicationGroup {
2006 /**
2007 * The identifier for the replication group.
2008 */
2009 ReplicationGroupId?: String;
2010 /**
2011 * The user supplied description of the replication group.
2012 */
2013 Description?: String;
2014 /**
2015 * The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
2016 */
2017 Status?: String;
2018 /**
2019 * A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
2020 */
2021 PendingModifiedValues?: ReplicationGroupPendingModifiedValues;
2022 /**
2023 * The names of all the cache clusters that are part of this replication group.
2024 */
2025 MemberClusters?: ClusterIdList;
2026 /**
2027 * A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
2028 */
2029 NodeGroups?: NodeGroupList;
2030 /**
2031 * The cluster ID that is used as the daily snapshot source for the replication group.
2032 */
2033 SnapshottingClusterId?: String;
2034 /**
2035 * Indicates the status of Multi-AZ with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types.
2036 */
2037 AutomaticFailover?: AutomaticFailoverStatus;
2038 /**
2039 * The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
2040 */
2041 ConfigurationEndpoint?: Endpoint;
2042 /**
2043 * The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
2044 */
2045 SnapshotRetentionLimit?: IntegerOptional;
2046 /**
2047 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. This parameter is only valid if the Engine parameter is redis.
2048 */
2049 SnapshotWindow?: String;
2050 /**
2051 * A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups). Valid values: true | false
2052 */
2053 ClusterEnabled?: BooleanOptional;
2054 /**
2055 * The name of the compute and memory capacity node type for each node in the replication group.
2056 */
2057 CacheNodeType?: String;
2058 /**
2059 * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false
2060 */
2061 AuthTokenEnabled?: BooleanOptional;
2062 /**
2063 * A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false
2064 */
2065 TransitEncryptionEnabled?: BooleanOptional;
2066 /**
2067 * A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x. Default: false
2068 */
2069 AtRestEncryptionEnabled?: BooleanOptional;
2070 }
2071 export type ReplicationGroupList = ReplicationGroup[];
2072 export interface ReplicationGroupMessage {
2073 /**
2074 * Provides an identifier to allow retrieval of paginated results.
2075 */
2076 Marker?: String;
2077 /**
2078 * A list of replication groups. Each item in the list contains detailed information about one replication group.
2079 */
2080 ReplicationGroups?: ReplicationGroupList;
2081 }
2082 export interface ReplicationGroupPendingModifiedValues {
2083 /**
2084 * The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
2085 */
2086 PrimaryClusterId?: String;
2087 /**
2088 * Indicates the status of Multi-AZ with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types.
2089 */
2090 AutomaticFailoverStatus?: PendingAutomaticFailoverStatus;
2091 /**
2092 * The status of an online resharding operation.
2093 */
2094 Resharding?: ReshardingStatus;
2095 }
2096 export interface ReservedCacheNode {
2097 /**
2098 * The unique identifier for the reservation.
2099 */
2100 ReservedCacheNodeId?: String;
2101 /**
2102 * The offering identifier.
2103 */
2104 ReservedCacheNodesOfferingId?: String;
2105 /**
2106 * The cache node type for the reserved cache nodes. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis
2107 */
2108 CacheNodeType?: String;
2109 /**
2110 * The time the reservation started.
2111 */
2112 StartTime?: TStamp;
2113 /**
2114 * The duration of the reservation in seconds.
2115 */
2116 Duration?: Integer;
2117 /**
2118 * The fixed price charged for this reserved cache node.
2119 */
2120 FixedPrice?: Double;
2121 /**
2122 * The hourly price charged for this reserved cache node.
2123 */
2124 UsagePrice?: Double;
2125 /**
2126 * The number of cache nodes that have been reserved.
2127 */
2128 CacheNodeCount?: Integer;
2129 /**
2130 * The description of the reserved cache node.
2131 */
2132 ProductDescription?: String;
2133 /**
2134 * The offering type of this reserved cache node.
2135 */
2136 OfferingType?: String;
2137 /**
2138 * The state of the reserved cache node.
2139 */
2140 State?: String;
2141 /**
2142 * The recurring price charged to run this reserved cache node.
2143 */
2144 RecurringCharges?: RecurringChargeList;
2145 /**
2146 * The Amazon Resource Name (ARN) of the reserved cache node. Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
2147 */
2148 ReservationARN?: String;
2149 }
2150 export type ReservedCacheNodeList = ReservedCacheNode[];
2151 export interface ReservedCacheNodeMessage {
2152 /**
2153 * Provides an identifier to allow retrieval of paginated results.
2154 */
2155 Marker?: String;
2156 /**
2157 * A list of reserved cache nodes. Each element in the list contains detailed information about one node.
2158 */
2159 ReservedCacheNodes?: ReservedCacheNodeList;
2160 }
2161 export interface ReservedCacheNodesOffering {
2162 /**
2163 * A unique identifier for the reserved cache node offering.
2164 */
2165 ReservedCacheNodesOfferingId?: String;
2166 /**
2167 * The cache node type for the reserved cache node. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis
2168 */
2169 CacheNodeType?: String;
2170 /**
2171 * The duration of the offering. in seconds.
2172 */
2173 Duration?: Integer;
2174 /**
2175 * The fixed price charged for this offering.
2176 */
2177 FixedPrice?: Double;
2178 /**
2179 * The hourly price charged for this offering.
2180 */
2181 UsagePrice?: Double;
2182 /**
2183 * The cache engine used by the offering.
2184 */
2185 ProductDescription?: String;
2186 /**
2187 * The offering type.
2188 */
2189 OfferingType?: String;
2190 /**
2191 * The recurring price charged to run this reserved cache node.
2192 */
2193 RecurringCharges?: RecurringChargeList;
2194 }
2195 export type ReservedCacheNodesOfferingList = ReservedCacheNodesOffering[];
2196 export interface ReservedCacheNodesOfferingMessage {
2197 /**
2198 * Provides an identifier to allow retrieval of paginated results.
2199 */
2200 Marker?: String;
2201 /**
2202 * A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
2203 */
2204 ReservedCacheNodesOfferings?: ReservedCacheNodesOfferingList;
2205 }
2206 export interface ResetCacheParameterGroupMessage {
2207 /**
2208 * The name of the cache parameter group to reset.
2209 */
2210 CacheParameterGroupName: String;
2211 /**
2212 * If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values. Valid values: true | false
2213 */
2214 ResetAllParameters?: Boolean;
2215 /**
2216 * An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.
2217 */
2218 ParameterNameValues?: ParameterNameValueList;
2219 }
2220 export interface ReshardingConfiguration {
2221 /**
2222 * The 4-digit id for the node group these configuration values apply to.
2223 */
2224 NodeGroupId?: AllowedNodeGroupId;
2225 /**
2226 * A list of preferred availability zones for the nodes in this cluster.
2227 */
2228 PreferredAvailabilityZones?: AvailabilityZonesList;
2229 }
2230 export type ReshardingConfigurationList = ReshardingConfiguration[];
2231 export interface ReshardingStatus {
2232 /**
2233 * Represents the progress of an online resharding operation.
2234 */
2235 SlotMigration?: SlotMigration;
2236 }
2237 export interface RevokeCacheSecurityGroupIngressMessage {
2238 /**
2239 * The name of the cache security group to revoke ingress from.
2240 */
2241 CacheSecurityGroupName: String;
2242 /**
2243 * The name of the Amazon EC2 security group to revoke access from.
2244 */
2245 EC2SecurityGroupName: String;
2246 /**
2247 * The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
2248 */
2249 EC2SecurityGroupOwnerId: String;
2250 }
2251 export interface RevokeCacheSecurityGroupIngressResult {
2252 CacheSecurityGroup?: CacheSecurityGroup;
2253 }
2254 export type SecurityGroupIdsList = String[];
2255 export interface SecurityGroupMembership {
2256 /**
2257 * The identifier of the cache security group.
2258 */
2259 SecurityGroupId?: String;
2260 /**
2261 * The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
2262 */
2263 Status?: String;
2264 }
2265 export type SecurityGroupMembershipList = SecurityGroupMembership[];
2266 export interface SlotMigration {
2267 /**
2268 * The percentage of the slot migration that is complete.
2269 */
2270 ProgressPercentage?: Double;
2271 }
2272 export interface Snapshot {
2273 /**
2274 * The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
2275 */
2276 SnapshotName?: String;
2277 /**
2278 * The unique identifier of the source replication group.
2279 */
2280 ReplicationGroupId?: String;
2281 /**
2282 * A description of the source replication group.
2283 */
2284 ReplicationGroupDescription?: String;
2285 /**
2286 * The user-supplied identifier of the source cluster.
2287 */
2288 CacheClusterId?: String;
2289 /**
2290 * The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
2291 */
2292 SnapshotStatus?: String;
2293 /**
2294 * Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
2295 */
2296 SnapshotSource?: String;
2297 /**
2298 * The name of the compute and memory capacity node type for the source cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC). Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances. Redis (cluster mode enabled): Backup/restore is not supported on T1 instances. Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances. For a complete listing of node types and specifications, see: Amazon ElastiCache Product Features and Details Cache Node Type-Specific Parameters for Memcached Cache Node Type-Specific Parameters for Redis
2299 */
2300 CacheNodeType?: String;
2301 /**
2302 * The name of the cache engine (memcached or redis) used by the source cluster.
2303 */
2304 Engine?: String;
2305 /**
2306 * The version of the cache engine version that is used by the source cluster.
2307 */
2308 EngineVersion?: String;
2309 /**
2310 * The number of cache nodes in the source cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
2311 */
2312 NumCacheNodes?: IntegerOptional;
2313 /**
2314 * The name of the Availability Zone in which the source cluster is located.
2315 */
2316 PreferredAvailabilityZone?: String;
2317 /**
2318 * The date and time when the source cluster was created.
2319 */
2320 CacheClusterCreateTime?: TStamp;
2321 /**
2322 * Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
2323 */
2324 PreferredMaintenanceWindow?: String;
2325 /**
2326 * The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
2327 */
2328 TopicArn?: String;
2329 /**
2330 * The port number used by each cache nodes in the source cluster.
2331 */
2332 Port?: IntegerOptional;
2333 /**
2334 * The cache parameter group that is associated with the source cluster.
2335 */
2336 CacheParameterGroupName?: String;
2337 /**
2338 * The name of the cache subnet group associated with the source cluster.
2339 */
2340 CacheSubnetGroupName?: String;
2341 /**
2342 * The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
2343 */
2344 VpcId?: String;
2345 /**
2346 * This parameter is currently disabled.
2347 */
2348 AutoMinorVersionUpgrade?: Boolean;
2349 /**
2350 * For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
2351 */
2352 SnapshotRetentionLimit?: IntegerOptional;
2353 /**
2354 * The daily time range during which ElastiCache takes daily snapshots of the source cluster.
2355 */
2356 SnapshotWindow?: String;
2357 /**
2358 * The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
2359 */
2360 NumNodeGroups?: IntegerOptional;
2361 /**
2362 * Indicates the status of Multi-AZ with automatic failover for the source Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 and T2 cache node types. Redis (cluster mode enabled): T1 node types.
2363 */
2364 AutomaticFailover?: AutomaticFailoverStatus;
2365 /**
2366 * A list of the cache nodes in the source cluster.
2367 */
2368 NodeSnapshots?: NodeSnapshotList;
2369 }
2370 export type SnapshotArnsList = String[];
2371 export type SnapshotList = Snapshot[];
2372 export type SourceType = "cache-cluster"|"cache-parameter-group"|"cache-security-group"|"cache-subnet-group"|"replication-group"|string;
2373 export type String = string;
2374 export interface Subnet {
2375 /**
2376 * The unique identifier for the subnet.
2377 */
2378 SubnetIdentifier?: String;
2379 /**
2380 * The Availability Zone associated with the subnet.
2381 */
2382 SubnetAvailabilityZone?: AvailabilityZone;
2383 }
2384 export type SubnetIdentifierList = String[];
2385 export type SubnetList = Subnet[];
2386 export type TStamp = Date;
2387 export interface Tag {
2388 /**
2389 * The key for the tag. May not be null.
2390 */
2391 Key?: String;
2392 /**
2393 * The tag's value. May be null.
2394 */
2395 Value?: String;
2396 }
2397 export type TagList = Tag[];
2398 export interface TagListMessage {
2399 /**
2400 * A list of cost allocation tags as key-value pairs.
2401 */
2402 TagList?: TagList;
2403 }
2404 export interface TestFailoverMessage {
2405 /**
2406 * The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
2407 */
2408 ReplicationGroupId: String;
2409 /**
2410 * The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.
2411 */
2412 NodeGroupId: AllowedNodeGroupId;
2413 }
2414 export interface TestFailoverResult {
2415 ReplicationGroup?: ReplicationGroup;
2416 }
2417 /**
2418 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2419 */
2420 export type apiVersion = "2012-11-15"|"2014-03-24"|"2014-07-15"|"2014-09-30"|"2015-02-02"|"latest"|string;
2421 export interface ClientApiVersions {
2422 /**
2423 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2424 */
2425 apiVersion?: apiVersion;
2426 }
2427 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2428 /**
2429 * Contains interfaces for use with the ElastiCache client.
2430 */
2431 export import Types = ElastiCache;
2432}
2433export = ElastiCache;