Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With Amazon 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 set-up, 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.
Declaration Syntax| C# |
public class AmazonElastiCacheClient : AmazonWebServiceClient, AmazonElastiCache, IDisposable
Members| All Members | Constructors | Methods | Events | ||
| Icon | Member | Description |
|---|---|---|
 | 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.
 CopyC#<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
| 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.
CopyC#<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
| 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.
CopyC#<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
| AmazonElastiCacheClient(AWSCredentials) |
Constructs AmazonElastiCacheClient with AWS Credentials
|
| AmazonElastiCacheClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonElastiCacheClient with AWS Credentials
|
| AmazonElastiCacheClient(AWSCredentials, AmazonElastiCacheConfig) |
Constructs AmazonElastiCacheClient with AWS Credentials and an
AmazonElastiCacheClient Configuration object.
|
| AmazonElastiCacheClient(String, String) |
Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key
|
| AmazonElastiCacheClient(String, String, RegionEndpoint) |
Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key
|
| AmazonElastiCacheClient(String, String, AmazonElastiCacheConfig) |
Constructs AmazonElastiCacheClient with AWS Access Key ID, AWS Secret Key and an
AmazonElastiCacheClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
|
| AmazonElastiCacheClient(String, String, String) |
Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key
|
| AmazonElastiCacheClient(String, String, String, RegionEndpoint) |
Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key
|
| AmazonElastiCacheClient(String, String, String, AmazonElastiCacheConfig) |
Constructs AmazonElastiCacheClient with AWS Access Key ID, AWS Secret Key and an
AmazonElastiCacheClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
|
 | AfterResponseEvent |
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.) |
| AuthorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest) | Authorizes ingress to a CacheSecurityGroup using EC2 Security Groups as authorization (therefore the application using the cache must be running on EC2 clusters). This API requires the following parameters: EC2SecurityGroupName and EC2SecurityGroupOwnerId. NOTE: You cannot authorize ingress from an EC2 security group in one Region to an Amazon Cache Cluster in another. |
| BeforeRequestEvent |
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.) |
| BeginAuthorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation.
|
| BeginCreateCacheCluster(CreateCacheClusterRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateCacheCluster operation.
|
| BeginCreateCacheParameterGroup(CreateCacheParameterGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateCacheParameterGroup operation.
|
| BeginCreateCacheSecurityGroup(CreateCacheSecurityGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateCacheSecurityGroup operation.
|
| BeginCreateCacheSubnetGroup(CreateCacheSubnetGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateCacheSubnetGroup operation.
|
| BeginDeleteCacheCluster(DeleteCacheClusterRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteCacheCluster operation.
|
| BeginDeleteCacheParameterGroup(DeleteCacheParameterGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteCacheParameterGroup operation.
|
| BeginDeleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteCacheSecurityGroup operation.
|
| BeginDeleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteCacheSubnetGroup operation.
|
| BeginDescribeCacheClusters(DescribeCacheClustersRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeCacheClusters operation.
|
| BeginDescribeCacheEngineVersions(DescribeCacheEngineVersionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeCacheEngineVersions operation.
|
| BeginDescribeCacheParameterGroups(DescribeCacheParameterGroupsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeCacheParameterGroups operation.
|
| BeginDescribeCacheParameters(DescribeCacheParametersRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeCacheParameters operation.
|
| BeginDescribeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeCacheSecurityGroups operation.
|
| BeginDescribeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeCacheSubnetGroups operation.
|
| BeginDescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation.
|
| BeginDescribeEvents(DescribeEventsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeEvents operation.
|
| BeginDescribeReservedCacheNodes(DescribeReservedCacheNodesRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeReservedCacheNodes operation.
|
| BeginDescribeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeReservedCacheNodesOfferings operation.
|
| BeginModifyCacheCluster(ModifyCacheClusterRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ModifyCacheCluster operation.
|
| BeginModifyCacheParameterGroup(ModifyCacheParameterGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ModifyCacheParameterGroup operation.
|
| BeginModifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ModifyCacheSubnetGroup operation.
|
| BeginPurchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the PurchaseReservedCacheNodesOffering operation.
|
| BeginRebootCacheCluster(RebootCacheClusterRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RebootCacheCluster operation.
|
| BeginResetCacheParameterGroup(ResetCacheParameterGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ResetCacheParameterGroup operation.
|
| BeginRevokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RevokeCacheSecurityGroupIngress operation.
|
| CreateCacheCluster(CreateCacheClusterRequest) | Creates a new Cache Cluster. |
| CreateCacheParameterGroup(CreateCacheParameterGroupRequest) | Creates a new Cache Parameter Group. Cache Parameter groups control the parameters for a Cache Cluster. |
| CreateCacheSecurityGroup(CreateCacheSecurityGroupRequest) | Creates a new Cache Security Group. Cache Security groups control access to one or more Cache Clusters. Only use cache security groups when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). Inside of a VPC, use VPC security groups. |
| CreateCacheSubnetGroup(CreateCacheSubnetGroupRequest) | Creates a new Cache Subnet Group. |
| DeleteCacheCluster(DeleteCacheClusterRequest) | Deletes a previously provisioned Cache Cluster. A successful response from the web service indicates the request was received correctly. This action cannot be canceled or reverted. DeleteCacheCluster deletes all associated Cache Nodes, node endpoints and the Cache Cluster itself. |
| DeleteCacheParameterGroup(DeleteCacheParameterGroupRequest) | Deletes the specified CacheParameterGroup. The CacheParameterGroup cannot be deleted if it is associated with any cache clusters. |
| DeleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest) | Deletes a Cache Security Group. NOTE:The specified Cache Security Group must not be associated with any Cache Clusters. |
| DeleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest) | Deletes a Cache Subnet Group. NOTE:The specified Cache Subnet Group must not be associated with any Cache Clusters. |
| DescribeCacheClusters(DescribeCacheClustersRequest) | 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. Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. 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. While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE. While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed. DescribeCacheClusters supports pagination. |
| DescribeCacheClusters()()()() | 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. Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. 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. While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE. While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed. DescribeCacheClusters supports pagination. |
| DescribeCacheEngineVersions(DescribeCacheEngineVersionsRequest) | Returns a list of the available cache engines and their versions. |
| DescribeCacheEngineVersions()()()() | Returns a list of the available cache engines and their versions. |
| DescribeCacheParameterGroups(DescribeCacheParameterGroupsRequest) | Returns a list of CacheParameterGroup descriptions. If a CacheParameterGroupName is specified, the list will contain only the descriptions of the specified CacheParameterGroup. |
| DescribeCacheParameterGroups()()()() | Returns a list of CacheParameterGroup descriptions. If a CacheParameterGroupName is specified, the list will contain only the descriptions of the specified CacheParameterGroup. |
| DescribeCacheParameters(DescribeCacheParametersRequest) | Returns the detailed parameter list for a particular CacheParameterGroup. |
| DescribeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest) | Returns a list of CacheSecurityGroup descriptions. If a CacheSecurityGroupName is specified, the list will contain only the description of the specified CacheSecurityGroup. |
| DescribeCacheSecurityGroups()()()() | Returns a list of CacheSecurityGroup descriptions. If a CacheSecurityGroupName is specified, the list will contain only the description of the specified CacheSecurityGroup. |
| DescribeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest) | Returns a list of CacheSubnetGroup descriptions. If a CacheSubnetGroupName is specified, the list will contain only the description of the specified Cache Subnet Group. |
| DescribeCacheSubnetGroups()()()() | Returns a list of CacheSubnetGroup descriptions. If a CacheSubnetGroupName is specified, the list will contain only the description of the specified Cache Subnet Group. |
| DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest) | Returns the default engine and system parameter information for the specified cache engine. |
| DescribeEvents(DescribeEventsRequest) | Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days. Events specific to a particular Cache Cluster, Cache Security Group, or Cache Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. |
| DescribeEvents()()()() | Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days. Events specific to a particular Cache Cluster, Cache Security Group, or Cache Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. |
| DescribeReservedCacheNodes(DescribeReservedCacheNodesRequest) | Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node. |
| DescribeReservedCacheNodes()()()() | Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node. |
| DescribeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest) | Lists available reserved Cache Node offerings. |
| DescribeReservedCacheNodesOfferings()()()() | Lists available reserved Cache Node offerings. |
| Dispose()()()() |
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.) |
| EndAuthorizeCacheSecurityGroupIngress(IAsyncResult) |
Finishes the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation.
|
| EndCreateCacheCluster(IAsyncResult) |
Finishes the asynchronous execution of the CreateCacheCluster operation.
|
| EndCreateCacheParameterGroup(IAsyncResult) |
Finishes the asynchronous execution of the CreateCacheParameterGroup operation.
|
| EndCreateCacheSecurityGroup(IAsyncResult) |
Finishes the asynchronous execution of the CreateCacheSecurityGroup operation.
|
| EndCreateCacheSubnetGroup(IAsyncResult) |
Finishes the asynchronous execution of the CreateCacheSubnetGroup operation.
|
| EndDeleteCacheCluster(IAsyncResult) |
Finishes the asynchronous execution of the DeleteCacheCluster operation.
|
| EndDeleteCacheParameterGroup(IAsyncResult) |
Finishes the asynchronous execution of the DeleteCacheParameterGroup operation.
|
| EndDeleteCacheSecurityGroup(IAsyncResult) |
Finishes the asynchronous execution of the DeleteCacheSecurityGroup operation.
|
| EndDeleteCacheSubnetGroup(IAsyncResult) |
Finishes the asynchronous execution of the DeleteCacheSubnetGroup operation.
|
| EndDescribeCacheClusters(IAsyncResult) |
Finishes the asynchronous execution of the DescribeCacheClusters operation.
|
| EndDescribeCacheEngineVersions(IAsyncResult) |
Finishes the asynchronous execution of the DescribeCacheEngineVersions operation.
|
| EndDescribeCacheParameterGroups(IAsyncResult) |
Finishes the asynchronous execution of the DescribeCacheParameterGroups operation.
|
| EndDescribeCacheParameters(IAsyncResult) |
Finishes the asynchronous execution of the DescribeCacheParameters operation.
|
| EndDescribeCacheSecurityGroups(IAsyncResult) |
Finishes the asynchronous execution of the DescribeCacheSecurityGroups operation.
|
| EndDescribeCacheSubnetGroups(IAsyncResult) |
Finishes the asynchronous execution of the DescribeCacheSubnetGroups operation.
|
| EndDescribeEngineDefaultParameters(IAsyncResult) |
Finishes the asynchronous execution of the DescribeEngineDefaultParameters operation.
|
| EndDescribeEvents(IAsyncResult) |
Finishes the asynchronous execution of the DescribeEvents operation.
|
| EndDescribeReservedCacheNodes(IAsyncResult) |
Finishes the asynchronous execution of the DescribeReservedCacheNodes operation.
|
| EndDescribeReservedCacheNodesOfferings(IAsyncResult) |
Finishes the asynchronous execution of the DescribeReservedCacheNodesOfferings operation.
|
| EndModifyCacheCluster(IAsyncResult) |
Finishes the asynchronous execution of the ModifyCacheCluster operation.
|
| EndModifyCacheParameterGroup(IAsyncResult) |
Finishes the asynchronous execution of the ModifyCacheParameterGroup operation.
|
| EndModifyCacheSubnetGroup(IAsyncResult) |
Finishes the asynchronous execution of the ModifyCacheSubnetGroup operation.
|
| EndPurchaseReservedCacheNodesOffering(IAsyncResult) |
Finishes the asynchronous execution of the PurchaseReservedCacheNodesOffering operation.
|
| EndRebootCacheCluster(IAsyncResult) |
Finishes the asynchronous execution of the RebootCacheCluster operation.
|
| EndResetCacheParameterGroup(IAsyncResult) |
Finishes the asynchronous execution of the ResetCacheParameterGroup operation.
|
| EndRevokeCacheSecurityGroupIngress(IAsyncResult) |
Finishes the asynchronous execution of the RevokeCacheSecurityGroupIngress operation.
|
| Equals(Object) | (Inherited from Object.) |
| ExceptionEvent |
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| ModifyCacheCluster(ModifyCacheClusterRequest) | Modifies the Cache Cluster settings. You can change one or more Cache Cluster configuration parameters by specifying the parameters and the new values in the request. |
| ModifyCacheParameterGroup(ModifyCacheParameterGroupRequest) | Modifies the parameters of a CacheParameterGroup. To modify more than one parameter, submit a list of ParameterName and ParameterValue parameters. A maximum of 20 parameters can be modified in a single request. |
| ModifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest) | Modifies an existing Cache Subnet Group. |
| PurchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest) | Purchases a reserved Cache Node offering. |
| RebootCacheCluster(RebootCacheClusterRequest) | Reboots some (or all) of the cache cluster nodes within a previously provisioned ElastiCache cluster. This API results in the application of modified CacheParameterGroup parameters to the cache cluster. This action is taken as soon as possible, and results in a momentary outage to the cache cluster during which the cache cluster status is set to rebooting. During that momentary outage, the contents of the cache (for each cache cluster node being rebooted) are lost. A CacheCluster event is created when the reboot is completed. |
| ResetCacheParameterGroup(ResetCacheParameterGroupRequest) | Modifies the parameters of a CacheParameterGroup to the engine or system default value. To reset specific parameters submit a list of the parameter names. To reset the entire CacheParameterGroup, specify the CacheParameterGroup name and ResetAllParameters parameters. |
| RevokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest) | Revokes ingress from a CacheSecurityGroup for previously authorized EC2 Security Groups. |
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceClient | |
| AmazonElastiCacheClient | |
