AWS SDK Version 3 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.

Implementation for accessing DAX DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.DAX.AmazonDAXClient

Namespace: Amazon.DAX
Assembly: AWSSDK.DAX.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonDAXClient : AmazonServiceClient
         IAmazonDAX, IAmazonService, IDisposable

The AmazonDAXClient type exposes the following members

Constructors

NameDescription
Public Method AmazonDAXClient()

Constructs AmazonDAXClient 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.



    
        
    

             

Public Method AmazonDAXClient(RegionEndpoint)

Constructs AmazonDAXClient 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.



    
        
    

             

Public Method AmazonDAXClient(AmazonDAXConfig)

Constructs AmazonDAXClient 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.



    
        
    

             

Public Method AmazonDAXClient(AWSCredentials)

Constructs AmazonDAXClient with AWS Credentials

Public Method AmazonDAXClient(AWSCredentials, RegionEndpoint)

Constructs AmazonDAXClient with AWS Credentials

Public Method AmazonDAXClient(AWSCredentials, AmazonDAXConfig)

Constructs AmazonDAXClient with AWS Credentials and an AmazonDAXClient Configuration object.

Public Method AmazonDAXClient(string, string)

Constructs AmazonDAXClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonDAXClient(string, string, RegionEndpoint)

Constructs AmazonDAXClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonDAXClient(string, string, AmazonDAXConfig)

Constructs AmazonDAXClient with AWS Access Key ID, AWS Secret Key and an AmazonDAXClient Configuration object.

Public Method AmazonDAXClient(string, string, string)

Constructs AmazonDAXClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonDAXClient(string, string, string, RegionEndpoint)

Constructs AmazonDAXClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonDAXClient(string, string, string, AmazonDAXConfig)

Constructs AmazonDAXClient with AWS Access Key ID, AWS Secret Key and an AmazonDAXClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateCluster(CreateClusterRequest)

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

Public Method CreateClusterAsync(CreateClusterRequest, CancellationToken)

Initiates the asynchronous execution of the CreateCluster operation.

Public Method CreateParameterGroup(CreateParameterGroupRequest)

Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.

Public Method CreateParameterGroupAsync(CreateParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateParameterGroup operation.

Public Method CreateSubnetGroup(CreateSubnetGroupRequest)

Creates a new subnet group.

Public Method CreateSubnetGroupAsync(CreateSubnetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateSubnetGroup operation.

Public Method DecreaseReplicationFactor(DecreaseReplicationFactorRequest)

Removes one or more nodes from a DAX cluster.

You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.

Public Method DecreaseReplicationFactorAsync(DecreaseReplicationFactorRequest, CancellationToken)

Initiates the asynchronous execution of the DecreaseReplicationFactor operation.

Public Method DeleteCluster(DeleteClusterRequest)

Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.

Public Method DeleteClusterAsync(DeleteClusterRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCluster operation.

Public Method DeleteParameterGroup(DeleteParameterGroupRequest)

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.

Public Method DeleteParameterGroupAsync(DeleteParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteParameterGroup operation.

Public Method DeleteSubnetGroup(DeleteSubnetGroupRequest)

Deletes a subnet group.

You cannot delete a subnet group if it is associated with any DAX clusters.

Public Method DeleteSubnetGroupAsync(DeleteSubnetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSubnetGroup operation.

Public Method DescribeClusters(DescribeClustersRequest)

Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.

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 nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use.

If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.

Public Method DescribeClustersAsync(DescribeClustersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeClusters operation.

Public Method DescribeDefaultParameters(DescribeDefaultParametersRequest)

Returns the default system parameter information for the DAX caching software.

Public Method DescribeDefaultParametersAsync(DescribeDefaultParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDefaultParameters operation.

Public Method DescribeEvents(DescribeEventsRequest)

Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or 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 DescribeParameterGroups(DescribeParameterGroupsRequest)

Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.

Public Method DescribeParameterGroupsAsync(DescribeParameterGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeParameterGroups operation.

Public Method DescribeParameters(DescribeParametersRequest)

Returns the detailed parameter list for a particular parameter group.

Public Method DescribeParametersAsync(DescribeParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeParameters operation.

Public Method DescribeSubnetGroups(DescribeSubnetGroupsRequest)

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

Public Method DescribeSubnetGroupsAsync(DescribeSubnetGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeSubnetGroups operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method IncreaseReplicationFactor(IncreaseReplicationFactorRequest)

Adds one or more nodes to a DAX cluster.

Public Method IncreaseReplicationFactorAsync(IncreaseReplicationFactorRequest, CancellationToken)

Initiates the asynchronous execution of the IncreaseReplicationFactor operation.

Public Method ListTags(ListTagsRequest)

List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTags operation.

Public Method RebootNode(RebootNodeRequest)

Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.

Public Method RebootNodeAsync(RebootNodeRequest, CancellationToken)

Initiates the asynchronous execution of the RebootNode operation.

Public Method TagResource(TagResourceRequest)

Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the TagResource operation.

Public Method UntagResource(UntagResourceRequest)

Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the UntagResource operation.

Public Method UpdateCluster(UpdateClusterRequest)

Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.

Public Method UpdateClusterAsync(UpdateClusterRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateCluster operation.

Public Method UpdateParameterGroup(UpdateParameterGroupRequest)

Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

Public Method UpdateParameterGroupAsync(UpdateParameterGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateParameterGroup operation.

Public Method UpdateSubnetGroup(UpdateSubnetGroupRequest)

Modifies an existing subnet group.

Public Method UpdateSubnetGroupAsync(UpdateSubnetGroupRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateSubnetGroup 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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms