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.
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.
Namespace: Amazon.ElastiCache
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonElastiCache IDisposable
The IAmazonElastiCache type exposes the following members
Name | Description | |
---|---|---|
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. |
|
AddTagsToResourceAsync(AddTagsToResourceRequest, CancellationToken) | Initiates the asynchronous execution of the AddTagsToResource operation. | |
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.
|
|
AuthorizeCacheSecurityGroupIngressAsync(AuthorizeCacheSecurityGroupIngressRequest, CancellationToken) | Initiates the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation. | |
CopySnapshot(CopySnapshotRequest) | The CopySnapshot action makes a copy of an existing snapshot. | |
CopySnapshotAsync(CopySnapshotRequest, CancellationToken) | Initiates the asynchronous execution of the CopySnapshot operation. | |
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. | |
CreateCacheClusterAsync(CreateCacheClusterRequest, CancellationToken) | Initiates the asynchronous execution of the CreateCacheCluster operation. | |
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. | |
CreateCacheParameterGroupAsync(CreateCacheParameterGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateCacheParameterGroup operation. | |
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. |
|
CreateCacheSecurityGroupAsync(CreateCacheSecurityGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateCacheSecurityGroup operation. | |
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). |
|
CreateCacheSubnetGroupAsync(CreateCacheSubnetGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateCacheSubnetGroup operation. | |
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. |
|
CreateReplicationGroupAsync(CreateReplicationGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateReplicationGroup operation. | |
CreateSnapshot(CreateSnapshotRequest) | The CreateSnapshot action creates a copy of an entire cache cluster at a specific moment in time. | |
CreateSnapshotAsync(CreateSnapshotRequest, CancellationToken) | Initiates the asynchronous execution of the CreateSnapshot operation. | |
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. |
|
DeleteCacheClusterAsync(DeleteCacheClusterRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteCacheCluster operation. | |
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. | |
DeleteCacheParameterGroupAsync(DeleteCacheParameterGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteCacheParameterGroup operation. | |
DeleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest) |
The DeleteCacheSecurityGroup action deletes a cache security group.
|
|
DeleteCacheSecurityGroupAsync(DeleteCacheSecurityGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteCacheSecurityGroup operation. | |
DeleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest) |
The DeleteCacheSubnetGroup action deletes a cache subnet group.
|
|
DeleteCacheSubnetGroupAsync(DeleteCacheSubnetGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteCacheSubnetGroup operation. | |
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. |
|
DeleteReplicationGroupAsync(DeleteReplicationGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteReplicationGroup operation. | |
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. | |
DeleteSnapshotAsync(DeleteSnapshotRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteSnapshot operation. | |
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. |
|
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. |
|
DescribeCacheClustersAsync(DescribeCacheClustersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeCacheClusters operation. | |
DescribeCacheEngineVersions() | The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions. | |
DescribeCacheEngineVersions(DescribeCacheEngineVersionsRequest) | The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions. | |
DescribeCacheEngineVersionsAsync(DescribeCacheEngineVersionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeCacheEngineVersions operation. | |
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. | |
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. | |
DescribeCacheParameterGroupsAsync(DescribeCacheParameterGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeCacheParameterGroups operation. | |
DescribeCacheParameters(DescribeCacheParametersRequest) | The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group. | |
DescribeCacheParametersAsync(DescribeCacheParametersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeCacheParameters operation. | |
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. | |
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. | |
DescribeCacheSecurityGroupsAsync(DescribeCacheSecurityGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeCacheSecurityGroups operation. | |
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. | |
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. | |
DescribeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeCacheSubnetGroups operation. | |
DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest) | The DescribeEngineDefaultParameters action returns the default engine and system parameter information for the specified cache engine. | |
DescribeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation. | |
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. |
|
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. |
|
DescribeEventsAsync(DescribeEventsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEvents operation. | |
DescribeReplicationGroups() | The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. | |
DescribeReplicationGroups(DescribeReplicationGroupsRequest) | The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. | |
DescribeReplicationGroupsAsync(DescribeReplicationGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeReplicationGroups operation. | |
DescribeReservedCacheNodes() | The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node. | |
DescribeReservedCacheNodes(DescribeReservedCacheNodesRequest) | The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node. | |
DescribeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeReservedCacheNodes operation. | |
DescribeReservedCacheNodesOfferings() | The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings. | |
DescribeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest) | The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings. | |
DescribeReservedCacheNodesOfferingsAsync(DescribeReservedCacheNodesOfferingsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeReservedCacheNodesOfferings operation. | |
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. | |
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. | |
DescribeSnapshotsAsync(DescribeSnapshotsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeSnapshots operation. | |
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. |
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) | Initiates the asynchronous execution of the ListTagsForResource operation. | |
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. | |
ModifyCacheClusterAsync(ModifyCacheClusterRequest, CancellationToken) | Initiates the asynchronous execution of the ModifyCacheCluster operation. | |
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. | |
ModifyCacheParameterGroupAsync(ModifyCacheParameterGroupRequest, CancellationToken) | Initiates the asynchronous execution of the ModifyCacheParameterGroup operation. | |
ModifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest) | The ModifyCacheSubnetGroup action modifies an existing cache subnet group. | |
ModifyCacheSubnetGroupAsync(ModifyCacheSubnetGroupRequest, CancellationToken) | Initiates the asynchronous execution of the ModifyCacheSubnetGroup operation. | |
ModifyReplicationGroup(ModifyReplicationGroupRequest) | The ModifyReplicationGroup action modifies the settings for a replication group. | |
ModifyReplicationGroupAsync(ModifyReplicationGroupRequest, CancellationToken) | Initiates the asynchronous execution of the ModifyReplicationGroup operation. | |
PurchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest) | The PurchaseReservedCacheNodesOffering action allows you to purchase a reserved cache node offering. | |
PurchaseReservedCacheNodesOfferingAsync(PurchaseReservedCacheNodesOfferingRequest, CancellationToken) | Initiates the asynchronous execution of the PurchaseReservedCacheNodesOffering operation. | |
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. |
|
RebootCacheClusterAsync(RebootCacheClusterRequest, CancellationToken) | Initiates the asynchronous execution of the RebootCacheCluster operation. | |
RemoveTagsFromResource(RemoveTagsFromResourceRequest) |
The RemoveTagsFromResource action removes the tags identified by the TagKeys
list from the named resource.
|
|
RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest, CancellationToken) | Initiates the asynchronous execution of the RemoveTagsFromResource operation. | |
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. | |
ResetCacheParameterGroupAsync(ResetCacheParameterGroupRequest, CancellationToken) | Initiates the asynchronous execution of the ResetCacheParameterGroup operation. | |
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. | |
RevokeCacheSecurityGroupIngressAsync(RevokeCacheSecurityGroupIngressRequest, CancellationToken) | Initiates the asynchronous execution of the RevokeCacheSecurityGroupIngress operation. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8