com.amazonaws.services.dax

Interface AmazonDax

All Known Subinterfaces:

AmazonDaxAsync

All Known Implementing Classes:

AbstractAmazonDax, AbstractAmazonDaxAsync, AmazonDaxAsyncClient, AmazonDaxClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDax

Interface for accessing Amazon DAX.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonDax instead.

DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateClusterResult	createCluster(CreateClusterRequest createClusterRequest) Creates a DAX cluster.
CreateParameterGroupResult	createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest) Creates a new parameter group.
CreateSubnetGroupResult	createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest) Creates a new subnet group.
DecreaseReplicationFactorResult	decreaseReplicationFactor(DecreaseReplicationFactorRequest decreaseReplicationFactorRequest) Removes one or more nodes from a DAX cluster.
DeleteClusterResult	deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes a previously provisioned DAX cluster.
DeleteParameterGroupResult	deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest) Deletes the specified parameter group.
DeleteSubnetGroupResult	deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest) Deletes a subnet group.
DescribeClustersResult	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.
DescribeDefaultParametersResult	describeDefaultParameters(DescribeDefaultParametersRequest describeDefaultParametersRequest) Returns the default system parameter information for the DAX caching software.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) Returns events related to DAX clusters and parameter groups.
DescribeParameterGroupsResult	describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest) Returns a list of parameter group descriptions.
DescribeParametersResult	describeParameters(DescribeParametersRequest describeParametersRequest) Returns the detailed parameter list for a particular parameter group.
DescribeSubnetGroupsResult	describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest) 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 increaseReplicationFactorRequest) Adds one or more nodes to a DAX cluster.
ListTagsResult	listTags(ListTagsRequest listTagsRequest) List all of the tags for a DAX cluster.
RebootNodeResult	rebootNode(RebootNodeRequest rebootNodeRequest) 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 tagResourceRequest) Associates a set of tags with a DAX resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the association of tags from a DAX resource.
UpdateClusterResult	updateCluster(UpdateClusterRequest updateClusterRequest) Modifies the settings for a DAX cluster.
UpdateParameterGroupResult	updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest) Modifies the parameters of a parameter group.
UpdateSubnetGroupResult	updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest) Modifies an existing subnet group.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createCluster

CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)

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

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

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

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

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

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

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

ParameterGroupNotFoundException - The specified parameter group does not exist.

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

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

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

InvalidVPCNetworkStateException - The VPC network is in an invalid state.

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

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.

See Also:

AWS API Documentation

createParameterGroup

CreateParameterGroupResult 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:

Result of the CreateParameterGroup operation returned by the service.

Throws:

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

ParameterGroupAlreadyExistsException - The specified parameter group already exists.

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

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.

See Also:

AWS API Documentation

createSubnetGroup

CreateSubnetGroupResult createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest)

Creates a new subnet group.

Parameters:

createSubnetGroupRequest -

Returns:

Result of the CreateSubnetGroup operation returned by the service.

Throws:

SubnetGroupAlreadyExistsException - The specified subnet group already exists.

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

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

InvalidSubnetException - An invalid subnet identifier was specified.

ServiceLinkedRoleNotFoundException - The specified service linked role (SLR) was not found.

See Also:

AWS API Documentation

decreaseReplicationFactor

DecreaseReplicationFactorResult 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:

Result of the DecreaseReplicationFactor operation returned by the service.

Throws:

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

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

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

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.

See Also:

AWS API Documentation

deleteCluster

DeleteClusterResult 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:

Result of the DeleteCluster operation returned by the service.

Throws:

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

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

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.

See Also:

AWS API Documentation

deleteParameterGroup

DeleteParameterGroupResult 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:

Result of the DeleteParameterGroup operation returned by the service.

Throws:

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

ParameterGroupNotFoundException - The specified parameter group does not exist.

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.

See Also:

AWS API Documentation

deleteSubnetGroup

DeleteSubnetGroupResult deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest)

Deletes a subnet group.

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

Parameters:

deleteSubnetGroupRequest -

Returns:

Result of the DeleteSubnetGroup operation returned by the service.

Throws:

SubnetGroupInUseException - The specified subnet group is currently in use.

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

ServiceLinkedRoleNotFoundException - The specified service linked role (SLR) was not found.

See Also:

AWS API Documentation

describeClusters

DescribeClustersResult 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:

Result of the DescribeClusters operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeDefaultParameters

DescribeDefaultParametersResult describeDefaultParameters(DescribeDefaultParametersRequest describeDefaultParametersRequest)

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

Parameters:

describeDefaultParametersRequest -

Returns:

Result of the DescribeDefaultParameters operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeEvents

DescribeEventsResult 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:

Result of the DescribeEvents operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeParameterGroups

DescribeParameterGroupsResult 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:

Result of the DescribeParameterGroups operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeParameters

DescribeParametersResult describeParameters(DescribeParametersRequest describeParametersRequest)

Returns the detailed parameter list for a particular parameter group.

Parameters:

describeParametersRequest -

Returns:

Result of the DescribeParameters operation returned by the service.

Throws:

ParameterGroupNotFoundException - The specified parameter group does not exist.

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.

See Also:

AWS API Documentation

describeSubnetGroups

DescribeSubnetGroupsResult 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:

Result of the DescribeSubnetGroups operation returned by the service.

Throws:

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

ServiceLinkedRoleNotFoundException - The specified service linked role (SLR) was not found.

See Also:

AWS API Documentation

increaseReplicationFactor

IncreaseReplicationFactorResult increaseReplicationFactor(IncreaseReplicationFactorRequest increaseReplicationFactorRequest)

Adds one or more nodes to a DAX cluster.

Parameters:

increaseReplicationFactorRequest -

Returns:

Result of the IncreaseReplicationFactor operation returned by the service.

Throws:

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

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

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

InvalidVPCNetworkStateException - The VPC network is in an invalid state.

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

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

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.

See Also:

AWS API Documentation

listTags

ListTagsResult 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:

Result of the ListTags operation returned by the service.

Throws:

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

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

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

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.

See Also:

AWS API Documentation

rebootNode

RebootNodeResult 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:

Result of the RebootNode operation returned by the service.

Throws:

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

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

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

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult 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:

Result of the TagResource operation returned by the service.

Throws:

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

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

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

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

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult 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:

Result of the UntagResource operation returned by the service.

Throws:

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

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

TagNotFoundException - The tag does not exist.

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

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.

See Also:

AWS API Documentation

updateCluster

UpdateClusterResult 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:

Result of the UpdateCluster operation returned by the service.

Throws:

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

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

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

ParameterGroupNotFoundException - The specified parameter group does not exist.

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.

See Also:

AWS API Documentation

updateParameterGroup

UpdateParameterGroupResult 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:

Result of the UpdateParameterGroup operation returned by the service.

Throws:

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

ParameterGroupNotFoundException - The specified parameter group does not exist.

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.

See Also:

AWS API Documentation

updateSubnetGroup

UpdateSubnetGroupResult updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest)

Modifies an existing subnet group.

Parameters:

updateSubnetGroupRequest -

Returns:

Result of the UpdateSubnetGroup operation returned by the service.

Throws:

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

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

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

InvalidSubnetException - An invalid subnet identifier was specified.

ServiceLinkedRoleNotFoundException - The specified service linked role (SLR) was not found.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.