Interface DaxClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic DaxClientBuilder
builder()
Create a builder that can be used to configure and create aDaxClient
.static DaxClient
create()
Create aDaxClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateClusterResponse
createCluster
(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates a DAX cluster.default CreateClusterResponse
createCluster
(CreateClusterRequest createClusterRequest) Creates a DAX cluster.default CreateParameterGroupResponse
createParameterGroup
(Consumer<CreateParameterGroupRequest.Builder> createParameterGroupRequest) Creates a new parameter group.default CreateParameterGroupResponse
createParameterGroup
(CreateParameterGroupRequest createParameterGroupRequest) Creates a new parameter group.default CreateSubnetGroupResponse
createSubnetGroup
(Consumer<CreateSubnetGroupRequest.Builder> createSubnetGroupRequest) Creates a new subnet group.default CreateSubnetGroupResponse
createSubnetGroup
(CreateSubnetGroupRequest createSubnetGroupRequest) Creates a new subnet group.decreaseReplicationFactor
(Consumer<DecreaseReplicationFactorRequest.Builder> decreaseReplicationFactorRequest) Removes one or more nodes from a DAX cluster.decreaseReplicationFactor
(DecreaseReplicationFactorRequest decreaseReplicationFactorRequest) Removes one or more nodes from a DAX cluster.default DeleteClusterResponse
deleteCluster
(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes a previously provisioned DAX cluster.default DeleteClusterResponse
deleteCluster
(DeleteClusterRequest deleteClusterRequest) Deletes a previously provisioned DAX cluster.default DeleteParameterGroupResponse
deleteParameterGroup
(Consumer<DeleteParameterGroupRequest.Builder> deleteParameterGroupRequest) Deletes the specified parameter group.default DeleteParameterGroupResponse
deleteParameterGroup
(DeleteParameterGroupRequest deleteParameterGroupRequest) Deletes the specified parameter group.default DeleteSubnetGroupResponse
deleteSubnetGroup
(Consumer<DeleteSubnetGroupRequest.Builder> deleteSubnetGroupRequest) Deletes a subnet group.default DeleteSubnetGroupResponse
deleteSubnetGroup
(DeleteSubnetGroupRequest deleteSubnetGroupRequest) Deletes a subnet group.default DescribeClustersResponse
Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.default DescribeClustersResponse
describeClusters
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.default DescribeClustersResponse
describeClusters
(DescribeClustersRequest describeClustersRequest) Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.Returns the default system parameter information for the DAX caching software.describeDefaultParameters
(Consumer<DescribeDefaultParametersRequest.Builder> describeDefaultParametersRequest) Returns the default system parameter information for the DAX caching software.describeDefaultParameters
(DescribeDefaultParametersRequest describeDefaultParametersRequest) Returns the default system parameter information for the DAX caching software.default DescribeEventsResponse
Returns events related to DAX clusters and parameter groups.default DescribeEventsResponse
describeEvents
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns events related to DAX clusters and parameter groups.default DescribeEventsResponse
describeEvents
(DescribeEventsRequest describeEventsRequest) Returns events related to DAX clusters and parameter groups.default DescribeParameterGroupsResponse
Returns a list of parameter group descriptions.default DescribeParameterGroupsResponse
describeParameterGroups
(Consumer<DescribeParameterGroupsRequest.Builder> describeParameterGroupsRequest) Returns a list of parameter group descriptions.default DescribeParameterGroupsResponse
describeParameterGroups
(DescribeParameterGroupsRequest describeParameterGroupsRequest) Returns a list of parameter group descriptions.default DescribeParametersResponse
describeParameters
(Consumer<DescribeParametersRequest.Builder> describeParametersRequest) Returns the detailed parameter list for a particular parameter group.default DescribeParametersResponse
describeParameters
(DescribeParametersRequest describeParametersRequest) Returns the detailed parameter list for a particular parameter group.default DescribeSubnetGroupsResponse
Returns a list of subnet group descriptions.default DescribeSubnetGroupsResponse
describeSubnetGroups
(Consumer<DescribeSubnetGroupsRequest.Builder> describeSubnetGroupsRequest) Returns a list of subnet group descriptions.default DescribeSubnetGroupsResponse
describeSubnetGroups
(DescribeSubnetGroupsRequest describeSubnetGroupsRequest) Returns a list of subnet group descriptions.increaseReplicationFactor
(Consumer<IncreaseReplicationFactorRequest.Builder> increaseReplicationFactorRequest) Adds one or more nodes to a DAX cluster.increaseReplicationFactor
(IncreaseReplicationFactorRequest increaseReplicationFactorRequest) Adds one or more nodes to a DAX cluster.default ListTagsResponse
listTags
(Consumer<ListTagsRequest.Builder> listTagsRequest) List all of the tags for a DAX cluster.default ListTagsResponse
listTags
(ListTagsRequest listTagsRequest) List all of the tags for a DAX cluster.default RebootNodeResponse
rebootNode
(Consumer<RebootNodeRequest.Builder> rebootNodeRequest) Reboots a single node of a DAX cluster.default RebootNodeResponse
rebootNode
(RebootNodeRequest rebootNodeRequest) Reboots a single node of a DAX cluster.default DaxServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates a set of tags with a DAX resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Associates a set of tags with a DAX resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the association of tags from a DAX resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the association of tags from a DAX resource.default UpdateClusterResponse
updateCluster
(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) Modifies the settings for a DAX cluster.default UpdateClusterResponse
updateCluster
(UpdateClusterRequest updateClusterRequest) Modifies the settings for a DAX cluster.default UpdateParameterGroupResponse
updateParameterGroup
(Consumer<UpdateParameterGroupRequest.Builder> updateParameterGroupRequest) Modifies the parameters of a parameter group.default UpdateParameterGroupResponse
updateParameterGroup
(UpdateParameterGroupRequest updateParameterGroupRequest) Modifies the parameters of a parameter group.default UpdateSubnetGroupResponse
updateSubnetGroup
(Consumer<UpdateSubnetGroupRequest.Builder> updateSubnetGroupRequest) Modifies an existing subnet group.default UpdateSubnetGroupResponse
updateSubnetGroup
(UpdateSubnetGroupRequest updateSubnetGroupRequest) Modifies an existing subnet group.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createCluster
default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws ClusterAlreadyExistsException, InvalidClusterStateException, InsufficientClusterCapacityException, SubnetGroupNotFoundException, InvalidParameterGroupStateException, ParameterGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, DaxException Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
- Parameters:
createClusterRequest
-- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createCluster
default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws ClusterAlreadyExistsException, InvalidClusterStateException, InsufficientClusterCapacityException, SubnetGroupNotFoundException, InvalidParameterGroupStateException, ParameterGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, DaxException Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
This is a convenience which creates an instance of the
CreateClusterRequest.Builder
avoiding the need to create one manually viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createParameterGroup
default CreateParameterGroupResponse createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest) throws ParameterGroupQuotaExceededException, ParameterGroupAlreadyExistsException, InvalidParameterGroupStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.
- Parameters:
createParameterGroupRequest
-- Returns:
- Result of the CreateParameterGroup operation returned by the service.
- See Also:
-
createParameterGroup
default CreateParameterGroupResponse createParameterGroup(Consumer<CreateParameterGroupRequest.Builder> createParameterGroupRequest) throws ParameterGroupQuotaExceededException, ParameterGroupAlreadyExistsException, InvalidParameterGroupStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.
This is a convenience which creates an instance of the
CreateParameterGroupRequest.Builder
avoiding the need to create one manually viaCreateParameterGroupRequest.builder()
- Parameters:
createParameterGroupRequest
- AConsumer
that will call methods onCreateParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateParameterGroup operation returned by the service.
- See Also:
-
createSubnetGroup
default CreateSubnetGroupResponse createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest) throws SubnetGroupAlreadyExistsException, SubnetGroupQuotaExceededException, SubnetQuotaExceededException, InvalidSubnetException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, DaxException Creates a new subnet group.
- Parameters:
createSubnetGroupRequest
-- Returns:
- Result of the CreateSubnetGroup operation returned by the service.
- See Also:
-
createSubnetGroup
default CreateSubnetGroupResponse createSubnetGroup(Consumer<CreateSubnetGroupRequest.Builder> createSubnetGroupRequest) throws SubnetGroupAlreadyExistsException, SubnetGroupQuotaExceededException, SubnetQuotaExceededException, InvalidSubnetException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, DaxException Creates a new subnet group.
This is a convenience which creates an instance of the
CreateSubnetGroupRequest.Builder
avoiding the need to create one manually viaCreateSubnetGroupRequest.builder()
- Parameters:
createSubnetGroupRequest
- AConsumer
that will call methods onCreateSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateSubnetGroup operation returned by the service.
- See Also:
-
decreaseReplicationFactor
default DecreaseReplicationFactorResponse decreaseReplicationFactor(DecreaseReplicationFactorRequest decreaseReplicationFactorRequest) throws ClusterNotFoundException, NodeNotFoundException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Removes one or more nodes from a DAX cluster.
You cannot use
DecreaseReplicationFactor
to remove the last node in a DAX cluster. If you need to do this, useDeleteCluster
instead.- Parameters:
decreaseReplicationFactorRequest
-- Returns:
- Result of the DecreaseReplicationFactor operation returned by the service.
- See Also:
-
decreaseReplicationFactor
default DecreaseReplicationFactorResponse decreaseReplicationFactor(Consumer<DecreaseReplicationFactorRequest.Builder> decreaseReplicationFactorRequest) throws ClusterNotFoundException, NodeNotFoundException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Removes one or more nodes from a DAX cluster.
You cannot use
DecreaseReplicationFactor
to remove the last node in a DAX cluster. If you need to do this, useDeleteCluster
instead.
This is a convenience which creates an instance of the
DecreaseReplicationFactorRequest.Builder
avoiding the need to create one manually viaDecreaseReplicationFactorRequest.builder()
- Parameters:
decreaseReplicationFactorRequest
- AConsumer
that will call methods onDecreaseReplicationFactorRequest.Builder
to create a request.- Returns:
- Result of the DecreaseReplicationFactor operation returned by the service.
- See Also:
-
deleteCluster
default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.
- Parameters:
deleteClusterRequest
-- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteCluster
default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws ClusterNotFoundException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.
This is a convenience which creates an instance of the
DeleteClusterRequest.Builder
avoiding the need to create one manually viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.Builder
to create a request.- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteParameterGroup
default DeleteParameterGroupResponse deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest) throws InvalidParameterGroupStateException, ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
- Parameters:
deleteParameterGroupRequest
-- Returns:
- Result of the DeleteParameterGroup operation returned by the service.
- See Also:
-
deleteParameterGroup
default DeleteParameterGroupResponse deleteParameterGroup(Consumer<DeleteParameterGroupRequest.Builder> deleteParameterGroupRequest) throws InvalidParameterGroupStateException, ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
This is a convenience which creates an instance of the
DeleteParameterGroupRequest.Builder
avoiding the need to create one manually viaDeleteParameterGroupRequest.builder()
- Parameters:
deleteParameterGroupRequest
- AConsumer
that will call methods onDeleteParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteParameterGroup operation returned by the service.
- See Also:
-
deleteSubnetGroup
default DeleteSubnetGroupResponse deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest) throws SubnetGroupInUseException, SubnetGroupNotFoundException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, DaxException Deletes a subnet group.
You cannot delete a subnet group if it is associated with any DAX clusters.
- Parameters:
deleteSubnetGroupRequest
-- Returns:
- Result of the DeleteSubnetGroup operation returned by the service.
- See Also:
-
deleteSubnetGroup
default DeleteSubnetGroupResponse deleteSubnetGroup(Consumer<DeleteSubnetGroupRequest.Builder> deleteSubnetGroupRequest) throws SubnetGroupInUseException, SubnetGroupNotFoundException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, DaxException Deletes a subnet group.
You cannot delete a subnet group if it is associated with any DAX clusters.
This is a convenience which creates an instance of the
DeleteSubnetGroupRequest.Builder
avoiding the need to create one manually viaDeleteSubnetGroupRequest.builder()
- Parameters:
deleteSubnetGroupRequest
- AConsumer
that will call methods onDeleteSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteSubnetGroup operation returned by the service.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest) throws ClusterNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.
If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use.
If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.
- Parameters:
describeClustersRequest
-- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws ClusterNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.
If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use.
If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters() throws ClusterNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxExceptionReturns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.
If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use.
If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.
- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeDefaultParameters
default DescribeDefaultParametersResponse describeDefaultParameters(DescribeDefaultParametersRequest describeDefaultParametersRequest) throws ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns the default system parameter information for the DAX caching software.
- Parameters:
describeDefaultParametersRequest
-- Returns:
- Result of the DescribeDefaultParameters operation returned by the service.
- See Also:
-
describeDefaultParameters
default DescribeDefaultParametersResponse describeDefaultParameters(Consumer<DescribeDefaultParametersRequest.Builder> describeDefaultParametersRequest) throws ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns the default system parameter information for the DAX caching software.
This is a convenience which creates an instance of the
DescribeDefaultParametersRequest.Builder
avoiding the need to create one manually viaDescribeDefaultParametersRequest.builder()
- Parameters:
describeDefaultParametersRequest
- AConsumer
that will call methods onDescribeDefaultParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeDefaultParameters operation returned by the service.
- See Also:
-
describeDefaultParameters
default DescribeDefaultParametersResponse describeDefaultParameters() throws ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxExceptionReturns the default system parameter information for the DAX caching software.
- Returns:
- Result of the DescribeDefaultParameters operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.
By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.
- Parameters:
describeEventsRequest
-- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.
By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents() throws ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxExceptionReturns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.
By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.
- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeParameterGroups
default DescribeParameterGroupsResponse describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest) throws ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
- Parameters:
describeParameterGroupsRequest
-- Returns:
- Result of the DescribeParameterGroups operation returned by the service.
- See Also:
-
describeParameterGroups
default DescribeParameterGroupsResponse describeParameterGroups(Consumer<DescribeParameterGroupsRequest.Builder> describeParameterGroupsRequest) throws ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
This is a convenience which creates an instance of the
DescribeParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeParameterGroupsRequest.builder()
- Parameters:
describeParameterGroupsRequest
- AConsumer
that will call methods onDescribeParameterGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeParameterGroups operation returned by the service.
- See Also:
-
describeParameterGroups
default DescribeParameterGroupsResponse describeParameterGroups() throws ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxExceptionReturns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
- Returns:
- Result of the DescribeParameterGroups operation returned by the service.
- See Also:
-
describeParameters
default DescribeParametersResponse describeParameters(DescribeParametersRequest describeParametersRequest) throws ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns the detailed parameter list for a particular parameter group.
- Parameters:
describeParametersRequest
-- Returns:
- Result of the DescribeParameters operation returned by the service.
- See Also:
-
describeParameters
default DescribeParametersResponse describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest) throws ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Returns the detailed parameter list for a particular parameter group.
This is a convenience which creates an instance of the
DescribeParametersRequest.Builder
avoiding the need to create one manually viaDescribeParametersRequest.builder()
- Parameters:
describeParametersRequest
- AConsumer
that will call methods onDescribeParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeParameters operation returned by the service.
- See Also:
-
describeSubnetGroups
default DescribeSubnetGroupsResponse describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest) throws SubnetGroupNotFoundException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, DaxException Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
- Parameters:
describeSubnetGroupsRequest
-- Returns:
- Result of the DescribeSubnetGroups operation returned by the service.
- See Also:
-
describeSubnetGroups
default DescribeSubnetGroupsResponse describeSubnetGroups(Consumer<DescribeSubnetGroupsRequest.Builder> describeSubnetGroupsRequest) throws SubnetGroupNotFoundException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, DaxException Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
This is a convenience which creates an instance of the
DescribeSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeSubnetGroupsRequest.builder()
- Parameters:
describeSubnetGroupsRequest
- AConsumer
that will call methods onDescribeSubnetGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeSubnetGroups operation returned by the service.
- See Also:
-
describeSubnetGroups
default DescribeSubnetGroupsResponse describeSubnetGroups() throws SubnetGroupNotFoundException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, DaxExceptionReturns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
- Returns:
- Result of the DescribeSubnetGroups operation returned by the service.
- See Also:
-
increaseReplicationFactor
default IncreaseReplicationFactorResponse increaseReplicationFactor(IncreaseReplicationFactorRequest increaseReplicationFactorRequest) throws ClusterNotFoundException, InvalidClusterStateException, InsufficientClusterCapacityException, InvalidVpcNetworkStateException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Adds one or more nodes to a DAX cluster.
- Parameters:
increaseReplicationFactorRequest
-- Returns:
- Result of the IncreaseReplicationFactor operation returned by the service.
- See Also:
-
increaseReplicationFactor
default IncreaseReplicationFactorResponse increaseReplicationFactor(Consumer<IncreaseReplicationFactorRequest.Builder> increaseReplicationFactorRequest) throws ClusterNotFoundException, InvalidClusterStateException, InsufficientClusterCapacityException, InvalidVpcNetworkStateException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Adds one or more nodes to a DAX cluster.
This is a convenience which creates an instance of the
IncreaseReplicationFactorRequest.Builder
avoiding the need to create one manually viaIncreaseReplicationFactorRequest.builder()
- Parameters:
increaseReplicationFactorRequest
- AConsumer
that will call methods onIncreaseReplicationFactorRequest.Builder
to create a request.- Returns:
- Result of the IncreaseReplicationFactor operation returned by the service.
- See Also:
-
listTags
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws ClusterNotFoundException, InvalidArnException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException List all of the tags for a DAX cluster. You can call
ListTags
up to 10 times per second, per account.- Parameters:
listTagsRequest
-- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
listTags
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ClusterNotFoundException, InvalidArnException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException List all of the tags for a DAX cluster. You can call
ListTags
up to 10 times per second, per account.
This is a convenience which creates an instance of the
ListTagsRequest.Builder
avoiding the need to create one manually viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
rebootNode
default RebootNodeResponse rebootNode(RebootNodeRequest rebootNodeRequest) throws ClusterNotFoundException, NodeNotFoundException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.
RebootNode
restarts the DAX engine process and does not remove the contents of the cache.- Parameters:
rebootNodeRequest
-- Returns:
- Result of the RebootNode operation returned by the service.
- See Also:
-
rebootNode
default RebootNodeResponse rebootNode(Consumer<RebootNodeRequest.Builder> rebootNodeRequest) throws ClusterNotFoundException, NodeNotFoundException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.
RebootNode
restarts the DAX engine process and does not remove the contents of the cache.
This is a convenience which creates an instance of the
RebootNodeRequest.Builder
avoiding the need to create one manually viaRebootNodeRequest.builder()
- Parameters:
rebootNodeRequest
- AConsumer
that will call methods onRebootNodeRequest.Builder
to create a request.- Returns:
- Result of the RebootNode operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ClusterNotFoundException, TagQuotaPerResourceExceededException, InvalidArnException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Associates a set of tags with a DAX resource. You can call
TagResource
up to 5 times per second, per account.- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ClusterNotFoundException, TagQuotaPerResourceExceededException, InvalidArnException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Associates a set of tags with a DAX resource. You can call
TagResource
up to 5 times per second, per account.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ClusterNotFoundException, InvalidArnException, TagNotFoundException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Removes the association of tags from a DAX resource. You can call
UntagResource
up to 5 times per second, per account.- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ClusterNotFoundException, InvalidArnException, TagNotFoundException, InvalidClusterStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Removes the association of tags from a DAX resource. You can call
UntagResource
up to 5 times per second, per account.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateCluster
default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest) throws InvalidClusterStateException, ClusterNotFoundException, InvalidParameterGroupStateException, ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.
- Parameters:
updateClusterRequest
-- Returns:
- Result of the UpdateCluster operation returned by the service.
- See Also:
-
updateCluster
default UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) throws InvalidClusterStateException, ClusterNotFoundException, InvalidParameterGroupStateException, ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.
This is a convenience which creates an instance of the
UpdateClusterRequest.Builder
avoiding the need to create one manually viaUpdateClusterRequest.builder()
- Parameters:
updateClusterRequest
- AConsumer
that will call methods onUpdateClusterRequest.Builder
to create a request.- Returns:
- Result of the UpdateCluster operation returned by the service.
- See Also:
-
updateParameterGroup
default UpdateParameterGroupResponse updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest) throws InvalidParameterGroupStateException, ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
- Parameters:
updateParameterGroupRequest
-- Returns:
- Result of the UpdateParameterGroup operation returned by the service.
- See Also:
-
updateParameterGroup
default UpdateParameterGroupResponse updateParameterGroup(Consumer<UpdateParameterGroupRequest.Builder> updateParameterGroupRequest) throws InvalidParameterGroupStateException, ParameterGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, DaxException Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
This is a convenience which creates an instance of the
UpdateParameterGroupRequest.Builder
avoiding the need to create one manually viaUpdateParameterGroupRequest.builder()
- Parameters:
updateParameterGroupRequest
- AConsumer
that will call methods onUpdateParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateParameterGroup operation returned by the service.
- See Also:
-
updateSubnetGroup
default UpdateSubnetGroupResponse updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest) throws SubnetGroupNotFoundException, SubnetQuotaExceededException, SubnetInUseException, InvalidSubnetException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, DaxException Modifies an existing subnet group.
- Parameters:
updateSubnetGroupRequest
-- Returns:
- Result of the UpdateSubnetGroup operation returned by the service.
- See Also:
-
updateSubnetGroup
default UpdateSubnetGroupResponse updateSubnetGroup(Consumer<UpdateSubnetGroupRequest.Builder> updateSubnetGroupRequest) throws SubnetGroupNotFoundException, SubnetQuotaExceededException, SubnetInUseException, InvalidSubnetException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, DaxException Modifies an existing subnet group.
This is a convenience which creates an instance of the
UpdateSubnetGroupRequest.Builder
avoiding the need to create one manually viaUpdateSubnetGroupRequest.builder()
- Parameters:
updateSubnetGroupRequest
- AConsumer
that will call methods onUpdateSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateSubnetGroup operation returned by the service.
- See Also:
-
create
Create aDaxClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aDaxClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-