AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
Implementation for accessing ElastiCache Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of 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

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ElastiCache.AmazonElastiCacheClient

Namespace: Amazon.ElastiCache
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class AmazonElastiCacheClient : AmazonServiceClient
         IAmazonElastiCache, IDisposable

The AmazonElastiCacheClient type exposes the following members

Constructors

NameDescription
Public Method AmazonElastiCacheClient() Constructs AmazonElastiCacheClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonElastiCacheClient(RegionEndpoint) Constructs AmazonElastiCacheClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonElastiCacheClient(AmazonElastiCacheConfig) Constructs AmazonElastiCacheClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonElastiCacheClient(AWSCredentials) Constructs AmazonElastiCacheClient with AWS Credentials
Public Method AmazonElastiCacheClient(AWSCredentials, RegionEndpoint) Constructs AmazonElastiCacheClient with AWS Credentials
Public Method AmazonElastiCacheClient(AWSCredentials, AmazonElastiCacheConfig) Constructs AmazonElastiCacheClient with AWS Credentials and an AmazonElastiCacheClient Configuration object.
Public Method AmazonElastiCacheClient(string, string) Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonElastiCacheClient(string, string, RegionEndpoint) Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonElastiCacheClient(string, string, AmazonElastiCacheConfig) Constructs AmazonElastiCacheClient with AWS Access Key ID, AWS Secret Key and an AmazonElastiCacheClient Configuration object.
Public Method AmazonElastiCacheClient(string, string, string) Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonElastiCacheClient(string, string, string, RegionEndpoint) Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonElastiCacheClient(string, string, string, AmazonElastiCacheConfig) Constructs AmazonElastiCacheClient with AWS Access Key ID, AWS Secret Key and an AmazonElastiCacheClient Configuration object.

Methods

NameDescription
Public Method AddTagsToResource(AddTagsToResourceRequest) The AddTagsToResource action 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. Cost allocation tags can be used 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.

Public Method AddTagsToResourceAsync(AddTagsToResourceRequest, CancellationToken) Initiates the asynchronous execution of the AddTagsToResource operation.
Public Method AuthorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest) The AuthorizeCacheSecurityGroupIngress action 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.
Public Method AuthorizeCacheSecurityGroupIngressAsync(AuthorizeCacheSecurityGroupIngressRequest, CancellationToken) Initiates the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation.
Public Method CopySnapshot(CopySnapshotRequest) The CopySnapshot action makes a copy of an existing snapshot.
Public Method CopySnapshotAsync(CopySnapshotRequest, CancellationToken) Initiates the asynchronous execution of the CopySnapshot operation.
Public Method CreateCacheCluster(CreateCacheClusterRequest) The CreateCacheCluster action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
Public Method CreateCacheClusterAsync(CreateCacheClusterRequest, CancellationToken) Initiates the asynchronous execution of the CreateCacheCluster operation.
Public Method CreateCacheParameterGroup(CreateCacheParameterGroupRequest) The CreateCacheParameterGroup action 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.
Public Method CreateCacheParameterGroupAsync(CreateCacheParameterGroupRequest, CancellationToken) Initiates the asynchronous execution of the CreateCacheParameterGroup operation.
Public Method CreateCacheSecurityGroup(CreateCacheSecurityGroupRequest) The CreateCacheSecurityGroup action 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 (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

Public Method CreateCacheSecurityGroupAsync(CreateCacheSecurityGroupRequest, CancellationToken) Initiates the asynchronous execution of the CreateCacheSecurityGroup operation.
Public Method CreateCacheSubnetGroup(CreateCacheSubnetGroupRequest) The CreateCacheSubnetGroup action creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

Public Method CreateCacheSubnetGroupAsync(CreateCacheSubnetGroupRequest, CancellationToken) Initiates the asynchronous execution of the CreateCacheSubnetGroup operation.
Public Method CreateReplicationGroup(CreateReplicationGroupRequest) The CreateReplicationGroup action creates a replication group. A 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 automatically propagated to the replicas.

When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.

Note: This action is valid only for Redis.

Public Method CreateReplicationGroupAsync(CreateReplicationGroupRequest, CancellationToken) Initiates the asynchronous execution of the CreateReplicationGroup operation.
Public Method CreateSnapshot(CreateSnapshotRequest) The CreateSnapshot action creates a copy of an entire cache cluster at a specific moment in time.
Public Method CreateSnapshotAsync(CreateSnapshotRequest, CancellationToken) Initiates the asynchronous execution of the CreateSnapshot operation.
Public Method DeleteCacheCluster(DeleteCacheClusterRequest) The DeleteCacheCluster action 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 action, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this action.

This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled.

Public Method DeleteCacheClusterAsync(DeleteCacheClusterRequest, CancellationToken) Initiates the asynchronous execution of the DeleteCacheCluster operation.
Public Method DeleteCacheParameterGroup(DeleteCacheParameterGroupRequest) The DeleteCacheParameterGroup action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
Public Method DeleteCacheParameterGroupAsync(DeleteCacheParameterGroupRequest, CancellationToken) Initiates the asynchronous execution of the DeleteCacheParameterGroup operation.
Public Method DeleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest) The DeleteCacheSecurityGroup action deletes a cache security group. You cannot delete a cache security group if it is associated with any cache clusters.
Public Method DeleteCacheSecurityGroupAsync(DeleteCacheSecurityGroupRequest, CancellationToken) Initiates the asynchronous execution of the DeleteCacheSecurityGroup operation.
Public Method DeleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest) The DeleteCacheSubnetGroup action deletes a cache subnet group. You cannot delete a cache subnet group if it is associated with any cache clusters.
Public Method DeleteCacheSubnetGroupAsync(DeleteCacheSubnetGroupRequest, CancellationToken) Initiates the asynchronous execution of the DeleteCacheSubnetGroup operation.
Public Method DeleteReplicationGroup(DeleteReplicationGroupRequest) The DeleteReplicationGroup action deletes an existing replication group. By default, this action deletes the entire replication group, including the primary cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cluster.

When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action.

Public Method DeleteReplicationGroupAsync(DeleteReplicationGroupRequest, CancellationToken) Initiates the asynchronous execution of the DeleteReplicationGroup operation.
Public Method DeleteSnapshot(DeleteSnapshotRequest) The DeleteSnapshot action deletes an existing snapshot. When you receive a successful response from this action, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this action.
Public Method DeleteSnapshotAsync(DeleteSnapshotRequest, CancellationToken) Initiates the asynchronous execution of the DeleteSnapshot operation.
Public Method DescribeCacheClusters() The DescribeCacheClusters action 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(s) will be 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 will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be 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.

Public Method DescribeCacheClusters(DescribeCacheClustersRequest) The DescribeCacheClusters action 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(s) will be 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 will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be 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.

Public Method DescribeCacheClustersAsync(DescribeCacheClustersRequest, CancellationToken) Initiates the asynchronous execution of the DescribeCacheClusters operation.
Public Method DescribeCacheEngineVersions() The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
Public Method DescribeCacheEngineVersions(DescribeCacheEngineVersionsRequest) The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
Public Method DescribeCacheEngineVersionsAsync(DescribeCacheEngineVersionsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeCacheEngineVersions operation.
Public Method DescribeCacheParameterGroups() The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.
Public Method DescribeCacheParameterGroups(DescribeCacheParameterGroupsRequest) The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.
Public Method DescribeCacheParameterGroupsAsync(DescribeCacheParameterGroupsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeCacheParameterGroups operation.
Public Method DescribeCacheParameters(DescribeCacheParametersRequest) The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group.
Public Method DescribeCacheParametersAsync(DescribeCacheParametersRequest, CancellationToken) Initiates the asynchronous execution of the DescribeCacheParameters operation.
Public Method DescribeCacheSecurityGroups() The DescribeCacheSecurityGroups action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.
Public Method DescribeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest) The DescribeCacheSecurityGroups action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.
Public Method DescribeCacheSecurityGroupsAsync(DescribeCacheSecurityGroupsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeCacheSecurityGroups operation.
Public Method DescribeCacheSubnetGroups() The DescribeCacheSubnetGroups action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
Public Method DescribeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest) The DescribeCacheSubnetGroups action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
Public Method DescribeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeCacheSubnetGroups operation.
Public Method DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest) The DescribeEngineDefaultParameters action returns the default engine and system parameter information for the specified cache engine.
Public Method DescribeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest, CancellationToken) Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation.
Public Method DescribeEvents() The DescribeEvents action 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.

Public Method DescribeEvents(DescribeEventsRequest) The DescribeEvents action 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.

Public Method DescribeEventsAsync(DescribeEventsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeEvents operation.
Public Method DescribeReplicationGroups() The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
Public Method DescribeReplicationGroups(DescribeReplicationGroupsRequest) The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
Public Method DescribeReplicationGroupsAsync(DescribeReplicationGroupsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeReplicationGroups operation.
Public Method DescribeReservedCacheNodes() The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
Public Method DescribeReservedCacheNodes(DescribeReservedCacheNodesRequest) The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
Public Method DescribeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest, CancellationToken) Initiates the asynchronous execution of the DescribeReservedCacheNodes operation.
Public Method DescribeReservedCacheNodesOfferings() The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
Public Method DescribeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest) The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
Public Method DescribeReservedCacheNodesOfferingsAsync(DescribeReservedCacheNodesOfferingsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeReservedCacheNodesOfferings operation.
Public Method DescribeSnapshots() The DescribeSnapshots action returns information about cache cluster 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.
Public Method DescribeSnapshots(DescribeSnapshotsRequest) The DescribeSnapshots action returns information about cache cluster 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.
Public Method DescribeSnapshotsAsync(DescribeSnapshotsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeSnapshots operation.
Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ListTagsForResource(ListTagsForResourceRequest) The ListTagsForResource action 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. Cost allocation tags can be used 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.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) Initiates the asynchronous execution of the ListTagsForResource operation.
Public Method ModifyCacheCluster(ModifyCacheClusterRequest) The ModifyCacheCluster action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.
Public Method ModifyCacheClusterAsync(ModifyCacheClusterRequest, CancellationToken) Initiates the asynchronous execution of the ModifyCacheCluster operation.
Public Method ModifyCacheParameterGroup(ModifyCacheParameterGroupRequest) The ModifyCacheParameterGroup action 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.
Public Method ModifyCacheParameterGroupAsync(ModifyCacheParameterGroupRequest, CancellationToken) Initiates the asynchronous execution of the ModifyCacheParameterGroup operation.
Public Method ModifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest) The ModifyCacheSubnetGroup action modifies an existing cache subnet group.
Public Method ModifyCacheSubnetGroupAsync(ModifyCacheSubnetGroupRequest, CancellationToken) Initiates the asynchronous execution of the ModifyCacheSubnetGroup operation.
Public Method ModifyReplicationGroup(ModifyReplicationGroupRequest) The ModifyReplicationGroup action modifies the settings for a replication group.
Public Method ModifyReplicationGroupAsync(ModifyReplicationGroupRequest, CancellationToken) Initiates the asynchronous execution of the ModifyReplicationGroup operation.
Public Method PurchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest) The PurchaseReservedCacheNodesOffering action allows you to purchase a reserved cache node offering.
Public Method PurchaseReservedCacheNodesOfferingAsync(PurchaseReservedCacheNodesOfferingRequest, CancellationToken) Initiates the asynchronous execution of the PurchaseReservedCacheNodesOffering operation.
Public Method RebootCacheCluster(RebootCacheClusterRequest) The RebootCacheCluster action reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action 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.

Public Method RebootCacheClusterAsync(RebootCacheClusterRequest, CancellationToken) Initiates the asynchronous execution of the RebootCacheCluster operation.
Public Method RemoveTagsFromResource(RemoveTagsFromResourceRequest) The RemoveTagsFromResource action removes the tags identified by the TagKeys list from the named resource.
Public Method RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest, CancellationToken) Initiates the asynchronous execution of the RemoveTagsFromResource operation.
Public Method ResetCacheParameterGroup(ResetCacheParameterGroupRequest) The ResetCacheParameterGroup action 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.
Public Method ResetCacheParameterGroupAsync(ResetCacheParameterGroupRequest, CancellationToken) Initiates the asynchronous execution of the ResetCacheParameterGroup operation.
Public Method RevokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest) The RevokeCacheSecurityGroupIngress action revokes ingress from a cache security group. Use this action to disallow access from an Amazon EC2 security group that had been previously authorized.
Public Method RevokeCacheSecurityGroupIngressAsync(RevokeCacheSecurityGroupIngressRequest, CancellationToken) Initiates the asynchronous execution of the RevokeCacheSecurityGroupIngress operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8