AbstractAmazonDax (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dax.AbstractAmazonDax

All Implemented Interfaces:

AmazonDax

Direct Known Subclasses:

AbstractAmazonDaxAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonDax
extends Object
implements AmazonDax
```
Abstract implementation of AmazonDax. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.dax.AmazonDax
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateClusterResult`	`createCluster(CreateClusterRequest request)` Creates a DAX cluster.
`CreateParameterGroupResult`	`createParameterGroup(CreateParameterGroupRequest request)` Creates a new parameter group.
`CreateSubnetGroupResult`	`createSubnetGroup(CreateSubnetGroupRequest request)` Creates a new subnet group.
`DecreaseReplicationFactorResult`	`decreaseReplicationFactor(DecreaseReplicationFactorRequest request)` Removes one or more nodes from a DAX cluster.
`DeleteClusterResult`	`deleteCluster(DeleteClusterRequest request)` Deletes a previously provisioned DAX cluster.
`DeleteParameterGroupResult`	`deleteParameterGroup(DeleteParameterGroupRequest request)` Deletes the specified parameter group.
`DeleteSubnetGroupResult`	`deleteSubnetGroup(DeleteSubnetGroupRequest request)` Deletes a subnet group.
`DescribeClustersResult`	`describeClusters(DescribeClustersRequest request)` 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.
`DescribeDefaultParametersResult`	`describeDefaultParameters(DescribeDefaultParametersRequest request)` Returns the default system parameter information for the DAX caching software.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest request)` Returns events related to DAX clusters and parameter groups.
`DescribeParameterGroupsResult`	`describeParameterGroups(DescribeParameterGroupsRequest request)` Returns a list of parameter group descriptions.
`DescribeParametersResult`	`describeParameters(DescribeParametersRequest request)` Returns the detailed parameter list for a particular parameter group.
`DescribeSubnetGroupsResult`	`describeSubnetGroups(DescribeSubnetGroupsRequest request)` Returns a list of subnet group descriptions.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`IncreaseReplicationFactorResult`	`increaseReplicationFactor(IncreaseReplicationFactorRequest request)` Adds one or more nodes to a DAX cluster.
`ListTagsResult`	`listTags(ListTagsRequest request)` List all of the tags for a DAX cluster.
`RebootNodeResult`	`rebootNode(RebootNodeRequest request)` Reboots a single node of a DAX cluster.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Associates a set of tags with a DAX resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the association of tags from a DAX resource.
`UpdateClusterResult`	`updateCluster(UpdateClusterRequest request)` Modifies the settings for a DAX cluster.
`UpdateParameterGroupResult`	`updateParameterGroup(UpdateParameterGroupRequest request)` Modifies the parameters of a parameter group.
`UpdateSubnetGroupResult`	`updateSubnetGroup(UpdateSubnetGroupRequest request)` Modifies an existing subnet group.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createCluster
```
public CreateClusterResult createCluster(CreateClusterRequest request)
```
    Description copied from interface: AmazonDax
    
    Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
    
    Specified by:
    
    createCluster in interface AmazonDax
    
    Returns:
    
    Result of the CreateCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createParameterGroup
```
public CreateParameterGroupResult createParameterGroup(CreateParameterGroupRequest request)
```
    Description copied from interface: AmazonDax
    
    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.
    
    Specified by:
    
    createParameterGroup in interface AmazonDax
    
    Returns:
    
    Result of the CreateParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSubnetGroup
```
public CreateSubnetGroupResult createSubnetGroup(CreateSubnetGroupRequest request)
```
    Description copied from interface: AmazonDax
    
    Creates a new subnet group.
    
    Specified by:
    
    createSubnetGroup in interface AmazonDax
    
    Returns:
    
    Result of the CreateSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - decreaseReplicationFactor
```
public DecreaseReplicationFactorResult decreaseReplicationFactor(DecreaseReplicationFactorRequest request)
```
    Description copied from interface: AmazonDax
    
    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.
    
    Specified by:
    
    decreaseReplicationFactor in interface AmazonDax
    
    Returns:
    
    Result of the DecreaseReplicationFactor operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCluster
```
public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
```
    Description copied from interface: AmazonDax
    
    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.
    
    Specified by:
    
    deleteCluster in interface AmazonDax
    
    Returns:
    
    Result of the DeleteCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteParameterGroup
```
public DeleteParameterGroupResult deleteParameterGroup(DeleteParameterGroupRequest request)
```
    Description copied from interface: AmazonDax
    
    Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
    
    Specified by:
    
    deleteParameterGroup in interface AmazonDax
    
    Returns:
    
    Result of the DeleteParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSubnetGroup
```
public DeleteSubnetGroupResult deleteSubnetGroup(DeleteSubnetGroupRequest request)
```
    Description copied from interface: AmazonDax
    
    Deletes a subnet group.
    
    You cannot delete a subnet group if it is associated with any DAX clusters.
    
    Specified by:
    
    deleteSubnetGroup in interface AmazonDax
    
    Returns:
    
    Result of the DeleteSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeClusters
```
public DescribeClustersResult describeClusters(DescribeClustersRequest request)
```
    Description copied from interface: AmazonDax
    
    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.
    
    Specified by:
    
    describeClusters in interface AmazonDax
    
    Returns:
    
    Result of the DescribeClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDefaultParameters
```
public DescribeDefaultParametersResult describeDefaultParameters(DescribeDefaultParametersRequest request)
```
    Description copied from interface: AmazonDax
    
    Returns the default system parameter information for the DAX caching software.
    
    Specified by:
    
    describeDefaultParameters in interface AmazonDax
    
    Returns:
    
    Result of the DescribeDefaultParameters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
```
    Description copied from interface: AmazonDax
    
    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.
    
    Specified by:
    
    describeEvents in interface AmazonDax
    
    Returns:
    
    Result of the DescribeEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeParameterGroups
```
public DescribeParameterGroupsResult describeParameterGroups(DescribeParameterGroupsRequest request)
```
    Description copied from interface: AmazonDax
    
    Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
    
    Specified by:
    
    describeParameterGroups in interface AmazonDax
    
    Returns:
    
    Result of the DescribeParameterGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeParameters
```
public DescribeParametersResult describeParameters(DescribeParametersRequest request)
```
    Description copied from interface: AmazonDax
    
    Returns the detailed parameter list for a particular parameter group.
    
    Specified by:
    
    describeParameters in interface AmazonDax
    
    Returns:
    
    Result of the DescribeParameters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSubnetGroups
```
public DescribeSubnetGroupsResult describeSubnetGroups(DescribeSubnetGroupsRequest request)
```
    Description copied from interface: AmazonDax
    
    Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
    
    Specified by:
    
    describeSubnetGroups in interface AmazonDax
    
    Returns:
    
    Result of the DescribeSubnetGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - increaseReplicationFactor
```
public IncreaseReplicationFactorResult increaseReplicationFactor(IncreaseReplicationFactorRequest request)
```
    Description copied from interface: AmazonDax
    
    Adds one or more nodes to a DAX cluster.
    
    Specified by:
    
    increaseReplicationFactor in interface AmazonDax
    
    Returns:
    
    Result of the IncreaseReplicationFactor operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Description copied from interface: AmazonDax
    
    List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.
    
    Specified by:
    
    listTags in interface AmazonDax
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rebootNode
```
public RebootNodeResult rebootNode(RebootNodeRequest request)
```
    Description copied from interface: AmazonDax
    
    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.
    
    Specified by:
    
    rebootNode in interface AmazonDax
    
    Returns:
    
    Result of the RebootNode operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonDax
    
    Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.
    
    Specified by:
    
    tagResource in interface AmazonDax
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonDax
    
    Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.
    
    Specified by:
    
    untagResource in interface AmazonDax
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateCluster
```
public UpdateClusterResult updateCluster(UpdateClusterRequest request)
```
    Description copied from interface: AmazonDax
    
    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.
    
    Specified by:
    
    updateCluster in interface AmazonDax
    
    Returns:
    
    Result of the UpdateCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateParameterGroup
```
public UpdateParameterGroupResult updateParameterGroup(UpdateParameterGroupRequest request)
```
    Description copied from interface: AmazonDax
    
    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.
    
    Specified by:
    
    updateParameterGroup in interface AmazonDax
    
    Returns:
    
    Result of the UpdateParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSubnetGroup
```
public UpdateSubnetGroupResult updateSubnetGroup(UpdateSubnetGroupRequest request)
```
    Description copied from interface: AmazonDax
    
    Modifies an existing subnet group.
    
    Specified by:
    
    updateSubnetGroup in interface AmazonDax
    
    Returns:
    
    Result of the UpdateSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonDax
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonDax
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonDax
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonDax
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonDax

Field Summary

Fields inherited from interface com.amazonaws.services.dax.AmazonDax

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createCluster

createParameterGroup

createSubnetGroup

decreaseReplicationFactor

deleteCluster

deleteParameterGroup

deleteSubnetGroup

describeClusters

describeDefaultParameters

describeEvents

describeParameterGroups

describeParameters

describeSubnetGroups

increaseReplicationFactor

listTags

rebootNode

tagResource

untagResource

updateCluster

updateParameterGroup

updateSubnetGroup

shutdown

getCachedResponseMetadata