Interface for accessing ElastiCache
Amazon ElastiCacheAmazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
Inheritance Hierarchy
Namespace: Amazon.ElastiCache
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z
Syntax
public interface IAmazonElastiCache IAmazonService, IDisposable
The IAmazonElastiCache type exposes the following members
Properties
| Name | Type | Description | |
|---|---|---|---|
|
Paginators | Amazon.ElastiCache.Model.IElastiCachePaginatorFactory |
Paginators for the service |
Methods
| Name | Description | |
|---|---|---|
|
|
AddTagsToResource(AddTagsToResourceRequest) |
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide. |
|
|
AddTagsToResourceAsync(AddTagsToResourceRequest, CancellationToken) |
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions. For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide. |
|
|
AuthorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest) |
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.
|
|
|
AuthorizeCacheSecurityGroupIngressAsync(AuthorizeCacheSecurityGroupIngressRequest, CancellationToken) |
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.
|
|
|
BatchApplyUpdateAction(BatchApplyUpdateActionRequest) |
Apply the service update. For more information on service updates and applying them, see Applying Service Updates. |
|
|
BatchApplyUpdateActionAsync(BatchApplyUpdateActionRequest, CancellationToken) |
Apply the service update. For more information on service updates and applying them, see Applying Service Updates. |
|
|
BatchStopUpdateAction(BatchStopUpdateActionRequest) |
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates. |
|
|
BatchStopUpdateActionAsync(BatchStopUpdateActionRequest, CancellationToken) |
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates. |
|
|
CompleteMigration(CompleteMigrationRequest) |
Complete the migration of data. |
|
|
CompleteMigrationAsync(CompleteMigrationRequest, CancellationToken) |
Complete the migration of data. |
|
|
CopyServerlessCacheSnapshot(CopyServerlessCacheSnapshotRequest) |
Creates a copy of an existing serverless cache’s snapshot. Available for Redis only. |
|
|
CopyServerlessCacheSnapshotAsync(CopyServerlessCacheSnapshotRequest, CancellationToken) |
Creates a copy of an existing serverless cache’s snapshot. Available for Redis only. |
|
|
CopySnapshot(CopySnapshotRequest) |
Makes a copy of an existing snapshot.
This operation is valid for Redis only.
Users or groups that have permissions to use the You could receive the following error messages. Error Messages
|
|
|
CopySnapshotAsync(CopySnapshotRequest, CancellationToken) |
Makes a copy of an existing snapshot.
This operation is valid for Redis only.
Users or groups that have permissions to use the You could receive the following error messages. Error Messages
|
|
|
CreateCacheCluster(CreateCacheClusterRequest) |
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters. |
|
|
CreateCacheClusterAsync(CreateCacheClusterRequest, CancellationToken) |
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters. |
|
|
CreateCacheParameterGroup(CreateCacheParameterGroupRequest) |
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
|
|
|
CreateCacheParameterGroupAsync(CreateCacheParameterGroupRequest, CancellationToken) |
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
|
|
|
CreateCacheSecurityGroup(CreateCacheSecurityGroupRequest) |
Creates a new cache security group. Use a cache security group to control access to one or more clusters. Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup. |
|
|
CreateCacheSecurityGroupAsync(CreateCacheSecurityGroupRequest, CancellationToken) |
Creates a new cache security group. Use a cache security group to control access to one or more clusters. Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup. |
|
|
CreateCacheSubnetGroup(CreateCacheSubnetGroupRequest) |
Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). |
|
|
CreateCacheSubnetGroupAsync(CreateCacheSubnetGroupRequest, CancellationToken) |
Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). |
|
|
CreateGlobalReplicationGroup(CreateGlobalReplicationGroupRequest) |
Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
|
|
|
CreateGlobalReplicationGroupAsync(CreateGlobalReplicationGroupRequest, CancellationToken) |
Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
|
|
|
CreateReplicationGroup(CreateReplicationGroupRequest) |
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore. A Redis (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster. To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type. When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide. This operation is valid for Redis only. |
|
|
CreateReplicationGroupAsync(CreateReplicationGroupRequest, CancellationToken) |
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore. A Redis (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster. To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type. When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide. This operation is valid for Redis only. |
|
|
CreateServerlessCache(CreateServerlessCacheRequest) |
Creates a serverless cache. |
|
|
CreateServerlessCacheAsync(CreateServerlessCacheRequest, CancellationToken) |
Creates a serverless cache. |
|
|
CreateServerlessCacheSnapshot(CreateServerlessCacheSnapshotRequest) |
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only. |
|
|
CreateServerlessCacheSnapshotAsync(CreateServerlessCacheSnapshotRequest, CancellationToken) |
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only. |
|
|
CreateSnapshot(CreateSnapshotRequest) |
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
|
|
|
CreateSnapshotAsync(CreateSnapshotRequest, CancellationToken) |
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
|
|
|
CreateUser(CreateUserRequest) |
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC). |
|
|
CreateUserAsync(CreateUserRequest, CancellationToken) |
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC). |
|
|
CreateUserGroup(CreateUserGroupRequest) |
For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) |
|
|
CreateUserGroupAsync(CreateUserGroupRequest, CancellationToken) |
For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) |
|
|
DecreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest) |
Decreases the number of node groups in a Global datastore |
|
|
DecreaseNodeGroupsInGlobalReplicationGroupAsync(DecreaseNodeGroupsInGlobalReplicationGroupRequest, CancellationToken) |
Decreases the number of node groups in a Global datastore |
|
|
DecreaseReplicaCount(DecreaseReplicaCountRequest) |
Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. |
|
|
DecreaseReplicaCountAsync(DecreaseReplicaCountRequest, CancellationToken) |
Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. |
|
|
DeleteCacheCluster(DeleteCacheClusterRequest) |
Deletes a previously provisioned cluster. This operation is not valid for:
|
|
|
DeleteCacheClusterAsync(DeleteCacheClusterRequest, CancellationToken) |
Deletes a previously provisioned cluster. This operation is not valid for:
|
|
|
DeleteCacheParameterGroup(DeleteCacheParameterGroupRequest) |
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account. |
|
|
DeleteCacheParameterGroupAsync(DeleteCacheParameterGroupRequest, CancellationToken) |
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account. |
|
|
DeleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest) |
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
|
|
|
DeleteCacheSecurityGroupAsync(DeleteCacheSecurityGroupRequest, CancellationToken) |
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
|
|
|
DeleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest) |
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any
clusters.
|
|
|
DeleteCacheSubnetGroupAsync(DeleteCacheSubnetGroupRequest, CancellationToken) |
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any
clusters.
|
|
|
DeleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest) |
Deleting a Global datastore is a two-step process:
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore
while retaining the primary by setting When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. |
|
|
DeleteGlobalReplicationGroupAsync(DeleteGlobalReplicationGroupRequest, CancellationToken) |
Deleting a Global datastore is a two-step process:
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore
while retaining the primary by setting When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. |
|
|
DeleteReplicationGroup(DeleteReplicationGroupRequest) |
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 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. |
|
|
DeleteReplicationGroupAsync(DeleteReplicationGroupRequest, CancellationToken) |
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 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. |
|
|
DeleteServerlessCache(DeleteServerlessCacheRequest) |
Deletes a specified existing serverless cache. |
|
|
DeleteServerlessCacheAsync(DeleteServerlessCacheRequest, CancellationToken) |
Deletes a specified existing serverless cache. |
|
|
DeleteServerlessCacheSnapshot(DeleteServerlessCacheSnapshotRequest) |
Deletes an existing serverless cache snapshot. Available for Redis only. |
|
|
DeleteServerlessCacheSnapshotAsync(DeleteServerlessCacheSnapshotRequest, CancellationToken) |
Deletes an existing serverless cache snapshot. Available for Redis only. |
|
|
DeleteSnapshot(DeleteSnapshotRequest) |
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.
|
|
|
DeleteSnapshotAsync(DeleteSnapshotRequest, CancellationToken) |
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.
|
|
|
DeleteUser(DeleteUserRequest) |
For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC). |
|
|
DeleteUserAsync(DeleteUserRequest, CancellationToken) |
For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC). |
|
|
DeleteUserGroup(DeleteUserGroupRequest) |
For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC). |
|
|
DeleteUserGroupAsync(DeleteUserGroupRequest, CancellationToken) |
For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC). |
|
|
DescribeCacheClusters() |
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed. |
|
|
DescribeCacheClusters(DescribeCacheClustersRequest) |
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed. |
|
|
DescribeCacheClustersAsync(CancellationToken) |
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed. |
|
|
DescribeCacheClustersAsync(DescribeCacheClustersRequest, CancellationToken) |
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed. |
|
|
DescribeCacheEngineVersions() |
Returns a list of the available cache engines and their versions. |
|
|
DescribeCacheEngineVersions(DescribeCacheEngineVersionsRequest) |
Returns a list of the available cache engines and their versions. |
|
|
DescribeCacheEngineVersionsAsync(CancellationToken) |
Returns a list of the available cache engines and their versions. |
|
|
DescribeCacheEngineVersionsAsync(DescribeCacheEngineVersionsRequest, CancellationToken) |
Returns a list of the available cache engines and their versions. |
|
|
DescribeCacheParameterGroups() |
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. |
|
|
DescribeCacheParameterGroups(DescribeCacheParameterGroupsRequest) |
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. |
|
|
DescribeCacheParameterGroupsAsync(CancellationToken) |
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. |
|
|
DescribeCacheParameterGroupsAsync(DescribeCacheParameterGroupsRequest, CancellationToken) |
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. |
|
|
DescribeCacheParameters(DescribeCacheParametersRequest) |
Returns the detailed parameter list for a particular cache parameter group. |
|
|
DescribeCacheParametersAsync(DescribeCacheParametersRequest, CancellationToken) |
Returns the detailed parameter list for a particular cache parameter group. |
|
|
DescribeCacheSecurityGroups() |
Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup |
|
|
DescribeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest) |
Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup |
|
|
DescribeCacheSecurityGroupsAsync(CancellationToken) |
Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup |
|
|
DescribeCacheSecurityGroupsAsync(DescribeCacheSecurityGroupsRequest, CancellationToken) |
Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup |
|
|
DescribeCacheSubnetGroups() |
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default. |
|
|
DescribeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest) |
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default. |
|
|
DescribeCacheSubnetGroupsAsync(CancellationToken) |
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default. |
|
|
DescribeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest, CancellationToken) |
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default. |
|
|
DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest) |
Returns the default engine and system parameter information for the specified cache engine. |
|
|
DescribeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest, CancellationToken) |
Returns the default engine and system parameter information for the specified cache engine. |
|
|
DescribeEvents() |
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. |
|
|
DescribeEvents(DescribeEventsRequest) |
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. |
|
|
DescribeEventsAsync(CancellationToken) |
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. |
|
|
DescribeEventsAsync(DescribeEventsRequest, CancellationToken) |
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. |
|
|
DescribeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest) |
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. |
|
|
DescribeGlobalReplicationGroupsAsync(DescribeGlobalReplicationGroupsRequest, CancellationToken) |
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores. |
|
|
DescribeReplicationGroups() |
Returns information about a particular replication group. If no identifier is specified,
This operation is valid for Redis only.
|
|
|
DescribeReplicationGroups(DescribeReplicationGroupsRequest) |
Returns information about a particular replication group. If no identifier is specified,
This operation is valid for Redis only.
|
|
|
DescribeReplicationGroupsAsync(CancellationToken) |
Returns information about a particular replication group. If no identifier is specified,
This operation is valid for Redis only.
|
|
|
DescribeReplicationGroupsAsync(DescribeReplicationGroupsRequest, CancellationToken) |
Returns information about a particular replication group. If no identifier is specified,
This operation is valid for Redis only.
|
|
|
DescribeReservedCacheNodes() |
Returns information about reserved cache nodes for this account, or about a specified reserved cache node. |
|
|
DescribeReservedCacheNodes(DescribeReservedCacheNodesRequest) |
Returns information about reserved cache nodes for this account, or about a specified reserved cache node. |
|
|
DescribeReservedCacheNodesAsync(CancellationToken) |
Returns information about reserved cache nodes for this account, or about a specified reserved cache node. |
|
|
DescribeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest, CancellationToken) |
Returns information about reserved cache nodes for this account, or about a specified reserved cache node. |
|
|
DescribeReservedCacheNodesOfferings() |
Lists available reserved cache node offerings. |
|
|
DescribeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest) |
Lists available reserved cache node offerings. |
|
|
DescribeReservedCacheNodesOfferingsAsync(CancellationToken) |
Lists available reserved cache node offerings. |
|
|
DescribeReservedCacheNodesOfferingsAsync(DescribeReservedCacheNodesOfferingsRequest, CancellationToken) |
Lists available reserved cache node offerings. |
|
|
DescribeServerlessCaches(DescribeServerlessCachesRequest) |
Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account. |
|
|
DescribeServerlessCachesAsync(DescribeServerlessCachesRequest, CancellationToken) |
Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account. |
|
|
DescribeServerlessCacheSnapshots(DescribeServerlessCacheSnapshotsRequest) |
Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis only. |
|
|
DescribeServerlessCacheSnapshotsAsync(DescribeServerlessCacheSnapshotsRequest, CancellationToken) |
Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis only. |
|
|
DescribeServiceUpdates(DescribeServiceUpdatesRequest) |
Returns details of the service updates |
|
|
DescribeServiceUpdatesAsync(DescribeServiceUpdatesRequest, CancellationToken) |
Returns details of the service updates |
|
|
DescribeSnapshots() |
Returns information about cluster or replication group snapshots. By default,
This operation is valid for Redis only.
|
|
|
DescribeSnapshots(DescribeSnapshotsRequest) |
Returns information about cluster or replication group snapshots. By default,
This operation is valid for Redis only.
|
|
|
DescribeSnapshotsAsync(CancellationToken) |
Returns information about cluster or replication group snapshots. By default,
This operation is valid for Redis only.
|
|
|
DescribeSnapshotsAsync(DescribeSnapshotsRequest, CancellationToken) |
Returns information about cluster or replication group snapshots. By default,
This operation is valid for Redis only.
|
|
|
DescribeUpdateActions(DescribeUpdateActionsRequest) |
Returns details of the update actions |
|
|
DescribeUpdateActionsAsync(DescribeUpdateActionsRequest, CancellationToken) |
Returns details of the update actions |
|
|
DescribeUserGroups(DescribeUserGroupsRequest) |
Returns a list of user groups. |
|
|
DescribeUserGroupsAsync(DescribeUserGroupsRequest, CancellationToken) |
Returns a list of user groups. |
|
|
DescribeUsers(DescribeUsersRequest) |
Returns a list of users. |
|
|
DescribeUsersAsync(DescribeUsersRequest, CancellationToken) |
Returns a list of users. |
|
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
|
DisassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest) |
Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region. |
|
|
DisassociateGlobalReplicationGroupAsync(DisassociateGlobalReplicationGroupRequest, CancellationToken) |
Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region. |
|
|
ExportServerlessCacheSnapshot(ExportServerlessCacheSnapshotRequest) |
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis only. |
|
|
ExportServerlessCacheSnapshotAsync(ExportServerlessCacheSnapshotRequest, CancellationToken) |
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis only. |
|
|
FailoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest) |
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary. |
|
|
FailoverGlobalReplicationGroupAsync(FailoverGlobalReplicationGroupRequest, CancellationToken) |
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary. |
|
|
IncreaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest) |
Increase the number of node groups in the Global datastore |
|
|
IncreaseNodeGroupsInGlobalReplicationGroupAsync(IncreaseNodeGroupsInGlobalReplicationGroupRequest, CancellationToken) |
Increase the number of node groups in the Global datastore |
|
|
IncreaseReplicaCount(IncreaseReplicaCountRequest) |
Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. |
|
|
IncreaseReplicaCountAsync(IncreaseReplicaCountRequest, CancellationToken) |
Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time. |
|
|
ListAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest) |
Lists all available node types that you can scale your Redis cluster's or replication group's current node type.
When you use the |
|
|
ListAllowedNodeTypeModificationsAsync(ListAllowedNodeTypeModificationsRequest, CancellationToken) |
Lists all available node types that you can scale your Redis cluster's or replication group's current node type.
When you use the |
|
|
ListTagsForResource(ListTagsForResourceRequest) |
Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
If the cluster is not in the available state, |
|
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
If the cluster is not in the available state, |
|
|
ModifyCacheCluster(ModifyCacheClusterRequest) |
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values. |
|
|
ModifyCacheClusterAsync(ModifyCacheClusterRequest, CancellationToken) |
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values. |
|
|
ModifyCacheParameterGroup(ModifyCacheParameterGroupRequest) |
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. |
|
|
ModifyCacheParameterGroupAsync(ModifyCacheParameterGroupRequest, CancellationToken) |
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. |
|
|
ModifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest) |
Modifies an existing cache subnet group. |
|
|
ModifyCacheSubnetGroupAsync(ModifyCacheSubnetGroupRequest, CancellationToken) |
Modifies an existing cache subnet group. |
|
|
ModifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest) |
Modifies the settings for a Global datastore. |
|
|
ModifyGlobalReplicationGroupAsync(ModifyGlobalReplicationGroupRequest, CancellationToken) |
Modifies the settings for a Global datastore. |
|
|
ModifyReplicationGroup(ModifyReplicationGroupRequest) |
Modifies the settings for a replication group. This is limited to Redis 7 and newer.
This operation is valid for Redis only. |
|
|
ModifyReplicationGroupAsync(ModifyReplicationGroupRequest, CancellationToken) |
Modifies the settings for a replication group. This is limited to Redis 7 and newer.
This operation is valid for Redis only. |
|
|
ModifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest) |
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards. |
|
|
ModifyReplicationGroupShardConfigurationAsync(ModifyReplicationGroupShardConfigurationRequest, CancellationToken) |
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards. |
|
|
ModifyServerlessCache(ModifyServerlessCacheRequest) |
This API modifies the attributes of a serverless cache. |
|
|
ModifyServerlessCacheAsync(ModifyServerlessCacheRequest, CancellationToken) |
This API modifies the attributes of a serverless cache. |
|
|
ModifyUser(ModifyUserRequest) |
Changes user password(s) and/or access string. |
|
|
ModifyUserAsync(ModifyUserRequest, CancellationToken) |
Changes user password(s) and/or access string. |
|
|
ModifyUserGroup(ModifyUserGroupRequest) |
Changes the list of users that belong to the user group. |
|
|
ModifyUserGroupAsync(ModifyUserGroupRequest, CancellationToken) |
Changes the list of users that belong to the user group. |
|
|
PurchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest) |
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached. |
|
|
PurchaseReservedCacheNodesOfferingAsync(PurchaseReservedCacheNodesOfferingRequest, CancellationToken) |
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached. |
|
|
RebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest) |
Redistribute slots to ensure uniform distribution across existing shards in the cluster. |
|
|
RebalanceSlotsInGlobalReplicationGroupAsync(RebalanceSlotsInGlobalReplicationGroupRequest, CancellationToken) |
Redistribute slots to ensure uniform distribution across existing shards in the cluster. |
|
|
RebootCacheCluster(RebootCacheClusterRequest) |
Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process. |
|
|
RebootCacheClusterAsync(RebootCacheClusterRequest, CancellationToken) |
Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process. |
|
|
RemoveTagsFromResource(RemoveTagsFromResourceRequest) |
Removes the tags identified by the |
|
|
RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest, CancellationToken) |
Removes the tags identified by the |
|
|
ResetCacheParameterGroup(ResetCacheParameterGroupRequest) |
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 |
|
|
ResetCacheParameterGroupAsync(ResetCacheParameterGroupRequest, CancellationToken) |
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 |
|
|
RevokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest) |
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized. |
|
|
RevokeCacheSecurityGroupIngressAsync(RevokeCacheSecurityGroupIngressRequest, CancellationToken) |
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized. |
|
|
StartMigration(StartMigrationRequest) |
Start the migration of data. |
|
|
StartMigrationAsync(StartMigrationRequest, CancellationToken) |
Start the migration of data. |
|
|
TestFailover(TestFailoverRequest) |
Represents the input of a This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API. Note the following
Also see, Testing Multi-AZ in the ElastiCache User Guide. |
|
|
TestFailoverAsync(TestFailoverRequest, CancellationToken) |
Represents the input of a This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API. Note the following
Also see, Testing Multi-AZ in the ElastiCache User Guide. |
|
|
TestMigration(TestMigrationRequest) |
Async API to test connection between source and target replication group. |
|
|
TestMigrationAsync(TestMigrationRequest, CancellationToken) |
Async API to test connection between source and target replication group. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5