AWS SDK for .NET Documentation
AmazonElastiCache Interface
AmazonAmazon.ElastiCacheAmazonElastiCache Did this page help you?   Yes   No    Tell us about it...
Interface for accessing AmazonElastiCache. 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 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 interface AmazonElastiCache : IDisposable
Members
All MembersMethods



IconMemberDescription
AuthorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest)

The AuthorizeCacheSecurityGroupIngress operation 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.

NOTE: You cannot authorize ingress from an Amazon EC2 security group in one Region to an ElastiCache cluster in another Region.


BeginAuthorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation.

BeginCopySnapshot(CopySnapshotRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CopySnapshot 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.

BeginCreateReplicationGroup(CreateReplicationGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateReplicationGroup operation.

BeginCreateSnapshot(CreateSnapshotRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateSnapshot 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.

BeginDeleteReplicationGroup(DeleteReplicationGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteReplicationGroup operation.

BeginDeleteSnapshot(DeleteSnapshotRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteSnapshot 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.

BeginDescribeReplicationGroups(DescribeReplicationGroupsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeReplicationGroups 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.

BeginDescribeSnapshots(DescribeSnapshotsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeSnapshots 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.

BeginModifyReplicationGroup(ModifyReplicationGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ModifyReplicationGroup 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.

CopySnapshot(CopySnapshotRequest)

The CopySnapshot operation makes a copy of an existing snapshot.


CreateCacheCluster(CreateCacheClusterRequest)

The CreateCacheCluster operation creates a new cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software - either Memcached or Redis.


CreateCacheParameterGroup(CreateCacheParameterGroupRequest)

The CreateCacheParameterGroup operation 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.


CreateCacheSecurityGroup(CreateCacheSecurityGroupRequest)

The CreateCacheSecurityGroup operation 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 cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup .


CreateCacheSubnetGroup(CreateCacheSubnetGroupRequest)

The CreateCacheSubnetGroup operation creates a new cache subnet group.

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


CreateReplicationGroup(CreateReplicationGroupRequest)

The CreateReplicationGroup operation creates a replication group. A replication group is a collection of cache clusters, where one of the clusters is a read/write primary and the other clusters 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.


CreateSnapshot(CreateSnapshotRequest)

The CreateSnapshot operation creates a copy of an entire cache cluster at a specific moment in time.


DeleteCacheCluster(DeleteCacheClusterRequest)

The DeleteCacheCluster operation deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.


DeleteCacheParameterGroup(DeleteCacheParameterGroupRequest)

The DeleteCacheParameterGroup operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.


DeleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest)

The DeleteCacheSecurityGroup operation deletes a cache security group.

NOTE:You cannot delete a cache security group if it is associated with any cache clusters.


DeleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest)

The DeleteCacheSubnetGroup operation deletes a cache subnet group.

NOTE:You cannot delete a cache subnet group if it is associated with any cache clusters.


DeleteReplicationGroup(DeleteReplicationGroupRequest)

The DeleteReplicationGroup operation deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary cache cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cache cluster.

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


DeleteSnapshot(DeleteSnapshotRequest)

The DeleteSnapshot operation 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.


DescribeCacheClusters(DescribeCacheClustersRequest)

The DescribeCacheClusters operation 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.


DescribeCacheClusters()()()()

The DescribeCacheClusters operation 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.


DescribeCacheEngineVersions(DescribeCacheEngineVersionsRequest)

The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.


DescribeCacheEngineVersions()()()()

The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.


DescribeCacheParameterGroups(DescribeCacheParameterGroupsRequest)

The DescribeCacheParameterGroups operation 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.


DescribeCacheParameterGroups()()()()

The DescribeCacheParameterGroups operation 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.


DescribeCacheParameters(DescribeCacheParametersRequest)

The DescribeCacheParameters operation returns the detailed parameter list for a particular cache parameter group.


DescribeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest)

The DescribeCacheSecurityGroups operation 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.


DescribeCacheSecurityGroups()()()()

The DescribeCacheSecurityGroups operation 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.


DescribeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest)

The DescribeCacheSubnetGroups operation 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.


DescribeCacheSubnetGroups()()()()

The DescribeCacheSubnetGroups operation 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.


DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest)

The DescribeEngineDefaultParameters operation returns the default engine and system parameter information for the specified cache engine.


DescribeEvents(DescribeEventsRequest)

The DescribeEvents operation 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.


DescribeEvents()()()()

The DescribeEvents operation 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.


DescribeReplicationGroups(DescribeReplicationGroupsRequest)

The DescribeReplicationGroups operation returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.


DescribeReplicationGroups()()()()

The DescribeReplicationGroups operation returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.


DescribeReservedCacheNodes(DescribeReservedCacheNodesRequest)

The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.


DescribeReservedCacheNodes()()()()

The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.


DescribeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)

The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.


DescribeReservedCacheNodesOfferings()()()()

The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.


DescribeSnapshots(DescribeSnapshotsRequest)

The DescribeSnapshots operation 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.


DescribeSnapshots()()()()

The DescribeSnapshots operation 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.


Dispose()()()()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
EndAuthorizeCacheSecurityGroupIngress(IAsyncResult)
Finishes the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation.

EndCopySnapshot(IAsyncResult)
Finishes the asynchronous execution of the CopySnapshot 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.

EndCreateReplicationGroup(IAsyncResult)
Finishes the asynchronous execution of the CreateReplicationGroup operation.

EndCreateSnapshot(IAsyncResult)
Finishes the asynchronous execution of the CreateSnapshot 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.

EndDeleteReplicationGroup(IAsyncResult)
Finishes the asynchronous execution of the DeleteReplicationGroup operation.

EndDeleteSnapshot(IAsyncResult)
Finishes the asynchronous execution of the DeleteSnapshot 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.

EndDescribeReplicationGroups(IAsyncResult)
Finishes the asynchronous execution of the DescribeReplicationGroups operation.

EndDescribeReservedCacheNodes(IAsyncResult)
Finishes the asynchronous execution of the DescribeReservedCacheNodes operation.

EndDescribeReservedCacheNodesOfferings(IAsyncResult)
Finishes the asynchronous execution of the DescribeReservedCacheNodesOfferings operation.

EndDescribeSnapshots(IAsyncResult)
Finishes the asynchronous execution of the DescribeSnapshots 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.

EndModifyReplicationGroup(IAsyncResult)
Finishes the asynchronous execution of the ModifyReplicationGroup 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.

ModifyCacheCluster(ModifyCacheClusterRequest)

The ModifyCacheCluster operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.


ModifyCacheParameterGroup(ModifyCacheParameterGroupRequest)

The ModifyCacheParameterGroup operation 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)

The ModifyCacheSubnetGroup operation modifies an existing cache subnet group.


ModifyReplicationGroup(ModifyReplicationGroupRequest)

The ModifyReplicationGroup operation modifies the settings for a replication group.


PurchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest)

The PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved cache node offering.


RebootCacheCluster(RebootCacheClusterRequest)

The RebootCacheCluster operation reboots some, or all, of the cache cluster 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 cluster node being rebooted) to be lost.

When the reboot is complete, a cache cluster event is created.


ResetCacheParameterGroup(ResetCacheParameterGroupRequest)

The ResetCacheParameterGroup operation 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.


RevokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest)

The RevokeCacheSecurityGroupIngress operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.


Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)