Package software.amazon.awssdk.services.dax

Interface DAXClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface DAXClient
extends AutoCloseable

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 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(CreateClusterRequest createClusterRequest)	Creates a DAX cluster.
default CreateParameterGroupResponse	createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest)	Creates a new parameter group.
default CreateSubnetGroupResponse	createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest)	Creates a new subnet group.
default DecreaseReplicationFactorResponse	decreaseReplicationFactor(DecreaseReplicationFactorRequest decreaseReplicationFactorRequest)	Removes one or more nodes from a DAX cluster.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest)	Deletes a previously provisioned DAX cluster.
default DeleteParameterGroupResponse	deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest)	Deletes the specified parameter group.
default DeleteSubnetGroupResponse	deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest)	Deletes a subnet group.
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(DescribeDefaultParametersRequest describeDefaultParametersRequest)	Returns the default system parameter information for the DAX caching software.
default DescribeEventsResponse	describeEvents(DescribeEventsRequest describeEventsRequest)	Returns events related to DAX clusters and parameter groups.
default DescribeParameterGroupsResponse	describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest)	Returns a list of parameter group descriptions.
default DescribeParametersResponse	describeParameters(DescribeParametersRequest describeParametersRequest)	Returns the detailed parameter list for a particular parameter group.
default DescribeSubnetGroupsResponse	describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest)	Returns a list of subnet group descriptions.
default IncreaseReplicationFactorResponse	increaseReplicationFactor(IncreaseReplicationFactorRequest increaseReplicationFactorRequest)	Adds one or more nodes to a DAX cluster.
default ListTagsResponse	listTags(ListTagsRequest listTagsRequest)	List all of the tags for a DAX cluster.
default RebootNodeResponse	rebootNode(RebootNodeRequest rebootNodeRequest)	Reboots a single node of a DAX cluster.
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Associates a set of tags with a DAX resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the association of tags from a DAX resource.
default UpdateClusterResponse	updateCluster(UpdateClusterRequest updateClusterRequest)	Modifies the settings for a DAX cluster.
default UpdateParameterGroupResponse	updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest)	Modifies the parameters of a parameter group.
default UpdateSubnetGroupResponse	updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest)	Modifies an existing subnet group.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

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.

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws ClusterAlreadyExistsException,
                                            InvalidClusterStateException,
                                            InsufficientClusterCapacityException,
                                            SubnetGroupNotFoundException,
                                            InvalidParameterGroupStateException,
                                            ParameterGroupNotFoundException,
                                            ClusterQuotaForCustomerExceededException,
                                            NodeQuotaForClusterExceededException,
                                            NodeQuotaForCustomerExceededException,
                                            InvalidVPCNetworkStateException,
                                            TagQuotaPerResourceExceededException,
                                            InvalidParameterValueException,
                                            InvalidParameterCombinationException,
                                            SdkBaseException,
                                            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.

Throws:

ClusterAlreadyExistsException - You already have a DAX cluster with the given identifier.

InvalidClusterStateException - The requested DAX cluster is not in the available state.

InsufficientClusterCapacityException - There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).

SubnetGroupNotFoundException - The requested subnet group name does not refer to an existing subnet group.

InvalidParameterGroupStateException - One or more parameters in a parameter group are in an invalid state.

ParameterGroupNotFoundException - The specified parameter group does not exist.

ClusterQuotaForCustomerExceededException - You have attempted to exceed the maximum number of DAX clusters for your AWS account.

NodeQuotaForClusterExceededException - You have attempted to exceed the maximum number of nodes for a DAX cluster.

NodeQuotaForCustomerExceededException - You have attempted to exceed the maximum number of nodes for your AWS account.

InvalidVPCNetworkStateException - The VPC network is in an invalid state.

TagQuotaPerResourceExceededException - You have exceeded the maximum number of tags for this DAX cluster.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createParameterGroup

default CreateParameterGroupResponse createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest)
                                                   throws ParameterGroupQuotaExceededException,
                                                          ParameterGroupAlreadyExistsException,
                                                          InvalidParameterGroupStateException,
                                                          InvalidParameterValueException,
                                                          InvalidParameterCombinationException,
                                                          SdkBaseException,
                                                          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.

Throws:

ParameterGroupQuotaExceededException - You have attempted to exceed the maximum number of parameter groups.

ParameterGroupAlreadyExistsException - The specified parameter group already exists.

InvalidParameterGroupStateException - One or more parameters in a parameter group are in an invalid state.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createSubnetGroup

default CreateSubnetGroupResponse createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest)
                                             throws SubnetGroupAlreadyExistsException,
                                                    SubnetGroupQuotaExceededException,
                                                    SubnetQuotaExceededException,
                                                    InvalidSubnetException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    DAXException

Creates a new subnet group.

Parameters:

createSubnetGroupRequest -

Returns:

Result of the CreateSubnetGroup operation returned by the service.

Throws:

SubnetGroupAlreadyExistsException - The specified subnet group already exists.

SubnetGroupQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

SubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

InvalidSubnetException - An invalid subnet identifier was specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

decreaseReplicationFactor

default DecreaseReplicationFactorResponse decreaseReplicationFactor(DecreaseReplicationFactorRequest decreaseReplicationFactorRequest)
                                                             throws ClusterNotFoundException,
                                                                    NodeNotFoundException,
                                                                    InvalidClusterStateException,
                                                                    InvalidParameterValueException,
                                                                    InvalidParameterCombinationException,
                                                                    SdkBaseException,
                                                                    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.

Throws:

ClusterNotFoundException - The requested cluster ID does not refer to an existing DAX cluster.

NodeNotFoundException - None of the nodes in the cluster have the given node ID.

InvalidClusterStateException - The requested DAX cluster is not in the available state.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws ClusterNotFoundException,
                                            InvalidClusterStateException,
                                            InvalidParameterValueException,
                                            InvalidParameterCombinationException,
                                            SdkBaseException,
                                            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.

Throws:

ClusterNotFoundException - The requested cluster ID does not refer to an existing DAX cluster.

InvalidClusterStateException - The requested DAX cluster is not in the available state.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteParameterGroup

default DeleteParameterGroupResponse deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest)
                                                   throws InvalidParameterGroupStateException,
                                                          ParameterGroupNotFoundException,
                                                          InvalidParameterValueException,
                                                          InvalidParameterCombinationException,
                                                          SdkBaseException,
                                                          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.

Throws:

InvalidParameterGroupStateException - One or more parameters in a parameter group are in an invalid state.

ParameterGroupNotFoundException - The specified parameter group does not exist.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteSubnetGroup

default DeleteSubnetGroupResponse deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest)
                                             throws SubnetGroupInUseException,
                                                    SubnetGroupNotFoundException,
                                                    SdkBaseException,
                                                    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.

Throws:

SubnetGroupInUseException - The specified subnet group is currently in use.

SubnetGroupNotFoundException - The requested subnet group name does not refer to an existing subnet group.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeClusters

default DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest)
                                           throws ClusterNotFoundException,
                                                  InvalidParameterValueException,
                                                  InvalidParameterCombinationException,
                                                  SdkBaseException,
                                                  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.

Throws:

ClusterNotFoundException - The requested cluster ID does not refer to an existing DAX cluster.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeDefaultParameters

default DescribeDefaultParametersResponse describeDefaultParameters(DescribeDefaultParametersRequest describeDefaultParametersRequest)
                                                             throws InvalidParameterValueException,
                                                                    InvalidParameterCombinationException,
                                                                    SdkBaseException,
                                                                    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.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeEvents

default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest)
                                       throws InvalidParameterValueException,
                                              InvalidParameterCombinationException,
                                              SdkBaseException,
                                              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 hour 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.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeParameterGroups

default DescribeParameterGroupsResponse describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest)
                                                         throws ParameterGroupNotFoundException,
                                                                InvalidParameterValueException,
                                                                InvalidParameterCombinationException,
                                                                SdkBaseException,
                                                                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.

Throws:

ParameterGroupNotFoundException - The specified parameter group does not exist.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeParameters

default DescribeParametersResponse describeParameters(DescribeParametersRequest describeParametersRequest)
                                               throws ParameterGroupNotFoundException,
                                                      InvalidParameterValueException,
                                                      InvalidParameterCombinationException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      DAXException

Returns the detailed parameter list for a particular parameter group.

Parameters:

describeParametersRequest -

Returns:

Result of the DescribeParameters operation returned by the service.

Throws:

ParameterGroupNotFoundException - The specified parameter group does not exist.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeSubnetGroups

default DescribeSubnetGroupsResponse describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest)
                                                   throws SubnetGroupNotFoundException,
                                                          SdkBaseException,
                                                          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.

Throws:

SubnetGroupNotFoundException - The requested subnet group name does not refer to an existing subnet group.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

increaseReplicationFactor

default IncreaseReplicationFactorResponse increaseReplicationFactor(IncreaseReplicationFactorRequest increaseReplicationFactorRequest)
                                                             throws ClusterNotFoundException,
                                                                    InvalidClusterStateException,
                                                                    InsufficientClusterCapacityException,
                                                                    InvalidVPCNetworkStateException,
                                                                    NodeQuotaForClusterExceededException,
                                                                    NodeQuotaForCustomerExceededException,
                                                                    InvalidParameterValueException,
                                                                    InvalidParameterCombinationException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    DAXException

Adds one or more nodes to a DAX cluster.

Parameters:

increaseReplicationFactorRequest -

Returns:

Result of the IncreaseReplicationFactor operation returned by the service.

Throws:

ClusterNotFoundException - The requested cluster ID does not refer to an existing DAX cluster.

InvalidClusterStateException - The requested DAX cluster is not in the available state.

InsufficientClusterCapacityException - There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).

InvalidVPCNetworkStateException - The VPC network is in an invalid state.

NodeQuotaForClusterExceededException - You have attempted to exceed the maximum number of nodes for a DAX cluster.

NodeQuotaForCustomerExceededException - You have attempted to exceed the maximum number of nodes for your AWS account.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listTags

default ListTagsResponse listTags(ListTagsRequest listTagsRequest)
                           throws ClusterNotFoundException,
                                  InvalidARNException,
                                  InvalidClusterStateException,
                                  InvalidParameterValueException,
                                  InvalidParameterCombinationException,
                                  SdkBaseException,
                                  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.

Throws:

ClusterNotFoundException - The requested cluster ID does not refer to an existing DAX cluster.

InvalidARNException - The Amazon Resource Name (ARN) supplied in the request is not valid.

InvalidClusterStateException - The requested DAX cluster is not in the available state.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

rebootNode

default RebootNodeResponse rebootNode(RebootNodeRequest rebootNodeRequest)
                               throws ClusterNotFoundException,
                                      NodeNotFoundException,
                                      InvalidClusterStateException,
                                      InvalidParameterValueException,
                                      InvalidParameterCombinationException,
                                      SdkBaseException,
                                      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.

Parameters:

rebootNodeRequest -

Returns:

Result of the RebootNode operation returned by the service.

Throws:

ClusterNotFoundException - The requested cluster ID does not refer to an existing DAX cluster.

NodeNotFoundException - None of the nodes in the cluster have the given node ID.

InvalidClusterStateException - The requested DAX cluster is not in the available state.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ClusterNotFoundException,
                                        TagQuotaPerResourceExceededException,
                                        InvalidARNException,
                                        InvalidClusterStateException,
                                        InvalidParameterValueException,
                                        InvalidParameterCombinationException,
                                        SdkBaseException,
                                        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.

Throws:

ClusterNotFoundException - The requested cluster ID does not refer to an existing DAX cluster.

TagQuotaPerResourceExceededException - You have exceeded the maximum number of tags for this DAX cluster.

InvalidARNException - The Amazon Resource Name (ARN) supplied in the request is not valid.

InvalidClusterStateException - The requested DAX cluster is not in the available state.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ClusterNotFoundException,
                                            InvalidARNException,
                                            TagNotFoundException,
                                            InvalidClusterStateException,
                                            InvalidParameterValueException,
                                            InvalidParameterCombinationException,
                                            SdkBaseException,
                                            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.

Throws:

ClusterNotFoundException - The requested cluster ID does not refer to an existing DAX cluster.

InvalidARNException - The Amazon Resource Name (ARN) supplied in the request is not valid.

TagNotFoundException - The tag does not exist.

InvalidClusterStateException - The requested DAX cluster is not in the available state.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateCluster

default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest)
                                     throws InvalidClusterStateException,
                                            ClusterNotFoundException,
                                            InvalidParameterGroupStateException,
                                            ParameterGroupNotFoundException,
                                            InvalidParameterValueException,
                                            InvalidParameterCombinationException,
                                            SdkBaseException,
                                            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.

Throws:

InvalidClusterStateException - The requested DAX cluster is not in the available state.

ClusterNotFoundException - The requested cluster ID does not refer to an existing DAX cluster.

InvalidParameterGroupStateException - One or more parameters in a parameter group are in an invalid state.

ParameterGroupNotFoundException - The specified parameter group does not exist.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateParameterGroup

default UpdateParameterGroupResponse updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest)
                                                   throws InvalidParameterGroupStateException,
                                                          ParameterGroupNotFoundException,
                                                          InvalidParameterValueException,
                                                          InvalidParameterCombinationException,
                                                          SdkBaseException,
                                                          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.

Throws:

InvalidParameterGroupStateException - One or more parameters in a parameter group are in an invalid state.

ParameterGroupNotFoundException - The specified parameter group does not exist.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateSubnetGroup

default UpdateSubnetGroupResponse updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest)
                                             throws SubnetGroupNotFoundException,
                                                    SubnetQuotaExceededException,
                                                    SubnetInUseException,
                                                    InvalidSubnetException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    DAXException

Modifies an existing subnet group.

Parameters:

updateSubnetGroupRequest -

Returns:

Result of the UpdateSubnetGroup operation returned by the service.

Throws:

SubnetGroupNotFoundException - The requested subnet group name does not refer to an existing subnet group.

SubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

SubnetInUseException - The requested subnet is being used by another subnet group.

InvalidSubnetException - An invalid subnet identifier was specified.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

DAXException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()