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.

Classes

NameDescription
Class Cluster

Contains all of the attributes of a specific DAX cluster.

Class ClusterAlreadyExistsException

DAX exception

Class ClusterNotFoundException

DAX exception

Class ClusterQuotaForCustomerExceededException

DAX exception

Class CreateClusterRequest

Container for the parameters to the CreateCluster operation. Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

Class CreateClusterResponse

This is the response object from the CreateCluster operation.

Class CreateParameterGroupRequest

Container for the parameters to the CreateParameterGroup operation. 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.

Class CreateParameterGroupResponse

This is the response object from the CreateParameterGroup operation.

Class CreateSubnetGroupRequest

Container for the parameters to the CreateSubnetGroup operation. Creates a new subnet group.

Class CreateSubnetGroupResponse

This is the response object from the CreateSubnetGroup operation.

Class DecreaseReplicationFactorRequest

Container for the parameters to the DecreaseReplicationFactor operation. 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.

Class DecreaseReplicationFactorResponse

This is the response object from the DecreaseReplicationFactor operation.

Class DeleteClusterRequest

Container for the parameters to the DeleteCluster operation. 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.

Class DeleteClusterResponse

This is the response object from the DeleteCluster operation.

Class DeleteParameterGroupRequest

Container for the parameters to the DeleteParameterGroup operation. Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.

Class DeleteParameterGroupResponse

This is the response object from the DeleteParameterGroup operation.

Class DeleteSubnetGroupRequest

Container for the parameters to the DeleteSubnetGroup operation. Deletes a subnet group.

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

Class DeleteSubnetGroupResponse

This is the response object from the DeleteSubnetGroup operation.

Class DescribeClustersRequest

Container for the parameters to the DescribeClusters operation. 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.

Class DescribeClustersResponse

This is the response object from the DescribeClusters operation.

Class DescribeDefaultParametersRequest

Container for the parameters to the DescribeDefaultParameters operation. Returns the default system parameter information for the DAX caching software.

Class DescribeDefaultParametersResponse

This is the response object from the DescribeDefaultParameters operation.

Class DescribeEventsRequest

Container for the parameters to the DescribeEvents operation. 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.

Class DescribeEventsResponse

This is the response object from the DescribeEvents operation.

Class DescribeParameterGroupsRequest

Container for the parameters to the DescribeParameterGroups operation. Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.

Class DescribeParameterGroupsResponse

This is the response object from the DescribeParameterGroups operation.

Class DescribeParametersRequest

Container for the parameters to the DescribeParameters operation. Returns the detailed parameter list for a particular parameter group.

Class DescribeParametersResponse

This is the response object from the DescribeParameters operation.

Class DescribeSubnetGroupsRequest

Container for the parameters to the DescribeSubnetGroups operation. Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

Class DescribeSubnetGroupsResponse

This is the response object from the DescribeSubnetGroups operation.

Class Endpoint

Represents the information required for client programs to connect to the configuration endpoint for a DAX cluster, or to an individual node within the cluster.

Class Event

Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.

Class IncreaseReplicationFactorRequest

Container for the parameters to the IncreaseReplicationFactor operation. Adds one or more nodes to a DAX cluster.

Class IncreaseReplicationFactorResponse

This is the response object from the IncreaseReplicationFactor operation.

Class InsufficientClusterCapacityException

DAX exception

Class InvalidARNException

DAX exception

Class InvalidClusterStateException

DAX exception

Class InvalidParameterCombinationException

DAX exception

Class InvalidParameterGroupStateException

DAX exception

Class InvalidParameterValueException

DAX exception

Class InvalidSubnetException

DAX exception

Class InvalidVPCNetworkStateException

DAX exception

Class ListTagsRequest

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

Class ListTagsResponse

This is the response object from the ListTags operation.

Class Node

Represents an individual node within a DAX cluster.

Class NodeNotFoundException

DAX exception

Class NodeQuotaForClusterExceededException

DAX exception

Class NodeQuotaForCustomerExceededException

DAX exception

Class NodeTypeSpecificValue

Represents a parameter value that is applicable to a particular node type.

Class NotificationConfiguration

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

Class Parameter

Describes an individual setting that controls some aspect of DAX behavior.

Class ParameterGroup

A named set of parameters that are applied to all of the nodes in a DAX cluster.

Class ParameterGroupAlreadyExistsException

DAX exception

Class ParameterGroupNotFoundException

DAX exception

Class ParameterGroupQuotaExceededException

DAX exception

Class ParameterGroupStatus

The status of a parameter group.

Class ParameterNameValue

An individual DAX parameter.

Class RebootNodeRequest

Container for the parameters to the RebootNode operation. 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.

Class RebootNodeResponse

This is the response object from the RebootNode operation.

Class SecurityGroupMembership

An individual VPC security group and its status.

Class Subnet

Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.

Class SubnetGroup

Represents the output of one of the following actions:

  • CreateSubnetGroup

  • ModifySubnetGroup

Class SubnetGroupAlreadyExistsException

DAX exception

Class SubnetGroupInUseException

DAX exception

Class SubnetGroupNotFoundException

DAX exception

Class SubnetGroupQuotaExceededException

DAX exception

Class SubnetInUseException

DAX exception

Class SubnetQuotaExceededException

DAX exception

Class Tag

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user:.

You cannot backdate the application of a tag.

Class TagNotFoundException

DAX exception

Class TagQuotaPerResourceExceededException

DAX exception

Class TagResourceRequest

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

Class TagResourceResponse

This is the response object from the TagResource operation.

Class UntagResourceRequest

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

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateClusterRequest

Container for the parameters to the UpdateCluster operation. 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.

Class UpdateClusterResponse

This is the response object from the UpdateCluster operation.

Class UpdateParameterGroupRequest

Container for the parameters to the UpdateParameterGroup operation. 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.

Class UpdateParameterGroupResponse

This is the response object from the UpdateParameterGroup operation.

Class UpdateSubnetGroupRequest

Container for the parameters to the UpdateSubnetGroup operation. Modifies an existing subnet group.

Class UpdateSubnetGroupResponse

This is the response object from the UpdateSubnetGroup operation.