AmazonDAXClient Class | AWS SDK for .NET V3

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

public class AmazonDAXClient : AmazonServiceClient
         IAmazonDAX, IAmazonService, IDisposable

The AmazonDAXClient type exposes the following members

Constructors

	Name	Description
	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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
	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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
	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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
	AmazonDAXClient(AWSCredentials)	Constructs AmazonDAXClient with AWS Credentials
	AmazonDAXClient(AWSCredentials, RegionEndpoint)	Constructs AmazonDAXClient with AWS Credentials
	AmazonDAXClient(AWSCredentials, AmazonDAXConfig)	Constructs AmazonDAXClient with AWS Credentials and an AmazonDAXClient Configuration object.
	AmazonDAXClient(string, string)	Constructs AmazonDAXClient with AWS Access Key ID and AWS Secret Key
	AmazonDAXClient(string, string, RegionEndpoint)	Constructs AmazonDAXClient with AWS Access Key ID and AWS Secret Key
	AmazonDAXClient(string, string, AmazonDAXConfig)	Constructs AmazonDAXClient with AWS Access Key ID, AWS Secret Key and an AmazonDAXClient Configuration object.
	AmazonDAXClient(string, string, string)	Constructs AmazonDAXClient with AWS Access Key ID and AWS Secret Key
	AmazonDAXClient(string, string, string, RegionEndpoint)	Constructs AmazonDAXClient with AWS Access Key ID and AWS Secret Key
	AmazonDAXClient(string, string, string, AmazonDAXConfig)	Constructs AmazonDAXClient with AWS Access Key ID, AWS Secret Key and an AmazonDAXClient Configuration object.

Properties

	Name	Type	Description
	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.

	Name	Description
	CreateCluster(CreateClusterRequest)	Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
	CreateClusterAsync(CreateClusterRequest, CancellationToken)	Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
	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.
	CreateParameterGroupAsync(CreateParameterGroupRequest, CancellationToken)	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.
	CreateSubnetGroup(CreateSubnetGroupRequest)	Creates a new subnet group.
	CreateSubnetGroupAsync(CreateSubnetGroupRequest, CancellationToken)	Creates a new subnet group.
	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.
	DecreaseReplicationFactorAsync(DecreaseReplicationFactorRequest, CancellationToken)	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.
	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.
	DeleteClusterAsync(DeleteClusterRequest, CancellationToken)	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.
	DeleteParameterGroup(DeleteParameterGroupRequest)	Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
	DeleteParameterGroupAsync(DeleteParameterGroupRequest, CancellationToken)	Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
	DeleteSubnetGroup(DeleteSubnetGroupRequest)	Deletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters.
	DeleteSubnetGroupAsync(DeleteSubnetGroupRequest, CancellationToken)	Deletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters.
	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.
	DescribeClustersAsync(DescribeClustersRequest, CancellationToken)	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.
	DescribeDefaultParameters(DescribeDefaultParametersRequest)	Returns the default system parameter information for the DAX caching software.
	DescribeDefaultParametersAsync(DescribeDefaultParametersRequest, CancellationToken)	Returns the default system parameter information for the DAX caching software.
	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 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.
	DescribeEventsAsync(DescribeEventsRequest, CancellationToken)	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 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.
	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.
	DescribeParameterGroupsAsync(DescribeParameterGroupsRequest, CancellationToken)	Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
	DescribeParameters(DescribeParametersRequest)	Returns the detailed parameter list for a particular parameter group.
	DescribeParametersAsync(DescribeParametersRequest, CancellationToken)	Returns the detailed parameter list for a particular parameter group.
	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.
	DescribeSubnetGroupsAsync(DescribeSubnetGroupsRequest, CancellationToken)	Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
	DetermineServiceOperationEndpoint(AmazonWebServiceRequest)	Returns the endpoint that will be used for a particular request.
	Dispose()	Inherited from Amazon.Runtime.AmazonServiceClient.
	IncreaseReplicationFactor(IncreaseReplicationFactorRequest)	Adds one or more nodes to a DAX cluster.
	IncreaseReplicationFactorAsync(IncreaseReplicationFactorRequest, CancellationToken)	Adds one or more nodes to a DAX cluster.
	ListTags(ListTagsRequest)	List all of the tags for a DAX cluster. You can call `ListTags` up to 10 times per second, per account.
	ListTagsAsync(ListTagsRequest, CancellationToken)	List all of the tags for a DAX cluster. You can call `ListTags` up to 10 times per second, per account.
	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. `RebootNode` restarts the DAX engine process and does not remove the contents of the cache.
	RebootNodeAsync(RebootNodeRequest, CancellationToken)	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. `RebootNode` restarts the DAX engine process and does not remove the contents of the cache.
	TagResource(TagResourceRequest)	Associates a set of tags with a DAX resource. You can call `TagResource` up to 5 times per second, per account.
	TagResourceAsync(TagResourceRequest, CancellationToken)	Associates a set of tags with a DAX resource. You can call `TagResource` up to 5 times per second, per account.
	UntagResource(UntagResourceRequest)	Removes the association of tags from a DAX resource. You can call `UntagResource` up to 5 times per second, per account.
	UntagResourceAsync(UntagResourceRequest, CancellationToken)	Removes the association of tags from a DAX resource. You can call `UntagResource` up to 5 times per second, per account.
	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.
	UpdateClusterAsync(UpdateClusterRequest, CancellationToken)	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.
	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.
	UpdateParameterGroupAsync(UpdateParameterGroupRequest, CancellationToken)	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.
	UpdateSubnetGroup(UpdateSubnetGroupRequest)	Modifies an existing subnet group.
	UpdateSubnetGroupAsync(UpdateSubnetGroupRequest, CancellationToken)	Modifies an existing subnet group.

Events

	Name	Description
	AfterResponseEvent	Inherited from Amazon.Runtime.AmazonServiceClient.
	BeforeRequestEvent	Inherited from Amazon.Runtime.AmazonServiceClient.
	ExceptionEvent	Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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