UNPKG

218 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 * Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
33 */
34 batchApplyUpdateAction(params: ElastiCache.Types.BatchApplyUpdateActionMessage, callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionResultsMessage) => void): Request<ElastiCache.Types.UpdateActionResultsMessage, AWSError>;
35 /**
36 * Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
37 */
38 batchApplyUpdateAction(callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionResultsMessage) => void): Request<ElastiCache.Types.UpdateActionResultsMessage, AWSError>;
39 /**
40 * Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
41 */
42 batchStopUpdateAction(params: ElastiCache.Types.BatchStopUpdateActionMessage, callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionResultsMessage) => void): Request<ElastiCache.Types.UpdateActionResultsMessage, AWSError>;
43 /**
44 * Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
45 */
46 batchStopUpdateAction(callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionResultsMessage) => void): Request<ElastiCache.Types.UpdateActionResultsMessage, AWSError>;
47 /**
48 * Complete the migration of data.
49 */
50 completeMigration(params: ElastiCache.Types.CompleteMigrationMessage, callback?: (err: AWSError, data: ElastiCache.Types.CompleteMigrationResponse) => void): Request<ElastiCache.Types.CompleteMigrationResponse, AWSError>;
51 /**
52 * Complete the migration of data.
53 */
54 completeMigration(callback?: (err: AWSError, data: ElastiCache.Types.CompleteMigrationResponse) => void): Request<ElastiCache.Types.CompleteMigrationResponse, AWSError>;
55 /**
56 * 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.
57 */
58 copySnapshot(params: ElastiCache.Types.CopySnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.CopySnapshotResult) => void): Request<ElastiCache.Types.CopySnapshotResult, AWSError>;
59 /**
60 * 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.
61 */
62 copySnapshot(callback?: (err: AWSError, data: ElastiCache.Types.CopySnapshotResult) => void): Request<ElastiCache.Types.CopySnapshotResult, AWSError>;
63 /**
64 * 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.
65 */
66 createCacheCluster(params: ElastiCache.Types.CreateCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheClusterResult) => void): Request<ElastiCache.Types.CreateCacheClusterResult, AWSError>;
67 /**
68 * 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.
69 */
70 createCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheClusterResult) => void): Request<ElastiCache.Types.CreateCacheClusterResult, AWSError>;
71 /**
72 * 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.
73 */
74 createCacheParameterGroup(params: ElastiCache.Types.CreateCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheParameterGroupResult) => void): Request<ElastiCache.Types.CreateCacheParameterGroupResult, AWSError>;
75 /**
76 * 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.
77 */
78 createCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheParameterGroupResult) => void): Request<ElastiCache.Types.CreateCacheParameterGroupResult, AWSError>;
79 /**
80 * 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.
81 */
82 createCacheSecurityGroup(params: ElastiCache.Types.CreateCacheSecurityGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSecurityGroupResult) => void): Request<ElastiCache.Types.CreateCacheSecurityGroupResult, AWSError>;
83 /**
84 * 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.
85 */
86 createCacheSecurityGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSecurityGroupResult) => void): Request<ElastiCache.Types.CreateCacheSecurityGroupResult, AWSError>;
87 /**
88 * Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
89 */
90 createCacheSubnetGroup(params: ElastiCache.Types.CreateCacheSubnetGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSubnetGroupResult) => void): Request<ElastiCache.Types.CreateCacheSubnetGroupResult, AWSError>;
91 /**
92 * Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
93 */
94 createCacheSubnetGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSubnetGroupResult) => void): Request<ElastiCache.Types.CreateCacheSubnetGroupResult, AWSError>;
95 /**
96 * Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore. The GlobalReplicationGroupId is the name of the Global Datastore. The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
97 */
98 createGlobalReplicationGroup(params: ElastiCache.Types.CreateGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.CreateGlobalReplicationGroupResult, AWSError>;
99 /**
100 * Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore. The GlobalReplicationGroupId is the name of the Global Datastore. The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
101 */
102 createGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.CreateGlobalReplicationGroupResult, AWSError>;
103 /**
104 * Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore. 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 90 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.
105 */
106 createReplicationGroup(params: ElastiCache.Types.CreateReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateReplicationGroupResult) => void): Request<ElastiCache.Types.CreateReplicationGroupResult, AWSError>;
107 /**
108 * Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore. 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 90 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.
109 */
110 createReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateReplicationGroupResult) => void): Request<ElastiCache.Types.CreateReplicationGroupResult, AWSError>;
111 /**
112 * Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Redis only.
113 */
114 createSnapshot(params: ElastiCache.Types.CreateSnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateSnapshotResult) => void): Request<ElastiCache.Types.CreateSnapshotResult, AWSError>;
115 /**
116 * Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Redis only.
117 */
118 createSnapshot(callback?: (err: AWSError, data: ElastiCache.Types.CreateSnapshotResult) => void): Request<ElastiCache.Types.CreateSnapshotResult, AWSError>;
119 /**
120 * Decreases the number of node groups in a Global Datastore
121 */
122 decreaseNodeGroupsInGlobalReplicationGroup(params: ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupResult, AWSError>;
123 /**
124 * Decreases the number of node groups in a Global Datastore
125 */
126 decreaseNodeGroupsInGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupResult, AWSError>;
127 /**
128 * Dynamically decreases the number of replicas 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.
129 */
130 decreaseReplicaCount(params: ElastiCache.Types.DecreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request<ElastiCache.Types.DecreaseReplicaCountResult, AWSError>;
131 /**
132 * Dynamically decreases the number of replicas 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.
133 */
134 decreaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request<ElastiCache.Types.DecreaseReplicaCountResult, AWSError>;
135 /**
136 * 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 is not valid for: Redis (cluster mode enabled) clusters A cluster that is the last read replica of a replication group A node group (shard) that has Multi-AZ mode enabled A cluster from a Redis (cluster mode enabled) replication group A cluster that is not in the available state
137 */
138 deleteCacheCluster(params: ElastiCache.Types.DeleteCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request<ElastiCache.Types.DeleteCacheClusterResult, AWSError>;
139 /**
140 * 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 is not valid for: Redis (cluster mode enabled) clusters A cluster that is the last read replica of a replication group A node group (shard) that has Multi-AZ mode enabled A cluster from a Redis (cluster mode enabled) replication group A cluster that is not in the available state
141 */
142 deleteCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request<ElastiCache.Types.DeleteCacheClusterResult, AWSError>;
143 /**
144 * Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
145 */
146 deleteCacheParameterGroup(params: ElastiCache.Types.DeleteCacheParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
147 /**
148 * Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
149 */
150 deleteCacheParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
151 /**
152 * Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters.
153 */
154 deleteCacheSecurityGroup(params: ElastiCache.Types.DeleteCacheSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
155 /**
156 * Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters.
157 */
158 deleteCacheSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
159 /**
160 * Deletes a cache subnet group. You cannot delete a cache subnet group if it is associated with any clusters.
161 */
162 deleteCacheSubnetGroup(params: ElastiCache.Types.DeleteCacheSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
163 /**
164 * Deletes a cache subnet group. You cannot delete a cache subnet group if it is associated with any clusters.
165 */
166 deleteCacheSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
167 /**
168 * Deleting a Global Datastore is a two-step process: First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global Datastore. Once the Global Datastore contains only the primary cluster, you can use DeleteGlobalReplicationGroup API to delete the Global Datastore while retainining the primary cluster using Retain…= true. Since the Global Datastore has only a primary cluster, you can delete the Global Datastore 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.
169 */
170 deleteGlobalReplicationGroup(params: ElastiCache.Types.DeleteGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteGlobalReplicationGroupResult, AWSError>;
171 /**
172 * Deleting a Global Datastore is a two-step process: First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global Datastore. Once the Global Datastore contains only the primary cluster, you can use DeleteGlobalReplicationGroup API to delete the Global Datastore while retainining the primary cluster using Retain…= true. Since the Global Datastore has only a primary cluster, you can delete the Global Datastore 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.
173 */
174 deleteGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DeleteGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteGlobalReplicationGroupResult, AWSError>;
175 /**
176 * 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.
177 */
178 deleteReplicationGroup(params: ElastiCache.Types.DeleteReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteReplicationGroupResult, AWSError>;
179 /**
180 * 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.
181 */
182 deleteReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteReplicationGroupResult, AWSError>;
183 /**
184 * 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.
185 */
186 deleteSnapshot(params: ElastiCache.Types.DeleteSnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request<ElastiCache.Types.DeleteSnapshotResult, AWSError>;
187 /**
188 * 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.
189 */
190 deleteSnapshot(callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request<ElastiCache.Types.DeleteSnapshotResult, AWSError>;
191 /**
192 * 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.
193 */
194 describeCacheClusters(params: ElastiCache.Types.DescribeCacheClustersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
195 /**
196 * 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.
197 */
198 describeCacheClusters(callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
199 /**
200 * Returns a list of the available cache engines and their versions.
201 */
202 describeCacheEngineVersions(params: ElastiCache.Types.DescribeCacheEngineVersionsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request<ElastiCache.Types.CacheEngineVersionMessage, AWSError>;
203 /**
204 * Returns a list of the available cache engines and their versions.
205 */
206 describeCacheEngineVersions(callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request<ElastiCache.Types.CacheEngineVersionMessage, AWSError>;
207 /**
208 * 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.
209 */
210 describeCacheParameterGroups(params: ElastiCache.Types.DescribeCacheParameterGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request<ElastiCache.Types.CacheParameterGroupsMessage, AWSError>;
211 /**
212 * 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.
213 */
214 describeCacheParameterGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request<ElastiCache.Types.CacheParameterGroupsMessage, AWSError>;
215 /**
216 * Returns the detailed parameter list for a particular cache parameter group.
217 */
218 describeCacheParameters(params: ElastiCache.Types.DescribeCacheParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request<ElastiCache.Types.CacheParameterGroupDetails, AWSError>;
219 /**
220 * Returns the detailed parameter list for a particular cache parameter group.
221 */
222 describeCacheParameters(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request<ElastiCache.Types.CacheParameterGroupDetails, AWSError>;
223 /**
224 * 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. This applicable only when you have ElastiCache in Classic setup
225 */
226 describeCacheSecurityGroups(params: ElastiCache.Types.DescribeCacheSecurityGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request<ElastiCache.Types.CacheSecurityGroupMessage, AWSError>;
227 /**
228 * 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. This applicable only when you have ElastiCache in Classic setup
229 */
230 describeCacheSecurityGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request<ElastiCache.Types.CacheSecurityGroupMessage, AWSError>;
231 /**
232 * Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
233 */
234 describeCacheSubnetGroups(params: ElastiCache.Types.DescribeCacheSubnetGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request<ElastiCache.Types.CacheSubnetGroupMessage, AWSError>;
235 /**
236 * Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
237 */
238 describeCacheSubnetGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request<ElastiCache.Types.CacheSubnetGroupMessage, AWSError>;
239 /**
240 * Returns the default engine and system parameter information for the specified cache engine.
241 */
242 describeEngineDefaultParameters(params: ElastiCache.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request<ElastiCache.Types.DescribeEngineDefaultParametersResult, AWSError>;
243 /**
244 * Returns the default engine and system parameter information for the specified cache engine.
245 */
246 describeEngineDefaultParameters(callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request<ElastiCache.Types.DescribeEngineDefaultParametersResult, AWSError>;
247 /**
248 * 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.
249 */
250 describeEvents(params: ElastiCache.Types.DescribeEventsMessage, callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request<ElastiCache.Types.EventsMessage, AWSError>;
251 /**
252 * 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.
253 */
254 describeEvents(callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request<ElastiCache.Types.EventsMessage, AWSError>;
255 /**
256 * Returns information about a particular global replication group. If no identifier is specified, returns information about all Global Datastores.
257 */
258 describeGlobalReplicationGroups(params: ElastiCache.Types.DescribeGlobalReplicationGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeGlobalReplicationGroupsResult) => void): Request<ElastiCache.Types.DescribeGlobalReplicationGroupsResult, AWSError>;
259 /**
260 * Returns information about a particular global replication group. If no identifier is specified, returns information about all Global Datastores.
261 */
262 describeGlobalReplicationGroups(callback?: (err: AWSError, data: ElastiCache.Types.DescribeGlobalReplicationGroupsResult) => void): Request<ElastiCache.Types.DescribeGlobalReplicationGroupsResult, AWSError>;
263 /**
264 * 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.
265 */
266 describeReplicationGroups(params: ElastiCache.Types.DescribeReplicationGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
267 /**
268 * 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.
269 */
270 describeReplicationGroups(callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
271 /**
272 * Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
273 */
274 describeReservedCacheNodes(params: ElastiCache.Types.DescribeReservedCacheNodesMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request<ElastiCache.Types.ReservedCacheNodeMessage, AWSError>;
275 /**
276 * Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
277 */
278 describeReservedCacheNodes(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request<ElastiCache.Types.ReservedCacheNodeMessage, AWSError>;
279 /**
280 * Lists available reserved cache node offerings.
281 */
282 describeReservedCacheNodesOfferings(params: ElastiCache.Types.DescribeReservedCacheNodesOfferingsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request<ElastiCache.Types.ReservedCacheNodesOfferingMessage, AWSError>;
283 /**
284 * Lists available reserved cache node offerings.
285 */
286 describeReservedCacheNodesOfferings(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request<ElastiCache.Types.ReservedCacheNodesOfferingMessage, AWSError>;
287 /**
288 * Returns details of the service updates
289 */
290 describeServiceUpdates(params: ElastiCache.Types.DescribeServiceUpdatesMessage, callback?: (err: AWSError, data: ElastiCache.Types.ServiceUpdatesMessage) => void): Request<ElastiCache.Types.ServiceUpdatesMessage, AWSError>;
291 /**
292 * Returns details of the service updates
293 */
294 describeServiceUpdates(callback?: (err: AWSError, data: ElastiCache.Types.ServiceUpdatesMessage) => void): Request<ElastiCache.Types.ServiceUpdatesMessage, AWSError>;
295 /**
296 * 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.
297 */
298 describeSnapshots(params: ElastiCache.Types.DescribeSnapshotsMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request<ElastiCache.Types.DescribeSnapshotsListMessage, AWSError>;
299 /**
300 * 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.
301 */
302 describeSnapshots(callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request<ElastiCache.Types.DescribeSnapshotsListMessage, AWSError>;
303 /**
304 * Returns details of the update actions
305 */
306 describeUpdateActions(params: ElastiCache.Types.DescribeUpdateActionsMessage, callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionsMessage) => void): Request<ElastiCache.Types.UpdateActionsMessage, AWSError>;
307 /**
308 * Returns details of the update actions
309 */
310 describeUpdateActions(callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionsMessage) => void): Request<ElastiCache.Types.UpdateActionsMessage, AWSError>;
311 /**
312 * Remove a secondary cluster from the Global Datastore using the Global Datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that AWS region.
313 */
314 disassociateGlobalReplicationGroup(params: ElastiCache.Types.DisassociateGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DisassociateGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DisassociateGlobalReplicationGroupResult, AWSError>;
315 /**
316 * Remove a secondary cluster from the Global Datastore using the Global Datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that AWS region.
317 */
318 disassociateGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DisassociateGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DisassociateGlobalReplicationGroupResult, AWSError>;
319 /**
320 * Used to failover the primary region to a selected secondary region.
321 */
322 failoverGlobalReplicationGroup(params: ElastiCache.Types.FailoverGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.FailoverGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.FailoverGlobalReplicationGroupResult, AWSError>;
323 /**
324 * Used to failover the primary region to a selected secondary region.
325 */
326 failoverGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.FailoverGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.FailoverGlobalReplicationGroupResult, AWSError>;
327 /**
328 * Increase the number of node groups in the Global Datastore
329 */
330 increaseNodeGroupsInGlobalReplicationGroup(params: ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupResult, AWSError>;
331 /**
332 * Increase the number of node groups in the Global Datastore
333 */
334 increaseNodeGroupsInGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupResult, AWSError>;
335 /**
336 * 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.
337 */
338 increaseReplicaCount(params: ElastiCache.Types.IncreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request<ElastiCache.Types.IncreaseReplicaCountResult, AWSError>;
339 /**
340 * 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.
341 */
342 increaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request<ElastiCache.Types.IncreaseReplicaCountResult, AWSError>;
343 /**
344 * Lists all available node types that you can scale your Redis cluster's or replication group's current node type. When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
345 */
346 listAllowedNodeTypeModifications(params: ElastiCache.Types.ListAllowedNodeTypeModificationsMessage, callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request<ElastiCache.Types.AllowedNodeTypeModificationsMessage, AWSError>;
347 /**
348 * Lists all available node types that you can scale your Redis cluster's or replication group's current node type. When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
349 */
350 listAllowedNodeTypeModifications(callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request<ElastiCache.Types.AllowedNodeTypeModificationsMessage, AWSError>;
351 /**
352 * 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.
353 */
354 listTagsForResource(params: ElastiCache.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
355 /**
356 * 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.
357 */
358 listTagsForResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
359 /**
360 * 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.
361 */
362 modifyCacheCluster(params: ElastiCache.Types.ModifyCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request<ElastiCache.Types.ModifyCacheClusterResult, AWSError>;
363 /**
364 * 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.
365 */
366 modifyCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request<ElastiCache.Types.ModifyCacheClusterResult, AWSError>;
367 /**
368 * 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.
369 */
370 modifyCacheParameterGroup(params: ElastiCache.Types.ModifyCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
371 /**
372 * 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.
373 */
374 modifyCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
375 /**
376 * Modifies an existing cache subnet group.
377 */
378 modifyCacheSubnetGroup(params: ElastiCache.Types.ModifyCacheSubnetGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request<ElastiCache.Types.ModifyCacheSubnetGroupResult, AWSError>;
379 /**
380 * Modifies an existing cache subnet group.
381 */
382 modifyCacheSubnetGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request<ElastiCache.Types.ModifyCacheSubnetGroupResult, AWSError>;
383 /**
384 * Modifies the settings for a Global Datastore.
385 */
386 modifyGlobalReplicationGroup(params: ElastiCache.Types.ModifyGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyGlobalReplicationGroupResult, AWSError>;
387 /**
388 * Modifies the settings for a Global Datastore.
389 */
390 modifyGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyGlobalReplicationGroupResult, AWSError>;
391 /**
392 * 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 (cluster mode enabled) in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Redis only.
393 */
394 modifyReplicationGroup(params: ElastiCache.Types.ModifyReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupResult, AWSError>;
395 /**
396 * 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 (cluster mode enabled) in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Redis only.
397 */
398 modifyReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupResult, AWSError>;
399 /**
400 * Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.
401 */
402 modifyReplicationGroupShardConfiguration(params: ElastiCache.Types.ModifyReplicationGroupShardConfigurationMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult, AWSError>;
403 /**
404 * Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.
405 */
406 modifyReplicationGroupShardConfiguration(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult, AWSError>;
407 /**
408 * Allows you to purchase a reserved cache node offering.
409 */
410 purchaseReservedCacheNodesOffering(params: ElastiCache.Types.PurchaseReservedCacheNodesOfferingMessage, callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request<ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult, AWSError>;
411 /**
412 * Allows you to purchase a reserved cache node offering.
413 */
414 purchaseReservedCacheNodesOffering(callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request<ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult, AWSError>;
415 /**
416 * Redistribute slots to ensure unifirom distribution across existing shards in the cluster.
417 */
418 rebalanceSlotsInGlobalReplicationGroup(params: ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupResult, AWSError>;
419 /**
420 * Redistribute slots to ensure unifirom distribution across existing shards in the cluster.
421 */
422 rebalanceSlotsInGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupResult, AWSError>;
423 /**
424 * 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.
425 */
426 rebootCacheCluster(params: ElastiCache.Types.RebootCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request<ElastiCache.Types.RebootCacheClusterResult, AWSError>;
427 /**
428 * 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.
429 */
430 rebootCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request<ElastiCache.Types.RebootCacheClusterResult, AWSError>;
431 /**
432 * Removes the tags identified by the TagKeys list from the named resource.
433 */
434 removeTagsFromResource(params: ElastiCache.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
435 /**
436 * Removes the tags identified by the TagKeys list from the named resource.
437 */
438 removeTagsFromResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
439 /**
440 * 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.
441 */
442 resetCacheParameterGroup(params: ElastiCache.Types.ResetCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
443 /**
444 * 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.
445 */
446 resetCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
447 /**
448 * Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
449 */
450 revokeCacheSecurityGroupIngress(params: ElastiCache.Types.RevokeCacheSecurityGroupIngressMessage, callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.RevokeCacheSecurityGroupIngressResult, AWSError>;
451 /**
452 * Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
453 */
454 revokeCacheSecurityGroupIngress(callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.RevokeCacheSecurityGroupIngressResult, AWSError>;
455 /**
456 * Start the migration of data.
457 */
458 startMigration(params: ElastiCache.Types.StartMigrationMessage, callback?: (err: AWSError, data: ElastiCache.Types.StartMigrationResponse) => void): Request<ElastiCache.Types.StartMigrationResponse, AWSError>;
459 /**
460 * Start the migration of data.
461 */
462 startMigration(callback?: (err: AWSError, data: ElastiCache.Types.StartMigrationResponse) => void): Request<ElastiCache.Types.StartMigrationResponse, AWSError>;
463 /**
464 * 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.
465 */
466 testFailover(params: ElastiCache.Types.TestFailoverMessage, callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request<ElastiCache.Types.TestFailoverResult, AWSError>;
467 /**
468 * 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.
469 */
470 testFailover(callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request<ElastiCache.Types.TestFailoverResult, AWSError>;
471 /**
472 * 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.
473 */
474 waitFor(state: "cacheClusterAvailable", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
475 /**
476 * 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.
477 */
478 waitFor(state: "cacheClusterAvailable", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
479 /**
480 * 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.
481 */
482 waitFor(state: "cacheClusterDeleted", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
483 /**
484 * 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.
485 */
486 waitFor(state: "cacheClusterDeleted", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
487 /**
488 * 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.
489 */
490 waitFor(state: "replicationGroupAvailable", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
491 /**
492 * 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.
493 */
494 waitFor(state: "replicationGroupAvailable", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
495 /**
496 * 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.
497 */
498 waitFor(state: "replicationGroupDeleted", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
499 /**
500 * 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.
501 */
502 waitFor(state: "replicationGroupDeleted", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
503}
504declare namespace ElastiCache {
505 export type AZMode = "single-az"|"cross-az"|string;
506 export interface AddTagsToResourceMessage {
507 /**
508 * 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.
509 */
510 ResourceName: String;
511 /**
512 * 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.
513 */
514 Tags: TagList;
515 }
516 export type AllowedNodeGroupId = string;
517 export interface AllowedNodeTypeModificationsMessage {
518 /**
519 * 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.
520 */
521 ScaleUpModifications?: NodeTypeList;
522 /**
523 * 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 down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
524 */
525 ScaleDownModifications?: NodeTypeList;
526 }
527 export type AuthTokenUpdateStatus = "SETTING"|"ROTATING"|string;
528 export type AuthTokenUpdateStrategyType = "SET"|"ROTATE"|string;
529 export interface AuthorizeCacheSecurityGroupIngressMessage {
530 /**
531 * The cache security group that allows network ingress.
532 */
533 CacheSecurityGroupName: String;
534 /**
535 * The Amazon EC2 security group to be authorized for ingress to the cache security group.
536 */
537 EC2SecurityGroupName: String;
538 /**
539 * 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.
540 */
541 EC2SecurityGroupOwnerId: String;
542 }
543 export interface AuthorizeCacheSecurityGroupIngressResult {
544 CacheSecurityGroup?: CacheSecurityGroup;
545 }
546 export type AutomaticFailoverStatus = "enabled"|"disabled"|"enabling"|"disabling"|string;
547 export interface AvailabilityZone {
548 /**
549 * The name of the Availability Zone.
550 */
551 Name?: String;
552 }
553 export type AvailabilityZonesList = String[];
554 export interface BatchApplyUpdateActionMessage {
555 /**
556 * The replication group IDs
557 */
558 ReplicationGroupIds?: ReplicationGroupIdList;
559 /**
560 * The cache cluster IDs
561 */
562 CacheClusterIds?: CacheClusterIdList;
563 /**
564 * The unique ID of the service update
565 */
566 ServiceUpdateName: String;
567 }
568 export interface BatchStopUpdateActionMessage {
569 /**
570 * The replication group IDs
571 */
572 ReplicationGroupIds?: ReplicationGroupIdList;
573 /**
574 * The cache cluster IDs
575 */
576 CacheClusterIds?: CacheClusterIdList;
577 /**
578 * The unique ID of the service update
579 */
580 ServiceUpdateName: String;
581 }
582 export type Boolean = boolean;
583 export type BooleanOptional = boolean;
584 export interface CacheCluster {
585 /**
586 * The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
587 */
588 CacheClusterId?: String;
589 /**
590 * 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
591 */
592 ConfigurationEndpoint?: Endpoint;
593 /**
594 * The URL of the web page where you can download the latest ElastiCache client library.
595 */
596 ClientDownloadLandingPage?: String;
597 /**
598 * 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: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium 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 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge 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 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
599 */
600 CacheNodeType?: String;
601 /**
602 * The name of the cache engine (memcached or redis) to be used for this cluster.
603 */
604 Engine?: String;
605 /**
606 * The version of the cache engine that is used in this cluster.
607 */
608 EngineVersion?: String;
609 /**
610 * 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.
611 */
612 CacheClusterStatus?: String;
613 /**
614 * 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.
615 */
616 NumCacheNodes?: IntegerOptional;
617 /**
618 * The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
619 */
620 PreferredAvailabilityZone?: String;
621 /**
622 * The date and time when the cluster was created.
623 */
624 CacheClusterCreateTime?: TStamp;
625 /**
626 * 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
627 */
628 PreferredMaintenanceWindow?: String;
629 PendingModifiedValues?: PendingModifiedValues;
630 /**
631 * Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
632 */
633 NotificationConfiguration?: NotificationConfiguration;
634 /**
635 * A list of cache security group elements, composed of name and status sub-elements.
636 */
637 CacheSecurityGroups?: CacheSecurityGroupMembershipList;
638 /**
639 * Status of the cache parameter group.
640 */
641 CacheParameterGroup?: CacheParameterGroupStatus;
642 /**
643 * The name of the cache subnet group associated with the cluster.
644 */
645 CacheSubnetGroupName?: String;
646 /**
647 * A list of cache nodes that are members of the cluster.
648 */
649 CacheNodes?: CacheNodeList;
650 /**
651 * This parameter is currently disabled.
652 */
653 AutoMinorVersionUpgrade?: Boolean;
654 /**
655 * A list of VPC Security Groups associated with the cluster.
656 */
657 SecurityGroups?: SecurityGroupMembershipList;
658 /**
659 * The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
660 */
661 ReplicationGroupId?: String;
662 /**
663 * 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.
664 */
665 SnapshotRetentionLimit?: IntegerOptional;
666 /**
667 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: 05:00-09:00
668 */
669 SnapshotWindow?: String;
670 /**
671 * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false
672 */
673 AuthTokenEnabled?: BooleanOptional;
674 /**
675 * The date the auth token was last modified
676 */
677 AuthTokenLastModifiedDate?: TStamp;
678 /**
679 * 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, 4.x or later. Default: false
680 */
681 TransitEncryptionEnabled?: BooleanOptional;
682 /**
683 * 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, 4.x or later. Default: false
684 */
685 AtRestEncryptionEnabled?: BooleanOptional;
686 }
687 export type CacheClusterIdList = String[];
688 export type CacheClusterList = CacheCluster[];
689 export interface CacheClusterMessage {
690 /**
691 * Provides an identifier to allow retrieval of paginated results.
692 */
693 Marker?: String;
694 /**
695 * A list of clusters. Each item in the list contains detailed information about one cluster.
696 */
697 CacheClusters?: CacheClusterList;
698 }
699 export interface CacheEngineVersion {
700 /**
701 * The name of the cache engine.
702 */
703 Engine?: String;
704 /**
705 * The version number of the cache engine.
706 */
707 EngineVersion?: String;
708 /**
709 * The name of the cache parameter group family associated with this cache engine. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
710 */
711 CacheParameterGroupFamily?: String;
712 /**
713 * The description of the cache engine.
714 */
715 CacheEngineDescription?: String;
716 /**
717 * The description of the cache engine version.
718 */
719 CacheEngineVersionDescription?: String;
720 }
721 export type CacheEngineVersionList = CacheEngineVersion[];
722 export interface CacheEngineVersionMessage {
723 /**
724 * Provides an identifier to allow retrieval of paginated results.
725 */
726 Marker?: String;
727 /**
728 * A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.
729 */
730 CacheEngineVersions?: CacheEngineVersionList;
731 }
732 export interface CacheNode {
733 /**
734 * 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.
735 */
736 CacheNodeId?: String;
737 /**
738 * The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.
739 */
740 CacheNodeStatus?: String;
741 /**
742 * The date and time when the cache node was created.
743 */
744 CacheNodeCreateTime?: TStamp;
745 /**
746 * The hostname for connecting to this cache node.
747 */
748 Endpoint?: Endpoint;
749 /**
750 * The status of the parameter group applied to this cache node.
751 */
752 ParameterGroupStatus?: String;
753 /**
754 * 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.
755 */
756 SourceCacheNodeId?: String;
757 /**
758 * The Availability Zone where this node was created and now resides.
759 */
760 CustomerAvailabilityZone?: String;
761 }
762 export type CacheNodeIdsList = String[];
763 export type CacheNodeList = CacheNode[];
764 export interface CacheNodeTypeSpecificParameter {
765 /**
766 * The name of the parameter.
767 */
768 ParameterName?: String;
769 /**
770 * A description of the parameter.
771 */
772 Description?: String;
773 /**
774 * The source of the parameter value.
775 */
776 Source?: String;
777 /**
778 * The valid data type for the parameter.
779 */
780 DataType?: String;
781 /**
782 * The valid range of values for the parameter.
783 */
784 AllowedValues?: String;
785 /**
786 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
787 */
788 IsModifiable?: Boolean;
789 /**
790 * The earliest cache engine version to which the parameter can apply.
791 */
792 MinimumEngineVersion?: String;
793 /**
794 * A list of cache node types and their corresponding values for this parameter.
795 */
796 CacheNodeTypeSpecificValues?: CacheNodeTypeSpecificValueList;
797 /**
798 * 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.
799 */
800 ChangeType?: ChangeType;
801 }
802 export type CacheNodeTypeSpecificParametersList = CacheNodeTypeSpecificParameter[];
803 export interface CacheNodeTypeSpecificValue {
804 /**
805 * The cache node type for which this value applies.
806 */
807 CacheNodeType?: String;
808 /**
809 * The value for the cache node type.
810 */
811 Value?: String;
812 }
813 export type CacheNodeTypeSpecificValueList = CacheNodeTypeSpecificValue[];
814 export interface CacheNodeUpdateStatus {
815 /**
816 * The node ID of the cache cluster
817 */
818 CacheNodeId?: String;
819 /**
820 * The update status of the node
821 */
822 NodeUpdateStatus?: NodeUpdateStatus;
823 /**
824 * The deletion date of the node
825 */
826 NodeDeletionDate?: TStamp;
827 /**
828 * The start date of the update for a node
829 */
830 NodeUpdateStartDate?: TStamp;
831 /**
832 * The end date of the update for a node
833 */
834 NodeUpdateEndDate?: TStamp;
835 /**
836 * Reflects whether the update was initiated by the customer or automatically applied
837 */
838 NodeUpdateInitiatedBy?: NodeUpdateInitiatedBy;
839 /**
840 * The date when the update is triggered
841 */
842 NodeUpdateInitiatedDate?: TStamp;
843 /**
844 * The date when the NodeUpdateStatus was last modified&gt;
845 */
846 NodeUpdateStatusModifiedDate?: TStamp;
847 }
848 export type CacheNodeUpdateStatusList = CacheNodeUpdateStatus[];
849 export interface CacheParameterGroup {
850 /**
851 * The name of the cache parameter group.
852 */
853 CacheParameterGroupName?: String;
854 /**
855 * The name of the cache parameter group family that this cache parameter group is compatible with. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
856 */
857 CacheParameterGroupFamily?: String;
858 /**
859 * The description for this cache parameter group.
860 */
861 Description?: String;
862 /**
863 * Indicates whether the parameter group is associated with a Global Datastore
864 */
865 IsGlobal?: Boolean;
866 }
867 export interface CacheParameterGroupDetails {
868 /**
869 * Provides an identifier to allow retrieval of paginated results.
870 */
871 Marker?: String;
872 /**
873 * A list of Parameter instances.
874 */
875 Parameters?: ParametersList;
876 /**
877 * A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
878 */
879 CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList;
880 }
881 export type CacheParameterGroupList = CacheParameterGroup[];
882 export interface CacheParameterGroupNameMessage {
883 /**
884 * The name of the cache parameter group.
885 */
886 CacheParameterGroupName?: String;
887 }
888 export interface CacheParameterGroupStatus {
889 /**
890 * The name of the cache parameter group.
891 */
892 CacheParameterGroupName?: String;
893 /**
894 * The status of parameter updates.
895 */
896 ParameterApplyStatus?: String;
897 /**
898 * 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.).
899 */
900 CacheNodeIdsToReboot?: CacheNodeIdsList;
901 }
902 export interface CacheParameterGroupsMessage {
903 /**
904 * Provides an identifier to allow retrieval of paginated results.
905 */
906 Marker?: String;
907 /**
908 * A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
909 */
910 CacheParameterGroups?: CacheParameterGroupList;
911 }
912 export interface CacheSecurityGroup {
913 /**
914 * The AWS account ID of the cache security group owner.
915 */
916 OwnerId?: String;
917 /**
918 * The name of the cache security group.
919 */
920 CacheSecurityGroupName?: String;
921 /**
922 * The description of the cache security group.
923 */
924 Description?: String;
925 /**
926 * A list of Amazon EC2 security groups that are associated with this cache security group.
927 */
928 EC2SecurityGroups?: EC2SecurityGroupList;
929 }
930 export interface CacheSecurityGroupMembership {
931 /**
932 * The name of the cache security group.
933 */
934 CacheSecurityGroupName?: String;
935 /**
936 * 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.
937 */
938 Status?: String;
939 }
940 export type CacheSecurityGroupMembershipList = CacheSecurityGroupMembership[];
941 export interface CacheSecurityGroupMessage {
942 /**
943 * Provides an identifier to allow retrieval of paginated results.
944 */
945 Marker?: String;
946 /**
947 * A list of cache security groups. Each element in the list contains detailed information about one group.
948 */
949 CacheSecurityGroups?: CacheSecurityGroups;
950 }
951 export type CacheSecurityGroupNameList = String[];
952 export type CacheSecurityGroups = CacheSecurityGroup[];
953 export interface CacheSubnetGroup {
954 /**
955 * The name of the cache subnet group.
956 */
957 CacheSubnetGroupName?: String;
958 /**
959 * The description of the cache subnet group.
960 */
961 CacheSubnetGroupDescription?: String;
962 /**
963 * The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
964 */
965 VpcId?: String;
966 /**
967 * A list of subnets associated with the cache subnet group.
968 */
969 Subnets?: SubnetList;
970 }
971 export interface CacheSubnetGroupMessage {
972 /**
973 * Provides an identifier to allow retrieval of paginated results.
974 */
975 Marker?: String;
976 /**
977 * A list of cache subnet groups. Each element in the list contains detailed information about one group.
978 */
979 CacheSubnetGroups?: CacheSubnetGroups;
980 }
981 export type CacheSubnetGroups = CacheSubnetGroup[];
982 export type ChangeType = "immediate"|"requires-reboot"|string;
983 export type ClusterIdList = String[];
984 export interface CompleteMigrationMessage {
985 /**
986 * The ID of the replication group to which data is being migrated.
987 */
988 ReplicationGroupId: String;
989 /**
990 * Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.
991 */
992 Force?: Boolean;
993 }
994 export interface CompleteMigrationResponse {
995 ReplicationGroup?: ReplicationGroup;
996 }
997 export interface ConfigureShard {
998 /**
999 * 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.
1000 */
1001 NodeGroupId: AllowedNodeGroupId;
1002 /**
1003 * 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)
1004 */
1005 NewReplicaCount: Integer;
1006 /**
1007 * 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.
1008 */
1009 PreferredAvailabilityZones?: PreferredAvailabilityZoneList;
1010 }
1011 export interface CopySnapshotMessage {
1012 /**
1013 * The name of an existing snapshot from which to make a copy.
1014 */
1015 SourceSnapshotName: String;
1016 /**
1017 * 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.
1018 */
1019 TargetSnapshotName: String;
1020 /**
1021 * 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.
1022 */
1023 TargetBucket?: String;
1024 /**
1025 * The ID of the KMS key used to encrypt the target snapshot.
1026 */
1027 KmsKeyId?: String;
1028 }
1029 export interface CopySnapshotResult {
1030 Snapshot?: Snapshot;
1031 }
1032 export interface CreateCacheClusterMessage {
1033 /**
1034 * The node group (shard) identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 50 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens.
1035 */
1036 CacheClusterId: String;
1037 /**
1038 * 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.
1039 */
1040 ReplicationGroupId?: String;
1041 /**
1042 * 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.
1043 */
1044 AZMode?: AZMode;
1045 /**
1046 * 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.
1047 */
1048 PreferredAvailabilityZone?: String;
1049 /**
1050 * 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.
1051 */
1052 PreferredAvailabilityZones?: PreferredAvailabilityZoneList;
1053 /**
1054 * 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/.
1055 */
1056 NumCacheNodes?: IntegerOptional;
1057 /**
1058 * 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: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium 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 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge 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 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
1059 */
1060 CacheNodeType?: String;
1061 /**
1062 * The name of the cache engine to be used for this cluster. Valid values for this parameter are: memcached | redis
1063 */
1064 Engine?: String;
1065 /**
1066 * 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.
1067 */
1068 EngineVersion?: String;
1069 /**
1070 * 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.
1071 */
1072 CacheParameterGroupName?: String;
1073 /**
1074 * 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.
1075 */
1076 CacheSubnetGroupName?: String;
1077 /**
1078 * 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).
1079 */
1080 CacheSecurityGroupNames?: CacheSecurityGroupNameList;
1081 /**
1082 * 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).
1083 */
1084 SecurityGroupIds?: SecurityGroupIdsList;
1085 /**
1086 * A list of cost allocation tags to be added to this resource.
1087 */
1088 Tags?: TagList;
1089 /**
1090 * 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
1091 */
1092 SnapshotArns?: SnapshotArnsList;
1093 /**
1094 * 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.
1095 */
1096 SnapshotName?: String;
1097 /**
1098 * 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
1099 */
1100 PreferredMaintenanceWindow?: String;
1101 /**
1102 * The port number on which each of the cache nodes accepts connections.
1103 */
1104 Port?: IntegerOptional;
1105 /**
1106 * 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.
1107 */
1108 NotificationTopicArn?: String;
1109 /**
1110 * This parameter is currently disabled.
1111 */
1112 AutoMinorVersionUpgrade?: BooleanOptional;
1113 /**
1114 * 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).
1115 */
1116 SnapshotRetentionLimit?: IntegerOptional;
1117 /**
1118 * 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.
1119 */
1120 SnapshotWindow?: String;
1121 /**
1122 * 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. The only permitted printable special characters are !, &amp;, #, $, ^, &lt;, &gt;, and -. Other printable special characters cannot be used in the AUTH token. For more information, see AUTH password at http://redis.io/commands/AUTH.
1123 */
1124 AuthToken?: String;
1125 }
1126 export interface CreateCacheClusterResult {
1127 CacheCluster?: CacheCluster;
1128 }
1129 export interface CreateCacheParameterGroupMessage {
1130 /**
1131 * A user-specified name for the cache parameter group.
1132 */
1133 CacheParameterGroupName: String;
1134 /**
1135 * The name of the cache parameter group family that the cache parameter group can be used with. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
1136 */
1137 CacheParameterGroupFamily: String;
1138 /**
1139 * A user-specified description for the cache parameter group.
1140 */
1141 Description: String;
1142 }
1143 export interface CreateCacheParameterGroupResult {
1144 CacheParameterGroup?: CacheParameterGroup;
1145 }
1146 export interface CreateCacheSecurityGroupMessage {
1147 /**
1148 * 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
1149 */
1150 CacheSecurityGroupName: String;
1151 /**
1152 * A description for the cache security group.
1153 */
1154 Description: String;
1155 }
1156 export interface CreateCacheSecurityGroupResult {
1157 CacheSecurityGroup?: CacheSecurityGroup;
1158 }
1159 export interface CreateCacheSubnetGroupMessage {
1160 /**
1161 * 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
1162 */
1163 CacheSubnetGroupName: String;
1164 /**
1165 * A description for the cache subnet group.
1166 */
1167 CacheSubnetGroupDescription: String;
1168 /**
1169 * A list of VPC subnet IDs for the cache subnet group.
1170 */
1171 SubnetIds: SubnetIdentifierList;
1172 }
1173 export interface CreateCacheSubnetGroupResult {
1174 CacheSubnetGroup?: CacheSubnetGroup;
1175 }
1176 export interface CreateGlobalReplicationGroupMessage {
1177 /**
1178 * The suffix for name of a Global Datastore. The suffix guarantees uniqueness of the Global Datastore name across multiple regions.
1179 */
1180 GlobalReplicationGroupIdSuffix: String;
1181 /**
1182 * Provides details of the Global Datastore
1183 */
1184 GlobalReplicationGroupDescription?: String;
1185 /**
1186 * The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
1187 */
1188 PrimaryReplicationGroupId: String;
1189 }
1190 export interface CreateGlobalReplicationGroupResult {
1191 GlobalReplicationGroup?: GlobalReplicationGroup;
1192 }
1193 export interface CreateReplicationGroupMessage {
1194 /**
1195 * The replication group identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 40 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens.
1196 */
1197 ReplicationGroupId: String;
1198 /**
1199 * A user-created description for the replication group.
1200 */
1201 ReplicationGroupDescription: String;
1202 /**
1203 * The name of the Global Datastore
1204 */
1205 GlobalReplicationGroupId?: String;
1206 /**
1207 * 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.
1208 */
1209 PrimaryClusterId?: String;
1210 /**
1211 * 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 node types. Redis (cluster mode enabled): T1 node types.
1212 */
1213 AutomaticFailoverEnabled?: BooleanOptional;
1214 /**
1215 * 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).
1216 */
1217 NumCacheClusters?: IntegerOptional;
1218 /**
1219 * 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.
1220 */
1221 PreferredCacheClusterAZs?: AvailabilityZonesList;
1222 /**
1223 * 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
1224 */
1225 NumNodeGroups?: IntegerOptional;
1226 /**
1227 * An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
1228 */
1229 ReplicasPerNodeGroup?: IntegerOptional;
1230 /**
1231 * 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.
1232 */
1233 NodeGroupConfiguration?: NodeGroupConfigurationList;
1234 /**
1235 * 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: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium 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 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge 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 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
1236 */
1237 CacheNodeType?: String;
1238 /**
1239 * The name of the cache engine to be used for the clusters in this replication group.
1240 */
1241 Engine?: String;
1242 /**
1243 * 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.
1244 */
1245 EngineVersion?: String;
1246 /**
1247 * 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 restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0. 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.
1248 */
1249 CacheParameterGroupName?: String;
1250 /**
1251 * 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.
1252 */
1253 CacheSubnetGroupName?: String;
1254 /**
1255 * A list of cache security group names to associate with this replication group.
1256 */
1257 CacheSecurityGroupNames?: CacheSecurityGroupNameList;
1258 /**
1259 * 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).
1260 */
1261 SecurityGroupIds?: SecurityGroupIdsList;
1262 /**
1263 * A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
1264 */
1265 Tags?: TagList;
1266 /**
1267 * 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
1268 */
1269 SnapshotArns?: SnapshotArnsList;
1270 /**
1271 * 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.
1272 */
1273 SnapshotName?: String;
1274 /**
1275 * 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
1276 */
1277 PreferredMaintenanceWindow?: String;
1278 /**
1279 * The port number on which each member of the replication group accepts connections.
1280 */
1281 Port?: IntegerOptional;
1282 /**
1283 * 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.
1284 */
1285 NotificationTopicArn?: String;
1286 /**
1287 * This parameter is currently disabled.
1288 */
1289 AutoMinorVersionUpgrade?: BooleanOptional;
1290 /**
1291 * 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).
1292 */
1293 SnapshotRetentionLimit?: IntegerOptional;
1294 /**
1295 * 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.
1296 */
1297 SnapshotWindow?: String;
1298 /**
1299 * 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. The only permitted printable special characters are !, &amp;, #, $, ^, &lt;, &gt;, and -. Other printable special characters cannot be used in the AUTH token. For more information, see AUTH password at http://redis.io/commands/AUTH.
1300 */
1301 AuthToken?: String;
1302 /**
1303 * 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, 4.x or later, 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, 4.x or later. Default: false For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
1304 */
1305 TransitEncryptionEnabled?: BooleanOptional;
1306 /**
1307 * 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, 4.x or later. Default: false
1308 */
1309 AtRestEncryptionEnabled?: BooleanOptional;
1310 /**
1311 * The ID of the KMS key used to encrypt the disk in the cluster.
1312 */
1313 KmsKeyId?: String;
1314 }
1315 export interface CreateReplicationGroupResult {
1316 ReplicationGroup?: ReplicationGroup;
1317 }
1318 export interface CreateSnapshotMessage {
1319 /**
1320 * The identifier of an existing replication group. The snapshot is created from this replication group.
1321 */
1322 ReplicationGroupId?: String;
1323 /**
1324 * The identifier of an existing cluster. The snapshot is created from this cluster.
1325 */
1326 CacheClusterId?: String;
1327 /**
1328 * A name for the snapshot being created.
1329 */
1330 SnapshotName: String;
1331 /**
1332 * The ID of the KMS key used to encrypt the snapshot.
1333 */
1334 KmsKeyId?: String;
1335 }
1336 export interface CreateSnapshotResult {
1337 Snapshot?: Snapshot;
1338 }
1339 export interface CustomerNodeEndpoint {
1340 /**
1341 * The address of the node endpoint
1342 */
1343 Address?: String;
1344 /**
1345 * The port of the node endpoint
1346 */
1347 Port?: IntegerOptional;
1348 }
1349 export type CustomerNodeEndpointList = CustomerNodeEndpoint[];
1350 export interface DecreaseNodeGroupsInGlobalReplicationGroupMessage {
1351 /**
1352 * The name of the Global Datastore
1353 */
1354 GlobalReplicationGroupId: String;
1355 /**
1356 * The number of node groups (shards) that results from the modification of the shard configuration
1357 */
1358 NodeGroupCount: Integer;
1359 /**
1360 * If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
1361 */
1362 GlobalNodeGroupsToRemove?: GlobalNodeGroupIdList;
1363 /**
1364 * If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
1365 */
1366 GlobalNodeGroupsToRetain?: GlobalNodeGroupIdList;
1367 /**
1368 * Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
1369 */
1370 ApplyImmediately: Boolean;
1371 }
1372 export interface DecreaseNodeGroupsInGlobalReplicationGroupResult {
1373 GlobalReplicationGroup?: GlobalReplicationGroup;
1374 }
1375 export interface DecreaseReplicaCountMessage {
1376 /**
1377 * The id of the replication group from which you want to remove replica nodes.
1378 */
1379 ReplicationGroupId: String;
1380 /**
1381 * 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)
1382 */
1383 NewReplicaCount?: IntegerOptional;
1384 /**
1385 * 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.
1386 */
1387 ReplicaConfiguration?: ReplicaConfigurationList;
1388 /**
1389 * A list of the node ids to remove from the replication group or node group (shard).
1390 */
1391 ReplicasToRemove?: RemoveReplicasList;
1392 /**
1393 * If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.
1394 */
1395 ApplyImmediately: Boolean;
1396 }
1397 export interface DecreaseReplicaCountResult {
1398 ReplicationGroup?: ReplicationGroup;
1399 }
1400 export interface DeleteCacheClusterMessage {
1401 /**
1402 * The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
1403 */
1404 CacheClusterId: String;
1405 /**
1406 * 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.
1407 */
1408 FinalSnapshotIdentifier?: String;
1409 }
1410 export interface DeleteCacheClusterResult {
1411 CacheCluster?: CacheCluster;
1412 }
1413 export interface DeleteCacheParameterGroupMessage {
1414 /**
1415 * The name of the cache parameter group to delete. The specified cache security group must not be associated with any clusters.
1416 */
1417 CacheParameterGroupName: String;
1418 }
1419 export interface DeleteCacheSecurityGroupMessage {
1420 /**
1421 * The name of the cache security group to delete. You cannot delete the default security group.
1422 */
1423 CacheSecurityGroupName: String;
1424 }
1425 export interface DeleteCacheSubnetGroupMessage {
1426 /**
1427 * The name of the cache subnet group to delete. Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
1428 */
1429 CacheSubnetGroupName: String;
1430 }
1431 export interface DeleteGlobalReplicationGroupMessage {
1432 /**
1433 * The name of the Global Datastore
1434 */
1435 GlobalReplicationGroupId: String;
1436 /**
1437 * If set to true, the primary replication is retained as a standalone replication group.
1438 */
1439 RetainPrimaryReplicationGroup: Boolean;
1440 }
1441 export interface DeleteGlobalReplicationGroupResult {
1442 GlobalReplicationGroup?: GlobalReplicationGroup;
1443 }
1444 export interface DeleteReplicationGroupMessage {
1445 /**
1446 * The identifier for the cluster to be deleted. This parameter is not case sensitive.
1447 */
1448 ReplicationGroupId: String;
1449 /**
1450 * If set to true, all of the read replicas are deleted, but the primary node is retained.
1451 */
1452 RetainPrimaryCluster?: BooleanOptional;
1453 /**
1454 * 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.
1455 */
1456 FinalSnapshotIdentifier?: String;
1457 }
1458 export interface DeleteReplicationGroupResult {
1459 ReplicationGroup?: ReplicationGroup;
1460 }
1461 export interface DeleteSnapshotMessage {
1462 /**
1463 * The name of the snapshot to be deleted.
1464 */
1465 SnapshotName: String;
1466 }
1467 export interface DeleteSnapshotResult {
1468 Snapshot?: Snapshot;
1469 }
1470 export interface DescribeCacheClustersMessage {
1471 /**
1472 * The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.
1473 */
1474 CacheClusterId?: String;
1475 /**
1476 * 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.
1477 */
1478 MaxRecords?: IntegerOptional;
1479 /**
1480 * 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.
1481 */
1482 Marker?: String;
1483 /**
1484 * An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
1485 */
1486 ShowCacheNodeInfo?: BooleanOptional;
1487 /**
1488 * 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.
1489 */
1490 ShowCacheClustersNotInReplicationGroups?: BooleanOptional;
1491 }
1492 export interface DescribeCacheEngineVersionsMessage {
1493 /**
1494 * The cache engine to return. Valid values: memcached | redis
1495 */
1496 Engine?: String;
1497 /**
1498 * The cache engine version to return. Example: 1.4.14
1499 */
1500 EngineVersion?: String;
1501 /**
1502 * The name of a specific cache parameter group family to return details for. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.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
1503 */
1504 CacheParameterGroupFamily?: String;
1505 /**
1506 * 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.
1507 */
1508 MaxRecords?: IntegerOptional;
1509 /**
1510 * 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.
1511 */
1512 Marker?: String;
1513 /**
1514 * If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
1515 */
1516 DefaultOnly?: Boolean;
1517 }
1518 export interface DescribeCacheParameterGroupsMessage {
1519 /**
1520 * The name of a specific cache parameter group to return details for.
1521 */
1522 CacheParameterGroupName?: String;
1523 /**
1524 * 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.
1525 */
1526 MaxRecords?: IntegerOptional;
1527 /**
1528 * 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.
1529 */
1530 Marker?: String;
1531 }
1532 export interface DescribeCacheParametersMessage {
1533 /**
1534 * The name of a specific cache parameter group to return details for.
1535 */
1536 CacheParameterGroupName: String;
1537 /**
1538 * The parameter types to return. Valid values: user | system | engine-default
1539 */
1540 Source?: String;
1541 /**
1542 * 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.
1543 */
1544 MaxRecords?: IntegerOptional;
1545 /**
1546 * 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.
1547 */
1548 Marker?: String;
1549 }
1550 export interface DescribeCacheSecurityGroupsMessage {
1551 /**
1552 * The name of the cache security group to return details for.
1553 */
1554 CacheSecurityGroupName?: String;
1555 /**
1556 * 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.
1557 */
1558 MaxRecords?: IntegerOptional;
1559 /**
1560 * 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.
1561 */
1562 Marker?: String;
1563 }
1564 export interface DescribeCacheSubnetGroupsMessage {
1565 /**
1566 * The name of the cache subnet group to return details for.
1567 */
1568 CacheSubnetGroupName?: String;
1569 /**
1570 * 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.
1571 */
1572 MaxRecords?: IntegerOptional;
1573 /**
1574 * 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.
1575 */
1576 Marker?: String;
1577 }
1578 export interface DescribeEngineDefaultParametersMessage {
1579 /**
1580 * The name of the cache parameter group family. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
1581 */
1582 CacheParameterGroupFamily: String;
1583 /**
1584 * 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.
1585 */
1586 MaxRecords?: IntegerOptional;
1587 /**
1588 * 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.
1589 */
1590 Marker?: String;
1591 }
1592 export interface DescribeEngineDefaultParametersResult {
1593 EngineDefaults?: EngineDefaults;
1594 }
1595 export interface DescribeEventsMessage {
1596 /**
1597 * The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
1598 */
1599 SourceIdentifier?: String;
1600 /**
1601 * The event source to retrieve events for. If no value is specified, all events are returned.
1602 */
1603 SourceType?: SourceType;
1604 /**
1605 * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
1606 */
1607 StartTime?: TStamp;
1608 /**
1609 * The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
1610 */
1611 EndTime?: TStamp;
1612 /**
1613 * The number of minutes worth of events to retrieve.
1614 */
1615 Duration?: IntegerOptional;
1616 /**
1617 * 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.
1618 */
1619 MaxRecords?: IntegerOptional;
1620 /**
1621 * 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.
1622 */
1623 Marker?: String;
1624 }
1625 export interface DescribeGlobalReplicationGroupsMessage {
1626 /**
1627 * The name of the Global Datastore
1628 */
1629 GlobalReplicationGroupId?: String;
1630 /**
1631 * 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.
1632 */
1633 MaxRecords?: IntegerOptional;
1634 /**
1635 * 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.
1636 */
1637 Marker?: String;
1638 /**
1639 * Returns the list of members that comprise the Global Datastore.
1640 */
1641 ShowMemberInfo?: BooleanOptional;
1642 }
1643 export interface DescribeGlobalReplicationGroupsResult {
1644 /**
1645 * 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. &gt;
1646 */
1647 Marker?: String;
1648 /**
1649 * Indicates the slot configuration and global identifier for each slice group.
1650 */
1651 GlobalReplicationGroups?: GlobalReplicationGroupList;
1652 }
1653 export interface DescribeReplicationGroupsMessage {
1654 /**
1655 * 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.
1656 */
1657 ReplicationGroupId?: String;
1658 /**
1659 * 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.
1660 */
1661 MaxRecords?: IntegerOptional;
1662 /**
1663 * 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.
1664 */
1665 Marker?: String;
1666 }
1667 export interface DescribeReservedCacheNodesMessage {
1668 /**
1669 * The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
1670 */
1671 ReservedCacheNodeId?: String;
1672 /**
1673 * The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
1674 */
1675 ReservedCacheNodesOfferingId?: String;
1676 /**
1677 * 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: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium 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 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge 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 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
1678 */
1679 CacheNodeType?: String;
1680 /**
1681 * 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
1682 */
1683 Duration?: String;
1684 /**
1685 * The product description filter value. Use this parameter to show only those reservations matching the specified product description.
1686 */
1687 ProductDescription?: String;
1688 /**
1689 * 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"
1690 */
1691 OfferingType?: String;
1692 /**
1693 * 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.
1694 */
1695 MaxRecords?: IntegerOptional;
1696 /**
1697 * 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.
1698 */
1699 Marker?: String;
1700 }
1701 export interface DescribeReservedCacheNodesOfferingsMessage {
1702 /**
1703 * 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
1704 */
1705 ReservedCacheNodesOfferingId?: String;
1706 /**
1707 * 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: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium 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 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge 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 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
1708 */
1709 CacheNodeType?: String;
1710 /**
1711 * 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
1712 */
1713 Duration?: String;
1714 /**
1715 * The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
1716 */
1717 ProductDescription?: String;
1718 /**
1719 * 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"
1720 */
1721 OfferingType?: String;
1722 /**
1723 * 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.
1724 */
1725 MaxRecords?: IntegerOptional;
1726 /**
1727 * 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.
1728 */
1729 Marker?: String;
1730 }
1731 export interface DescribeServiceUpdatesMessage {
1732 /**
1733 * The unique ID of the service update
1734 */
1735 ServiceUpdateName?: String;
1736 /**
1737 * The status of the service update
1738 */
1739 ServiceUpdateStatus?: ServiceUpdateStatusList;
1740 /**
1741 * The maximum number of records to include in the response
1742 */
1743 MaxRecords?: IntegerOptional;
1744 /**
1745 * 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.
1746 */
1747 Marker?: String;
1748 }
1749 export interface DescribeSnapshotsListMessage {
1750 /**
1751 * 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.
1752 */
1753 Marker?: String;
1754 /**
1755 * A list of snapshots. Each item in the list contains detailed information about one snapshot.
1756 */
1757 Snapshots?: SnapshotList;
1758 }
1759 export interface DescribeSnapshotsMessage {
1760 /**
1761 * A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
1762 */
1763 ReplicationGroupId?: String;
1764 /**
1765 * A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
1766 */
1767 CacheClusterId?: String;
1768 /**
1769 * A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
1770 */
1771 SnapshotName?: String;
1772 /**
1773 * 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.
1774 */
1775 SnapshotSource?: String;
1776 /**
1777 * 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.
1778 */
1779 Marker?: String;
1780 /**
1781 * 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.
1782 */
1783 MaxRecords?: IntegerOptional;
1784 /**
1785 * A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
1786 */
1787 ShowNodeGroupConfig?: BooleanOptional;
1788 }
1789 export interface DescribeUpdateActionsMessage {
1790 /**
1791 * The unique ID of the service update
1792 */
1793 ServiceUpdateName?: String;
1794 /**
1795 * The replication group IDs
1796 */
1797 ReplicationGroupIds?: ReplicationGroupIdList;
1798 /**
1799 * The cache cluster IDs
1800 */
1801 CacheClusterIds?: CacheClusterIdList;
1802 /**
1803 * The Elasticache engine to which the update applies. Either Redis or Memcached
1804 */
1805 Engine?: String;
1806 /**
1807 * The status of the service update
1808 */
1809 ServiceUpdateStatus?: ServiceUpdateStatusList;
1810 /**
1811 * The range of time specified to search for service updates that are in available status
1812 */
1813 ServiceUpdateTimeRange?: TimeRangeFilter;
1814 /**
1815 * The status of the update action.
1816 */
1817 UpdateActionStatus?: UpdateActionStatusList;
1818 /**
1819 * Dictates whether to include node level update status in the response
1820 */
1821 ShowNodeLevelUpdateStatus?: BooleanOptional;
1822 /**
1823 * The maximum number of records to include in the response
1824 */
1825 MaxRecords?: IntegerOptional;
1826 /**
1827 * 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.
1828 */
1829 Marker?: String;
1830 }
1831 export interface DisassociateGlobalReplicationGroupMessage {
1832 /**
1833 * The name of the Global Datastore
1834 */
1835 GlobalReplicationGroupId: String;
1836 /**
1837 * The name of the secondary cluster you wish to remove from the Global Datastore
1838 */
1839 ReplicationGroupId: String;
1840 /**
1841 * The AWS region of secondary cluster you wish to remove from the Global Datastore
1842 */
1843 ReplicationGroupRegion: String;
1844 }
1845 export interface DisassociateGlobalReplicationGroupResult {
1846 GlobalReplicationGroup?: GlobalReplicationGroup;
1847 }
1848 export type Double = number;
1849 export interface EC2SecurityGroup {
1850 /**
1851 * The status of the Amazon EC2 security group.
1852 */
1853 Status?: String;
1854 /**
1855 * The name of the Amazon EC2 security group.
1856 */
1857 EC2SecurityGroupName?: String;
1858 /**
1859 * The AWS account ID of the Amazon EC2 security group owner.
1860 */
1861 EC2SecurityGroupOwnerId?: String;
1862 }
1863 export type EC2SecurityGroupList = EC2SecurityGroup[];
1864 export interface Endpoint {
1865 /**
1866 * The DNS hostname of the cache node.
1867 */
1868 Address?: String;
1869 /**
1870 * The port number that the cache engine is listening on.
1871 */
1872 Port?: Integer;
1873 }
1874 export interface EngineDefaults {
1875 /**
1876 * Specifies the name of the cache parameter group family to which the engine default parameters apply. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
1877 */
1878 CacheParameterGroupFamily?: String;
1879 /**
1880 * Provides an identifier to allow retrieval of paginated results.
1881 */
1882 Marker?: String;
1883 /**
1884 * Contains a list of engine default parameters.
1885 */
1886 Parameters?: ParametersList;
1887 /**
1888 * A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
1889 */
1890 CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList;
1891 }
1892 export interface Event {
1893 /**
1894 * 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.
1895 */
1896 SourceIdentifier?: String;
1897 /**
1898 * Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
1899 */
1900 SourceType?: SourceType;
1901 /**
1902 * The text of the event.
1903 */
1904 Message?: String;
1905 /**
1906 * The date and time when the event occurred.
1907 */
1908 Date?: TStamp;
1909 }
1910 export type EventList = Event[];
1911 export interface EventsMessage {
1912 /**
1913 * Provides an identifier to allow retrieval of paginated results.
1914 */
1915 Marker?: String;
1916 /**
1917 * A list of events. Each element in the list contains detailed information about one event.
1918 */
1919 Events?: EventList;
1920 }
1921 export interface FailoverGlobalReplicationGroupMessage {
1922 /**
1923 * The name of the Global Datastore
1924 */
1925 GlobalReplicationGroupId: String;
1926 /**
1927 * The AWS region of the primary cluster of the Global Datastore
1928 */
1929 PrimaryRegion: String;
1930 /**
1931 * The name of the primary replication group
1932 */
1933 PrimaryReplicationGroupId: String;
1934 }
1935 export interface FailoverGlobalReplicationGroupResult {
1936 GlobalReplicationGroup?: GlobalReplicationGroup;
1937 }
1938 export interface GlobalNodeGroup {
1939 /**
1940 * The name of the global node group
1941 */
1942 GlobalNodeGroupId?: String;
1943 /**
1944 * The keyspace for this node group
1945 */
1946 Slots?: String;
1947 }
1948 export type GlobalNodeGroupIdList = String[];
1949 export type GlobalNodeGroupList = GlobalNodeGroup[];
1950 export interface GlobalReplicationGroup {
1951 /**
1952 * The name of the Global Datastore
1953 */
1954 GlobalReplicationGroupId?: String;
1955 /**
1956 * The optional description of the Global Datastore
1957 */
1958 GlobalReplicationGroupDescription?: String;
1959 /**
1960 * The status of the Global Datastore
1961 */
1962 Status?: String;
1963 /**
1964 * The cache node type of the Global Datastore
1965 */
1966 CacheNodeType?: String;
1967 /**
1968 * The Elasticache engine. For preview, it is Redis only.
1969 */
1970 Engine?: String;
1971 /**
1972 * The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 only.
1973 */
1974 EngineVersion?: String;
1975 /**
1976 * The replication groups that comprise the Global Datastore.
1977 */
1978 Members?: GlobalReplicationGroupMemberList;
1979 /**
1980 * A flag that indicates whether the Global Datastore is cluster enabled.
1981 */
1982 ClusterEnabled?: BooleanOptional;
1983 /**
1984 * Indicates the slot configuration and global identifier for each slice group.
1985 */
1986 GlobalNodeGroups?: GlobalNodeGroupList;
1987 /**
1988 * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false
1989 */
1990 AuthTokenEnabled?: BooleanOptional;
1991 /**
1992 * 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.
1993 */
1994 TransitEncryptionEnabled?: BooleanOptional;
1995 /**
1996 * 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, 4.x or later.
1997 */
1998 AtRestEncryptionEnabled?: BooleanOptional;
1999 }
2000 export interface GlobalReplicationGroupInfo {
2001 /**
2002 * The name of the Global Datastore
2003 */
2004 GlobalReplicationGroupId?: String;
2005 /**
2006 * The role of the replication group in a Global Datastore. Can be primary or secondary.
2007 */
2008 GlobalReplicationGroupMemberRole?: String;
2009 }
2010 export type GlobalReplicationGroupList = GlobalReplicationGroup[];
2011 export interface GlobalReplicationGroupMember {
2012 /**
2013 * The replication group id of the Global Datastore member.
2014 */
2015 ReplicationGroupId?: String;
2016 /**
2017 * The AWS region of the Global Datastore member.
2018 */
2019 ReplicationGroupRegion?: String;
2020 /**
2021 * Indicates the role of the replication group, primary or secondary.
2022 */
2023 Role?: String;
2024 /**
2025 * Indicates whether automatic failover is enabled for the replication group.
2026 */
2027 AutomaticFailover?: AutomaticFailoverStatus;
2028 /**
2029 * The status of the membership of the replication group.
2030 */
2031 Status?: String;
2032 }
2033 export type GlobalReplicationGroupMemberList = GlobalReplicationGroupMember[];
2034 export interface IncreaseNodeGroupsInGlobalReplicationGroupMessage {
2035 /**
2036 * The name of the Global Datastore
2037 */
2038 GlobalReplicationGroupId: String;
2039 /**
2040 * The number of node groups you wish to add
2041 */
2042 NodeGroupCount: Integer;
2043 /**
2044 * Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore
2045 */
2046 RegionalConfigurations?: RegionalConfigurationList;
2047 /**
2048 * Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.
2049 */
2050 ApplyImmediately: Boolean;
2051 }
2052 export interface IncreaseNodeGroupsInGlobalReplicationGroupResult {
2053 GlobalReplicationGroup?: GlobalReplicationGroup;
2054 }
2055 export interface IncreaseReplicaCountMessage {
2056 /**
2057 * The id of the replication group to which you want to add replica nodes.
2058 */
2059 ReplicationGroupId: String;
2060 /**
2061 * 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.
2062 */
2063 NewReplicaCount?: IntegerOptional;
2064 /**
2065 * 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.
2066 */
2067 ReplicaConfiguration?: ReplicaConfigurationList;
2068 /**
2069 * If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.
2070 */
2071 ApplyImmediately: Boolean;
2072 }
2073 export interface IncreaseReplicaCountResult {
2074 ReplicationGroup?: ReplicationGroup;
2075 }
2076 export type Integer = number;
2077 export type IntegerOptional = number;
2078 export type KeyList = String[];
2079 export interface ListAllowedNodeTypeModificationsMessage {
2080 /**
2081 * 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.
2082 */
2083 CacheClusterId?: String;
2084 /**
2085 * 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.
2086 */
2087 ReplicationGroupId?: String;
2088 }
2089 export interface ListTagsForResourceMessage {
2090 /**
2091 * 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.
2092 */
2093 ResourceName: String;
2094 }
2095 export interface ModifyCacheClusterMessage {
2096 /**
2097 * The cluster identifier. This value is stored as a lowercase string.
2098 */
2099 CacheClusterId: String;
2100 /**
2101 * 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.
2102 */
2103 NumCacheNodes?: IntegerOptional;
2104 /**
2105 * 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.
2106 */
2107 CacheNodeIdsToRemove?: CacheNodeIdsList;
2108 /**
2109 * 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.
2110 */
2111 AZMode?: AZMode;
2112 /**
2113 * 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.
2114 */
2115 NewAvailabilityZones?: PreferredAvailabilityZoneList;
2116 /**
2117 * 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".
2118 */
2119 CacheSecurityGroupNames?: CacheSecurityGroupNameList;
2120 /**
2121 * 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).
2122 */
2123 SecurityGroupIds?: SecurityGroupIdsList;
2124 /**
2125 * 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
2126 */
2127 PreferredMaintenanceWindow?: String;
2128 /**
2129 * 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.
2130 */
2131 NotificationTopicArn?: String;
2132 /**
2133 * 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.
2134 */
2135 CacheParameterGroupName?: String;
2136 /**
2137 * The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. Valid values: active | inactive
2138 */
2139 NotificationTopicStatus?: String;
2140 /**
2141 * 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
2142 */
2143 ApplyImmediately?: Boolean;
2144 /**
2145 * 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.
2146 */
2147 EngineVersion?: String;
2148 /**
2149 * This parameter is currently disabled.
2150 */
2151 AutoMinorVersionUpgrade?: BooleanOptional;
2152 /**
2153 * 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.
2154 */
2155 SnapshotRetentionLimit?: IntegerOptional;
2156 /**
2157 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
2158 */
2159 SnapshotWindow?: String;
2160 /**
2161 * A valid cache node type that you want to scale this cluster up to.
2162 */
2163 CacheNodeType?: String;
2164 /**
2165 * Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. 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 AUTH.
2166 */
2167 AuthToken?: String;
2168 /**
2169 * Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values: Rotate Set For more information, see Authenticating Users with Redis AUTH
2170 */
2171 AuthTokenUpdateStrategy?: AuthTokenUpdateStrategyType;
2172 }
2173 export interface ModifyCacheClusterResult {
2174 CacheCluster?: CacheCluster;
2175 }
2176 export interface ModifyCacheParameterGroupMessage {
2177 /**
2178 * The name of the cache parameter group to modify.
2179 */
2180 CacheParameterGroupName: String;
2181 /**
2182 * 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.
2183 */
2184 ParameterNameValues: ParameterNameValueList;
2185 }
2186 export interface ModifyCacheSubnetGroupMessage {
2187 /**
2188 * 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
2189 */
2190 CacheSubnetGroupName: String;
2191 /**
2192 * A description of the cache subnet group.
2193 */
2194 CacheSubnetGroupDescription?: String;
2195 /**
2196 * The EC2 subnet IDs for the cache subnet group.
2197 */
2198 SubnetIds?: SubnetIdentifierList;
2199 }
2200 export interface ModifyCacheSubnetGroupResult {
2201 CacheSubnetGroup?: CacheSubnetGroup;
2202 }
2203 export interface ModifyGlobalReplicationGroupMessage {
2204 /**
2205 * The name of the Global Datastore
2206 */
2207 GlobalReplicationGroupId: String;
2208 /**
2209 * 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.
2210 */
2211 ApplyImmediately: Boolean;
2212 /**
2213 * A valid cache node type that you want to scale this Global Datastore to.
2214 */
2215 CacheNodeType?: String;
2216 /**
2217 * The upgraded version of the cache engine to be run on the clusters in the Global Datastore.
2218 */
2219 EngineVersion?: String;
2220 /**
2221 * A description of the Global Datastore
2222 */
2223 GlobalReplicationGroupDescription?: String;
2224 /**
2225 * Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
2226 */
2227 AutomaticFailoverEnabled?: BooleanOptional;
2228 }
2229 export interface ModifyGlobalReplicationGroupResult {
2230 GlobalReplicationGroup?: GlobalReplicationGroup;
2231 }
2232 export interface ModifyReplicationGroupMessage {
2233 /**
2234 * The identifier of the replication group to modify.
2235 */
2236 ReplicationGroupId: String;
2237 /**
2238 * A description for the replication group. Maximum length is 255 characters.
2239 */
2240 ReplicationGroupDescription?: String;
2241 /**
2242 * 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.
2243 */
2244 PrimaryClusterId?: String;
2245 /**
2246 * 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.
2247 */
2248 SnapshottingClusterId?: String;
2249 /**
2250 * 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 node types. Redis (cluster mode enabled): T1 node types.
2251 */
2252 AutomaticFailoverEnabled?: BooleanOptional;
2253 /**
2254 * Deprecated. This parameter is not used.
2255 */
2256 NodeGroupId?: String;
2257 /**
2258 * 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.
2259 */
2260 CacheSecurityGroupNames?: CacheSecurityGroupNameList;
2261 /**
2262 * 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).
2263 */
2264 SecurityGroupIds?: SecurityGroupIdsList;
2265 /**
2266 * 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
2267 */
2268 PreferredMaintenanceWindow?: String;
2269 /**
2270 * 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.
2271 */
2272 NotificationTopicArn?: String;
2273 /**
2274 * 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.
2275 */
2276 CacheParameterGroupName?: String;
2277 /**
2278 * 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
2279 */
2280 NotificationTopicStatus?: String;
2281 /**
2282 * 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
2283 */
2284 ApplyImmediately?: Boolean;
2285 /**
2286 * 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.
2287 */
2288 EngineVersion?: String;
2289 /**
2290 * This parameter is currently disabled.
2291 */
2292 AutoMinorVersionUpgrade?: BooleanOptional;
2293 /**
2294 * 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.
2295 */
2296 SnapshotRetentionLimit?: IntegerOptional;
2297 /**
2298 * 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.
2299 */
2300 SnapshotWindow?: String;
2301 /**
2302 * A valid cache node type that you want to scale this replication group to.
2303 */
2304 CacheNodeType?: String;
2305 /**
2306 * Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. 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 AUTH.
2307 */
2308 AuthToken?: String;
2309 /**
2310 * Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values: Rotate Set For more information, see Authenticating Users with Redis AUTH
2311 */
2312 AuthTokenUpdateStrategy?: AuthTokenUpdateStrategyType;
2313 }
2314 export interface ModifyReplicationGroupResult {
2315 ReplicationGroup?: ReplicationGroup;
2316 }
2317 export interface ModifyReplicationGroupShardConfigurationMessage {
2318 /**
2319 * The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
2320 */
2321 ReplicationGroupId: String;
2322 /**
2323 * The number of node groups (shards) that results from the modification of the shard configuration.
2324 */
2325 NodeGroupCount: Integer;
2326 /**
2327 * Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. Value: true
2328 */
2329 ApplyImmediately: Boolean;
2330 /**
2331 * 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).
2332 */
2333 ReshardingConfiguration?: ReshardingConfigurationList;
2334 /**
2335 * If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
2336 */
2337 NodeGroupsToRemove?: NodeGroupsToRemoveList;
2338 /**
2339 * If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster. ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.
2340 */
2341 NodeGroupsToRetain?: NodeGroupsToRetainList;
2342 }
2343 export interface ModifyReplicationGroupShardConfigurationResult {
2344 ReplicationGroup?: ReplicationGroup;
2345 }
2346 export interface NodeGroup {
2347 /**
2348 * 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 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
2349 */
2350 NodeGroupId?: String;
2351 /**
2352 * The current state of this replication group - creating, available, etc.
2353 */
2354 Status?: String;
2355 /**
2356 * The endpoint of the primary node in this node group (shard).
2357 */
2358 PrimaryEndpoint?: Endpoint;
2359 /**
2360 * The endpoint of the replica nodes in this node group (shard).
2361 */
2362 ReaderEndpoint?: Endpoint;
2363 /**
2364 * The keyspace for this node group (shard).
2365 */
2366 Slots?: String;
2367 /**
2368 * A list containing information about individual nodes within the node group (shard).
2369 */
2370 NodeGroupMembers?: NodeGroupMemberList;
2371 }
2372 export interface NodeGroupConfiguration {
2373 /**
2374 * Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
2375 */
2376 NodeGroupId?: AllowedNodeGroupId;
2377 /**
2378 * 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"
2379 */
2380 Slots?: String;
2381 /**
2382 * The number of read replica nodes in this node group (shard).
2383 */
2384 ReplicaCount?: IntegerOptional;
2385 /**
2386 * The Availability Zone where the primary node of this node group (shard) is launched.
2387 */
2388 PrimaryAvailabilityZone?: String;
2389 /**
2390 * 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.
2391 */
2392 ReplicaAvailabilityZones?: AvailabilityZonesList;
2393 }
2394 export type NodeGroupConfigurationList = NodeGroupConfiguration[];
2395 export type NodeGroupList = NodeGroup[];
2396 export interface NodeGroupMember {
2397 /**
2398 * The ID of the cluster to which the node belongs.
2399 */
2400 CacheClusterId?: String;
2401 /**
2402 * The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
2403 */
2404 CacheNodeId?: String;
2405 /**
2406 * 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.
2407 */
2408 ReadEndpoint?: Endpoint;
2409 /**
2410 * The name of the Availability Zone in which the node is located.
2411 */
2412 PreferredAvailabilityZone?: String;
2413 /**
2414 * The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
2415 */
2416 CurrentRole?: String;
2417 }
2418 export type NodeGroupMemberList = NodeGroupMember[];
2419 export interface NodeGroupMemberUpdateStatus {
2420 /**
2421 * The cache cluster ID
2422 */
2423 CacheClusterId?: String;
2424 /**
2425 * The node ID of the cache cluster
2426 */
2427 CacheNodeId?: String;
2428 /**
2429 * The update status of the node
2430 */
2431 NodeUpdateStatus?: NodeUpdateStatus;
2432 /**
2433 * The deletion date of the node
2434 */
2435 NodeDeletionDate?: TStamp;
2436 /**
2437 * The start date of the update for a node
2438 */
2439 NodeUpdateStartDate?: TStamp;
2440 /**
2441 * The end date of the update for a node
2442 */
2443 NodeUpdateEndDate?: TStamp;
2444 /**
2445 * Reflects whether the update was initiated by the customer or automatically applied
2446 */
2447 NodeUpdateInitiatedBy?: NodeUpdateInitiatedBy;
2448 /**
2449 * The date when the update is triggered
2450 */
2451 NodeUpdateInitiatedDate?: TStamp;
2452 /**
2453 * The date when the NodeUpdateStatus was last modified
2454 */
2455 NodeUpdateStatusModifiedDate?: TStamp;
2456 }
2457 export type NodeGroupMemberUpdateStatusList = NodeGroupMemberUpdateStatus[];
2458 export interface NodeGroupUpdateStatus {
2459 /**
2460 * The ID of the node group
2461 */
2462 NodeGroupId?: String;
2463 /**
2464 * The status of the service update on the node group member
2465 */
2466 NodeGroupMemberUpdateStatus?: NodeGroupMemberUpdateStatusList;
2467 }
2468 export type NodeGroupUpdateStatusList = NodeGroupUpdateStatus[];
2469 export type NodeGroupsToRemoveList = AllowedNodeGroupId[];
2470 export type NodeGroupsToRetainList = AllowedNodeGroupId[];
2471 export interface NodeSnapshot {
2472 /**
2473 * A unique identifier for the source cluster.
2474 */
2475 CacheClusterId?: String;
2476 /**
2477 * A unique identifier for the source node group (shard).
2478 */
2479 NodeGroupId?: String;
2480 /**
2481 * The cache node identifier for the node in the source cluster.
2482 */
2483 CacheNodeId?: String;
2484 /**
2485 * The configuration for the source node group (shard).
2486 */
2487 NodeGroupConfiguration?: NodeGroupConfiguration;
2488 /**
2489 * The size of the cache on the source cache node.
2490 */
2491 CacheSize?: String;
2492 /**
2493 * The date and time when the cache node was created in the source cluster.
2494 */
2495 CacheNodeCreateTime?: TStamp;
2496 /**
2497 * The date and time when the source node's metadata and cache data set was obtained for the snapshot.
2498 */
2499 SnapshotCreateTime?: TStamp;
2500 }
2501 export type NodeSnapshotList = NodeSnapshot[];
2502 export type NodeTypeList = String[];
2503 export type NodeUpdateInitiatedBy = "system"|"customer"|string;
2504 export type NodeUpdateStatus = "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete"|string;
2505 export interface NotificationConfiguration {
2506 /**
2507 * The Amazon Resource Name (ARN) that identifies the topic.
2508 */
2509 TopicArn?: String;
2510 /**
2511 * The current state of the topic.
2512 */
2513 TopicStatus?: String;
2514 }
2515 export interface Parameter {
2516 /**
2517 * The name of the parameter.
2518 */
2519 ParameterName?: String;
2520 /**
2521 * The value of the parameter.
2522 */
2523 ParameterValue?: String;
2524 /**
2525 * A description of the parameter.
2526 */
2527 Description?: String;
2528 /**
2529 * The source of the parameter.
2530 */
2531 Source?: String;
2532 /**
2533 * The valid data type for the parameter.
2534 */
2535 DataType?: String;
2536 /**
2537 * The valid range of values for the parameter.
2538 */
2539 AllowedValues?: String;
2540 /**
2541 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
2542 */
2543 IsModifiable?: Boolean;
2544 /**
2545 * The earliest cache engine version to which the parameter can apply.
2546 */
2547 MinimumEngineVersion?: String;
2548 /**
2549 * 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.
2550 */
2551 ChangeType?: ChangeType;
2552 }
2553 export interface ParameterNameValue {
2554 /**
2555 * The name of the parameter.
2556 */
2557 ParameterName?: String;
2558 /**
2559 * The value of the parameter.
2560 */
2561 ParameterValue?: String;
2562 }
2563 export type ParameterNameValueList = ParameterNameValue[];
2564 export type ParametersList = Parameter[];
2565 export type PendingAutomaticFailoverStatus = "enabled"|"disabled"|string;
2566 export interface PendingModifiedValues {
2567 /**
2568 * 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.
2569 */
2570 NumCacheNodes?: IntegerOptional;
2571 /**
2572 * 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.).
2573 */
2574 CacheNodeIdsToRemove?: CacheNodeIdsList;
2575 /**
2576 * The new cache engine version that the cluster runs.
2577 */
2578 EngineVersion?: String;
2579 /**
2580 * The cache node type that this cluster or replication group is scaled to.
2581 */
2582 CacheNodeType?: String;
2583 /**
2584 * The auth token status
2585 */
2586 AuthTokenStatus?: AuthTokenUpdateStatus;
2587 }
2588 export type PreferredAvailabilityZoneList = String[];
2589 export interface ProcessedUpdateAction {
2590 /**
2591 * The ID of the replication group
2592 */
2593 ReplicationGroupId?: String;
2594 /**
2595 * The ID of the cache cluster
2596 */
2597 CacheClusterId?: String;
2598 /**
2599 * The unique ID of the service update
2600 */
2601 ServiceUpdateName?: String;
2602 /**
2603 * The status of the update action on the Redis cluster
2604 */
2605 UpdateActionStatus?: UpdateActionStatus;
2606 }
2607 export type ProcessedUpdateActionList = ProcessedUpdateAction[];
2608 export interface PurchaseReservedCacheNodesOfferingMessage {
2609 /**
2610 * The ID of the reserved cache node offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
2611 */
2612 ReservedCacheNodesOfferingId: String;
2613 /**
2614 * 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
2615 */
2616 ReservedCacheNodeId?: String;
2617 /**
2618 * The number of cache node instances to reserve. Default: 1
2619 */
2620 CacheNodeCount?: IntegerOptional;
2621 }
2622 export interface PurchaseReservedCacheNodesOfferingResult {
2623 ReservedCacheNode?: ReservedCacheNode;
2624 }
2625 export interface RebalanceSlotsInGlobalReplicationGroupMessage {
2626 /**
2627 * The name of the Global Datastore
2628 */
2629 GlobalReplicationGroupId: String;
2630 /**
2631 * If True, redistribution is applied immediately.
2632 */
2633 ApplyImmediately: Boolean;
2634 }
2635 export interface RebalanceSlotsInGlobalReplicationGroupResult {
2636 GlobalReplicationGroup?: GlobalReplicationGroup;
2637 }
2638 export interface RebootCacheClusterMessage {
2639 /**
2640 * The cluster identifier. This parameter is stored as a lowercase string.
2641 */
2642 CacheClusterId: String;
2643 /**
2644 * 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.
2645 */
2646 CacheNodeIdsToReboot: CacheNodeIdsList;
2647 }
2648 export interface RebootCacheClusterResult {
2649 CacheCluster?: CacheCluster;
2650 }
2651 export interface RecurringCharge {
2652 /**
2653 * The monetary amount of the recurring charge.
2654 */
2655 RecurringChargeAmount?: Double;
2656 /**
2657 * The frequency of the recurring charge.
2658 */
2659 RecurringChargeFrequency?: String;
2660 }
2661 export type RecurringChargeList = RecurringCharge[];
2662 export interface RegionalConfiguration {
2663 /**
2664 * The name of the secondary cluster
2665 */
2666 ReplicationGroupId: String;
2667 /**
2668 * The AWS region where the cluster is stored
2669 */
2670 ReplicationGroupRegion: String;
2671 /**
2672 * A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
2673 */
2674 ReshardingConfiguration: ReshardingConfigurationList;
2675 }
2676 export type RegionalConfigurationList = RegionalConfiguration[];
2677 export type RemoveReplicasList = String[];
2678 export interface RemoveTagsFromResourceMessage {
2679 /**
2680 * 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.
2681 */
2682 ResourceName: String;
2683 /**
2684 * A list of TagKeys identifying the tags you want removed from the named resource.
2685 */
2686 TagKeys: KeyList;
2687 }
2688 export type ReplicaConfigurationList = ConfigureShard[];
2689 export interface ReplicationGroup {
2690 /**
2691 * The identifier for the replication group.
2692 */
2693 ReplicationGroupId?: String;
2694 /**
2695 * The user supplied description of the replication group.
2696 */
2697 Description?: String;
2698 /**
2699 * The name of the Global Datastore and role of this replication group in the Global Datastore.
2700 */
2701 GlobalReplicationGroupInfo?: GlobalReplicationGroupInfo;
2702 /**
2703 * The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
2704 */
2705 Status?: String;
2706 /**
2707 * A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
2708 */
2709 PendingModifiedValues?: ReplicationGroupPendingModifiedValues;
2710 /**
2711 * The names of all the cache clusters that are part of this replication group.
2712 */
2713 MemberClusters?: ClusterIdList;
2714 /**
2715 * 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).
2716 */
2717 NodeGroups?: NodeGroupList;
2718 /**
2719 * The cluster ID that is used as the daily snapshot source for the replication group.
2720 */
2721 SnapshottingClusterId?: String;
2722 /**
2723 * 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 node types. Redis (cluster mode enabled): T1 node types.
2724 */
2725 AutomaticFailover?: AutomaticFailoverStatus;
2726 /**
2727 * The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
2728 */
2729 ConfigurationEndpoint?: Endpoint;
2730 /**
2731 * 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.
2732 */
2733 SnapshotRetentionLimit?: IntegerOptional;
2734 /**
2735 * 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.
2736 */
2737 SnapshotWindow?: String;
2738 /**
2739 * 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
2740 */
2741 ClusterEnabled?: BooleanOptional;
2742 /**
2743 * The name of the compute and memory capacity node type for each node in the replication group.
2744 */
2745 CacheNodeType?: String;
2746 /**
2747 * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false
2748 */
2749 AuthTokenEnabled?: BooleanOptional;
2750 /**
2751 * The date the auth token was last modified
2752 */
2753 AuthTokenLastModifiedDate?: TStamp;
2754 /**
2755 * 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, 4.x or later. Default: false
2756 */
2757 TransitEncryptionEnabled?: BooleanOptional;
2758 /**
2759 * 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, 4.x or later. Default: false
2760 */
2761 AtRestEncryptionEnabled?: BooleanOptional;
2762 /**
2763 * The ID of the KMS key used to encrypt the disk in the cluster.
2764 */
2765 KmsKeyId?: String;
2766 }
2767 export type ReplicationGroupIdList = String[];
2768 export type ReplicationGroupList = ReplicationGroup[];
2769 export interface ReplicationGroupMessage {
2770 /**
2771 * Provides an identifier to allow retrieval of paginated results.
2772 */
2773 Marker?: String;
2774 /**
2775 * A list of replication groups. Each item in the list contains detailed information about one replication group.
2776 */
2777 ReplicationGroups?: ReplicationGroupList;
2778 }
2779 export interface ReplicationGroupPendingModifiedValues {
2780 /**
2781 * The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
2782 */
2783 PrimaryClusterId?: String;
2784 /**
2785 * 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 node types. Redis (cluster mode enabled): T1 node types.
2786 */
2787 AutomaticFailoverStatus?: PendingAutomaticFailoverStatus;
2788 /**
2789 * The status of an online resharding operation.
2790 */
2791 Resharding?: ReshardingStatus;
2792 /**
2793 * The auth token status
2794 */
2795 AuthTokenStatus?: AuthTokenUpdateStatus;
2796 }
2797 export interface ReservedCacheNode {
2798 /**
2799 * The unique identifier for the reservation.
2800 */
2801 ReservedCacheNodeId?: String;
2802 /**
2803 * The offering identifier.
2804 */
2805 ReservedCacheNodesOfferingId?: String;
2806 /**
2807 * 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: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium 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 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge 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 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
2808 */
2809 CacheNodeType?: String;
2810 /**
2811 * The time the reservation started.
2812 */
2813 StartTime?: TStamp;
2814 /**
2815 * The duration of the reservation in seconds.
2816 */
2817 Duration?: Integer;
2818 /**
2819 * The fixed price charged for this reserved cache node.
2820 */
2821 FixedPrice?: Double;
2822 /**
2823 * The hourly price charged for this reserved cache node.
2824 */
2825 UsagePrice?: Double;
2826 /**
2827 * The number of cache nodes that have been reserved.
2828 */
2829 CacheNodeCount?: Integer;
2830 /**
2831 * The description of the reserved cache node.
2832 */
2833 ProductDescription?: String;
2834 /**
2835 * The offering type of this reserved cache node.
2836 */
2837 OfferingType?: String;
2838 /**
2839 * The state of the reserved cache node.
2840 */
2841 State?: String;
2842 /**
2843 * The recurring price charged to run this reserved cache node.
2844 */
2845 RecurringCharges?: RecurringChargeList;
2846 /**
2847 * 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
2848 */
2849 ReservationARN?: String;
2850 }
2851 export type ReservedCacheNodeList = ReservedCacheNode[];
2852 export interface ReservedCacheNodeMessage {
2853 /**
2854 * Provides an identifier to allow retrieval of paginated results.
2855 */
2856 Marker?: String;
2857 /**
2858 * A list of reserved cache nodes. Each element in the list contains detailed information about one node.
2859 */
2860 ReservedCacheNodes?: ReservedCacheNodeList;
2861 }
2862 export interface ReservedCacheNodesOffering {
2863 /**
2864 * A unique identifier for the reserved cache node offering.
2865 */
2866 ReservedCacheNodesOfferingId?: String;
2867 /**
2868 * 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: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium 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 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge 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 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
2869 */
2870 CacheNodeType?: String;
2871 /**
2872 * The duration of the offering. in seconds.
2873 */
2874 Duration?: Integer;
2875 /**
2876 * The fixed price charged for this offering.
2877 */
2878 FixedPrice?: Double;
2879 /**
2880 * The hourly price charged for this offering.
2881 */
2882 UsagePrice?: Double;
2883 /**
2884 * The cache engine used by the offering.
2885 */
2886 ProductDescription?: String;
2887 /**
2888 * The offering type.
2889 */
2890 OfferingType?: String;
2891 /**
2892 * The recurring price charged to run this reserved cache node.
2893 */
2894 RecurringCharges?: RecurringChargeList;
2895 }
2896 export type ReservedCacheNodesOfferingList = ReservedCacheNodesOffering[];
2897 export interface ReservedCacheNodesOfferingMessage {
2898 /**
2899 * Provides an identifier to allow retrieval of paginated results.
2900 */
2901 Marker?: String;
2902 /**
2903 * A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
2904 */
2905 ReservedCacheNodesOfferings?: ReservedCacheNodesOfferingList;
2906 }
2907 export interface ResetCacheParameterGroupMessage {
2908 /**
2909 * The name of the cache parameter group to reset.
2910 */
2911 CacheParameterGroupName: String;
2912 /**
2913 * 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
2914 */
2915 ResetAllParameters?: Boolean;
2916 /**
2917 * 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.
2918 */
2919 ParameterNameValues?: ParameterNameValueList;
2920 }
2921 export interface ReshardingConfiguration {
2922 /**
2923 * Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
2924 */
2925 NodeGroupId?: AllowedNodeGroupId;
2926 /**
2927 * A list of preferred availability zones for the nodes in this cluster.
2928 */
2929 PreferredAvailabilityZones?: AvailabilityZonesList;
2930 }
2931 export type ReshardingConfigurationList = ReshardingConfiguration[];
2932 export interface ReshardingStatus {
2933 /**
2934 * Represents the progress of an online resharding operation.
2935 */
2936 SlotMigration?: SlotMigration;
2937 }
2938 export interface RevokeCacheSecurityGroupIngressMessage {
2939 /**
2940 * The name of the cache security group to revoke ingress from.
2941 */
2942 CacheSecurityGroupName: String;
2943 /**
2944 * The name of the Amazon EC2 security group to revoke access from.
2945 */
2946 EC2SecurityGroupName: String;
2947 /**
2948 * 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.
2949 */
2950 EC2SecurityGroupOwnerId: String;
2951 }
2952 export interface RevokeCacheSecurityGroupIngressResult {
2953 CacheSecurityGroup?: CacheSecurityGroup;
2954 }
2955 export type SecurityGroupIdsList = String[];
2956 export interface SecurityGroupMembership {
2957 /**
2958 * The identifier of the cache security group.
2959 */
2960 SecurityGroupId?: String;
2961 /**
2962 * 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.
2963 */
2964 Status?: String;
2965 }
2966 export type SecurityGroupMembershipList = SecurityGroupMembership[];
2967 export interface ServiceUpdate {
2968 /**
2969 * The unique ID of the service update
2970 */
2971 ServiceUpdateName?: String;
2972 /**
2973 * The date when the service update is initially available
2974 */
2975 ServiceUpdateReleaseDate?: TStamp;
2976 /**
2977 * The date after which the service update is no longer available
2978 */
2979 ServiceUpdateEndDate?: TStamp;
2980 /**
2981 * The severity of the service update
2982 */
2983 ServiceUpdateSeverity?: ServiceUpdateSeverity;
2984 /**
2985 * The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
2986 */
2987 ServiceUpdateRecommendedApplyByDate?: TStamp;
2988 /**
2989 * The status of the service update
2990 */
2991 ServiceUpdateStatus?: ServiceUpdateStatus;
2992 /**
2993 * Provides details of the service update
2994 */
2995 ServiceUpdateDescription?: String;
2996 /**
2997 * Reflects the nature of the service update
2998 */
2999 ServiceUpdateType?: ServiceUpdateType;
3000 /**
3001 * The Elasticache engine to which the update applies. Either Redis or Memcached
3002 */
3003 Engine?: String;
3004 /**
3005 * The Elasticache engine version to which the update applies. Either Redis or Memcached engine version
3006 */
3007 EngineVersion?: String;
3008 /**
3009 * Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.
3010 */
3011 AutoUpdateAfterRecommendedApplyByDate?: BooleanOptional;
3012 /**
3013 * The estimated length of time the service update will take
3014 */
3015 EstimatedUpdateTime?: String;
3016 }
3017 export type ServiceUpdateList = ServiceUpdate[];
3018 export type ServiceUpdateSeverity = "critical"|"important"|"medium"|"low"|string;
3019 export type ServiceUpdateStatus = "available"|"cancelled"|"expired"|string;
3020 export type ServiceUpdateStatusList = ServiceUpdateStatus[];
3021 export type ServiceUpdateType = "security-update"|string;
3022 export interface ServiceUpdatesMessage {
3023 /**
3024 * 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.
3025 */
3026 Marker?: String;
3027 /**
3028 * A list of service updates
3029 */
3030 ServiceUpdates?: ServiceUpdateList;
3031 }
3032 export type SlaMet = "yes"|"no"|"n/a"|string;
3033 export interface SlotMigration {
3034 /**
3035 * The percentage of the slot migration that is complete.
3036 */
3037 ProgressPercentage?: Double;
3038 }
3039 export interface Snapshot {
3040 /**
3041 * The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
3042 */
3043 SnapshotName?: String;
3044 /**
3045 * The unique identifier of the source replication group.
3046 */
3047 ReplicationGroupId?: String;
3048 /**
3049 * A description of the source replication group.
3050 */
3051 ReplicationGroupDescription?: String;
3052 /**
3053 * The user-supplied identifier of the source cluster.
3054 */
3055 CacheClusterId?: String;
3056 /**
3057 * The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
3058 */
3059 SnapshotStatus?: String;
3060 /**
3061 * Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
3062 */
3063 SnapshotSource?: String;
3064 /**
3065 * 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: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium 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 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge 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 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
3066 */
3067 CacheNodeType?: String;
3068 /**
3069 * The name of the cache engine (memcached or redis) used by the source cluster.
3070 */
3071 Engine?: String;
3072 /**
3073 * The version of the cache engine version that is used by the source cluster.
3074 */
3075 EngineVersion?: String;
3076 /**
3077 * 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.
3078 */
3079 NumCacheNodes?: IntegerOptional;
3080 /**
3081 * The name of the Availability Zone in which the source cluster is located.
3082 */
3083 PreferredAvailabilityZone?: String;
3084 /**
3085 * The date and time when the source cluster was created.
3086 */
3087 CacheClusterCreateTime?: TStamp;
3088 /**
3089 * 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
3090 */
3091 PreferredMaintenanceWindow?: String;
3092 /**
3093 * The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
3094 */
3095 TopicArn?: String;
3096 /**
3097 * The port number used by each cache nodes in the source cluster.
3098 */
3099 Port?: IntegerOptional;
3100 /**
3101 * The cache parameter group that is associated with the source cluster.
3102 */
3103 CacheParameterGroupName?: String;
3104 /**
3105 * The name of the cache subnet group associated with the source cluster.
3106 */
3107 CacheSubnetGroupName?: String;
3108 /**
3109 * The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
3110 */
3111 VpcId?: String;
3112 /**
3113 * This parameter is currently disabled.
3114 */
3115 AutoMinorVersionUpgrade?: Boolean;
3116 /**
3117 * 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.
3118 */
3119 SnapshotRetentionLimit?: IntegerOptional;
3120 /**
3121 * The daily time range during which ElastiCache takes daily snapshots of the source cluster.
3122 */
3123 SnapshotWindow?: String;
3124 /**
3125 * 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.
3126 */
3127 NumNodeGroups?: IntegerOptional;
3128 /**
3129 * 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 node types. Redis (cluster mode enabled): T1 node types.
3130 */
3131 AutomaticFailover?: AutomaticFailoverStatus;
3132 /**
3133 * A list of the cache nodes in the source cluster.
3134 */
3135 NodeSnapshots?: NodeSnapshotList;
3136 /**
3137 * The ID of the KMS key used to encrypt the snapshot.
3138 */
3139 KmsKeyId?: String;
3140 }
3141 export type SnapshotArnsList = String[];
3142 export type SnapshotList = Snapshot[];
3143 export type SourceType = "cache-cluster"|"cache-parameter-group"|"cache-security-group"|"cache-subnet-group"|"replication-group"|string;
3144 export interface StartMigrationMessage {
3145 /**
3146 * The ID of the replication group to which data should be migrated.
3147 */
3148 ReplicationGroupId: String;
3149 /**
3150 * List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.
3151 */
3152 CustomerNodeEndpointList: CustomerNodeEndpointList;
3153 }
3154 export interface StartMigrationResponse {
3155 ReplicationGroup?: ReplicationGroup;
3156 }
3157 export type String = string;
3158 export interface Subnet {
3159 /**
3160 * The unique identifier for the subnet.
3161 */
3162 SubnetIdentifier?: String;
3163 /**
3164 * The Availability Zone associated with the subnet.
3165 */
3166 SubnetAvailabilityZone?: AvailabilityZone;
3167 }
3168 export type SubnetIdentifierList = String[];
3169 export type SubnetList = Subnet[];
3170 export type TStamp = Date;
3171 export interface Tag {
3172 /**
3173 * The key for the tag. May not be null.
3174 */
3175 Key?: String;
3176 /**
3177 * The tag's value. May be null.
3178 */
3179 Value?: String;
3180 }
3181 export type TagList = Tag[];
3182 export interface TagListMessage {
3183 /**
3184 * A list of cost allocation tags as key-value pairs.
3185 */
3186 TagList?: TagList;
3187 }
3188 export interface TestFailoverMessage {
3189 /**
3190 * The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
3191 */
3192 ReplicationGroupId: String;
3193 /**
3194 * 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.
3195 */
3196 NodeGroupId: AllowedNodeGroupId;
3197 }
3198 export interface TestFailoverResult {
3199 ReplicationGroup?: ReplicationGroup;
3200 }
3201 export interface TimeRangeFilter {
3202 /**
3203 * The start time of the time range filter
3204 */
3205 StartTime?: TStamp;
3206 /**
3207 * The end time of the time range filter
3208 */
3209 EndTime?: TStamp;
3210 }
3211 export interface UnprocessedUpdateAction {
3212 /**
3213 * The replication group ID
3214 */
3215 ReplicationGroupId?: String;
3216 /**
3217 * The ID of the cache cluster
3218 */
3219 CacheClusterId?: String;
3220 /**
3221 * The unique ID of the service update
3222 */
3223 ServiceUpdateName?: String;
3224 /**
3225 * The error type for requests that are not processed
3226 */
3227 ErrorType?: String;
3228 /**
3229 * The error message that describes the reason the request was not processed
3230 */
3231 ErrorMessage?: String;
3232 }
3233 export type UnprocessedUpdateActionList = UnprocessedUpdateAction[];
3234 export interface UpdateAction {
3235 /**
3236 * The ID of the replication group
3237 */
3238 ReplicationGroupId?: String;
3239 /**
3240 * The ID of the cache cluster
3241 */
3242 CacheClusterId?: String;
3243 /**
3244 * The unique ID of the service update
3245 */
3246 ServiceUpdateName?: String;
3247 /**
3248 * The date the update is first available
3249 */
3250 ServiceUpdateReleaseDate?: TStamp;
3251 /**
3252 * The severity of the service update
3253 */
3254 ServiceUpdateSeverity?: ServiceUpdateSeverity;
3255 /**
3256 * The status of the service update
3257 */
3258 ServiceUpdateStatus?: ServiceUpdateStatus;
3259 /**
3260 * The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
3261 */
3262 ServiceUpdateRecommendedApplyByDate?: TStamp;
3263 /**
3264 * Reflects the nature of the service update
3265 */
3266 ServiceUpdateType?: ServiceUpdateType;
3267 /**
3268 * The date that the service update is available to a replication group
3269 */
3270 UpdateActionAvailableDate?: TStamp;
3271 /**
3272 * The status of the update action
3273 */
3274 UpdateActionStatus?: UpdateActionStatus;
3275 /**
3276 * The progress of the service update on the replication group
3277 */
3278 NodesUpdated?: String;
3279 /**
3280 * The date when the UpdateActionStatus was last modified
3281 */
3282 UpdateActionStatusModifiedDate?: TStamp;
3283 /**
3284 * If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.
3285 */
3286 SlaMet?: SlaMet;
3287 /**
3288 * The status of the service update on the node group
3289 */
3290 NodeGroupUpdateStatus?: NodeGroupUpdateStatusList;
3291 /**
3292 * The status of the service update on the cache node
3293 */
3294 CacheNodeUpdateStatus?: CacheNodeUpdateStatusList;
3295 /**
3296 * The estimated length of time for the update to complete
3297 */
3298 EstimatedUpdateTime?: String;
3299 /**
3300 * The Elasticache engine to which the update applies. Either Redis or Memcached
3301 */
3302 Engine?: String;
3303 }
3304 export type UpdateActionList = UpdateAction[];
3305 export interface UpdateActionResultsMessage {
3306 /**
3307 * Update actions that have been processed successfully
3308 */
3309 ProcessedUpdateActions?: ProcessedUpdateActionList;
3310 /**
3311 * Update actions that haven't been processed successfully
3312 */
3313 UnprocessedUpdateActions?: UnprocessedUpdateActionList;
3314 }
3315 export type UpdateActionStatus = "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete"|string;
3316 export type UpdateActionStatusList = UpdateActionStatus[];
3317 export interface UpdateActionsMessage {
3318 /**
3319 * 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.
3320 */
3321 Marker?: String;
3322 /**
3323 * Returns a list of update actions
3324 */
3325 UpdateActions?: UpdateActionList;
3326 }
3327 /**
3328 * 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.
3329 */
3330 export type apiVersion = "2012-11-15"|"2014-03-24"|"2014-07-15"|"2014-09-30"|"2015-02-02"|"latest"|string;
3331 export interface ClientApiVersions {
3332 /**
3333 * 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.
3334 */
3335 apiVersion?: apiVersion;
3336 }
3337 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
3338 /**
3339 * Contains interfaces for use with the ElastiCache client.
3340 */
3341 export import Types = ElastiCache;
3342}
3343export = ElastiCache;