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