Interface DaxClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface DaxClient
extends AwsClient

Service client for accessing Amazon DAX. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static DaxClientBuilder	builder()	Create a builder that can be used to configure and create a DaxClient.
static DaxClient	create()	Create a DaxClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateClusterResponse	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)	Creates a DAX cluster.
default CreateClusterResponse	createCluster(CreateClusterRequest createClusterRequest)	Creates a DAX cluster.
default CreateParameterGroupResponse	createParameterGroup(Consumer<CreateParameterGroupRequest.Builder> createParameterGroupRequest)	Creates a new parameter group.
default CreateParameterGroupResponse	createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest)	Creates a new parameter group.
default CreateSubnetGroupResponse	createSubnetGroup(Consumer<CreateSubnetGroupRequest.Builder> createSubnetGroupRequest)	Creates a new subnet group.
default CreateSubnetGroupResponse	createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest)	Creates a new subnet group.
default DecreaseReplicationFactorResponse	decreaseReplicationFactor(Consumer<DecreaseReplicationFactorRequest.Builder> decreaseReplicationFactorRequest)	Removes one or more nodes from a DAX cluster.
default DecreaseReplicationFactorResponse	decreaseReplicationFactor(DecreaseReplicationFactorRequest decreaseReplicationFactorRequest)	Removes one or more nodes from a DAX cluster.
default DeleteClusterResponse	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)	Deletes a previously provisioned DAX cluster.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest)	Deletes a previously provisioned DAX cluster.
default DeleteParameterGroupResponse	deleteParameterGroup(Consumer<DeleteParameterGroupRequest.Builder> deleteParameterGroupRequest)	Deletes the specified parameter group.
default DeleteParameterGroupResponse	deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest)	Deletes the specified parameter group.
default DeleteSubnetGroupResponse	deleteSubnetGroup(Consumer<DeleteSubnetGroupRequest.Builder> deleteSubnetGroupRequest)	Deletes a subnet group.
default DeleteSubnetGroupResponse	deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest)	Deletes a subnet group.
default DescribeClustersResponse	describeClusters()	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.
default DescribeClustersResponse	describeClusters(Consumer<DescribeClustersRequest.Builder> 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.
default DescribeClustersResponse	describeClusters(DescribeClustersRequest 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.
default DescribeDefaultParametersResponse	describeDefaultParameters()	Returns the default system parameter information for the DAX caching software.
default DescribeDefaultParametersResponse	describeDefaultParameters(Consumer<DescribeDefaultParametersRequest.Builder> describeDefaultParametersRequest)	Returns the default system parameter information for the DAX caching software.
default DescribeDefaultParametersResponse	describeDefaultParameters(DescribeDefaultParametersRequest describeDefaultParametersRequest)	Returns the default system parameter information for the DAX caching software.
default DescribeEventsResponse	describeEvents()	Returns events related to DAX clusters and parameter groups.
default DescribeEventsResponse	describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)	Returns events related to DAX clusters and parameter groups.
default DescribeEventsResponse	describeEvents(DescribeEventsRequest describeEventsRequest)	Returns events related to DAX clusters and parameter groups.
default DescribeParameterGroupsResponse	describeParameterGroups()	Returns a list of parameter group descriptions.
default DescribeParameterGroupsResponse	describeParameterGroups(Consumer<DescribeParameterGroupsRequest.Builder> describeParameterGroupsRequest)	Returns a list of parameter group descriptions.
default DescribeParameterGroupsResponse	describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest)	Returns a list of parameter group descriptions.
default DescribeParametersResponse	describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)	Returns the detailed parameter list for a particular parameter group.
default DescribeParametersResponse	describeParameters(DescribeParametersRequest describeParametersRequest)	Returns the detailed parameter list for a particular parameter group.
default DescribeSubnetGroupsResponse	describeSubnetGroups()	Returns a list of subnet group descriptions.
default DescribeSubnetGroupsResponse	describeSubnetGroups(Consumer<DescribeSubnetGroupsRequest.Builder> describeSubnetGroupsRequest)	Returns a list of subnet group descriptions.
default DescribeSubnetGroupsResponse	describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest)	Returns a list of subnet group descriptions.
default IncreaseReplicationFactorResponse	increaseReplicationFactor(Consumer<IncreaseReplicationFactorRequest.Builder> increaseReplicationFactorRequest)	Adds one or more nodes to a DAX cluster.
default IncreaseReplicationFactorResponse	increaseReplicationFactor(IncreaseReplicationFactorRequest increaseReplicationFactorRequest)	Adds one or more nodes to a DAX cluster.
default ListTagsResponse	listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)	List all of the tags for a DAX cluster.
default ListTagsResponse	listTags(ListTagsRequest listTagsRequest)	List all of the tags for a DAX cluster.
default RebootNodeResponse	rebootNode(Consumer<RebootNodeRequest.Builder> rebootNodeRequest)	Reboots a single node of a DAX cluster.
default RebootNodeResponse	rebootNode(RebootNodeRequest rebootNodeRequest)	Reboots a single node of a DAX cluster.
default DaxServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Associates a set of tags with a DAX resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Associates a set of tags with a DAX resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the association of tags from a DAX resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the association of tags from a DAX resource.
default UpdateClusterResponse	updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)	Modifies the settings for a DAX cluster.
default UpdateClusterResponse	updateCluster(UpdateClusterRequest updateClusterRequest)	Modifies the settings for a DAX cluster.
default UpdateParameterGroupResponse	updateParameterGroup(Consumer<UpdateParameterGroupRequest.Builder> updateParameterGroupRequest)	Modifies the parameters of a parameter group.
default UpdateParameterGroupResponse	updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest)	Modifies the parameters of a parameter group.
default UpdateSubnetGroupResponse	updateSubnetGroup(Consumer<UpdateSubnetGroupRequest.Builder> updateSubnetGroupRequest)	Modifies an existing subnet group.
default UpdateSubnetGroupResponse	updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest)	Modifies an existing subnet group.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws ClusterAlreadyExistsException,
InvalidClusterStateException,
InsufficientClusterCapacityException,
SubnetGroupNotFoundException,
InvalidParameterGroupStateException,
ParameterGroupNotFoundException,
ClusterQuotaForCustomerExceededException,
NodeQuotaForClusterExceededException,
NodeQuotaForCustomerExceededException,
InvalidVpcNetworkStateException,
TagQuotaPerResourceExceededException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
DaxException

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

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createCluster

default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
                                     throws ClusterAlreadyExistsException,
InvalidClusterStateException,
InsufficientClusterCapacityException,
SubnetGroupNotFoundException,
InvalidParameterGroupStateException,
ParameterGroupNotFoundException,
ClusterQuotaForCustomerExceededException,
NodeQuotaForClusterExceededException,
NodeQuotaForCustomerExceededException,
InvalidVpcNetworkStateException,
TagQuotaPerResourceExceededException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
DaxException

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

This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to create one manually via CreateClusterRequest.builder()

Parameters:

createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createParameterGroup

default CreateParameterGroupResponse createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest)
                                                   throws ParameterGroupQuotaExceededException,
ParameterGroupAlreadyExistsException,
InvalidParameterGroupStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Parameters:

createParameterGroupRequest -

Returns:

Result of the CreateParameterGroup operation returned by the service.

See Also:

• AWS API Documentation

createParameterGroup

default CreateParameterGroupResponse createParameterGroup(Consumer<CreateParameterGroupRequest.Builder> createParameterGroupRequest)
                                                   throws ParameterGroupQuotaExceededException,
ParameterGroupAlreadyExistsException,
InvalidParameterGroupStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

This is a convenience which creates an instance of the CreateParameterGroupRequest.Builder avoiding the need to create one manually via CreateParameterGroupRequest.builder()

Parameters:

createParameterGroupRequest - A Consumer that will call methods on CreateParameterGroupRequest.Builder to create a request.

Returns:

Result of the CreateParameterGroup operation returned by the service.

See Also:

• AWS API Documentation

createSubnetGroup

default CreateSubnetGroupResponse createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest)
                                             throws SubnetGroupAlreadyExistsException,
SubnetGroupQuotaExceededException,
SubnetQuotaExceededException,
InvalidSubnetException,
ServiceLinkedRoleNotFoundException,
AwsServiceException,
SdkClientException,
DaxException

Creates a new subnet group.

Parameters:

createSubnetGroupRequest -

Returns:

Result of the CreateSubnetGroup operation returned by the service.

See Also:

• AWS API Documentation

createSubnetGroup

default CreateSubnetGroupResponse createSubnetGroup(Consumer<CreateSubnetGroupRequest.Builder> createSubnetGroupRequest)
                                             throws SubnetGroupAlreadyExistsException,
SubnetGroupQuotaExceededException,
SubnetQuotaExceededException,
InvalidSubnetException,
ServiceLinkedRoleNotFoundException,
AwsServiceException,
SdkClientException,
DaxException

Creates a new subnet group.

This is a convenience which creates an instance of the CreateSubnetGroupRequest.Builder avoiding the need to create one manually via CreateSubnetGroupRequest.builder()

Parameters:

createSubnetGroupRequest - A Consumer that will call methods on CreateSubnetGroupRequest.Builder to create a request.

Returns:

Result of the CreateSubnetGroup operation returned by the service.

See Also:

• AWS API Documentation

decreaseReplicationFactor

default DecreaseReplicationFactorResponse decreaseReplicationFactor(DecreaseReplicationFactorRequest decreaseReplicationFactorRequest)
                                                             throws ClusterNotFoundException,
NodeNotFoundException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Parameters:

decreaseReplicationFactorRequest -

Returns:

Result of the DecreaseReplicationFactor operation returned by the service.

See Also:

• AWS API Documentation

decreaseReplicationFactor

default DecreaseReplicationFactorResponse decreaseReplicationFactor(Consumer<DecreaseReplicationFactorRequest.Builder> decreaseReplicationFactorRequest)
                                                             throws ClusterNotFoundException,
NodeNotFoundException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

This is a convenience which creates an instance of the DecreaseReplicationFactorRequest.Builder avoiding the need to create one manually via DecreaseReplicationFactorRequest.builder()

Parameters:

decreaseReplicationFactorRequest - A Consumer that will call methods on DecreaseReplicationFactorRequest.Builder to create a request.

Returns:

Result of the DecreaseReplicationFactor operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws ClusterNotFoundException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
                                     throws ClusterNotFoundException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

This is a convenience which creates an instance of the DeleteClusterRequest.Builder avoiding the need to create one manually via DeleteClusterRequest.builder()

Parameters:

deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteParameterGroup

default DeleteParameterGroupResponse deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest)
                                                   throws InvalidParameterGroupStateException,
ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

Parameters:

deleteParameterGroupRequest -

Returns:

Result of the DeleteParameterGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteParameterGroup

default DeleteParameterGroupResponse deleteParameterGroup(Consumer<DeleteParameterGroupRequest.Builder> deleteParameterGroupRequest)
                                                   throws InvalidParameterGroupStateException,
ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

This is a convenience which creates an instance of the DeleteParameterGroupRequest.Builder avoiding the need to create one manually via DeleteParameterGroupRequest.builder()

Parameters:

deleteParameterGroupRequest - A Consumer that will call methods on DeleteParameterGroupRequest.Builder to create a request.

Returns:

Result of the DeleteParameterGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteSubnetGroup

default DeleteSubnetGroupResponse deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest)
                                             throws SubnetGroupInUseException,
SubnetGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
AwsServiceException,
SdkClientException,
DaxException

Deletes a subnet group.

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

Parameters:

deleteSubnetGroupRequest -

Returns:

Result of the DeleteSubnetGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteSubnetGroup

default DeleteSubnetGroupResponse deleteSubnetGroup(Consumer<DeleteSubnetGroupRequest.Builder> deleteSubnetGroupRequest)
                                             throws SubnetGroupInUseException,
SubnetGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
AwsServiceException,
SdkClientException,
DaxException

Deletes a subnet group.

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

This is a convenience which creates an instance of the DeleteSubnetGroupRequest.Builder avoiding the need to create one manually via DeleteSubnetGroupRequest.builder()

Parameters:

deleteSubnetGroupRequest - A Consumer that will call methods on DeleteSubnetGroupRequest.Builder to create a request.

Returns:

Result of the DeleteSubnetGroup operation returned by the service.

See Also:

• AWS API Documentation

describeClusters

default DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest)
                                           throws ClusterNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Parameters:

describeClustersRequest -

Returns:

Result of the DescribeClusters operation returned by the service.

See Also:

• AWS API Documentation

describeClusters

default DescribeClustersResponse describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
                                           throws ClusterNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

This is a convenience which creates an instance of the DescribeClustersRequest.Builder avoiding the need to create one manually via DescribeClustersRequest.builder()

Parameters:

describeClustersRequest - A Consumer that will call methods on DescribeClustersRequest.Builder to create a request.

Returns:

Result of the DescribeClusters operation returned by the service.

See Also:

• AWS API Documentation

describeClusters

default DescribeClustersResponse describeClusters()
                                           throws ClusterNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Returns:

Result of the DescribeClusters operation returned by the service.

See Also:

• describeClusters(DescribeClustersRequest)
• AWS API Documentation

describeDefaultParameters

default DescribeDefaultParametersResponse describeDefaultParameters(DescribeDefaultParametersRequest describeDefaultParametersRequest)
                                                             throws ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

Parameters:

describeDefaultParametersRequest -

Returns:

Result of the DescribeDefaultParameters operation returned by the service.

See Also:

• AWS API Documentation

describeDefaultParameters

default DescribeDefaultParametersResponse describeDefaultParameters(Consumer<DescribeDefaultParametersRequest.Builder> describeDefaultParametersRequest)
                                                             throws ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

This is a convenience which creates an instance of the DescribeDefaultParametersRequest.Builder avoiding the need to create one manually via DescribeDefaultParametersRequest.builder()

Parameters:

describeDefaultParametersRequest - A Consumer that will call methods on DescribeDefaultParametersRequest.Builder to create a request.

Returns:

Result of the DescribeDefaultParameters operation returned by the service.

See Also:

• AWS API Documentation

describeDefaultParameters

default DescribeDefaultParametersResponse describeDefaultParameters()
                                                             throws ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

Returns:

Result of the DescribeDefaultParameters operation returned by the service.

See Also:

• describeDefaultParameters(DescribeDefaultParametersRequest)
• AWS API Documentation

describeEvents

default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest)
                                       throws ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Parameters:

describeEventsRequest -

Returns:

Result of the DescribeEvents operation returned by the service.

See Also:

• AWS API Documentation

describeEvents

default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
                                       throws ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to create one manually via DescribeEventsRequest.builder()

Parameters:

describeEventsRequest - A Consumer that will call methods on DescribeEventsRequest.Builder to create a request.

Returns:

Result of the DescribeEvents operation returned by the service.

See Also:

• AWS API Documentation

describeEvents

default DescribeEventsResponse describeEvents()
                                       throws ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Returns:

Result of the DescribeEvents operation returned by the service.

See Also:

• describeEvents(DescribeEventsRequest)
• AWS API Documentation

describeParameterGroups

default DescribeParameterGroupsResponse describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest)
                                                         throws ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

Parameters:

describeParameterGroupsRequest -

Returns:

Result of the DescribeParameterGroups operation returned by the service.

See Also:

• AWS API Documentation

describeParameterGroups

default DescribeParameterGroupsResponse describeParameterGroups(Consumer<DescribeParameterGroupsRequest.Builder> describeParameterGroupsRequest)
                                                         throws ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

This is a convenience which creates an instance of the DescribeParameterGroupsRequest.Builder avoiding the need to create one manually via DescribeParameterGroupsRequest.builder()

Parameters:

describeParameterGroupsRequest - A Consumer that will call methods on DescribeParameterGroupsRequest.Builder to create a request.

Returns:

Result of the DescribeParameterGroups operation returned by the service.

See Also:

• AWS API Documentation

describeParameterGroups

default DescribeParameterGroupsResponse describeParameterGroups()
                                                         throws ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

Returns:

Result of the DescribeParameterGroups operation returned by the service.

See Also:

• describeParameterGroups(DescribeParameterGroupsRequest)
• AWS API Documentation

describeParameters

default DescribeParametersResponse describeParameters(DescribeParametersRequest describeParametersRequest)
                                               throws ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

Returns the detailed parameter list for a particular parameter group.

Parameters:

describeParametersRequest -

Returns:

Result of the DescribeParameters operation returned by the service.

See Also:

• AWS API Documentation

describeParameters

default DescribeParametersResponse describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)
                                               throws ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

Returns the detailed parameter list for a particular parameter group.

This is a convenience which creates an instance of the DescribeParametersRequest.Builder avoiding the need to create one manually via DescribeParametersRequest.builder()

Parameters:

describeParametersRequest - A Consumer that will call methods on DescribeParametersRequest.Builder to create a request.

Returns:

Result of the DescribeParameters operation returned by the service.

See Also:

• AWS API Documentation

describeSubnetGroups

default DescribeSubnetGroupsResponse describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest)
                                                   throws SubnetGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
AwsServiceException,
SdkClientException,
DaxException

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

Parameters:

describeSubnetGroupsRequest -

Returns:

Result of the DescribeSubnetGroups operation returned by the service.

See Also:

• AWS API Documentation

describeSubnetGroups

default DescribeSubnetGroupsResponse describeSubnetGroups(Consumer<DescribeSubnetGroupsRequest.Builder> describeSubnetGroupsRequest)
                                                   throws SubnetGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
AwsServiceException,
SdkClientException,
DaxException

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

This is a convenience which creates an instance of the DescribeSubnetGroupsRequest.Builder avoiding the need to create one manually via DescribeSubnetGroupsRequest.builder()

Parameters:

describeSubnetGroupsRequest - A Consumer that will call methods on DescribeSubnetGroupsRequest.Builder to create a request.

Returns:

Result of the DescribeSubnetGroups operation returned by the service.

See Also:

• AWS API Documentation

describeSubnetGroups

default DescribeSubnetGroupsResponse describeSubnetGroups()
                                                   throws SubnetGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
AwsServiceException,
SdkClientException,
DaxException

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

Returns:

Result of the DescribeSubnetGroups operation returned by the service.

See Also:

• describeSubnetGroups(DescribeSubnetGroupsRequest)
• AWS API Documentation

increaseReplicationFactor

default IncreaseReplicationFactorResponse increaseReplicationFactor(IncreaseReplicationFactorRequest increaseReplicationFactorRequest)
                                                             throws ClusterNotFoundException,
InvalidClusterStateException,
InsufficientClusterCapacityException,
InvalidVpcNetworkStateException,
NodeQuotaForClusterExceededException,
NodeQuotaForCustomerExceededException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

Adds one or more nodes to a DAX cluster.

Parameters:

increaseReplicationFactorRequest -

Returns:

Result of the IncreaseReplicationFactor operation returned by the service.

See Also:

• AWS API Documentation

increaseReplicationFactor

default IncreaseReplicationFactorResponse increaseReplicationFactor(Consumer<IncreaseReplicationFactorRequest.Builder> increaseReplicationFactorRequest)
                                                             throws ClusterNotFoundException,
InvalidClusterStateException,
InsufficientClusterCapacityException,
InvalidVpcNetworkStateException,
NodeQuotaForClusterExceededException,
NodeQuotaForCustomerExceededException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

Adds one or more nodes to a DAX cluster.

This is a convenience which creates an instance of the IncreaseReplicationFactorRequest.Builder avoiding the need to create one manually via IncreaseReplicationFactorRequest.builder()

Parameters:

increaseReplicationFactorRequest - A Consumer that will call methods on IncreaseReplicationFactorRequest.Builder to create a request.

Returns:

Result of the IncreaseReplicationFactor operation returned by the service.

See Also:

• AWS API Documentation

listTags

default ListTagsResponse listTags(ListTagsRequest listTagsRequest)
                           throws ClusterNotFoundException,
InvalidArnException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

Parameters:

listTagsRequest -

Returns:

Result of the ListTags operation returned by the service.

See Also:

• AWS API Documentation

listTags

default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
                           throws ClusterNotFoundException,
InvalidArnException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to create one manually via ListTagsRequest.builder()

Parameters:

listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.

Returns:

Result of the ListTags operation returned by the service.

See Also:

• AWS API Documentation

rebootNode

default RebootNodeResponse rebootNode(RebootNodeRequest rebootNodeRequest)
                               throws ClusterNotFoundException,
NodeNotFoundException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Parameters:

rebootNodeRequest -

Returns:

Result of the RebootNode operation returned by the service.

See Also:

• AWS API Documentation

rebootNode

default RebootNodeResponse rebootNode(Consumer<RebootNodeRequest.Builder> rebootNodeRequest)
                               throws ClusterNotFoundException,
NodeNotFoundException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

This is a convenience which creates an instance of the RebootNodeRequest.Builder avoiding the need to create one manually via RebootNodeRequest.builder()

Parameters:

rebootNodeRequest - A Consumer that will call methods on RebootNodeRequest.Builder to create a request.

Returns:

Result of the RebootNode operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ClusterNotFoundException,
TagQuotaPerResourceExceededException,
InvalidArnException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ClusterNotFoundException,
TagQuotaPerResourceExceededException,
InvalidArnException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ClusterNotFoundException,
InvalidArnException,
TagNotFoundException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ClusterNotFoundException,
InvalidArnException,
TagNotFoundException,
InvalidClusterStateException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateCluster

default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest)
                                     throws InvalidClusterStateException,
ClusterNotFoundException,
InvalidParameterGroupStateException,
ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Parameters:

updateClusterRequest -

Returns:

Result of the UpdateCluster operation returned by the service.

See Also:

• AWS API Documentation

updateCluster

default UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)
                                     throws InvalidClusterStateException,
ClusterNotFoundException,
InvalidParameterGroupStateException,
ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

This is a convenience which creates an instance of the UpdateClusterRequest.Builder avoiding the need to create one manually via UpdateClusterRequest.builder()

Parameters:

updateClusterRequest - A Consumer that will call methods on UpdateClusterRequest.Builder to create a request.

Returns:

Result of the UpdateCluster operation returned by the service.

See Also:

• AWS API Documentation

updateParameterGroup

default UpdateParameterGroupResponse updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest)
                                                   throws InvalidParameterGroupStateException,
ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

Parameters:

updateParameterGroupRequest -

Returns:

Result of the UpdateParameterGroup operation returned by the service.

See Also:

• AWS API Documentation

updateParameterGroup

default UpdateParameterGroupResponse updateParameterGroup(Consumer<UpdateParameterGroupRequest.Builder> updateParameterGroupRequest)
                                                   throws InvalidParameterGroupStateException,
ParameterGroupNotFoundException,
ServiceLinkedRoleNotFoundException,
InvalidParameterValueException,
InvalidParameterCombinationException,
AwsServiceException,
SdkClientException,
DaxException

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.

This is a convenience which creates an instance of the UpdateParameterGroupRequest.Builder avoiding the need to create one manually via UpdateParameterGroupRequest.builder()

Parameters:

updateParameterGroupRequest - A Consumer that will call methods on UpdateParameterGroupRequest.Builder to create a request.

Returns:

Result of the UpdateParameterGroup operation returned by the service.

See Also:

• AWS API Documentation

updateSubnetGroup

default UpdateSubnetGroupResponse updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest)
                                             throws SubnetGroupNotFoundException,
SubnetQuotaExceededException,
SubnetInUseException,
InvalidSubnetException,
ServiceLinkedRoleNotFoundException,
AwsServiceException,
SdkClientException,
DaxException

Modifies an existing subnet group.

Parameters:

updateSubnetGroupRequest -

Returns:

Result of the UpdateSubnetGroup operation returned by the service.

See Also:

• AWS API Documentation

updateSubnetGroup

default UpdateSubnetGroupResponse updateSubnetGroup(Consumer<UpdateSubnetGroupRequest.Builder> updateSubnetGroupRequest)
                                             throws SubnetGroupNotFoundException,
SubnetQuotaExceededException,
SubnetInUseException,
InvalidSubnetException,
ServiceLinkedRoleNotFoundException,
AwsServiceException,
SdkClientException,
DaxException

Modifies an existing subnet group.

This is a convenience which creates an instance of the UpdateSubnetGroupRequest.Builder avoiding the need to create one manually via UpdateSubnetGroupRequest.builder()

Parameters:

updateSubnetGroupRequest - A Consumer that will call methods on UpdateSubnetGroupRequest.Builder to create a request.

Returns:

Result of the UpdateSubnetGroup operation returned by the service.

See Also:

• AWS API Documentation

create

static DaxClient create()

Create a DaxClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DaxClientBuilder builder()

Create a builder that can be used to configure and create a DaxClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default DaxServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration