Package software.amazon.awssdk.services.dax

Interface DaxAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface DaxAsyncClient extends AwsClient
Service client for accessing Amazon DAX asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference 
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)

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

      Parameters:
      createClusterRequest -
      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • ServiceQuotaExceededException You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted clusters.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)

      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:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • ServiceQuotaExceededException You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted clusters.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createParameterGroup

      default CompletableFuture<CreateParameterGroupResponse> createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest)

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

      Parameters:
      createParameterGroupRequest -
      Returns:
      A Java Future containing the result of the CreateParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createParameterGroup

      default CompletableFuture<CreateParameterGroupResponse> createParameterGroup(Consumer<CreateParameterGroupRequest.Builder> createParameterGroupRequest)

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


      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:
      A Java Future containing the result of the CreateParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSubnetGroup

      default CompletableFuture<CreateSubnetGroupResponse> createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest)

      Creates a new subnet group.

      Parameters:
      createSubnetGroupRequest -
      Returns:
      A Java Future containing the result of the CreateSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSubnetGroup

      default CompletableFuture<CreateSubnetGroupResponse> createSubnetGroup(Consumer<CreateSubnetGroupRequest.Builder> createSubnetGroupRequest)

      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:
      A Java Future containing the result of the CreateSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • decreaseReplicationFactor

      default CompletableFuture<DecreaseReplicationFactorResponse> decreaseReplicationFactor(DecreaseReplicationFactorRequest decreaseReplicationFactorRequest)

      Removes one or more nodes from a DAX cluster.

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

      Parameters:
      decreaseReplicationFactorRequest -
      Returns:
      A Java Future containing the result of the DecreaseReplicationFactor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • decreaseReplicationFactor

      default CompletableFuture<DecreaseReplicationFactorResponse> decreaseReplicationFactor(Consumer<DecreaseReplicationFactorRequest.Builder> decreaseReplicationFactorRequest)

      Removes one or more nodes from a DAX cluster.

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


      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:
      A Java Future containing the result of the DecreaseReplicationFactor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)

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

      Parameters:
      deleteClusterRequest -
      Returns:
      A Java Future containing the result of the DeleteCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The requested cluster ID does not refer to an existing DAX cluster.
      • InvalidClusterStateException The requested DAX cluster is not in the available state.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)

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


      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:
      A Java Future containing the result of the DeleteCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The requested cluster ID does not refer to an existing DAX cluster.
      • InvalidClusterStateException The requested DAX cluster is not in the available state.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteParameterGroup

      default CompletableFuture<DeleteParameterGroupResponse> deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest)

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

      Parameters:
      deleteParameterGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterGroupStateException One or more parameters in a parameter group are in an invalid state.
      • ParameterGroupNotFoundException The specified parameter group does not exist.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteParameterGroup

      default CompletableFuture<DeleteParameterGroupResponse> deleteParameterGroup(Consumer<DeleteParameterGroupRequest.Builder> deleteParameterGroupRequest)

      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:
      A Java Future containing the result of the DeleteParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterGroupStateException One or more parameters in a parameter group are in an invalid state.
      • ParameterGroupNotFoundException The specified parameter group does not exist.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSubnetGroup

      default CompletableFuture<DeleteSubnetGroupResponse> deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest)

      Deletes a subnet group.

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

      Parameters:
      deleteSubnetGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SubnetGroupInUseException The specified subnet group is currently in use.
      • SubnetGroupNotFoundException The requested subnet group name does not refer to an existing subnet group.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSubnetGroup

      default CompletableFuture<DeleteSubnetGroupResponse> deleteSubnetGroup(Consumer<DeleteSubnetGroupRequest.Builder> deleteSubnetGroupRequest)

      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:
      A Java Future containing the result of the DeleteSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SubnetGroupInUseException The specified subnet group is currently in use.
      • SubnetGroupNotFoundException The requested subnet group name does not refer to an existing subnet group.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeClusters

      default CompletableFuture<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.

      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:
      A Java Future containing the result of the DescribeClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The requested cluster ID does not refer to an existing DAX cluster.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeClusters

      default CompletableFuture<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.

      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:
      A Java Future containing the result of the DescribeClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The requested cluster ID does not refer to an existing DAX cluster.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeClusters

      default CompletableFuture<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.

      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:
      A Java Future containing the result of the DescribeClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The requested cluster ID does not refer to an existing DAX cluster.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDefaultParameters

      default CompletableFuture<DescribeDefaultParametersResponse> describeDefaultParameters(DescribeDefaultParametersRequest describeDefaultParametersRequest)

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

      Parameters:
      describeDefaultParametersRequest -
      Returns:
      A Java Future containing the result of the DescribeDefaultParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDefaultParameters

      default CompletableFuture<DescribeDefaultParametersResponse> describeDefaultParameters(Consumer<DescribeDefaultParametersRequest.Builder> describeDefaultParametersRequest)

      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:
      A Java Future containing the result of the DescribeDefaultParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDefaultParameters

      default CompletableFuture<DescribeDefaultParametersResponse> describeDefaultParameters()

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

      Returns:
      A Java Future containing the result of the DescribeDefaultParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest)

      Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.

      By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.

      Parameters:
      describeEventsRequest -
      Returns:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)

      Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.

      By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.


      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:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents()

      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:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParameterGroups

      default CompletableFuture<DescribeParameterGroupsResponse> describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest)

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

      Parameters:
      describeParameterGroupsRequest -
      Returns:
      A Java Future containing the result of the DescribeParameterGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ParameterGroupNotFoundException The specified parameter group does not exist.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParameterGroups

      default CompletableFuture<DescribeParameterGroupsResponse> describeParameterGroups(Consumer<DescribeParameterGroupsRequest.Builder> describeParameterGroupsRequest)

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


      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:
      A Java Future containing the result of the DescribeParameterGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ParameterGroupNotFoundException The specified parameter group does not exist.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParameterGroups

      default CompletableFuture<DescribeParameterGroupsResponse> describeParameterGroups()

      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:
      A Java Future containing the result of the DescribeParameterGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ParameterGroupNotFoundException The specified parameter group does not exist.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParameters

      default CompletableFuture<DescribeParametersResponse> describeParameters(DescribeParametersRequest describeParametersRequest)

      Returns the detailed parameter list for a particular parameter group.

      Parameters:
      describeParametersRequest -
      Returns:
      A Java Future containing the result of the DescribeParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ParameterGroupNotFoundException The specified parameter group does not exist.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeParameters

      default CompletableFuture<DescribeParametersResponse> describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)

      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:
      A Java Future containing the result of the DescribeParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ParameterGroupNotFoundException The specified parameter group does not exist.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSubnetGroups

      default CompletableFuture<DescribeSubnetGroupsResponse> describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest)

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

      Parameters:
      describeSubnetGroupsRequest -
      Returns:
      A Java Future containing the result of the DescribeSubnetGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SubnetGroupNotFoundException The requested subnet group name does not refer to an existing subnet group.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSubnetGroups

      default CompletableFuture<DescribeSubnetGroupsResponse> describeSubnetGroups(Consumer<DescribeSubnetGroupsRequest.Builder> describeSubnetGroupsRequest)

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


      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:
      A Java Future containing the result of the DescribeSubnetGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SubnetGroupNotFoundException The requested subnet group name does not refer to an existing subnet group.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSubnetGroups

      default CompletableFuture<DescribeSubnetGroupsResponse> describeSubnetGroups()

      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:
      A Java Future containing the result of the DescribeSubnetGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SubnetGroupNotFoundException The requested subnet group name does not refer to an existing subnet group.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • increaseReplicationFactor

      default CompletableFuture<IncreaseReplicationFactorResponse> increaseReplicationFactor(IncreaseReplicationFactorRequest increaseReplicationFactorRequest)

      Adds one or more nodes to a DAX cluster.

      Parameters:
      increaseReplicationFactorRequest -
      Returns:
      A Java Future containing the result of the IncreaseReplicationFactor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • increaseReplicationFactor

      default CompletableFuture<IncreaseReplicationFactorResponse> increaseReplicationFactor(Consumer<IncreaseReplicationFactorRequest.Builder> increaseReplicationFactorRequest)

      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:
      A Java Future containing the result of the IncreaseReplicationFactor operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTags

      default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)

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

      Parameters:
      listTagsRequest -
      Returns:
      A Java Future containing the result of the ListTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTags

      default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)

      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:
      A Java Future containing the result of the ListTags operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebootNode

      default CompletableFuture<RebootNodeResponse> rebootNode(RebootNodeRequest rebootNodeRequest)

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

      RebootNode restarts the DAX engine process and does not remove the contents of the cache.

      Parameters:
      rebootNodeRequest -
      Returns:
      A Java Future containing the result of the RebootNode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebootNode

      default CompletableFuture<RebootNodeResponse> rebootNode(Consumer<RebootNodeRequest.Builder> rebootNodeRequest)

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

      RebootNode restarts the DAX engine process and does not remove the contents of the cache.


      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:
      A Java Future containing the result of the RebootNode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

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

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

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

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(UpdateClusterRequest updateClusterRequest)

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

      Parameters:
      updateClusterRequest -
      Returns:
      A Java Future containing the result of the UpdateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)

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


      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:
      A Java Future containing the result of the UpdateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateParameterGroup

      default CompletableFuture<UpdateParameterGroupResponse> updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest)

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

      Parameters:
      updateParameterGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterGroupStateException One or more parameters in a parameter group are in an invalid state.
      • ParameterGroupNotFoundException The specified parameter group does not exist.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateParameterGroup

      default CompletableFuture<UpdateParameterGroupResponse> updateParameterGroup(Consumer<UpdateParameterGroupRequest.Builder> updateParameterGroupRequest)

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


      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:
      A Java Future containing the result of the UpdateParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterGroupStateException One or more parameters in a parameter group are in an invalid state.
      • ParameterGroupNotFoundException The specified parameter group does not exist.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSubnetGroup

      default CompletableFuture<UpdateSubnetGroupResponse> updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest)

      Modifies an existing subnet group.

      Parameters:
      updateSubnetGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSubnetGroup

      default CompletableFuture<UpdateSubnetGroupResponse> updateSubnetGroup(Consumer<UpdateSubnetGroupRequest.Builder> updateSubnetGroupRequest)

      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:
      A Java Future containing the result of the UpdateSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • 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

    • create

      static DaxAsyncClient create()
      Create a DaxAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static DaxAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a DaxAsyncClient.