/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / elasticache.d.ts
elasticache.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {WaiterConfiguration} from '../lib/service'; 6 import {ServiceConfigurationOptions} from '../lib/service'; 7 import {ConfigBase as Config} from '../lib/config-base'; 8 interface Blob {} 9 declare 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 * A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. For example, you can use cost-allocation tags to your ElastiCache resources, Amazon 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 * A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. For example, you can use cost-allocation tags to your ElastiCache resources, Amazon 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 & 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 & 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 GlobalReplicationGroupIdSuffix 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 GlobalReplicationGroupIdSuffix 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 cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster. To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type. 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. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters 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 cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster. To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type. 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. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters 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 * For Redis engine version 6.x onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC). 121 */ 122 createUser(params: ElastiCache.Types.CreateUserMessage, callback?: (err: AWSError, data: ElastiCache.Types.User) => void): Request<ElastiCache.Types.User, AWSError>; 123 /** 124 * For Redis engine version 6.x onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC). 125 */ 126 createUser(callback?: (err: AWSError, data: ElastiCache.Types.User) => void): Request<ElastiCache.Types.User, AWSError>; 127 /** 128 * For Redis engine version 6.x onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) 129 */ 130 createUserGroup(params: ElastiCache.Types.CreateUserGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.UserGroup) => void): Request<ElastiCache.Types.UserGroup, AWSError>; 131 /** 132 * For Redis engine version 6.x onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) 133 */ 134 createUserGroup(callback?: (err: AWSError, data: ElastiCache.Types.UserGroup) => void): Request<ElastiCache.Types.UserGroup, AWSError>; 135 /** 136 * Decreases the number of node groups in a Global datastore 137 */ 138 decreaseNodeGroupsInGlobalReplicationGroup(params: ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupResult, AWSError>; 139 /** 140 * Decreases the number of node groups in a Global datastore 141 */ 142 decreaseNodeGroupsInGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DecreaseNodeGroupsInGlobalReplicationGroupResult, AWSError>; 143 /** 144 * 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. 145 */ 146 decreaseReplicaCount(params: ElastiCache.Types.DecreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request<ElastiCache.Types.DecreaseReplicaCountResult, AWSError>; 147 /** 148 * 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. 149 */ 150 decreaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request<ElastiCache.Types.DecreaseReplicaCountResult, AWSError>; 151 /** 152 * 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 Redis (cluster mode disabled) clusters A cluster that is the last read replica of a replication group A cluster that is the primary node 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 153 */ 154 deleteCacheCluster(params: ElastiCache.Types.DeleteCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request<ElastiCache.Types.DeleteCacheClusterResult, AWSError>; 155 /** 156 * 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 Redis (cluster mode disabled) clusters A cluster that is the last read replica of a replication group A cluster that is the primary node 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 157 */ 158 deleteCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request<ElastiCache.Types.DeleteCacheClusterResult, AWSError>; 159 /** 160 * Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account. 161 */ 162 deleteCacheParameterGroup(params: ElastiCache.Types.DeleteCacheParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 163 /** 164 * Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account. 165 */ 166 deleteCacheParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 167 /** 168 * Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters. 169 */ 170 deleteCacheSecurityGroup(params: ElastiCache.Types.DeleteCacheSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 171 /** 172 * Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters. 173 */ 174 deleteCacheSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 175 /** 176 * Deletes a cache subnet group. You cannot delete a default cache subnet group or one that is associated with any clusters. 177 */ 178 deleteCacheSubnetGroup(params: ElastiCache.Types.DeleteCacheSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 179 /** 180 * Deletes a cache subnet group. You cannot delete a default cache subnet group or one that is associated with any clusters. 181 */ 182 deleteCacheSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 183 /** 184 * 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 the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true. Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. 185 */ 186 deleteGlobalReplicationGroup(params: ElastiCache.Types.DeleteGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteGlobalReplicationGroupResult, AWSError>; 187 /** 188 * 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 the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true. Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. 189 */ 190 deleteGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DeleteGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteGlobalReplicationGroupResult, AWSError>; 191 /** 192 * 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. 193 */ 194 deleteReplicationGroup(params: ElastiCache.Types.DeleteReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteReplicationGroupResult, AWSError>; 195 /** 196 * 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. 197 */ 198 deleteReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteReplicationGroupResult, AWSError>; 199 /** 200 * 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. 201 */ 202 deleteSnapshot(params: ElastiCache.Types.DeleteSnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request<ElastiCache.Types.DeleteSnapshotResult, AWSError>; 203 /** 204 * 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. 205 */ 206 deleteSnapshot(callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request<ElastiCache.Types.DeleteSnapshotResult, AWSError>; 207 /** 208 * For Redis engine version 6.x onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC). 209 */ 210 deleteUser(params: ElastiCache.Types.DeleteUserMessage, callback?: (err: AWSError, data: ElastiCache.Types.User) => void): Request<ElastiCache.Types.User, AWSError>; 211 /** 212 * For Redis engine version 6.x onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC). 213 */ 214 deleteUser(callback?: (err: AWSError, data: ElastiCache.Types.User) => void): Request<ElastiCache.Types.User, AWSError>; 215 /** 216 * For Redis engine version 6.x onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC). 217 */ 218 deleteUserGroup(params: ElastiCache.Types.DeleteUserGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.UserGroup) => void): Request<ElastiCache.Types.UserGroup, AWSError>; 219 /** 220 * For Redis engine version 6.x onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC). 221 */ 222 deleteUserGroup(callback?: (err: AWSError, data: ElastiCache.Types.UserGroup) => void): Request<ElastiCache.Types.UserGroup, AWSError>; 223 /** 224 * 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. 225 */ 226 describeCacheClusters(params: ElastiCache.Types.DescribeCacheClustersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>; 227 /** 228 * 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. 229 */ 230 describeCacheClusters(callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>; 231 /** 232 * Returns a list of the available cache engines and their versions. 233 */ 234 describeCacheEngineVersions(params: ElastiCache.Types.DescribeCacheEngineVersionsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request<ElastiCache.Types.CacheEngineVersionMessage, AWSError>; 235 /** 236 * Returns a list of the available cache engines and their versions. 237 */ 238 describeCacheEngineVersions(callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request<ElastiCache.Types.CacheEngineVersionMessage, AWSError>; 239 /** 240 * 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. 241 */ 242 describeCacheParameterGroups(params: ElastiCache.Types.DescribeCacheParameterGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request<ElastiCache.Types.CacheParameterGroupsMessage, AWSError>; 243 /** 244 * 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. 245 */ 246 describeCacheParameterGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request<ElastiCache.Types.CacheParameterGroupsMessage, AWSError>; 247 /** 248 * Returns the detailed parameter list for a particular cache parameter group. 249 */ 250 describeCacheParameters(params: ElastiCache.Types.DescribeCacheParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request<ElastiCache.Types.CacheParameterGroupDetails, AWSError>; 251 /** 252 * Returns the detailed parameter list for a particular cache parameter group. 253 */ 254 describeCacheParameters(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request<ElastiCache.Types.CacheParameterGroupDetails, AWSError>; 255 /** 256 * 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 257 */ 258 describeCacheSecurityGroups(params: ElastiCache.Types.DescribeCacheSecurityGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request<ElastiCache.Types.CacheSecurityGroupMessage, AWSError>; 259 /** 260 * 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 261 */ 262 describeCacheSecurityGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request<ElastiCache.Types.CacheSecurityGroupMessage, AWSError>; 263 /** 264 * 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. 265 */ 266 describeCacheSubnetGroups(params: ElastiCache.Types.DescribeCacheSubnetGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request<ElastiCache.Types.CacheSubnetGroupMessage, AWSError>; 267 /** 268 * 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. 269 */ 270 describeCacheSubnetGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request<ElastiCache.Types.CacheSubnetGroupMessage, AWSError>; 271 /** 272 * Returns the default engine and system parameter information for the specified cache engine. 273 */ 274 describeEngineDefaultParameters(params: ElastiCache.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request<ElastiCache.Types.DescribeEngineDefaultParametersResult, AWSError>; 275 /** 276 * Returns the default engine and system parameter information for the specified cache engine. 277 */ 278 describeEngineDefaultParameters(callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request<ElastiCache.Types.DescribeEngineDefaultParametersResult, AWSError>; 279 /** 280 * 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. 281 */ 282 describeEvents(params: ElastiCache.Types.DescribeEventsMessage, callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request<ElastiCache.Types.EventsMessage, AWSError>; 283 /** 284 * 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. 285 */ 286 describeEvents(callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request<ElastiCache.Types.EventsMessage, AWSError>; 287 /** 288 * Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. 289 */ 290 describeGlobalReplicationGroups(params: ElastiCache.Types.DescribeGlobalReplicationGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeGlobalReplicationGroupsResult) => void): Request<ElastiCache.Types.DescribeGlobalReplicationGroupsResult, AWSError>; 291 /** 292 * Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. 293 */ 294 describeGlobalReplicationGroups(callback?: (err: AWSError, data: ElastiCache.Types.DescribeGlobalReplicationGroupsResult) => void): Request<ElastiCache.Types.DescribeGlobalReplicationGroupsResult, AWSError>; 295 /** 296 * 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. 297 */ 298 describeReplicationGroups(params: ElastiCache.Types.DescribeReplicationGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>; 299 /** 300 * 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. 301 */ 302 describeReplicationGroups(callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>; 303 /** 304 * Returns information about reserved cache nodes for this account, or about a specified reserved cache node. 305 */ 306 describeReservedCacheNodes(params: ElastiCache.Types.DescribeReservedCacheNodesMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request<ElastiCache.Types.ReservedCacheNodeMessage, AWSError>; 307 /** 308 * Returns information about reserved cache nodes for this account, or about a specified reserved cache node. 309 */ 310 describeReservedCacheNodes(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request<ElastiCache.Types.ReservedCacheNodeMessage, AWSError>; 311 /** 312 * Lists available reserved cache node offerings. 313 */ 314 describeReservedCacheNodesOfferings(params: ElastiCache.Types.DescribeReservedCacheNodesOfferingsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request<ElastiCache.Types.ReservedCacheNodesOfferingMessage, AWSError>; 315 /** 316 * Lists available reserved cache node offerings. 317 */ 318 describeReservedCacheNodesOfferings(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request<ElastiCache.Types.ReservedCacheNodesOfferingMessage, AWSError>; 319 /** 320 * Returns details of the service updates 321 */ 322 describeServiceUpdates(params: ElastiCache.Types.DescribeServiceUpdatesMessage, callback?: (err: AWSError, data: ElastiCache.Types.ServiceUpdatesMessage) => void): Request<ElastiCache.Types.ServiceUpdatesMessage, AWSError>; 323 /** 324 * Returns details of the service updates 325 */ 326 describeServiceUpdates(callback?: (err: AWSError, data: ElastiCache.Types.ServiceUpdatesMessage) => void): Request<ElastiCache.Types.ServiceUpdatesMessage, AWSError>; 327 /** 328 * 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. 329 */ 330 describeSnapshots(params: ElastiCache.Types.DescribeSnapshotsMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request<ElastiCache.Types.DescribeSnapshotsListMessage, AWSError>; 331 /** 332 * 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. 333 */ 334 describeSnapshots(callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request<ElastiCache.Types.DescribeSnapshotsListMessage, AWSError>; 335 /** 336 * Returns details of the update actions 337 */ 338 describeUpdateActions(params: ElastiCache.Types.DescribeUpdateActionsMessage, callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionsMessage) => void): Request<ElastiCache.Types.UpdateActionsMessage, AWSError>; 339 /** 340 * Returns details of the update actions 341 */ 342 describeUpdateActions(callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionsMessage) => void): Request<ElastiCache.Types.UpdateActionsMessage, AWSError>; 343 /** 344 * Returns a list of user groups. 345 */ 346 describeUserGroups(params: ElastiCache.Types.DescribeUserGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeUserGroupsResult) => void): Request<ElastiCache.Types.DescribeUserGroupsResult, AWSError>; 347 /** 348 * Returns a list of user groups. 349 */ 350 describeUserGroups(callback?: (err: AWSError, data: ElastiCache.Types.DescribeUserGroupsResult) => void): Request<ElastiCache.Types.DescribeUserGroupsResult, AWSError>; 351 /** 352 * Returns a list of users. 353 */ 354 describeUsers(params: ElastiCache.Types.DescribeUsersMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeUsersResult) => void): Request<ElastiCache.Types.DescribeUsersResult, AWSError>; 355 /** 356 * Returns a list of users. 357 */ 358 describeUsers(callback?: (err: AWSError, data: ElastiCache.Types.DescribeUsersResult) => void): Request<ElastiCache.Types.DescribeUsersResult, AWSError>; 359 /** 360 * 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 Amazon region. 361 */ 362 disassociateGlobalReplicationGroup(params: ElastiCache.Types.DisassociateGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DisassociateGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DisassociateGlobalReplicationGroupResult, AWSError>; 363 /** 364 * 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 Amazon region. 365 */ 366 disassociateGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DisassociateGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.DisassociateGlobalReplicationGroupResult, AWSError>; 367 /** 368 * Used to failover the primary region to a selected secondary region. The selected secondary region will become primary, and all other clusters will become secondary. 369 */ 370 failoverGlobalReplicationGroup(params: ElastiCache.Types.FailoverGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.FailoverGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.FailoverGlobalReplicationGroupResult, AWSError>; 371 /** 372 * Used to failover the primary region to a selected secondary region. The selected secondary region will become primary, and all other clusters will become secondary. 373 */ 374 failoverGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.FailoverGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.FailoverGlobalReplicationGroupResult, AWSError>; 375 /** 376 * Increase the number of node groups in the Global datastore 377 */ 378 increaseNodeGroupsInGlobalReplicationGroup(params: ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupResult, AWSError>; 379 /** 380 * Increase the number of node groups in the Global datastore 381 */ 382 increaseNodeGroupsInGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.IncreaseNodeGroupsInGlobalReplicationGroupResult, AWSError>; 383 /** 384 * Dynamically increases 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. 385 */ 386 increaseReplicaCount(params: ElastiCache.Types.IncreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request<ElastiCache.Types.IncreaseReplicaCountResult, AWSError>; 387 /** 388 * Dynamically increases 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. 389 */ 390 increaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request<ElastiCache.Types.IncreaseReplicaCountResult, AWSError>; 391 /** 392 * 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. 393 */ 394 listAllowedNodeTypeModifications(params: ElastiCache.Types.ListAllowedNodeTypeModificationsMessage, callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request<ElastiCache.Types.AllowedNodeTypeModificationsMessage, AWSError>; 395 /** 396 * 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. 397 */ 398 listAllowedNodeTypeModifications(callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request<ElastiCache.Types.AllowedNodeTypeModificationsMessage, AWSError>; 399 /** 400 * Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. If the cluster is not in the available state, ListTagsForResource returns an error. 401 */ 402 listTagsForResource(params: ElastiCache.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>; 403 /** 404 * Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. If the cluster is not in the available state, ListTagsForResource returns an error. 405 */ 406 listTagsForResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>; 407 /** 408 * 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. 409 */ 410 modifyCacheCluster(params: ElastiCache.Types.ModifyCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request<ElastiCache.Types.ModifyCacheClusterResult, AWSError>; 411 /** 412 * 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. 413 */ 414 modifyCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request<ElastiCache.Types.ModifyCacheClusterResult, AWSError>; 415 /** 416 * 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. 417 */ 418 modifyCacheParameterGroup(params: ElastiCache.Types.ModifyCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>; 419 /** 420 * 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. 421 */ 422 modifyCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>; 423 /** 424 * Modifies an existing cache subnet group. 425 */ 426 modifyCacheSubnetGroup(params: ElastiCache.Types.ModifyCacheSubnetGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request<ElastiCache.Types.ModifyCacheSubnetGroupResult, AWSError>; 427 /** 428 * Modifies an existing cache subnet group. 429 */ 430 modifyCacheSubnetGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request<ElastiCache.Types.ModifyCacheSubnetGroupResult, AWSError>; 431 /** 432 * Modifies the settings for a Global datastore. 433 */ 434 modifyGlobalReplicationGroup(params: ElastiCache.Types.ModifyGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyGlobalReplicationGroupResult, AWSError>; 435 /** 436 * Modifies the settings for a Global datastore. 437 */ 438 modifyGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyGlobalReplicationGroupResult, AWSError>; 439 /** 440 * Modifies the settings for a replication group. 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. 441 */ 442 modifyReplicationGroup(params: ElastiCache.Types.ModifyReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupResult, AWSError>; 443 /** 444 * Modifies the settings for a replication group. 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. 445 */ 446 modifyReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupResult, AWSError>; 447 /** 448 * Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards. 449 */ 450 modifyReplicationGroupShardConfiguration(params: ElastiCache.Types.ModifyReplicationGroupShardConfigurationMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult, AWSError>; 451 /** 452 * Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards. 453 */ 454 modifyReplicationGroupShardConfiguration(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult, AWSError>; 455 /** 456 * Changes user password(s) and/or access string. 457 */ 458 modifyUser(params: ElastiCache.Types.ModifyUserMessage, callback?: (err: AWSError, data: ElastiCache.Types.User) => void): Request<ElastiCache.Types.User, AWSError>; 459 /** 460 * Changes user password(s) and/or access string. 461 */ 462 modifyUser(callback?: (err: AWSError, data: ElastiCache.Types.User) => void): Request<ElastiCache.Types.User, AWSError>; 463 /** 464 * Changes the list of users that belong to the user group. 465 */ 466 modifyUserGroup(params: ElastiCache.Types.ModifyUserGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.UserGroup) => void): Request<ElastiCache.Types.UserGroup, AWSError>; 467 /** 468 * Changes the list of users that belong to the user group. 469 */ 470 modifyUserGroup(callback?: (err: AWSError, data: ElastiCache.Types.UserGroup) => void): Request<ElastiCache.Types.UserGroup, AWSError>; 471 /** 472 * Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached. 473 */ 474 purchaseReservedCacheNodesOffering(params: ElastiCache.Types.PurchaseReservedCacheNodesOfferingMessage, callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request<ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult, AWSError>; 475 /** 476 * Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached. 477 */ 478 purchaseReservedCacheNodesOffering(callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request<ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult, AWSError>; 479 /** 480 * Redistribute slots to ensure uniform distribution across existing shards in the cluster. 481 */ 482 rebalanceSlotsInGlobalReplicationGroup(params: ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupResult, AWSError>; 483 /** 484 * Redistribute slots to ensure uniform distribution across existing shards in the cluster. 485 */ 486 rebalanceSlotsInGlobalReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupResult) => void): Request<ElastiCache.Types.RebalanceSlotsInGlobalReplicationGroupResult, AWSError>; 487 /** 488 * 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. 489 */ 490 rebootCacheCluster(params: ElastiCache.Types.RebootCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request<ElastiCache.Types.RebootCacheClusterResult, AWSError>; 491 /** 492 * 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. 493 */ 494 rebootCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request<ElastiCache.Types.RebootCacheClusterResult, AWSError>; 495 /** 496 * Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. 497 */ 498 removeTagsFromResource(params: ElastiCache.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>; 499 /** 500 * Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. 501 */ 502 removeTagsFromResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>; 503 /** 504 * 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. 505 */ 506 resetCacheParameterGroup(params: ElastiCache.Types.ResetCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>; 507 /** 508 * 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. 509 */ 510 resetCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>; 511 /** 512 * Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized. 513 */ 514 revokeCacheSecurityGroupIngress(params: ElastiCache.Types.RevokeCacheSecurityGroupIngressMessage, callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.RevokeCacheSecurityGroupIngressResult, AWSError>; 515 /** 516 * Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized. 517 */ 518 revokeCacheSecurityGroupIngress(callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.RevokeCacheSecurityGroupIngressResult, AWSError>; 519 /** 520 * Start the migration of data. 521 */ 522 startMigration(params: ElastiCache.Types.StartMigrationMessage, callback?: (err: AWSError, data: ElastiCache.Types.StartMigrationResponse) => void): Request<ElastiCache.Types.StartMigrationResponse, AWSError>; 523 /** 524 * Start the migration of data. 525 */ 526 startMigration(callback?: (err: AWSError, data: ElastiCache.Types.StartMigrationResponse) => void): Request<ElastiCache.Types.StartMigrationResponse, AWSError>; 527 /** 528 * 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 Amazon 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 Amazon 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 <node-group-id> Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> Cache cluster message: Finished recovery for cache nodes <node-id> For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also see, Testing Multi-AZ in the ElastiCache User Guide. 529 */ 530 testFailover(params: ElastiCache.Types.TestFailoverMessage, callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request<ElastiCache.Types.TestFailoverResult, AWSError>; 531 /** 532 * 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 Amazon 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 Amazon 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 <node-group-id> Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> Cache cluster message: Finished recovery for cache nodes <node-id> For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also see, Testing Multi-AZ in the ElastiCache User Guide. 533 */ 534 testFailover(callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request<ElastiCache.Types.TestFailoverResult, AWSError>; 535 /** 536 * 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. 537 */ 538 waitFor(state: "cacheClusterAvailable", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>; 539 /** 540 * 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. 541 */ 542 waitFor(state: "cacheClusterAvailable", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>; 543 /** 544 * 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. 545 */ 546 waitFor(state: "cacheClusterDeleted", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>; 547 /** 548 * 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. 549 */ 550 waitFor(state: "cacheClusterDeleted", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>; 551 /** 552 * 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. 553 */ 554 waitFor(state: "replicationGroupAvailable", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>; 555 /** 556 * 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. 557 */ 558 waitFor(state: "replicationGroupAvailable", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>; 559 /** 560 * 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. 561 */ 562 waitFor(state: "replicationGroupDeleted", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>; 563 /** 564 * 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. 565 */ 566 waitFor(state: "replicationGroupDeleted", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>; 567 } 568 declare namespace ElastiCache { 569 export type AZMode = "single-az"|"cross-az"|string; 570 export type AccessString = string; 571 export interface AddTagsToResourceMessage { 572 /** 573 * 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 Amazon Service Namespaces. 574 */ 575 ResourceName: String; 576 /** 577 * A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. 578 */ 579 Tags: TagList; 580 } 581 export type AllowedNodeGroupId = string; 582 export interface AllowedNodeTypeModificationsMessage { 583 /** 584 * 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. 585 */ 586 ScaleUpModifications?: NodeTypeList; 587 /** 588 * 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. 589 */ 590 ScaleDownModifications?: NodeTypeList; 591 } 592 export type AuthTokenUpdateStatus = "SETTING"|"ROTATING"|string; 593 export type AuthTokenUpdateStrategyType = "SET"|"ROTATE"|"DELETE"|string; 594 export interface Authentication { 595 /** 596 * Indicates whether the user requires a password to authenticate. 597 */ 598 Type?: AuthenticationType; 599 /** 600 * The number of passwords belonging to the user. The maximum is two. 601 */ 602 PasswordCount?: IntegerOptional; 603 } 604 export type AuthenticationType = "password"|"no-password"|string; 605 export interface AuthorizeCacheSecurityGroupIngressMessage { 606 /** 607 * The cache security group that allows network ingress. 608 */ 609 CacheSecurityGroupName: String; 610 /** 611 * The Amazon EC2 security group to be authorized for ingress to the cache security group. 612 */ 613 EC2SecurityGroupName: String; 614 /** 615 * The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter. 616 */ 617 EC2SecurityGroupOwnerId: String; 618 } 619 export interface AuthorizeCacheSecurityGroupIngressResult { 620 CacheSecurityGroup?: CacheSecurityGroup; 621 } 622 export type AutomaticFailoverStatus = "enabled"|"disabled"|"enabling"|"disabling"|string; 623 export interface AvailabilityZone { 624 /** 625 * The name of the Availability Zone. 626 */ 627 Name?: String; 628 } 629 export type AvailabilityZonesList = String[]; 630 export interface BatchApplyUpdateActionMessage { 631 /** 632 * The replication group IDs 633 */ 634 ReplicationGroupIds?: ReplicationGroupIdList; 635 /** 636 * The cache cluster IDs 637 */ 638 CacheClusterIds?: CacheClusterIdList; 639 /** 640 * The unique ID of the service update 641 */ 642 ServiceUpdateName: String; 643 } 644 export interface BatchStopUpdateActionMessage { 645 /** 646 * The replication group IDs 647 */ 648 ReplicationGroupIds?: ReplicationGroupIdList; 649 /** 650 * The cache cluster IDs 651 */ 652 CacheClusterIds?: CacheClusterIdList; 653 /** 654 * The unique ID of the service update 655 */ 656 ServiceUpdateName: String; 657 } 658 export type Boolean = boolean; 659 export type BooleanOptional = boolean; 660 export interface CacheCluster { 661 /** 662 * The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster. 663 */ 664 CacheClusterId?: String; 665 /** 666 * Represents a Memcached cluster endpoint which 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 667 */ 668 ConfigurationEndpoint?: Endpoint; 669 /** 670 * The URL of the web page where you can download the latest ElastiCache client library. 671 */ 672 ClientDownloadLandingPage?: String; 673 /** 674 * 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: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types 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: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types 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. 675 */ 676 CacheNodeType?: String; 677 /** 678 * The name of the cache engine (memcached or redis) to be used for this cluster. 679 */ 680 Engine?: String; 681 /** 682 * The version of the cache engine that is used in this cluster. 683 */ 684 EngineVersion?: String; 685 /** 686 * 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. 687 */ 688 CacheClusterStatus?: String; 689 /** 690 * 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 40. 691 */ 692 NumCacheNodes?: IntegerOptional; 693 /** 694 * The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones. 695 */ 696 PreferredAvailabilityZone?: String; 697 /** 698 * The outpost ARN in which the cache cluster is created. 699 */ 700 PreferredOutpostArn?: String; 701 /** 702 * The date and time when the cluster was created. 703 */ 704 CacheClusterCreateTime?: TStamp; 705 /** 706 * 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 707 */ 708 PreferredMaintenanceWindow?: String; 709 PendingModifiedValues?: PendingModifiedValues; 710 /** 711 * Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS). 712 */ 713 NotificationConfiguration?: NotificationConfiguration; 714 /** 715 * A list of cache security group elements, composed of name and status sub-elements. 716 */ 717 CacheSecurityGroups?: CacheSecurityGroupMembershipList; 718 /** 719 * Status of the cache parameter group. 720 */ 721 CacheParameterGroup?: CacheParameterGroupStatus; 722 /** 723 * The name of the cache subnet group associated with the cluster. 724 */ 725 CacheSubnetGroupName?: String; 726 /** 727 * A list of cache nodes that are members of the cluster. 728 */ 729 CacheNodes?: CacheNodeList; 730 /** 731 * This parameter is currently disabled. 732 */ 733 AutoMinorVersionUpgrade?: Boolean; 734 /** 735 * A list of VPC Security Groups associated with the cluster. 736 */ 737 SecurityGroups?: SecurityGroupMembershipList; 738 /** 739 * The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group. 740 */ 741 ReplicationGroupId?: String; 742 /** 743 * 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. 744 */ 745 SnapshotRetentionLimit?: IntegerOptional; 746 /** 747 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: 05:00-09:00 748 */ 749 SnapshotWindow?: String; 750 /** 751 * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false 752 */ 753 AuthTokenEnabled?: BooleanOptional; 754 /** 755 * The date the auth token was last modified 756 */ 757 AuthTokenLastModifiedDate?: TStamp; 758 /** 759 * 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 760 */ 761 TransitEncryptionEnabled?: BooleanOptional; 762 /** 763 * 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 764 */ 765 AtRestEncryptionEnabled?: BooleanOptional; 766 /** 767 * The ARN (Amazon Resource Name) of the cache cluster. 768 */ 769 ARN?: String; 770 /** 771 * A boolean value indicating whether log delivery is enabled for the replication group. 772 */ 773 ReplicationGroupLogDeliveryEnabled?: Boolean; 774 /** 775 * Returns the destination, format and type of the logs. 776 */ 777 LogDeliveryConfigurations?: LogDeliveryConfigurationList; 778 } 779 export type CacheClusterIdList = String[]; 780 export type CacheClusterList = CacheCluster[]; 781 export interface CacheClusterMessage { 782 /** 783 * Provides an identifier to allow retrieval of paginated results. 784 */ 785 Marker?: String; 786 /** 787 * A list of clusters. Each item in the list contains detailed information about one cluster. 788 */ 789 CacheClusters?: CacheClusterList; 790 } 791 export interface CacheEngineVersion { 792 /** 793 * The name of the cache engine. 794 */ 795 Engine?: String; 796 /** 797 * The version number of the cache engine. 798 */ 799 EngineVersion?: String; 800 /** 801 * The name of the cache parameter group family associated with this cache engine. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | 802 */ 803 CacheParameterGroupFamily?: String; 804 /** 805 * The description of the cache engine. 806 */ 807 CacheEngineDescription?: String; 808 /** 809 * The description of the cache engine version. 810 */ 811 CacheEngineVersionDescription?: String; 812 } 813 export type CacheEngineVersionList = CacheEngineVersion[]; 814 export interface CacheEngineVersionMessage { 815 /** 816 * Provides an identifier to allow retrieval of paginated results. 817 */ 818 Marker?: String; 819 /** 820 * A list of cache engine version details. Each element in the list contains detailed information about one cache engine version. 821 */ 822 CacheEngineVersions?: CacheEngineVersionList; 823 } 824 export interface CacheNode { 825 /** 826 * 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 Amazon account. 827 */ 828 CacheNodeId?: String; 829 /** 830 * The current state of this cache node, one of the following values: available, creating, rebooting, or deleting. 831 */ 832 CacheNodeStatus?: String; 833 /** 834 * The date and time when the cache node was created. 835 */ 836 CacheNodeCreateTime?: TStamp; 837 /** 838 * The hostname for connecting to this cache node. 839 */ 840 Endpoint?: Endpoint; 841 /** 842 * The status of the parameter group applied to this cache node. 843 */ 844 ParameterGroupStatus?: String; 845 /** 846 * 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. 847 */ 848 SourceCacheNodeId?: String; 849 /** 850 * The Availability Zone where this node was created and now resides. 851 */ 852 CustomerAvailabilityZone?: String; 853 /** 854 * The customer outpost ARN of the cache node. 855 */ 856 CustomerOutpostArn?: String; 857 } 858 export type CacheNodeIdsList = String[]; 859 export type CacheNodeList = CacheNode[]; 860 export interface CacheNodeTypeSpecificParameter { 861 /** 862 * The name of the parameter. 863 */ 864 ParameterName?: String; 865 /** 866 * A description of the parameter. 867 */ 868 Description?: String; 869 /** 870 * The source of the parameter value. 871 */ 872 Source?: String; 873 /** 874 * The valid data type for the parameter. 875 */ 876 DataType?: String; 877 /** 878 * The valid range of values for the parameter. 879 */ 880 AllowedValues?: String; 881 /** 882 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. 883 */ 884 IsModifiable?: Boolean; 885 /** 886 * The earliest cache engine version to which the parameter can apply. 887 */ 888 MinimumEngineVersion?: String; 889 /** 890 * A list of cache node types and their corresponding values for this parameter. 891 */ 892 CacheNodeTypeSpecificValues?: CacheNodeTypeSpecificValueList; 893 /** 894 * 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. 895 */ 896 ChangeType?: ChangeType; 897 } 898 export type CacheNodeTypeSpecificParametersList = CacheNodeTypeSpecificParameter[]; 899 export interface CacheNodeTypeSpecificValue { 900 /** 901 * The cache node type for which this value applies. 902 */ 903 CacheNodeType?: String; 904 /** 905 * The value for the cache node type. 906 */ 907 Value?: String; 908 } 909 export type CacheNodeTypeSpecificValueList = CacheNodeTypeSpecificValue[]; 910 export interface CacheNodeUpdateStatus { 911 /** 912 * The node ID of the cache cluster 913 */ 914 CacheNodeId?: String; 915 /** 916 * The update status of the node 917 */ 918 NodeUpdateStatus?: NodeUpdateStatus; 919 /** 920 * The deletion date of the node 921 */ 922 NodeDeletionDate?: TStamp; 923 /** 924 * The start date of the update for a node 925 */ 926 NodeUpdateStartDate?: TStamp; 927 /** 928 * The end date of the update for a node 929 */ 930 NodeUpdateEndDate?: TStamp; 931 /** 932 * Reflects whether the update was initiated by the customer or automatically applied 933 */ 934 NodeUpdateInitiatedBy?: NodeUpdateInitiatedBy; 935 /** 936 * The date when the update is triggered 937 */ 938 NodeUpdateInitiatedDate?: TStamp; 939 /** 940 * The date when the NodeUpdateStatus was last modified> 941 */ 942 NodeUpdateStatusModifiedDate?: TStamp; 943 } 944 export type CacheNodeUpdateStatusList = CacheNodeUpdateStatus[]; 945 export interface CacheParameterGroup { 946 /** 947 * The name of the cache parameter group. 948 */ 949 CacheParameterGroupName?: String; 950 /** 951 * The name of the cache parameter group family that this cache parameter group is compatible with. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | 952 */ 953 CacheParameterGroupFamily?: String; 954 /** 955 * The description for this cache parameter group. 956 */ 957 Description?: String; 958 /** 959 * Indicates whether the parameter group is associated with a Global datastore 960 */ 961 IsGlobal?: Boolean; 962 /** 963 * The ARN (Amazon Resource Name) of the cache parameter group. 964 */ 965 ARN?: String; 966 } 967 export interface CacheParameterGroupDetails { 968 /** 969 * Provides an identifier to allow retrieval of paginated results. 970 */ 971 Marker?: String; 972 /** 973 * A list of Parameter instances. 974 */ 975 Parameters?: ParametersList; 976 /** 977 * A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter. 978 */ 979 CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList; 980 } 981 export type CacheParameterGroupList = CacheParameterGroup[]; 982 export interface CacheParameterGroupNameMessage { 983 /** 984 * The name of the cache parameter group. 985 */ 986 CacheParameterGroupName?: String; 987 } 988 export interface CacheParameterGroupStatus { 989 /** 990 * The name of the cache parameter group. 991 */ 992 CacheParameterGroupName?: String; 993 /** 994 * The status of parameter updates. 995 */ 996 ParameterApplyStatus?: String; 997 /** 998 * 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.). 999 */ 1000 CacheNodeIdsToReboot?: CacheNodeIdsList; 1001 } 1002 export interface CacheParameterGroupsMessage { 1003 /** 1004 * Provides an identifier to allow retrieval of paginated results. 1005 */ 1006 Marker?: String; 1007 /** 1008 * A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group. 1009 */ 1010 CacheParameterGroups?: CacheParameterGroupList; 1011 } 1012 export interface CacheSecurityGroup { 1013 /** 1014 * The Amazon account ID of the cache security group owner. 1015 */ 1016 OwnerId?: String; 1017 /** 1018 * The name of the cache security group. 1019 */ 1020 CacheSecurityGroupName?: String; 1021 /** 1022 * The description of the cache security group. 1023 */ 1024 Description?: String; 1025 /** 1026 * A list of Amazon EC2 security groups that are associated with this cache security group. 1027 */ 1028 EC2SecurityGroups?: EC2SecurityGroupList; 1029 /** 1030 * The ARN of the cache security group, 1031 */ 1032 ARN?: String; 1033 } 1034 export interface CacheSecurityGroupMembership { 1035 /** 1036 * The name of the cache security group. 1037 */ 1038 CacheSecurityGroupName?: String; 1039 /** 1040 * 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. 1041 */ 1042 Status?: String; 1043 } 1044 export type CacheSecurityGroupMembershipList = CacheSecurityGroupMembership[]; 1045 export interface CacheSecurityGroupMessage { 1046 /** 1047 * Provides an identifier to allow retrieval of paginated results. 1048 */ 1049 Marker?: String; 1050 /** 1051 * A list of cache security groups. Each element in the list contains detailed information about one group. 1052 */ 1053 CacheSecurityGroups?: CacheSecurityGroups; 1054 } 1055 export type CacheSecurityGroupNameList = String[]; 1056 export type CacheSecurityGroups = CacheSecurityGroup[]; 1057 export interface CacheSubnetGroup { 1058 /** 1059 * The name of the cache subnet group. 1060 */ 1061 CacheSubnetGroupName?: String; 1062 /** 1063 * The description of the cache subnet group. 1064 */ 1065 CacheSubnetGroupDescription?: String; 1066 /** 1067 * The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group. 1068 */ 1069 VpcId?: String; 1070 /** 1071 * A list of subnets associated with the cache subnet group. 1072 */ 1073 Subnets?: SubnetList; 1074 /** 1075 * The ARN (Amazon Resource Name) of the cache subnet group. 1076 */ 1077 ARN?: String; 1078 } 1079 export interface CacheSubnetGroupMessage { 1080 /** 1081 * Provides an identifier to allow retrieval of paginated results. 1082 */ 1083 Marker?: String; 1084 /** 1085 * A list of cache subnet groups. Each element in the list contains detailed information about one group. 1086 */ 1087 CacheSubnetGroups?: CacheSubnetGroups; 1088 } 1089 export type CacheSubnetGroups = CacheSubnetGroup[]; 1090 export type ChangeType = "immediate"|"requires-reboot"|string; 1091 export interface CloudWatchLogsDestinationDetails { 1092 /** 1093 * The name of the CloudWatch Logs log group. 1094 */ 1095 LogGroup?: String; 1096 } 1097 export type ClusterIdList = String[]; 1098 export interface CompleteMigrationMessage { 1099 /** 1100 * The ID of the replication group to which data is being migrated. 1101 */ 1102 ReplicationGroupId: String; 1103 /** 1104 * 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. 1105 */ 1106 Force?: Boolean; 1107 } 1108 export interface CompleteMigrationResponse { 1109 ReplicationGroup?: ReplicationGroup; 1110 } 1111 export interface ConfigureShard { 1112 /** 1113 * 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. 1114 */ 1115 NodeGroupId: AllowedNodeGroupId; 1116 /** 1117 * 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: 1 If Multi-AZ: 0 Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails) 1118 */ 1119 NewReplicaCount: Integer; 1120 /** 1121 * 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. 1122 */ 1123 PreferredAvailabilityZones?: PreferredAvailabilityZoneList; 1124 /** 1125 * The outpost ARNs in which the cache cluster is created. 1126 */ 1127 PreferredOutpostArns?: PreferredOutpostArnList; 1128 } 1129 export interface CopySnapshotMessage { 1130 /** 1131 * The name of an existing snapshot from which to make a copy. 1132 */ 1133 SourceSnapshotName: String; 1134 /** 1135 * 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. 1136 */ 1137 TargetSnapshotName: String; 1138 /** 1139 * 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. 1140 */ 1141 TargetBucket?: String; 1142 /** 1143 * The ID of the KMS key used to encrypt the target snapshot. 1144 */ 1145 KmsKeyId?: String; 1146 /** 1147 * A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. 1148 */ 1149 Tags?: TagList; 1150 } 1151 export interface CopySnapshotResult { 1152 Snapshot?: Snapshot; 1153 } 1154 export interface CreateCacheClusterMessage { 1155 /** 1156 * 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. 1157 */ 1158 CacheClusterId: String; 1159 /** 1160 * 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. 1161 */ 1162 ReplicationGroupId?: String; 1163 /** 1164 * 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. 1165 */ 1166 AZMode?: AZMode; 1167 /** 1168 * The EC2 Availability Zone in which the cluster is created. All nodes belonging to this 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. 1169 */ 1170 PreferredAvailabilityZone?: String; 1171 /** 1172 * 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. 1173 */ 1174 PreferredAvailabilityZones?: PreferredAvailabilityZoneList; 1175 /** 1176 * 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 40. If you need more than 40 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/. 1177 */ 1178 NumCacheNodes?: IntegerOptional; 1179 /** 1180 * 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: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types 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: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types 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. 1181 */ 1182 CacheNodeType?: String; 1183 /** 1184 * The name of the cache engine to be used for this cluster. Valid values for this parameter are: memcached | redis 1185 */ 1186 Engine?: String; 1187 /** 1188 * 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. 1189 */ 1190 EngineVersion?: String; 1191 /** 1192 * 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. 1193 */ 1194 CacheParameterGroupName?: String; 1195 /** 1196 * 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. 1197 */ 1198 CacheSubnetGroupName?: String; 1199 /** 1200 * 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). 1201 */ 1202 CacheSecurityGroupNames?: CacheSecurityGroupNameList; 1203 /** 1204 * 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). 1205 */ 1206 SecurityGroupIds?: SecurityGroupIdsList; 1207 /** 1208 * A list of tags to be added to this resource. 1209 */ 1210 Tags?: TagList; 1211 /** 1212 * 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 1213 */ 1214 SnapshotArns?: SnapshotArnsList; 1215 /** 1216 * 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. 1217 */ 1218 SnapshotName?: String; 1219 /** 1220 * 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: 1221 */ 1222 PreferredMaintenanceWindow?: String; 1223 /** 1224 * The port number on which each of the cache nodes accepts connections. 1225 */ 1226 Port?: IntegerOptional; 1227 /** 1228 * 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. 1229 */ 1230 NotificationTopicArn?: String; 1231 /** 1232 * This parameter is currently disabled. 1233 */ 1234 AutoMinorVersionUpgrade?: BooleanOptional; 1235 /** 1236 * 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). 1237 */ 1238 SnapshotRetentionLimit?: IntegerOptional; 1239 /** 1240 * 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. 1241 */ 1242 SnapshotWindow?: String; 1243 /** 1244 * 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 !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token. For more information, see AUTH password at http://redis.io/commands/AUTH. 1245 */ 1246 AuthToken?: String; 1247 /** 1248 * Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts. 1249 */ 1250 OutpostMode?: OutpostMode; 1251 /** 1252 * The outpost ARN in which the cache cluster is created. 1253 */ 1254 PreferredOutpostArn?: String; 1255 /** 1256 * The outpost ARNs in which the cache cluster is created. 1257 */ 1258 PreferredOutpostArns?: PreferredOutpostArnList; 1259 /** 1260 * Specifies the destination, format and type of the logs. 1261 */ 1262 LogDeliveryConfigurations?: LogDeliveryConfigurationRequestList; 1263 } 1264 export interface CreateCacheClusterResult { 1265 CacheCluster?: CacheCluster; 1266 } 1267 export interface CreateCacheParameterGroupMessage { 1268 /** 1269 * A user-specified name for the cache parameter group. 1270 */ 1271 CacheParameterGroupName: String; 1272 /** 1273 * The name of the cache parameter group family that the cache parameter group can be used with. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | 1274 */ 1275 CacheParameterGroupFamily: String; 1276 /** 1277 * A user-specified description for the cache parameter group. 1278 */ 1279 Description: String; 1280 /** 1281 * A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. 1282 */ 1283 Tags?: TagList; 1284 } 1285 export interface CreateCacheParameterGroupResult { 1286 CacheParameterGroup?: CacheParameterGroup; 1287 } 1288 export interface CreateCacheSecurityGroupMessage { 1289 /** 1290 * 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 1291 */ 1292 CacheSecurityGroupName: String; 1293 /** 1294 * A description for the cache security group. 1295 */ 1296 Description: String; 1297 /** 1298 * A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. 1299 */ 1300 Tags?: TagList; 1301 } 1302 export interface CreateCacheSecurityGroupResult { 1303 CacheSecurityGroup?: CacheSecurityGroup; 1304 } 1305 export interface CreateCacheSubnetGroupMessage { 1306 /** 1307 * 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 1308 */ 1309 CacheSubnetGroupName: String; 1310 /** 1311 * A description for the cache subnet group. 1312 */ 1313 CacheSubnetGroupDescription: String; 1314 /** 1315 * A list of VPC subnet IDs for the cache subnet group. 1316 */ 1317 SubnetIds: SubnetIdentifierList; 1318 /** 1319 * A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. 1320 */ 1321 Tags?: TagList; 1322 } 1323 export interface CreateCacheSubnetGroupResult { 1324 CacheSubnetGroup?: CacheSubnetGroup; 1325 } 1326 export interface CreateGlobalReplicationGroupMessage { 1327 /** 1328 * The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions. For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores . 1329 */ 1330 GlobalReplicationGroupIdSuffix: String; 1331 /** 1332 * Provides details of the Global datastore 1333 */ 1334 GlobalReplicationGroupDescription?: String; 1335 /** 1336 * The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster. 1337 */ 1338 PrimaryReplicationGroupId: String; 1339 } 1340 export interface CreateGlobalReplicationGroupResult { 1341 GlobalReplicationGroup?: GlobalReplicationGroup; 1342 } 1343 export interface CreateReplicationGroupMessage { 1344 /** 1345 * 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. 1346 */ 1347 ReplicationGroupId: String; 1348 /** 1349 * A user-created description for the replication group. 1350 */ 1351 ReplicationGroupDescription: String; 1352 /** 1353 * The name of the Global datastore 1354 */ 1355 GlobalReplicationGroupId?: String; 1356 /** 1357 * 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. 1358 */ 1359 PrimaryClusterId?: String; 1360 /** 1361 * Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. Default: false 1362 */ 1363 AutomaticFailoverEnabled?: BooleanOptional; 1364 /** 1365 * A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ. 1366 */ 1367 MultiAZEnabled?: BooleanOptional; 1368 /** 1369 * 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). 1370 */ 1371 NumCacheClusters?: IntegerOptional; 1372 /** 1373 * 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. 1374 */ 1375 PreferredCacheClusterAZs?: AvailabilityZonesList; 1376 /** 1377 * 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 1378 */ 1379 NumNodeGroups?: IntegerOptional; 1380 /** 1381 * An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5. 1382 */ 1383 ReplicasPerNodeGroup?: IntegerOptional; 1384 /** 1385 * 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, it is required 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. 1386 */ 1387 NodeGroupConfiguration?: NodeGroupConfigurationList; 1388 /** 1389 * 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: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types 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: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types 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. 1390 */ 1391 CacheNodeType?: String; 1392 /** 1393 * The name of the cache engine to be used for the clusters in this replication group. Must be Redis. 1394 */ 1395 Engine?: String; 1396 /** 1397 * 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. 1398 */ 1399 EngineVersion?: String; 1400 /** 1401 * The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2. To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on. 1402 */ 1403 CacheParameterGroupName?: String; 1404 /** 1405 * 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. 1406 */ 1407 CacheSubnetGroupName?: String; 1408 /** 1409 * A list of cache security group names to associate with this replication group. 1410 */ 1411 CacheSecurityGroupNames?: CacheSecurityGroupNameList; 1412 /** 1413 * 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). 1414 */ 1415 SecurityGroupIds?: SecurityGroupIdsList; 1416 /** 1417 * A list of 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. Tags on replication groups will be replicated to all nodes. 1418 */ 1419 Tags?: TagList; 1420 /** 1421 * 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 1422 */ 1423 SnapshotArns?: SnapshotArnsList; 1424 /** 1425 * 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. 1426 */ 1427 SnapshotName?: String; 1428 /** 1429 * 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 1430 */ 1431 PreferredMaintenanceWindow?: String; 1432 /** 1433 * The port number on which each member of the replication group accepts connections. 1434 */ 1435 Port?: IntegerOptional; 1436 /** 1437 * 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. 1438 */ 1439 NotificationTopicArn?: String; 1440 /** 1441 * This parameter is currently disabled. 1442 */ 1443 AutoMinorVersionUpgrade?: BooleanOptional; 1444 /** 1445 * 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). 1446 */ 1447 SnapshotRetentionLimit?: IntegerOptional; 1448 /** 1449 * 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. 1450 */ 1451 SnapshotWindow?: String; 1452 /** 1453 * 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 !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token. For more information, see AUTH password at http://redis.io/commands/AUTH. 1454 */ 1455 AuthToken?: String; 1456 /** 1457 * 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. 1458 */ 1459 TransitEncryptionEnabled?: BooleanOptional; 1460 /** 1461 * 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 1462 */ 1463 AtRestEncryptionEnabled?: BooleanOptional; 1464 /** 1465 * The ID of the KMS key used to encrypt the disk in the cluster. 1466 */ 1467 KmsKeyId?: String; 1468 /** 1469 * The user group to associate with the replication group. 1470 */ 1471 UserGroupIds?: UserGroupIdListInput; 1472 /** 1473 * Specifies the destination, format and type of the logs. 1474 */ 1475 LogDeliveryConfigurations?: LogDeliveryConfigurationRequestList; 1476 } 1477 export interface CreateReplicationGroupResult { 1478 ReplicationGroup?: ReplicationGroup; 1479 } 1480 export interface CreateSnapshotMessage { 1481 /** 1482 * The identifier of an existing replication group. The snapshot is created from this replication group. 1483 */ 1484 ReplicationGroupId?: String; 1485 /** 1486 * The identifier of an existing cluster. The snapshot is created from this cluster. 1487 */ 1488 CacheClusterId?: String; 1489 /** 1490 * A name for the snapshot being created. 1491 */ 1492 SnapshotName: String; 1493 /** 1494 * The ID of the KMS key used to encrypt the snapshot. 1495 */ 1496 KmsKeyId?: String; 1497 /** 1498 * A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. 1499 */ 1500 Tags?: TagList; 1501 } 1502 export interface CreateSnapshotResult { 1503 Snapshot?: Snapshot; 1504 } 1505 export interface CreateUserGroupMessage { 1506 /** 1507 * The ID of the user group. 1508 */ 1509 UserGroupId: String; 1510 /** 1511 * The current supported value is Redis. 1512 */ 1513 Engine: EngineType; 1514 /** 1515 * The list of user IDs that belong to the user group. 1516 */ 1517 UserIds?: UserIdListInput; 1518 /** 1519 * A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. 1520 */ 1521 Tags?: TagList; 1522 } 1523 export interface CreateUserMessage { 1524 /** 1525 * The ID of the user. 1526 */ 1527 UserId: UserId; 1528 /** 1529 * The username of the user. 1530 */ 1531 UserName: UserName; 1532 /** 1533 * The current supported value is Redis. 1534 */ 1535 Engine: EngineType; 1536 /** 1537 * Passwords used for this user. You can create up to two passwords for each user. 1538 */ 1539 Passwords?: PasswordListInput; 1540 /** 1541 * Access permissions string used for this user. 1542 */ 1543 AccessString: AccessString; 1544 /** 1545 * Indicates a password is not required for this user. 1546 */ 1547 NoPasswordRequired?: BooleanOptional; 1548 /** 1549 * A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. 1550 */ 1551 Tags?: TagList; 1552 } 1553 export interface CustomerNodeEndpoint { 1554 /** 1555 * The address of the node endpoint 1556 */ 1557 Address?: String; 1558 /** 1559 * The port of the node endpoint 1560 */ 1561 Port?: IntegerOptional; 1562 } 1563 export type CustomerNodeEndpointList = CustomerNodeEndpoint[]; 1564 export interface DecreaseNodeGroupsInGlobalReplicationGroupMessage { 1565 /** 1566 * The name of the Global datastore 1567 */ 1568 GlobalReplicationGroupId: String; 1569 /** 1570 * The number of node groups (shards) that results from the modification of the shard configuration 1571 */ 1572 NodeGroupCount: Integer; 1573 /** 1574 * If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster. 1575 */ 1576 GlobalNodeGroupsToRemove?: GlobalNodeGroupIdList; 1577 /** 1578 * If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster. 1579 */ 1580 GlobalNodeGroupsToRetain?: GlobalNodeGroupIdList; 1581 /** 1582 * Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. 1583 */ 1584 ApplyImmediately: Boolean; 1585 } 1586 export interface DecreaseNodeGroupsInGlobalReplicationGroupResult { 1587 GlobalReplicationGroup?: GlobalReplicationGroup; 1588 } 1589 export interface DecreaseReplicaCountMessage { 1590 /** 1591 * The id of the replication group from which you want to remove replica nodes. 1592 */ 1593 ReplicationGroupId: String; 1594 /** 1595 * 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 is enabled: 1 If Multi-AZ 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) 1596 */ 1597 NewReplicaCount?: IntegerOptional; 1598 /** 1599 * 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. 1600 */ 1601 ReplicaConfiguration?: ReplicaConfigurationList; 1602 /** 1603 * A list of the node ids to remove from the replication group or node group (shard). 1604 */ 1605 ReplicasToRemove?: RemoveReplicasList; 1606 /** 1607 * If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported. 1608 */ 1609 ApplyImmediately: Boolean; 1610 } 1611 export interface DecreaseReplicaCountResult { 1612 ReplicationGroup?: ReplicationGroup; 1613 } 1614 export interface DeleteCacheClusterMessage { 1615 /** 1616 * The cluster identifier for the cluster to be deleted. This parameter is not case sensitive. 1617 */ 1618 CacheClusterId: String; 1619 /** 1620 * 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. 1621 */ 1622 FinalSnapshotIdentifier?: String; 1623 } 1624 export interface DeleteCacheClusterResult { 1625 CacheCluster?: CacheCluster; 1626 } 1627 export interface DeleteCacheParameterGroupMessage { 1628 /** 1629 * The name of the cache parameter group to delete. The specified cache security group must not be associated with any clusters. 1630 */ 1631 CacheParameterGroupName: String; 1632 } 1633 export interface DeleteCacheSecurityGroupMessage { 1634 /** 1635 * The name of the cache security group to delete. You cannot delete the default security group. 1636 */ 1637 CacheSecurityGroupName: String; 1638 } 1639 export interface DeleteCacheSubnetGroupMessage { 1640 /** 1641 * The name of the cache subnet group to delete. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. 1642 */ 1643 CacheSubnetGroupName: String; 1644 } 1645 export interface DeleteGlobalReplicationGroupMessage { 1646 /** 1647 * The name of the Global datastore 1648 */ 1649 GlobalReplicationGroupId: String; 1650 /** 1651 * The primary replication group is retained as a standalone replication group. 1652 */ 1653 RetainPrimaryReplicationGroup: Boolean; 1654 } 1655 export interface DeleteGlobalReplicationGroupResult { 1656 GlobalReplicationGroup?: GlobalReplicationGroup; 1657 } 1658 export interface DeleteReplicationGroupMessage { 1659 /** 1660 * The identifier for the cluster to be deleted. This parameter is not case sensitive. 1661 */ 1662 ReplicationGroupId: String; 1663 /** 1664 * If set to true, all of the read replicas are deleted, but the primary node is retained. 1665 */ 1666 RetainPrimaryCluster?: BooleanOptional; 1667 /** 1668 * 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. 1669 */ 1670 FinalSnapshotIdentifier?: String; 1671 } 1672 export interface DeleteReplicationGroupResult { 1673 ReplicationGroup?: ReplicationGroup; 1674 } 1675 export interface DeleteSnapshotMessage { 1676 /** 1677 * The name of the snapshot to be deleted. 1678 */ 1679 SnapshotName: String; 1680 } 1681 export interface DeleteSnapshotResult { 1682 Snapshot?: Snapshot; 1683 } 1684 export interface DeleteUserGroupMessage { 1685 /** 1686 * The ID of the user group. 1687 */ 1688 UserGroupId: String; 1689 } 1690 export interface DeleteUserMessage { 1691 /** 1692 * The ID of the user. 1693 */ 1694 UserId: UserId; 1695 } 1696 export interface DescribeCacheClustersMessage { 1697 /** 1698 * The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive. 1699 */ 1700 CacheClusterId?: String; 1701 /** 1702 * 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. 1703 */ 1704 MaxRecords?: IntegerOptional; 1705 /** 1706 * 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. 1707 */ 1708 Marker?: String; 1709 /** 1710 * An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes. 1711 */ 1712 ShowCacheNodeInfo?: BooleanOptional; 1713 /** 1714 * 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. 1715 */ 1716 ShowCacheClustersNotInReplicationGroups?: BooleanOptional; 1717 } 1718 export interface DescribeCacheEngineVersionsMessage { 1719 /** 1720 * The cache engine to return. Valid values: memcached | redis 1721 */ 1722 Engine?: String; 1723 /** 1724 * The cache engine version to return. Example: 1.4.14 1725 */ 1726 EngineVersion?: String; 1727 /** 1728 * The name of a specific cache parameter group family to return details for. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens 1729 */ 1730 CacheParameterGroupFamily?: String; 1731 /** 1732 * 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. 1733 */ 1734 MaxRecords?: IntegerOptional; 1735 /** 1736 * 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. 1737 */ 1738 Marker?: String; 1739 /** 1740 * If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned. 1741 */ 1742 DefaultOnly?: Boolean; 1743 } 1744 export interface DescribeCacheParameterGroupsMessage { 1745 /** 1746 * The name of a specific cache parameter group to return details for. 1747 */ 1748 CacheParameterGroupName?: String; 1749 /** 1750 * 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. 1751 */ 1752 MaxRecords?: IntegerOptional; 1753 /** 1754 * 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. 1755 */ 1756 Marker?: String; 1757 } 1758 export interface DescribeCacheParametersMessage { 1759 /** 1760 * The name of a specific cache parameter group to return details for. 1761 */ 1762 CacheParameterGroupName: String; 1763 /** 1764 * The parameter types to return. Valid values: user | system | engine-default 1765 */ 1766 Source?: String; 1767 /** 1768 * 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. 1769 */ 1770 MaxRecords?: IntegerOptional; 1771 /** 1772 * 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. 1773 */ 1774 Marker?: String; 1775 } 1776 export interface DescribeCacheSecurityGroupsMessage { 1777 /** 1778 * The name of the cache security group to return details for. 1779 */ 1780 CacheSecurityGroupName?: String; 1781 /** 1782 * 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. 1783 */ 1784 MaxRecords?: IntegerOptional; 1785 /** 1786 * 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. 1787 */ 1788 Marker?: String; 1789 } 1790 export interface DescribeCacheSubnetGroupsMessage { 1791 /** 1792 * The name of the cache subnet group to return details for. 1793 */ 1794 CacheSubnetGroupName?: String; 1795 /** 1796 * 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. 1797 */ 1798 MaxRecords?: IntegerOptional; 1799 /** 1800 * 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. 1801 */ 1802 Marker?: String; 1803 } 1804 export interface DescribeEngineDefaultParametersMessage { 1805 /** 1806 * The name of the cache parameter group family. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | 1807 */ 1808 CacheParameterGroupFamily: String; 1809 /** 1810 * 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. 1811 */ 1812 MaxRecords?: IntegerOptional; 1813 /** 1814 * 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. 1815 */ 1816 Marker?: String; 1817 } 1818 export interface DescribeEngineDefaultParametersResult { 1819 EngineDefaults?: EngineDefaults; 1820 } 1821 export interface DescribeEventsMessage { 1822 /** 1823 * The identifier of the event source for which events are returned. If not specified, all sources are included in the response. 1824 */ 1825 SourceIdentifier?: String; 1826 /** 1827 * The event source to retrieve events for. If no value is specified, all events are returned. 1828 */ 1829 SourceType?: SourceType; 1830 /** 1831 * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z 1832 */ 1833 StartTime?: TStamp; 1834 /** 1835 * The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z 1836 */ 1837 EndTime?: TStamp; 1838 /** 1839 * The number of minutes worth of events to retrieve. 1840 */ 1841 Duration?: IntegerOptional; 1842 /** 1843 * 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. 1844 */ 1845 MaxRecords?: IntegerOptional; 1846 /** 1847 * 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. 1848 */ 1849 Marker?: String; 1850 } 1851 export interface DescribeGlobalReplicationGroupsMessage { 1852 /** 1853 * The name of the Global datastore 1854 */ 1855 GlobalReplicationGroupId?: String; 1856 /** 1857 * 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. 1858 */ 1859 MaxRecords?: IntegerOptional; 1860 /** 1861 * 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. 1862 */ 1863 Marker?: String; 1864 /** 1865 * Returns the list of members that comprise the Global datastore. 1866 */ 1867 ShowMemberInfo?: BooleanOptional; 1868 } 1869 export interface DescribeGlobalReplicationGroupsResult { 1870 /** 1871 * 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. > 1872 */ 1873 Marker?: String; 1874 /** 1875 * Indicates the slot configuration and global identifier for each slice group. 1876 */ 1877 GlobalReplicationGroups?: GlobalReplicationGroupList; 1878 } 1879 export interface DescribeReplicationGroupsMessage { 1880 /** 1881 * 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. 1882 */ 1883 ReplicationGroupId?: String; 1884 /** 1885 * 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. 1886 */ 1887 MaxRecords?: IntegerOptional; 1888 /** 1889 * 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. 1890 */ 1891 Marker?: String; 1892 } 1893 export interface DescribeReservedCacheNodesMessage { 1894 /** 1895 * The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID. 1896 */ 1897 ReservedCacheNodeId?: String; 1898 /** 1899 * The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier. 1900 */ 1901 ReservedCacheNodesOfferingId?: String; 1902 /** 1903 * 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: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types 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: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types 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. 1904 */ 1905 CacheNodeType?: String; 1906 /** 1907 * 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 1908 */ 1909 Duration?: String; 1910 /** 1911 * The product description filter value. Use this parameter to show only those reservations matching the specified product description. 1912 */ 1913 ProductDescription?: String; 1914 /** 1915 * 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"|"All Upfront"|"Partial Upfront"| "No Upfront" 1916 */ 1917 OfferingType?: String; 1918 /** 1919 * 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. 1920 */ 1921 MaxRecords?: IntegerOptional; 1922 /** 1923 * 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. 1924 */ 1925 Marker?: String; 1926 } 1927 export interface DescribeReservedCacheNodesOfferingsMessage { 1928 /** 1929 * 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 1930 */ 1931 ReservedCacheNodesOfferingId?: String; 1932 /** 1933 * 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: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types 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: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types 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. 1934 */ 1935 CacheNodeType?: String; 1936 /** 1937 * 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 1938 */ 1939 Duration?: String; 1940 /** 1941 * The product description filter value. Use this parameter to show only the available offerings matching the specified product description. 1942 */ 1943 ProductDescription?: String; 1944 /** 1945 * 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" |"All Upfront"|"Partial Upfront"| "No Upfront" 1946 */ 1947 OfferingType?: String; 1948 /** 1949 * 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. 1950 */ 1951 MaxRecords?: IntegerOptional; 1952 /** 1953 * 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. 1954 */ 1955 Marker?: String; 1956 } 1957 export interface DescribeServiceUpdatesMessage { 1958 /** 1959 * The unique ID of the service update 1960 */ 1961 ServiceUpdateName?: String; 1962 /** 1963 * The status of the service update 1964 */ 1965 ServiceUpdateStatus?: ServiceUpdateStatusList; 1966 /** 1967 * The maximum number of records to include in the response 1968 */ 1969 MaxRecords?: IntegerOptional; 1970 /** 1971 * 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. 1972 */ 1973 Marker?: String; 1974 } 1975 export interface DescribeSnapshotsListMessage { 1976 /** 1977 * 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. 1978 */ 1979 Marker?: String; 1980 /** 1981 * A list of snapshots. Each item in the list contains detailed information about one snapshot. 1982 */ 1983 Snapshots?: SnapshotList; 1984 } 1985 export interface DescribeSnapshotsMessage { 1986 /** 1987 * A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described. 1988 */ 1989 ReplicationGroupId?: String; 1990 /** 1991 * A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described. 1992 */ 1993 CacheClusterId?: String; 1994 /** 1995 * A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described. 1996 */ 1997 SnapshotName?: String; 1998 /** 1999 * 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. 2000 */ 2001 SnapshotSource?: String; 2002 /** 2003 * 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. 2004 */ 2005 Marker?: String; 2006 /** 2007 * 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. 2008 */ 2009 MaxRecords?: IntegerOptional; 2010 /** 2011 * A Boolean value which if true, the node group (shard) configuration is included in the snapshot description. 2012 */ 2013 ShowNodeGroupConfig?: BooleanOptional; 2014 } 2015 export interface DescribeUpdateActionsMessage { 2016 /** 2017 * The unique ID of the service update 2018 */ 2019 ServiceUpdateName?: String; 2020 /** 2021 * The replication group IDs 2022 */ 2023 ReplicationGroupIds?: ReplicationGroupIdList; 2024 /** 2025 * The cache cluster IDs 2026 */ 2027 CacheClusterIds?: CacheClusterIdList; 2028 /** 2029 * The Elasticache engine to which the update applies. Either Redis or Memcached 2030 */ 2031 Engine?: String; 2032 /** 2033 * The status of the service update 2034 */ 2035 ServiceUpdateStatus?: ServiceUpdateStatusList; 2036 /** 2037 * The range of time specified to search for service updates that are in available status 2038 */ 2039 ServiceUpdateTimeRange?: TimeRangeFilter; 2040 /** 2041 * The status of the update action. 2042 */ 2043 UpdateActionStatus?: UpdateActionStatusList; 2044 /** 2045 * Dictates whether to include node level update status in the response 2046 */ 2047 ShowNodeLevelUpdateStatus?: BooleanOptional; 2048 /** 2049 * The maximum number of records to include in the response 2050 */ 2051 MaxRecords?: IntegerOptional; 2052 /** 2053 * 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. 2054 */ 2055 Marker?: String; 2056 } 2057 export interface DescribeUserGroupsMessage { 2058 /** 2059 * The ID of the user group. 2060 */ 2061 UserGroupId?: String; 2062 /** 2063 * 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. 2064 */ 2065 MaxRecords?: IntegerOptional; 2066 /** 2067 * 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. > 2068 */ 2069 Marker?: String; 2070 } 2071 export interface DescribeUserGroupsResult { 2072 /** 2073 * Returns a list of user groups. 2074 */ 2075 UserGroups?: UserGroupList; 2076 /** 2077 * 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. > 2078 */ 2079 Marker?: String; 2080 } 2081 export interface DescribeUsersMessage { 2082 /** 2083 * The Redis engine. 2084 */ 2085 Engine?: EngineType; 2086 /** 2087 * The ID of the user. 2088 */ 2089 UserId?: UserId; 2090 /** 2091 * Filter to determine the list of User IDs to return. 2092 */ 2093 Filters?: FilterList; 2094 /** 2095 * 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. 2096 */ 2097 MaxRecords?: IntegerOptional; 2098 /** 2099 * 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. > 2100 */ 2101 Marker?: String; 2102 } 2103 export interface DescribeUsersResult { 2104 /** 2105 * A list of users. 2106 */ 2107 Users?: UserList; 2108 /** 2109 * 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. > 2110 */ 2111 Marker?: String; 2112 } 2113 export interface DestinationDetails { 2114 /** 2115 * The configuration details of the CloudWatch Logs destination. 2116 */ 2117 CloudWatchLogsDetails?: CloudWatchLogsDestinationDetails; 2118 /** 2119 * The configuration details of the Kinesis Data Firehose destination. 2120 */ 2121 KinesisFirehoseDetails?: KinesisFirehoseDestinationDetails; 2122 } 2123 export type DestinationType = "cloudwatch-logs"|"kinesis-firehose"|string; 2124 export interface DisassociateGlobalReplicationGroupMessage { 2125 /** 2126 * The name of the Global datastore 2127 */ 2128 GlobalReplicationGroupId: String; 2129 /** 2130 * The name of the secondary cluster you wish to remove from the Global datastore 2131 */ 2132 ReplicationGroupId: String; 2133 /** 2134 * The Amazon region of secondary cluster you wish to remove from the Global datastore 2135 */ 2136 ReplicationGroupRegion: String; 2137 } 2138 export interface DisassociateGlobalReplicationGroupResult { 2139 GlobalReplicationGroup?: GlobalReplicationGroup; 2140 } 2141 export type Double = number; 2142 export interface EC2SecurityGroup { 2143 /** 2144 * The status of the Amazon EC2 security group. 2145 */ 2146 Status?: String; 2147 /** 2148 * The name of the Amazon EC2 security group. 2149 */ 2150 EC2SecurityGroupName?: String; 2151 /** 2152 * The Amazon account ID of the Amazon EC2 security group owner. 2153 */ 2154 EC2SecurityGroupOwnerId?: String; 2155 } 2156 export type EC2SecurityGroupList = EC2SecurityGroup[]; 2157 export interface Endpoint { 2158 /** 2159 * The DNS hostname of the cache node. 2160 */ 2161 Address?: String; 2162 /** 2163 * The port number that the cache engine is listening on. 2164 */ 2165 Port?: Integer; 2166 } 2167 export interface EngineDefaults { 2168 /** 2169 * Specifies the name of the cache parameter group family to which the engine default parameters apply. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | 2170 */ 2171 CacheParameterGroupFamily?: String; 2172 /** 2173 * Provides an identifier to allow retrieval of paginated results. 2174 */ 2175 Marker?: String; 2176 /** 2177 * Contains a list of engine default parameters. 2178 */ 2179 Parameters?: ParametersList; 2180 /** 2181 * A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter. 2182 */ 2183 CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList; 2184 } 2185 export type EngineType = string; 2186 export interface Event { 2187 /** 2188 * 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. 2189 */ 2190 SourceIdentifier?: String; 2191 /** 2192 * Specifies the origin of this event - a cluster, a parameter group, a security group, etc. 2193 */ 2194 SourceType?: SourceType; 2195 /** 2196 * The text of the event. 2197 */ 2198 Message?: String; 2199 /** 2200 * The date and time when the event occurred. 2201 */ 2202 Date?: TStamp; 2203 } 2204 export type EventList = Event[]; 2205 export interface EventsMessage { 2206 /** 2207 * Provides an identifier to allow retrieval of paginated results. 2208 */ 2209 Marker?: String; 2210 /** 2211 * A list of events. Each element in the list contains detailed information about one event. 2212 */ 2213 Events?: EventList; 2214 } 2215 export interface FailoverGlobalReplicationGroupMessage { 2216 /** 2217 * The name of the Global datastore 2218 */ 2219 GlobalReplicationGroupId: String; 2220 /** 2221 * The Amazon region of the primary cluster of the Global datastore 2222 */ 2223 PrimaryRegion: String; 2224 /** 2225 * The name of the primary replication group 2226 */ 2227 PrimaryReplicationGroupId: String; 2228 } 2229 export interface FailoverGlobalReplicationGroupResult { 2230 GlobalReplicationGroup?: GlobalReplicationGroup; 2231 } 2232 export interface Filter { 2233 /** 2234 * The property being filtered. For example, UserId. 2235 */ 2236 Name: FilterName; 2237 /** 2238 * The property values to filter on. For example, "user-123". 2239 */ 2240 Values: FilterValueList; 2241 } 2242 export type FilterList = Filter[]; 2243 export type FilterName = string; 2244 export type FilterValue = string; 2245 export type FilterValueList = FilterValue[]; 2246 export interface GlobalNodeGroup { 2247 /** 2248 * The name of the global node group 2249 */ 2250 GlobalNodeGroupId?: String; 2251 /** 2252 * The keyspace for this node group 2253 */ 2254 Slots?: String; 2255 } 2256 export type GlobalNodeGroupIdList = String[]; 2257 export type GlobalNodeGroupList = GlobalNodeGroup[]; 2258 export interface GlobalReplicationGroup { 2259 /** 2260 * The name of the Global datastore 2261 */ 2262 GlobalReplicationGroupId?: String; 2263 /** 2264 * The optional description of the Global datastore 2265 */ 2266 GlobalReplicationGroupDescription?: String; 2267 /** 2268 * The status of the Global datastore 2269 */ 2270 Status?: String; 2271 /** 2272 * The cache node type of the Global datastore 2273 */ 2274 CacheNodeType?: String; 2275 /** 2276 * The Elasticache engine. For Redis only. 2277 */ 2278 Engine?: String; 2279 /** 2280 * The Elasticache Redis engine version. 2281 */ 2282 EngineVersion?: String; 2283 /** 2284 * The replication groups that comprise the Global datastore. 2285 */ 2286 Members?: GlobalReplicationGroupMemberList; 2287 /** 2288 * A flag that indicates whether the Global datastore is cluster enabled. 2289 */ 2290 ClusterEnabled?: BooleanOptional; 2291 /** 2292 * Indicates the slot configuration and global identifier for each slice group. 2293 */ 2294 GlobalNodeGroups?: GlobalNodeGroupList; 2295 /** 2296 * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false 2297 */ 2298 AuthTokenEnabled?: BooleanOptional; 2299 /** 2300 * 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. 2301 */ 2302 TransitEncryptionEnabled?: BooleanOptional; 2303 /** 2304 * 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. 2305 */ 2306 AtRestEncryptionEnabled?: BooleanOptional; 2307 /** 2308 * The ARN (Amazon Resource Name) of the global replication group. 2309 */ 2310 ARN?: String; 2311 } 2312 export interface GlobalReplicationGroupInfo { 2313 /** 2314 * The name of the Global datastore 2315 */ 2316 GlobalReplicationGroupId?: String; 2317 /** 2318 * The role of the replication group in a Global datastore. Can be primary or secondary. 2319 */ 2320 GlobalReplicationGroupMemberRole?: String; 2321 } 2322 export type GlobalReplicationGroupList = GlobalReplicationGroup[]; 2323 export interface GlobalReplicationGroupMember { 2324 /** 2325 * The replication group id of the Global datastore member. 2326 */ 2327 ReplicationGroupId?: String; 2328 /** 2329 * The Amazon region of the Global datastore member. 2330 */ 2331 ReplicationGroupRegion?: String; 2332 /** 2333 * Indicates the role of the replication group, primary or secondary. 2334 */ 2335 Role?: String; 2336 /** 2337 * Indicates whether automatic failover is enabled for the replication group. 2338 */ 2339 AutomaticFailover?: AutomaticFailoverStatus; 2340 /** 2341 * The status of the membership of the replication group. 2342 */ 2343 Status?: String; 2344 } 2345 export type GlobalReplicationGroupMemberList = GlobalReplicationGroupMember[]; 2346 export interface IncreaseNodeGroupsInGlobalReplicationGroupMessage { 2347 /** 2348 * The name of the Global datastore 2349 */ 2350 GlobalReplicationGroupId: String; 2351 /** 2352 * The number of node groups you wish to add 2353 */ 2354 NodeGroupCount: Integer; 2355 /** 2356 * Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore 2357 */ 2358 RegionalConfigurations?: RegionalConfigurationList; 2359 /** 2360 * Indicates that the process begins immediately. At present, the only permitted value for this parameter is true. 2361 */ 2362 ApplyImmediately: Boolean; 2363 } 2364 export interface IncreaseNodeGroupsInGlobalReplicationGroupResult { 2365 GlobalReplicationGroup?: GlobalReplicationGroup; 2366 } 2367 export interface IncreaseReplicaCountMessage { 2368 /** 2369 * The id of the replication group to which you want to add replica nodes. 2370 */ 2371 ReplicationGroupId: String; 2372 /** 2373 * 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. 2374 */ 2375 NewReplicaCount?: IntegerOptional; 2376 /** 2377 * 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. 2378 */ 2379 ReplicaConfiguration?: ReplicaConfigurationList; 2380 /** 2381 * If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported. 2382 */ 2383 ApplyImmediately: Boolean; 2384 } 2385 export interface IncreaseReplicaCountResult { 2386 ReplicationGroup?: ReplicationGroup; 2387 } 2388 export type Integer = number; 2389 export type IntegerOptional = number; 2390 export type KeyList = String[]; 2391 export interface KinesisFirehoseDestinationDetails { 2392 /** 2393 * The name of the Kinesis Data Firehose delivery stream. 2394 */ 2395 DeliveryStream?: String; 2396 } 2397 export interface ListAllowedNodeTypeModificationsMessage { 2398 /** 2399 * 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. 2400 */ 2401 CacheClusterId?: String; 2402 /** 2403 * 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. 2404 */ 2405 ReplicationGroupId?: String; 2406 } 2407 export interface ListTagsForResourceMessage { 2408 /** 2409 * 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 Amazon Web Services Service Namespaces. 2410 */ 2411 ResourceName: String; 2412 } 2413 export interface LogDeliveryConfiguration { 2414 /** 2415 * Refers to slow-log. 2416 */ 2417 LogType?: LogType; 2418 /** 2419 * Returns the destination type, either cloudwatch-logs or kinesis-firehose. 2420 */ 2421 DestinationType?: DestinationType; 2422 /** 2423 * Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. 2424 */ 2425 DestinationDetails?: DestinationDetails; 2426 /** 2427 * Returns the log format, either JSON or TEXT. 2428 */ 2429 LogFormat?: LogFormat; 2430 /** 2431 * Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error 2432 */ 2433 Status?: LogDeliveryConfigurationStatus; 2434 /** 2435 * Returns an error message for the log delivery configuration. 2436 */ 2437 Message?: String; 2438 } 2439 export type LogDeliveryConfigurationList = LogDeliveryConfiguration[]; 2440 export interface LogDeliveryConfigurationRequest { 2441 /** 2442 * Refers to slow-log. 2443 */ 2444 LogType?: LogType; 2445 /** 2446 * Specify either cloudwatch-logs or kinesis-firehose as the destination type. 2447 */ 2448 DestinationType?: DestinationType; 2449 /** 2450 * Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. 2451 */ 2452 DestinationDetails?: DestinationDetails; 2453 /** 2454 * Specifies either JSON or TEXT 2455 */ 2456 LogFormat?: LogFormat; 2457 /** 2458 * Specify if log delivery is enabled. Default true. 2459 */ 2460 Enabled?: BooleanOptional; 2461 } 2462 export type LogDeliveryConfigurationRequestList = LogDeliveryConfigurationRequest[]; 2463 export type LogDeliveryConfigurationStatus = "active"|"enabling"|"modifying"|"disabling"|"error"|string; 2464 export type LogFormat = "text"|"json"|string; 2465 export type LogType = "slow-log"|string; 2466 export interface ModifyCacheClusterMessage { 2467 /** 2468 * The cluster identifier. This value is stored as a lowercase string. 2469 */ 2470 CacheClusterId: String; 2471 /** 2472 * 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 40. 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. 2473 */ 2474 NumCacheNodes?: IntegerOptional; 2475 /** 2476 * 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. 2477 */ 2478 CacheNodeIdsToRemove?: CacheNodeIdsList; 2479 /** 2480 * 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. 2481 */ 2482 AZMode?: AZMode; 2483 /** 2484 * This option is only supported on Memcached clusters. 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. 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. 2485 */ 2486 NewAvailabilityZones?: PreferredAvailabilityZoneList; 2487 /** 2488 * 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". 2489 */ 2490 CacheSecurityGroupNames?: CacheSecurityGroupNameList; 2491 /** 2492 * 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). 2493 */ 2494 SecurityGroupIds?: SecurityGroupIdsList; 2495 /** 2496 * 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 2497 */ 2498 PreferredMaintenanceWindow?: String; 2499 /** 2500 * 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. 2501 */ 2502 NotificationTopicArn?: String; 2503 /** 2504 * 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. 2505 */ 2506 CacheParameterGroupName?: String; 2507 /** 2508 * The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. Valid values: active | inactive 2509 */ 2510 NotificationTopicStatus?: String; 2511 /** 2512 * 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 2513 */ 2514 ApplyImmediately?: Boolean; 2515 /** 2516 * 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. 2517 */ 2518 EngineVersion?: String; 2519 /** 2520 * This parameter is currently disabled. 2521 */ 2522 AutoMinorVersionUpgrade?: BooleanOptional; 2523 /** 2524 * 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. 2525 */ 2526 SnapshotRetentionLimit?: IntegerOptional; 2527 /** 2528 * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. 2529 */ 2530 SnapshotWindow?: String; 2531 /** 2532 * A valid cache node type that you want to scale this cluster up to. 2533 */ 2534 CacheNodeType?: String; 2535 /** 2536 * 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. 2537 */ 2538 AuthToken?: String; 2539 /** 2540 * 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 2541 */ 2542 AuthTokenUpdateStrategy?: AuthTokenUpdateStrategyType; 2543 /** 2544 * Specifies the destination, format and type of the logs. 2545 */ 2546 LogDeliveryConfigurations?: LogDeliveryConfigurationRequestList; 2547 } 2548 export interface ModifyCacheClusterResult { 2549 CacheCluster?: CacheCluster; 2550 } 2551 export interface ModifyCacheParameterGroupMessage { 2552 /** 2553 * The name of the cache parameter group to modify. 2554 */ 2555 CacheParameterGroupName: String; 2556 /** 2557 * 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. 2558 */ 2559 ParameterNameValues: ParameterNameValueList; 2560 } 2561 export interface ModifyCacheSubnetGroupMessage { 2562 /** 2563 * 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 2564 */ 2565 CacheSubnetGroupName: String; 2566 /** 2567 * A description of the cache subnet group. 2568 */ 2569 CacheSubnetGroupDescription?: String; 2570 /** 2571 * The EC2 subnet IDs for the cache subnet group. 2572 */ 2573 SubnetIds?: SubnetIdentifierList; 2574 } 2575 export interface ModifyCacheSubnetGroupResult { 2576 CacheSubnetGroup?: CacheSubnetGroup; 2577 } 2578 export interface ModifyGlobalReplicationGroupMessage { 2579 /** 2580 * The name of the Global datastore 2581 */ 2582 GlobalReplicationGroupId: String; 2583 /** 2584 * This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow. 2585 */ 2586 ApplyImmediately: Boolean; 2587 /** 2588 * A valid cache node type that you want to scale this Global datastore to. 2589 */ 2590 CacheNodeType?: String; 2591 /** 2592 * The upgraded version of the cache engine to be run on the clusters in the Global datastore. 2593 */ 2594 EngineVersion?: String; 2595 /** 2596 * The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore. 2597 */ 2598 CacheParameterGroupName?: String; 2599 /** 2600 * A description of the Global datastore 2601 */ 2602 GlobalReplicationGroupDescription?: String; 2603 /** 2604 * Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. 2605 */ 2606 AutomaticFailoverEnabled?: BooleanOptional; 2607 } 2608 export interface ModifyGlobalReplicationGroupResult { 2609 GlobalReplicationGroup?: GlobalReplicationGroup; 2610 } 2611 export interface ModifyReplicationGroupMessage { 2612 /** 2613 * The identifier of the replication group to modify. 2614 */ 2615 ReplicationGroupId: String; 2616 /** 2617 * A description for the replication group. Maximum length is 255 characters. 2618 */ 2619 ReplicationGroupDescription?: String; 2620 /** 2621 * 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. 2622 */ 2623 PrimaryClusterId?: String; 2624 /** 2625 * 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. 2626 */ 2627 SnapshottingClusterId?: String; 2628 /** 2629 * Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. Valid values: true | false 2630 */ 2631 AutomaticFailoverEnabled?: BooleanOptional; 2632 /** 2633 * A flag to indicate MultiAZ is enabled. 2634 */ 2635 MultiAZEnabled?: BooleanOptional; 2636 /** 2637 * Deprecated. This parameter is not used. 2638 */ 2639 NodeGroupId?: String; 2640 /** 2641 * 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. 2642 */ 2643 CacheSecurityGroupNames?: CacheSecurityGroupNameList; 2644 /** 2645 * 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). 2646 */ 2647 SecurityGroupIds?: SecurityGroupIdsList; 2648 /** 2649 * 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 2650 */ 2651 PreferredMaintenanceWindow?: String; 2652 /** 2653 * 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. 2654 */ 2655 NotificationTopicArn?: String; 2656 /** 2657 * 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. 2658 */ 2659 CacheParameterGroupName?: String; 2660 /** 2661 * 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 2662 */ 2663 NotificationTopicStatus?: String; 2664 /** 2665 * 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 2666 */ 2667 ApplyImmediately?: Boolean; 2668 /** 2669 * 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. 2670 */ 2671 EngineVersion?: String; 2672 /** 2673 * This parameter is currently disabled. 2674 */ 2675 AutoMinorVersionUpgrade?: BooleanOptional; 2676 /** 2677 * 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. 2678 */ 2679 SnapshotRetentionLimit?: IntegerOptional; 2680 /** 2681 * 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. 2682 */ 2683 SnapshotWindow?: String; 2684 /** 2685 * A valid cache node type that you want to scale this replication group to. 2686 */ 2687 CacheNodeType?: String; 2688 /** 2689 * 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. 2690 */ 2691 AuthToken?: String; 2692 /** 2693 * 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 2694 */ 2695 AuthTokenUpdateStrategy?: AuthTokenUpdateStrategyType; 2696 /** 2697 * The user group you are associating with the replication group. 2698 */ 2699 UserGroupIdsToAdd?: UserGroupIdList; 2700 /** 2701 * The user group to remove, meaning the users in the group no longer can access the replication group. 2702 */ 2703 UserGroupIdsToRemove?: UserGroupIdList; 2704 /** 2705 * Removes the user groups that can access this replication group. 2706 */ 2707 RemoveUserGroups?: BooleanOptional; 2708 /** 2709 * Specifies the destination, format and type of the logs. 2710 */ 2711 LogDeliveryConfigurations?: LogDeliveryConfigurationRequestList; 2712 } 2713 export interface ModifyReplicationGroupResult { 2714 ReplicationGroup?: ReplicationGroup; 2715 } 2716 export interface ModifyReplicationGroupShardConfigurationMessage { 2717 /** 2718 * The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured. 2719 */ 2720 ReplicationGroupId: String; 2721 /** 2722 * The number of node groups (shards) that results from the modification of the shard configuration. 2723 */ 2724 NodeGroupCount: Integer; 2725 /** 2726 * Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. Value: true 2727 */ 2728 ApplyImmediately: Boolean; 2729 /** 2730 * 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). 2731 */ 2732 ReshardingConfiguration?: ReshardingConfigurationList; 2733 /** 2734 * 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. 2735 */ 2736 NodeGroupsToRemove?: NodeGroupsToRemoveList; 2737 /** 2738 * 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. 2739 */ 2740 NodeGroupsToRetain?: NodeGroupsToRetainList; 2741 } 2742 export interface ModifyReplicationGroupShardConfigurationResult { 2743 ReplicationGroup?: ReplicationGroup; 2744 } 2745 export interface ModifyUserGroupMessage { 2746 /** 2747 * The ID of the user group. 2748 */ 2749 UserGroupId: String; 2750 /** 2751 * The list of user IDs to add to the user group. 2752 */ 2753 UserIdsToAdd?: UserIdListInput; 2754 /** 2755 * The list of user IDs to remove from the user group. 2756 */ 2757 UserIdsToRemove?: UserIdListInput; 2758 } 2759 export interface ModifyUserMessage { 2760 /** 2761 * The ID of the user. 2762 */ 2763 UserId: UserId; 2764 /** 2765 * Access permissions string used for this user. 2766 */ 2767 AccessString?: AccessString; 2768 /** 2769 * Adds additional user permissions to the access string. 2770 */ 2771 AppendAccessString?: AccessString; 2772 /** 2773 * The passwords belonging to the user. You are allowed up to two. 2774 */ 2775 Passwords?: PasswordListInput; 2776 /** 2777 * Indicates no password is required for the user. 2778 */ 2779 NoPasswordRequired?: BooleanOptional; 2780 } 2781 export type MultiAZStatus = "enabled"|"disabled"|string; 2782 export interface NodeGroup { 2783 /** 2784 * 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. 2785 */ 2786 NodeGroupId?: String; 2787 /** 2788 * The current state of this replication group - creating, available, modifying, deleting. 2789 */ 2790 Status?: String; 2791 /** 2792 * The endpoint of the primary node in this node group (shard). 2793 */ 2794 PrimaryEndpoint?: Endpoint; 2795 /** 2796 * The endpoint of the replica nodes in this node group (shard). 2797 */ 2798 ReaderEndpoint?: Endpoint; 2799 /** 2800 * The keyspace for this node group (shard). 2801 */ 2802 Slots?: String; 2803 /** 2804 * A list containing information about individual nodes within the node group (shard). 2805 */ 2806 NodeGroupMembers?: NodeGroupMemberList; 2807 } 2808 export interface NodeGroupConfiguration { 2809 /** 2810 * Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to. 2811 */ 2812 NodeGroupId?: AllowedNodeGroupId; 2813 /** 2814 * 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" 2815 */ 2816 Slots?: String; 2817 /** 2818 * The number of read replica nodes in this node group (shard). 2819 */ 2820 ReplicaCount?: IntegerOptional; 2821 /** 2822 * The Availability Zone where the primary node of this node group (shard) is launched. 2823 */ 2824 PrimaryAvailabilityZone?: String; 2825 /** 2826 * 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. 2827 */ 2828 ReplicaAvailabilityZones?: AvailabilityZonesList; 2829 /** 2830 * The outpost ARN of the primary node. 2831 */ 2832 PrimaryOutpostArn?: String; 2833 /** 2834 * The outpost ARN of the node replicas. 2835 */ 2836 ReplicaOutpostArns?: OutpostArnsList; 2837 } 2838 export type NodeGroupConfigurationList = NodeGroupConfiguration[]; 2839 export type NodeGroupList = NodeGroup[]; 2840 export interface NodeGroupMember { 2841 /** 2842 * The ID of the cluster to which the node belongs. 2843 */ 2844 CacheClusterId?: String; 2845 /** 2846 * The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.). 2847 */ 2848 CacheNodeId?: String; 2849 /** 2850 * 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. 2851 */ 2852 ReadEndpoint?: Endpoint; 2853 /** 2854 * The name of the Availability Zone in which the node is located. 2855 */ 2856 PreferredAvailabilityZone?: String; 2857 /** 2858 * The outpost ARN of the node group member. 2859 */ 2860 PreferredOutpostArn?: String; 2861 /** 2862 * The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups. 2863 */ 2864 CurrentRole?: String; 2865 } 2866 export type NodeGroupMemberList = NodeGroupMember[]; 2867 export interface NodeGroupMemberUpdateStatus { 2868 /** 2869 * The cache cluster ID 2870 */ 2871 CacheClusterId?: String; 2872 /** 2873 * The node ID of the cache cluster 2874 */ 2875 CacheNodeId?: String; 2876 /** 2877 * The update status of the node 2878 */ 2879 NodeUpdateStatus?: NodeUpdateStatus; 2880 /** 2881 * The deletion date of the node 2882 */ 2883 NodeDeletionDate?: TStamp; 2884 /** 2885 * The start date of the update for a node 2886 */ 2887 NodeUpdateStartDate?: TStamp; 2888 /** 2889 * The end date of the update for a node 2890 */ 2891 NodeUpdateEndDate?: TStamp; 2892 /** 2893 * Reflects whether the update was initiated by the customer or automatically applied 2894 */ 2895 NodeUpdateInitiatedBy?: NodeUpdateInitiatedBy; 2896 /** 2897 * The date when the update is triggered 2898 */ 2899 NodeUpdateInitiatedDate?: TStamp; 2900 /** 2901 * The date when the NodeUpdateStatus was last modified 2902 */ 2903 NodeUpdateStatusModifiedDate?: TStamp; 2904 } 2905 export type NodeGroupMemberUpdateStatusList = NodeGroupMemberUpdateStatus[]; 2906 export interface NodeGroupUpdateStatus { 2907 /** 2908 * The ID of the node group 2909 */ 2910 NodeGroupId?: String; 2911 /** 2912 * The status of the service update on the node group member 2913 */ 2914 NodeGroupMemberUpdateStatus?: NodeGroupMemberUpdateStatusList; 2915 } 2916 export type NodeGroupUpdateStatusList = NodeGroupUpdateStatus[]; 2917 export type NodeGroupsToRemoveList = AllowedNodeGroupId[]; 2918 export type NodeGroupsToRetainList = AllowedNodeGroupId[]; 2919 export interface NodeSnapshot { 2920 /** 2921 * A unique identifier for the source cluster. 2922 */ 2923 CacheClusterId?: String; 2924 /** 2925 * A unique identifier for the source node group (shard). 2926 */ 2927 NodeGroupId?: String; 2928 /** 2929 * The cache node identifier for the node in the source cluster. 2930 */ 2931 CacheNodeId?: String; 2932 /** 2933 * The configuration for the source node group (shard). 2934 */ 2935 NodeGroupConfiguration?: NodeGroupConfiguration; 2936 /** 2937 * The size of the cache on the source cache node. 2938 */ 2939 CacheSize?: String; 2940 /** 2941 * The date and time when the cache node was created in the source cluster. 2942 */ 2943 CacheNodeCreateTime?: TStamp; 2944 /** 2945 * The date and time when the source node's metadata and cache data set was obtained for the snapshot. 2946 */ 2947 SnapshotCreateTime?: TStamp; 2948 } 2949 export type NodeSnapshotList = NodeSnapshot[]; 2950 export type NodeTypeList = String[]; 2951 export type NodeUpdateInitiatedBy = "system"|"customer"|string; 2952 export type NodeUpdateStatus = "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete"|string; 2953 export interface NotificationConfiguration { 2954 /** 2955 * The Amazon Resource Name (ARN) that identifies the topic. 2956 */ 2957 TopicArn?: String; 2958 /** 2959 * The current state of the topic. 2960 */ 2961 TopicStatus?: String; 2962 } 2963 export type OutpostArnsList = String[]; 2964 export type OutpostMode = "single-outpost"|"cross-outpost"|string; 2965 export interface Parameter { 2966 /** 2967 * The name of the parameter. 2968 */ 2969 ParameterName?: String; 2970 /** 2971 * The value of the parameter. 2972 */ 2973 ParameterValue?: String; 2974 /** 2975 * A description of the parameter. 2976 */ 2977 Description?: String; 2978 /** 2979 * The source of the parameter. 2980 */ 2981 Source?: String; 2982 /** 2983 * The valid data type for the parameter. 2984 */ 2985 DataType?: String; 2986 /** 2987 * The valid range of values for the parameter. 2988 */ 2989 AllowedValues?: String; 2990 /** 2991 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. 2992 */ 2993 IsModifiable?: Boolean; 2994 /** 2995 * The earliest cache engine version to which the parameter can apply. 2996 */ 2997 MinimumEngineVersion?: String; 2998 /** 2999 * 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. 3000 */ 3001 ChangeType?: ChangeType; 3002 } 3003 export interface ParameterNameValue { 3004 /** 3005 * The name of the parameter. 3006 */ 3007 ParameterName?: String; 3008 /** 3009 * The value of the parameter. 3010 */ 3011 ParameterValue?: String; 3012 } 3013 export type ParameterNameValueList = ParameterNameValue[]; 3014 export type ParametersList = Parameter[]; 3015 export type PasswordListInput = String[]; 3016 export type PendingAutomaticFailoverStatus = "enabled"|"disabled"|string; 3017 export interface PendingLogDeliveryConfiguration { 3018 /** 3019 * Refers to slow-log. 3020 */ 3021 LogType?: LogType; 3022 /** 3023 * Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose. 3024 */ 3025 DestinationType?: DestinationType; 3026 /** 3027 * Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. 3028 */ 3029 DestinationDetails?: DestinationDetails; 3030 /** 3031 * Returns the log format, either JSON or TEXT 3032 */ 3033 LogFormat?: LogFormat; 3034 } 3035 export type PendingLogDeliveryConfigurationList = PendingLogDeliveryConfiguration[]; 3036 export interface PendingModifiedValues { 3037 /** 3038 * 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 40. 3039 */ 3040 NumCacheNodes?: IntegerOptional; 3041 /** 3042 * 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.). 3043 */ 3044 CacheNodeIdsToRemove?: CacheNodeIdsList; 3045 /** 3046 * The new cache engine version that the cluster runs. 3047 */ 3048 EngineVersion?: String; 3049 /** 3050 * The cache node type that this cluster or replication group is scaled to. 3051 */ 3052 CacheNodeType?: String; 3053 /** 3054 * The auth token status 3055 */ 3056 AuthTokenStatus?: AuthTokenUpdateStatus; 3057 /** 3058 * The log delivery configurations being modified 3059 */ 3060 LogDeliveryConfigurations?: PendingLogDeliveryConfigurationList; 3061 } 3062 export type PreferredAvailabilityZoneList = String[]; 3063 export type PreferredOutpostArnList = String[]; 3064 export interface ProcessedUpdateAction { 3065 /** 3066 * The ID of the replication group 3067 */ 3068 ReplicationGroupId?: String; 3069 /** 3070 * The ID of the cache cluster 3071 */ 3072 CacheClusterId?: String; 3073 /** 3074 * The unique ID of the service update 3075 */ 3076 ServiceUpdateName?: String; 3077 /** 3078 * The status of the update action on the Redis cluster 3079 */ 3080 UpdateActionStatus?: UpdateActionStatus; 3081 } 3082 export type ProcessedUpdateActionList = ProcessedUpdateAction[]; 3083 export interface PurchaseReservedCacheNodesOfferingMessage { 3084 /** 3085 * The ID of the reserved cache node offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 3086 */ 3087 ReservedCacheNodesOfferingId: String; 3088 /** 3089 * 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 3090 */ 3091 ReservedCacheNodeId?: String; 3092 /** 3093 * The number of cache node instances to reserve. Default: 1 3094 */ 3095 CacheNodeCount?: IntegerOptional; 3096 /** 3097 * A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. 3098 */ 3099 Tags?: TagList; 3100 } 3101 export interface PurchaseReservedCacheNodesOfferingResult { 3102 ReservedCacheNode?: ReservedCacheNode; 3103 } 3104 export interface RebalanceSlotsInGlobalReplicationGroupMessage { 3105 /** 3106 * The name of the Global datastore 3107 */ 3108 GlobalReplicationGroupId: String; 3109 /** 3110 * If True, redistribution is applied immediately. 3111 */ 3112 ApplyImmediately: Boolean; 3113 } 3114 export interface RebalanceSlotsInGlobalReplicationGroupResult { 3115 GlobalReplicationGroup?: GlobalReplicationGroup; 3116 } 3117 export interface RebootCacheClusterMessage { 3118 /** 3119 * The cluster identifier. This parameter is stored as a lowercase string. 3120 */ 3121 CacheClusterId: String; 3122 /** 3123 * 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. 3124 */ 3125 CacheNodeIdsToReboot: CacheNodeIdsList; 3126 } 3127 export interface RebootCacheClusterResult { 3128 CacheCluster?: CacheCluster; 3129 } 3130 export interface RecurringCharge { 3131 /** 3132 * The monetary amount of the recurring charge. 3133 */ 3134 RecurringChargeAmount?: Double; 3135 /** 3136 * The frequency of the recurring charge. 3137 */ 3138 RecurringChargeFrequency?: String; 3139 } 3140 export type RecurringChargeList = RecurringCharge[]; 3141 export interface RegionalConfiguration { 3142 /** 3143 * The name of the secondary cluster 3144 */ 3145 ReplicationGroupId: String; 3146 /** 3147 * The Amazon region where the cluster is stored 3148 */ 3149 ReplicationGroupRegion: String; 3150 /** 3151 * A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. 3152 */ 3153 ReshardingConfiguration: ReshardingConfigurationList; 3154 } 3155 export type RegionalConfigurationList = RegionalConfiguration[]; 3156 export type RemoveReplicasList = String[]; 3157 export interface RemoveTagsFromResourceMessage { 3158 /** 3159 * 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 Amazon Service Namespaces. 3160 */ 3161 ResourceName: String; 3162 /** 3163 * A list of TagKeys identifying the tags you want removed from the named resource. 3164 */ 3165 TagKeys: KeyList; 3166 } 3167 export type ReplicaConfigurationList = ConfigureShard[]; 3168 export interface ReplicationGroup { 3169 /** 3170 * The identifier for the replication group. 3171 */ 3172 ReplicationGroupId?: String; 3173 /** 3174 * The user supplied description of the replication group. 3175 */ 3176 Description?: String; 3177 /** 3178 * The name of the Global datastore and role of this replication group in the Global datastore. 3179 */ 3180 GlobalReplicationGroupInfo?: GlobalReplicationGroupInfo; 3181 /** 3182 * The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting. 3183 */ 3184 Status?: String; 3185 /** 3186 * A group of settings to be applied to the replication group, either immediately or during the next maintenance window. 3187 */ 3188 PendingModifiedValues?: ReplicationGroupPendingModifiedValues; 3189 /** 3190 * The names of all the cache clusters that are part of this replication group. 3191 */ 3192 MemberClusters?: ClusterIdList; 3193 /** 3194 * 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). 3195 */ 3196 NodeGroups?: NodeGroupList; 3197 /** 3198 * The cluster ID that is used as the daily snapshot source for the replication group. 3199 */ 3200 SnapshottingClusterId?: String; 3201 /** 3202 * Indicates the status of automatic failover for this Redis replication group. 3203 */ 3204 AutomaticFailover?: AutomaticFailoverStatus; 3205 /** 3206 * A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ 3207 */ 3208 MultiAZ?: MultiAZStatus; 3209 /** 3210 * The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group. 3211 */ 3212 ConfigurationEndpoint?: Endpoint; 3213 /** 3214 * 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. 3215 */ 3216 SnapshotRetentionLimit?: IntegerOptional; 3217 /** 3218 * 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. 3219 */ 3220 SnapshotWindow?: String; 3221 /** 3222 * 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 3223 */ 3224 ClusterEnabled?: BooleanOptional; 3225 /** 3226 * The name of the compute and memory capacity node type for each node in the replication group. 3227 */ 3228 CacheNodeType?: String; 3229 /** 3230 * A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false 3231 */ 3232 AuthTokenEnabled?: BooleanOptional; 3233 /** 3234 * The date the auth token was last modified 3235 */ 3236 AuthTokenLastModifiedDate?: TStamp; 3237 /** 3238 * 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 3239 */ 3240 TransitEncryptionEnabled?: BooleanOptional; 3241 /** 3242 * 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 3243 */ 3244 AtRestEncryptionEnabled?: BooleanOptional; 3245 /** 3246 * The outpost ARNs of the replication group's member clusters. 3247 */ 3248 MemberClustersOutpostArns?: ReplicationGroupOutpostArnList; 3249 /** 3250 * The ID of the KMS key used to encrypt the disk in the cluster. 3251 */ 3252 KmsKeyId?: String; 3253 /** 3254 * The ARN (Amazon Resource Name) of the replication group. 3255 */ 3256 ARN?: String; 3257 /** 3258 * The list of user group IDs that have access to the replication group. 3259 */ 3260 UserGroupIds?: UserGroupIdList; 3261 /** 3262 * Returns the destination, format and type of the logs. 3263 */ 3264 LogDeliveryConfigurations?: LogDeliveryConfigurationList; 3265 /** 3266 * The date and time when the cluster was created. 3267 */ 3268 ReplicationGroupCreateTime?: TStamp; 3269 } 3270 export type ReplicationGroupIdList = String[]; 3271 export type ReplicationGroupList = ReplicationGroup[]; 3272 export interface ReplicationGroupMessage { 3273 /** 3274 * Provides an identifier to allow retrieval of paginated results. 3275 */ 3276 Marker?: String; 3277 /** 3278 * A list of replication groups. Each item in the list contains detailed information about one replication group. 3279 */ 3280 ReplicationGroups?: ReplicationGroupList; 3281 } 3282 export type ReplicationGroupOutpostArnList = String[]; 3283 export interface ReplicationGroupPendingModifiedValues { 3284 /** 3285 * The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window. 3286 */ 3287 PrimaryClusterId?: String; 3288 /** 3289 * Indicates the status of automatic failover for this Redis replication group. 3290 */ 3291 AutomaticFailoverStatus?: PendingAutomaticFailoverStatus; 3292 /** 3293 * The status of an online resharding operation. 3294 */ 3295 Resharding?: ReshardingStatus; 3296 /** 3297 * The auth token status 3298 */ 3299 AuthTokenStatus?: AuthTokenUpdateStatus; 3300 /** 3301 * The user groups being modified. 3302 */ 3303 UserGroups?: UserGroupsUpdateStatus; 3304 /** 3305 * The log delivery configurations being modified 3306 */ 3307 LogDeliveryConfigurations?: PendingLogDeliveryConfigurationList; 3308 } 3309 export interface ReservedCacheNode { 3310 /** 3311 * The unique identifier for the reservation. 3312 */ 3313 ReservedCacheNodeId?: String; 3314 /** 3315 * The offering identifier. 3316 */ 3317 ReservedCacheNodesOfferingId?: String; 3318 /** 3319 * 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: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types 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: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types 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. 3320 */ 3321 CacheNodeType?: String; 3322 /** 3323 * The time the reservation started. 3324 */ 3325 StartTime?: TStamp; 3326 /** 3327 * The duration of the reservation in seconds. 3328 */ 3329 Duration?: Integer; 3330 /** 3331 * The fixed price charged for this reserved cache node. 3332 */ 3333 FixedPrice?: Double; 3334 /** 3335 * The hourly price charged for this reserved cache node. 3336 */ 3337 UsagePrice?: Double; 3338 /** 3339 * The number of cache nodes that have been reserved. 3340 */ 3341 CacheNodeCount?: Integer; 3342 /** 3343 * The description of the reserved cache node. 3344 */ 3345 ProductDescription?: String; 3346 /** 3347 * The offering type of this reserved cache node. 3348 */ 3349 OfferingType?: String; 3350 /** 3351 * The state of the reserved cache node. 3352 */ 3353 State?: String; 3354 /** 3355 * The recurring price charged to run this reserved cache node. 3356 */ 3357 RecurringCharges?: RecurringChargeList; 3358 /** 3359 * 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 3360 */ 3361 ReservationARN?: String; 3362 } 3363 export type ReservedCacheNodeList = ReservedCacheNode[]; 3364 export interface ReservedCacheNodeMessage { 3365 /** 3366 * Provides an identifier to allow retrieval of paginated results. 3367 */ 3368 Marker?: String; 3369 /** 3370 * A list of reserved cache nodes. Each element in the list contains detailed information about one node. 3371 */ 3372 ReservedCacheNodes?: ReservedCacheNodeList; 3373 } 3374 export interface ReservedCacheNodesOffering { 3375 /** 3376 * A unique identifier for the reserved cache node offering. 3377 */ 3378 ReservedCacheNodesOfferingId?: String; 3379 /** 3380 * 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: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types 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: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types 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. 3381 */ 3382 CacheNodeType?: String; 3383 /** 3384 * The duration of the offering. in seconds. 3385 */ 3386 Duration?: Integer; 3387 /** 3388 * The fixed price charged for this offering. 3389 */ 3390 FixedPrice?: Double; 3391 /** 3392 * The hourly price charged for this offering. 3393 */ 3394 UsagePrice?: Double; 3395 /** 3396 * The cache engine used by the offering. 3397 */ 3398 ProductDescription?: String; 3399 /** 3400 * The offering type. 3401 */ 3402 OfferingType?: String; 3403 /** 3404 * The recurring price charged to run this reserved cache node. 3405 */ 3406 RecurringCharges?: RecurringChargeList; 3407 } 3408 export type ReservedCacheNodesOfferingList = ReservedCacheNodesOffering[]; 3409 export interface ReservedCacheNodesOfferingMessage { 3410 /** 3411 * Provides an identifier to allow retrieval of paginated results. 3412 */ 3413 Marker?: String; 3414 /** 3415 * A list of reserved cache node offerings. Each element in the list contains detailed information about one offering. 3416 */ 3417 ReservedCacheNodesOfferings?: ReservedCacheNodesOfferingList; 3418 } 3419 export interface ResetCacheParameterGroupMessage { 3420 /** 3421 * The name of the cache parameter group to reset. 3422 */ 3423 CacheParameterGroupName: String; 3424 /** 3425 * 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 3426 */ 3427 ResetAllParameters?: Boolean; 3428 /** 3429 * 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. 3430 */ 3431 ParameterNameValues?: ParameterNameValueList; 3432 } 3433 export interface ReshardingConfiguration { 3434 /** 3435 * Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to. 3436 */ 3437 NodeGroupId?: AllowedNodeGroupId; 3438 /** 3439 * A list of preferred availability zones for the nodes in this cluster. 3440 */ 3441 PreferredAvailabilityZones?: AvailabilityZonesList; 3442 } 3443 export type ReshardingConfigurationList = ReshardingConfiguration[]; 3444 export interface ReshardingStatus { 3445 /** 3446 * Represents the progress of an online resharding operation. 3447 */ 3448 SlotMigration?: SlotMigration; 3449 } 3450 export interface RevokeCacheSecurityGroupIngressMessage { 3451 /** 3452 * The name of the cache security group to revoke ingress from. 3453 */ 3454 CacheSecurityGroupName: String; 3455 /** 3456 * The name of the Amazon EC2 security group to revoke access from. 3457 */ 3458 EC2SecurityGroupName: String; 3459 /** 3460 * The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter. 3461 */ 3462 EC2SecurityGroupOwnerId: String; 3463 } 3464 export interface RevokeCacheSecurityGroupIngressResult { 3465 CacheSecurityGroup?: CacheSecurityGroup; 3466 } 3467 export type SecurityGroupIdsList = String[]; 3468 export interface SecurityGroupMembership { 3469 /** 3470 * The identifier of the cache security group. 3471 */ 3472 SecurityGroupId?: String; 3473 /** 3474 * 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. 3475 */ 3476 Status?: String; 3477 } 3478 export type SecurityGroupMembershipList = SecurityGroupMembership[]; 3479 export interface ServiceUpdate { 3480 /** 3481 * The unique ID of the service update 3482 */ 3483 ServiceUpdateName?: String; 3484 /** 3485 * The date when the service update is initially available 3486 */ 3487 ServiceUpdateReleaseDate?: TStamp; 3488 /** 3489 * The date after which the service update is no longer available 3490 */ 3491 ServiceUpdateEndDate?: TStamp; 3492 /** 3493 * The severity of the service update 3494 */ 3495 ServiceUpdateSeverity?: ServiceUpdateSeverity; 3496 /** 3497 * The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance. 3498 */ 3499 ServiceUpdateRecommendedApplyByDate?: TStamp; 3500 /** 3501 * The status of the service update 3502 */ 3503 ServiceUpdateStatus?: ServiceUpdateStatus; 3504 /** 3505 * Provides details of the service update 3506 */ 3507 ServiceUpdateDescription?: String; 3508 /** 3509 * Reflects the nature of the service update 3510 */ 3511 ServiceUpdateType?: ServiceUpdateType; 3512 /** 3513 * The Elasticache engine to which the update applies. Either Redis or Memcached 3514 */ 3515 Engine?: String; 3516 /** 3517 * The Elasticache engine version to which the update applies. Either Redis or Memcached engine version 3518 */ 3519 EngineVersion?: String; 3520 /** 3521 * Indicates whether the service update will be automatically applied once the recommended apply-by date has expired. 3522 */ 3523 AutoUpdateAfterRecommendedApplyByDate?: BooleanOptional; 3524 /** 3525 * The estimated length of time the service update will take 3526 */ 3527 EstimatedUpdateTime?: String; 3528 } 3529 export type ServiceUpdateList = ServiceUpdate[]; 3530 export type ServiceUpdateSeverity = "critical"|"important"|"medium"|"low"|string; 3531 export type ServiceUpdateStatus = "available"|"cancelled"|"expired"|string; 3532 export type ServiceUpdateStatusList = ServiceUpdateStatus[]; 3533 export type ServiceUpdateType = "security-update"|string; 3534 export interface ServiceUpdatesMessage { 3535 /** 3536 * 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. 3537 */ 3538 Marker?: String; 3539 /** 3540 * A list of service updates 3541 */ 3542 ServiceUpdates?: ServiceUpdateList; 3543 } 3544 export type SlaMet = "yes"|"no"|"n/a"|string; 3545 export interface SlotMigration { 3546 /** 3547 * The percentage of the slot migration that is complete. 3548 */ 3549 ProgressPercentage?: Double; 3550 } 3551 export interface Snapshot { 3552 /** 3553 * The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name. 3554 */ 3555 SnapshotName?: String; 3556 /** 3557 * The unique identifier of the source replication group. 3558 */ 3559 ReplicationGroupId?: String; 3560 /** 3561 * A description of the source replication group. 3562 */ 3563 ReplicationGroupDescription?: String; 3564 /** 3565 * The user-supplied identifier of the source cluster. 3566 */ 3567 CacheClusterId?: String; 3568 /** 3569 * The status of the snapshot. Valid values: creating | available | restoring | copying | deleting. 3570 */ 3571 SnapshotStatus?: String; 3572 /** 3573 * Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual). 3574 */ 3575 SnapshotSource?: String; 3576 /** 3577 * 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: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types 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: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types 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. 3578 */ 3579 CacheNodeType?: String; 3580 /** 3581 * The name of the cache engine (memcached or redis) used by the source cluster. 3582 */ 3583 Engine?: String; 3584 /** 3585 * The version of the cache engine version that is used by the source cluster. 3586 */ 3587 EngineVersion?: String; 3588 /** 3589 * 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 40. 3590 */ 3591 NumCacheNodes?: IntegerOptional; 3592 /** 3593 * The name of the Availability Zone in which the source cluster is located. 3594 */ 3595 PreferredAvailabilityZone?: String; 3596 /** 3597 * The ARN (Amazon Resource Name) of the preferred outpost. 3598 */ 3599 PreferredOutpostArn?: String; 3600 /** 3601 * The date and time when the source cluster was created. 3602 */ 3603 CacheClusterCreateTime?: TStamp; 3604 /** 3605 * 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 3606 */ 3607 PreferredMaintenanceWindow?: String; 3608 /** 3609 * The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications. 3610 */ 3611 TopicArn?: String; 3612 /** 3613 * The port number used by each cache nodes in the source cluster. 3614 */ 3615 Port?: IntegerOptional; 3616 /** 3617 * The cache parameter group that is associated with the source cluster. 3618 */ 3619 CacheParameterGroupName?: String; 3620 /** 3621 * The name of the cache subnet group associated with the source cluster. 3622 */ 3623 CacheSubnetGroupName?: String; 3624 /** 3625 * The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster. 3626 */ 3627 VpcId?: String; 3628 /** 3629 * This parameter is currently disabled. 3630 */ 3631 AutoMinorVersionUpgrade?: Boolean; 3632 /** 3633 * 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. 3634 */ 3635 SnapshotRetentionLimit?: IntegerOptional; 3636 /** 3637 * The daily time range during which ElastiCache takes daily snapshots of the source cluster. 3638 */ 3639 SnapshotWindow?: String; 3640 /** 3641 * 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. 3642 */ 3643 NumNodeGroups?: IntegerOptional; 3644 /** 3645 * Indicates the status of automatic failover for the source Redis replication group. 3646 */ 3647 AutomaticFailover?: AutomaticFailoverStatus; 3648 /** 3649 * A list of the cache nodes in the source cluster. 3650 */ 3651 NodeSnapshots?: NodeSnapshotList; 3652 /** 3653 * The ID of the KMS key used to encrypt the snapshot. 3654 */ 3655 KmsKeyId?: String; 3656 /** 3657 * The ARN (Amazon Resource Name) of the snapshot. 3658 */ 3659 ARN?: String; 3660 } 3661 export type SnapshotArnsList = String[]; 3662 export type SnapshotList = Snapshot[]; 3663 export type SourceType = "cache-cluster"|"cache-parameter-group"|"cache-security-group"|"cache-subnet-group"|"replication-group"|"user"|"user-group"|string; 3664 export interface StartMigrationMessage { 3665 /** 3666 * The ID of the replication group to which data should be migrated. 3667 */ 3668 ReplicationGroupId: String; 3669 /** 3670 * List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element. 3671 */ 3672 CustomerNodeEndpointList: CustomerNodeEndpointList; 3673 } 3674 export interface StartMigrationResponse { 3675 ReplicationGroup?: ReplicationGroup; 3676 } 3677 export type String = string; 3678 export interface Subnet { 3679 /** 3680 * The unique identifier for the subnet. 3681 */ 3682 SubnetIdentifier?: String; 3683 /** 3684 * The Availability Zone associated with the subnet. 3685 */ 3686 SubnetAvailabilityZone?: AvailabilityZone; 3687 /** 3688 * The outpost ARN of the subnet. 3689 */ 3690 SubnetOutpost?: SubnetOutpost; 3691 } 3692 export type SubnetIdentifierList = String[]; 3693 export type SubnetList = Subnet[]; 3694 export interface SubnetOutpost { 3695 /** 3696 * The outpost ARN of the subnet. 3697 */ 3698 SubnetOutpostArn?: String; 3699 } 3700 export type TStamp = Date; 3701 export interface Tag { 3702 /** 3703 * The key for the tag. May not be null. 3704 */ 3705 Key?: String; 3706 /** 3707 * The tag's value. May be null. 3708 */ 3709 Value?: String; 3710 } 3711 export type TagList = Tag[]; 3712 export interface TagListMessage { 3713 /** 3714 * A list of tags as key-value pairs. 3715 */ 3716 TagList?: TagList; 3717 } 3718 export interface TestFailoverMessage { 3719 /** 3720 * The name of the replication group (console: cluster) whose automatic failover is being tested by this operation. 3721 */ 3722 ReplicationGroupId: String; 3723 /** 3724 * 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. 3725 */ 3726 NodeGroupId: AllowedNodeGroupId; 3727 } 3728 export interface TestFailoverResult { 3729 ReplicationGroup?: ReplicationGroup; 3730 } 3731 export interface TimeRangeFilter { 3732 /** 3733 * The start time of the time range filter 3734 */ 3735 StartTime?: TStamp; 3736 /** 3737 * The end time of the time range filter 3738 */ 3739 EndTime?: TStamp; 3740 } 3741 export type UGReplicationGroupIdList = String[]; 3742 export interface UnprocessedUpdateAction { 3743 /** 3744 * The replication group ID 3745 */ 3746 ReplicationGroupId?: String; 3747 /** 3748 * The ID of the cache cluster 3749 */ 3750 CacheClusterId?: String; 3751 /** 3752 * The unique ID of the service update 3753 */ 3754 ServiceUpdateName?: String; 3755 /** 3756 * The error type for requests that are not processed 3757 */ 3758 ErrorType?: String; 3759 /** 3760 * The error message that describes the reason the request was not processed 3761 */ 3762 ErrorMessage?: String; 3763 } 3764 export type UnprocessedUpdateActionList = UnprocessedUpdateAction[]; 3765 export interface UpdateAction { 3766 /** 3767 * The ID of the replication group 3768 */ 3769 ReplicationGroupId?: String; 3770 /** 3771 * The ID of the cache cluster 3772 */ 3773 CacheClusterId?: String; 3774 /** 3775 * The unique ID of the service update 3776 */ 3777 ServiceUpdateName?: String; 3778 /** 3779 * The date the update is first available 3780 */ 3781 ServiceUpdateReleaseDate?: TStamp; 3782 /** 3783 * The severity of the service update 3784 */ 3785 ServiceUpdateSeverity?: ServiceUpdateSeverity; 3786 /** 3787 * The status of the service update 3788 */ 3789 ServiceUpdateStatus?: ServiceUpdateStatus; 3790 /** 3791 * The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance. 3792 */ 3793 ServiceUpdateRecommendedApplyByDate?: TStamp; 3794 /** 3795 * Reflects the nature of the service update 3796 */ 3797 ServiceUpdateType?: ServiceUpdateType; 3798 /** 3799 * The date that the service update is available to a replication group 3800 */ 3801 UpdateActionAvailableDate?: TStamp; 3802 /** 3803 * The status of the update action 3804 */ 3805 UpdateActionStatus?: UpdateActionStatus; 3806 /** 3807 * The progress of the service update on the replication group 3808 */ 3809 NodesUpdated?: String; 3810 /** 3811 * The date when the UpdateActionStatus was last modified 3812 */ 3813 UpdateActionStatusModifiedDate?: TStamp; 3814 /** 3815 * 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. 3816 */ 3817 SlaMet?: SlaMet; 3818 /** 3819 * The status of the service update on the node group 3820 */ 3821 NodeGroupUpdateStatus?: NodeGroupUpdateStatusList; 3822 /** 3823 * The status of the service update on the cache node 3824 */ 3825 CacheNodeUpdateStatus?: CacheNodeUpdateStatusList; 3826 /** 3827 * The estimated length of time for the update to complete 3828 */ 3829 EstimatedUpdateTime?: String; 3830 /** 3831 * The Elasticache engine to which the update applies. Either Redis or Memcached 3832 */ 3833 Engine?: String; 3834 } 3835 export type UpdateActionList = UpdateAction[]; 3836 export interface UpdateActionResultsMessage { 3837 /** 3838 * Update actions that have been processed successfully 3839 */ 3840 ProcessedUpdateActions?: ProcessedUpdateActionList; 3841 /** 3842 * Update actions that haven't been processed successfully 3843 */ 3844 UnprocessedUpdateActions?: UnprocessedUpdateActionList; 3845 } 3846 export type UpdateActionStatus = "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete"|"scheduling"|"scheduled"|"not-applicable"|string; 3847 export type UpdateActionStatusList = UpdateActionStatus[]; 3848 export interface UpdateActionsMessage { 3849 /** 3850 * 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. 3851 */ 3852 Marker?: String; 3853 /** 3854 * Returns a list of update actions 3855 */ 3856 UpdateActions?: UpdateActionList; 3857 } 3858 export interface User { 3859 /** 3860 * The ID of the user. 3861 */ 3862 UserId?: String; 3863 /** 3864 * The username of the user. 3865 */ 3866 UserName?: String; 3867 /** 3868 * Indicates the user status. Can be "active", "modifying" or "deleting". 3869 */ 3870 Status?: String; 3871 /** 3872 * The current supported value is Redis. 3873 */ 3874 Engine?: EngineType; 3875 /** 3876 * Access permissions string used for this user. 3877 */ 3878 AccessString?: String; 3879 /** 3880 * Returns a list of the user group IDs the user belongs to. 3881 */ 3882 UserGroupIds?: UserGroupIdList; 3883 /** 3884 * Denotes whether the user requires a password to authenticate. 3885 */ 3886 Authentication?: Authentication; 3887 /** 3888 * The Amazon Resource Name (ARN) of the user. 3889 */ 3890 ARN?: String; 3891 } 3892 export interface UserGroup { 3893 /** 3894 * The ID of the user group. 3895 */ 3896 UserGroupId?: String; 3897 /** 3898 * Indicates user group status. Can be "creating", "active", "modifying", "deleting". 3899 */ 3900 Status?: String; 3901 /** 3902 * The current supported value is Redis. 3903 */ 3904 Engine?: EngineType; 3905 /** 3906 * The list of user IDs that belong to the user group. 3907 */ 3908 UserIds?: UserIdList; 3909 /** 3910 * A list of updates being applied to the user groups. 3911 */ 3912 PendingChanges?: UserGroupPendingChanges; 3913 /** 3914 * A list of replication groups that the user group can access. 3915 */ 3916 ReplicationGroups?: UGReplicationGroupIdList; 3917 /** 3918 * The Amazon Resource Name (ARN) of the user group. 3919 */ 3920 ARN?: String; 3921 } 3922 export type UserGroupId = string; 3923 export type UserGroupIdList = UserGroupId[]; 3924 export type UserGroupIdListInput = UserGroupId[]; 3925 export type UserGroupList = UserGroup[]; 3926 export interface UserGroupPendingChanges { 3927 /** 3928 * The list of user IDs to remove. 3929 */ 3930 UserIdsToRemove?: UserIdList; 3931 /** 3932 * The list of user IDs to add. 3933 */ 3934 UserIdsToAdd?: UserIdList; 3935 } 3936 export interface UserGroupsUpdateStatus { 3937 /** 3938 * The list of user group IDs to add. 3939 */ 3940 UserGroupIdsToAdd?: UserGroupIdList; 3941 /** 3942 * The list of user group IDs to remove. 3943 */ 3944 UserGroupIdsToRemove?: UserGroupIdList; 3945 } 3946 export type UserId = string; 3947 export type UserIdList = UserId[]; 3948 export type UserIdListInput = UserId[]; 3949 export type UserList = User[]; 3950 export type UserName = string; 3951 /** 3952 * 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. 3953 */ 3954 export type apiVersion = "2012-11-15"|"2014-03-24"|"2014-07-15"|"2014-09-30"|"2015-02-02"|"latest"|string; 3955 export interface ClientApiVersions { 3956 /** 3957 * 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. 3958 */ 3959 apiVersion?: apiVersion; 3960 } 3961 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 3962 /** 3963 * Contains interfaces for use with the ElastiCache client. 3964 */ 3965 export import Types = ElastiCache; 3966 } 3967 export = ElastiCache;