AmazonMemoryDBClient (AWS Java SDK for Amazon MemoryDB 1.12.610 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.memorydb.AmazonMemoryDBClient

All Implemented Interfaces:

AmazonMemoryDB

Direct Known Subclasses:

AmazonMemoryDBAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonMemoryDBClient
extends AmazonWebServiceClient
implements AmazonMemoryDB
```
Client for accessing Amazon MemoryDB. All service calls made using this client are blocking, and will not return until the service call completes.

MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.memorydb.AmazonMemoryDB
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchUpdateClusterResult`	`batchUpdateCluster(BatchUpdateClusterRequest request)` Apply the service update to a list of clusters supplied.
`static AmazonMemoryDBClientBuilder`	`builder()`
`CopySnapshotResult`	`copySnapshot(CopySnapshotRequest request)` Makes a copy of an existing snapshot.
`CreateACLResult`	`createACL(CreateACLRequest request)` Creates an Access Control List.
`CreateClusterResult`	`createCluster(CreateClusterRequest request)` Creates a cluster.
`CreateParameterGroupResult`	`createParameterGroup(CreateParameterGroupRequest request)` Creates a new MemoryDB parameter group.
`CreateSnapshotResult`	`createSnapshot(CreateSnapshotRequest request)` Creates a copy of an entire cluster at a specific moment in time.
`CreateSubnetGroupResult`	`createSubnetGroup(CreateSubnetGroupRequest request)` Creates a subnet group.
`CreateUserResult`	`createUser(CreateUserRequest request)` Creates a MemoryDB user.
`DeleteACLResult`	`deleteACL(DeleteACLRequest request)` Deletes an Access Control List.
`DeleteClusterResult`	`deleteCluster(DeleteClusterRequest request)` Deletes a cluster.
`DeleteParameterGroupResult`	`deleteParameterGroup(DeleteParameterGroupRequest request)` Deletes the specified parameter group.
`DeleteSnapshotResult`	`deleteSnapshot(DeleteSnapshotRequest request)` Deletes an existing snapshot.
`DeleteSubnetGroupResult`	`deleteSubnetGroup(DeleteSubnetGroupRequest request)` Deletes a subnet group.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Deletes a user.
`DescribeACLsResult`	`describeACLs(DescribeACLsRequest request)` Returns a list of ACLs
`DescribeClustersResult`	`describeClusters(DescribeClustersRequest request)` Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
`DescribeEngineVersionsResult`	`describeEngineVersions(DescribeEngineVersionsRequest request)` Returns a list of the available Redis engine versions.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest request)` Returns events related to clusters, security groups, 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.
`DescribeReservedNodesResult`	`describeReservedNodes(DescribeReservedNodesRequest request)` Returns information about reserved nodes for this account, or about a specified reserved node.
`DescribeReservedNodesOfferingsResult`	`describeReservedNodesOfferings(DescribeReservedNodesOfferingsRequest request)` Lists available reserved node offerings.
`DescribeServiceUpdatesResult`	`describeServiceUpdates(DescribeServiceUpdatesRequest request)` Returns details of the service updates
`DescribeSnapshotsResult`	`describeSnapshots(DescribeSnapshotsRequest request)` Returns information about cluster snapshots.
`DescribeSubnetGroupsResult`	`describeSubnetGroups(DescribeSubnetGroupsRequest request)` Returns a list of subnet group descriptions.
`DescribeUsersResult`	`describeUsers(DescribeUsersRequest request)` Returns a list of users.
`FailoverShardResult`	`failoverShard(FailoverShardRequest request)` Used to failover a shard.
`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.
`ListAllowedNodeTypeUpdatesResult`	`listAllowedNodeTypeUpdates(ListAllowedNodeTypeUpdatesRequest request)` Lists all available node types that you can scale to from your cluster's current node type.
`ListTagsResult`	`listTags(ListTagsRequest request)` Lists all tags currently on a named resource.
`PurchaseReservedNodesOfferingResult`	`purchaseReservedNodesOffering(PurchaseReservedNodesOfferingRequest request)` Allows you to purchase a reserved node offering.
`ResetParameterGroupResult`	`resetParameterGroup(ResetParameterGroupRequest request)` Modifies the parameters of a parameter group to the engine or system default value.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` A tag is a key-value pair where the key and value are case-sensitive.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Use this operation to remove tags on a resource
`UpdateACLResult`	`updateACL(UpdateACLRequest request)` Changes the list of users that belong to the Access Control List.
`UpdateClusterResult`	`updateCluster(UpdateClusterRequest request)` Modifies the settings for a cluster.
`UpdateParameterGroupResult`	`updateParameterGroup(UpdateParameterGroupRequest request)` Updates the parameters of a parameter group.
`UpdateSubnetGroupResult`	`updateSubnetGroup(UpdateSubnetGroupRequest request)` Updates a subnet group.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Changes user password(s) and/or access string.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

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

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AmazonMemoryDBClientBuilder builder()
```
  - batchUpdateCluster
```
public BatchUpdateClusterResult batchUpdateCluster(BatchUpdateClusterRequest request)
```
    Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
    
    Specified by:
    
    batchUpdateCluster in interface AmazonMemoryDB
    
    Parameters:
    
    batchUpdateClusterRequest -
    
    Returns:
    
    Result of the BatchUpdateCluster operation returned by the service.
    
    Throws:
    
    ServiceUpdateNotFoundException
    
    InvalidParameterValueException
    
    See Also:
    
    AWS API Documentation
  - copySnapshot
```
public CopySnapshotResult copySnapshot(CopySnapshotRequest request)
```
    Makes a copy of an existing snapshot.
    
    Specified by:
    
    copySnapshot in interface AmazonMemoryDB
    
    Parameters:
    
    copySnapshotRequest -
    
    Returns:
    
    Result of the CopySnapshot operation returned by the service.
    
    Throws:
    
    SnapshotAlreadyExistsException
    
    SnapshotNotFoundException
    
    SnapshotQuotaExceededException
    
    InvalidSnapshotStateException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    TagQuotaPerResourceExceededException
    
    See Also:
    
    AWS API Documentation
  - createACL
```
public CreateACLResult createACL(CreateACLRequest request)
```
    Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
    
    Specified by:
    
    createACL in interface AmazonMemoryDB
    
    Parameters:
    
    createACLRequest -
    
    Returns:
    
    Result of the CreateACL operation returned by the service.
    
    Throws:
    
    UserNotFoundException
    
    DuplicateUserNameException
    
    ACLAlreadyExistsException
    
    DefaultUserRequiredException
    
    ACLQuotaExceededException
    
    InvalidParameterValueException
    
    TagQuotaPerResourceExceededException
    
    See Also:
    
    AWS API Documentation
  - createCluster
```
public CreateClusterResult createCluster(CreateClusterRequest request)
```
    Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
    
    Specified by:
    
    createCluster in interface AmazonMemoryDB
    
    Parameters:
    
    createClusterRequest -
    
    Returns:
    
    Result of the CreateCluster operation returned by the service.
    
    Throws:
    
    ClusterAlreadyExistsException
    
    SubnetGroupNotFoundException
    
    ClusterQuotaForCustomerExceededException
    
    NodeQuotaForClusterExceededException
    
    NodeQuotaForCustomerExceededException
    
    ParameterGroupNotFoundException
    
    InsufficientClusterCapacityException
    
    InvalidVPCNetworkStateException
    
    ServiceLinkedRoleNotFoundException
    
    ShardsPerClusterQuotaExceededException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    InvalidCredentialsException
    
    TagQuotaPerResourceExceededException
    
    ACLNotFoundException
    
    InvalidACLStateException
    
    See Also:
    
    AWS API Documentation
  - createParameterGroup
```
public CreateParameterGroupResult createParameterGroup(CreateParameterGroupRequest request)
```
    Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.
    
    Specified by:
    
    createParameterGroup in interface AmazonMemoryDB
    
    Parameters:
    
    createParameterGroupRequest -
    
    Returns:
    
    Result of the CreateParameterGroup operation returned by the service.
    
    Throws:
    
    ParameterGroupQuotaExceededException
    
    ParameterGroupAlreadyExistsException
    
    InvalidParameterGroupStateException
    
    ServiceLinkedRoleNotFoundException
    
    TagQuotaPerResourceExceededException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - createSnapshot
```
public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
```
    Creates a copy of an entire cluster at a specific moment in time.
    
    Specified by:
    
    createSnapshot in interface AmazonMemoryDB
    
    Parameters:
    
    createSnapshotRequest -
    
    Returns:
    
    Result of the CreateSnapshot operation returned by the service.
    
    Throws:
    
    SnapshotAlreadyExistsException
    
    ClusterNotFoundException
    
    InvalidClusterStateException
    
    SnapshotQuotaExceededException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterCombinationException
    
    InvalidParameterValueException
    
    TagQuotaPerResourceExceededException
    
    See Also:
    
    AWS API Documentation
  - createSubnetGroup
```
public CreateSubnetGroupResult createSubnetGroup(CreateSubnetGroupRequest request)
```
    Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups.
    
    Specified by:
    
    createSubnetGroup in interface AmazonMemoryDB
    
    Parameters:
    
    createSubnetGroupRequest -
    
    Returns:
    
    Result of the CreateSubnetGroup operation returned by the service.
    
    Throws:
    
    SubnetGroupAlreadyExistsException
    
    SubnetGroupQuotaExceededException
    
    SubnetQuotaExceededException
    
    InvalidSubnetException
    
    ServiceLinkedRoleNotFoundException
    
    SubnetNotAllowedException
    
    TagQuotaPerResourceExceededException
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
    
    Specified by:
    
    createUser in interface AmazonMemoryDB
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    UserAlreadyExistsException
    
    UserQuotaExceededException
    
    DuplicateUserNameException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    TagQuotaPerResourceExceededException
    
    See Also:
    
    AWS API Documentation
  - deleteACL
```
public DeleteACLResult deleteACL(DeleteACLRequest request)
```
    Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).
    
    Specified by:
    
    deleteACL in interface AmazonMemoryDB
    
    Parameters:
    
    deleteACLRequest -
    
    Returns:
    
    Result of the DeleteACL operation returned by the service.
    
    Throws:
    
    ACLNotFoundException
    
    InvalidACLStateException
    
    InvalidParameterValueException
    
    See Also:
    
    AWS API Documentation
  - deleteCluster
```
public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
```
    Deletes a cluster. It also deletes all associated nodes and node endpoints
    
    Specified by:
    
    deleteCluster in interface AmazonMemoryDB
    
    Parameters:
    
    deleteClusterRequest -
    
    Returns:
    
    Result of the DeleteCluster operation returned by the service.
    
    Throws:
    
    ClusterNotFoundException
    
    InvalidClusterStateException
    
    SnapshotAlreadyExistsException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - deleteParameterGroup
```
public DeleteParameterGroupResult deleteParameterGroup(DeleteParameterGroupRequest request)
```
    Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. You cannot delete the default parameter groups in your account.
    
    Specified by:
    
    deleteParameterGroup in interface AmazonMemoryDB
    
    Parameters:
    
    deleteParameterGroupRequest -
    
    Returns:
    
    Result of the DeleteParameterGroup operation returned by the service.
    
    Throws:
    
    InvalidParameterGroupStateException
    
    ParameterGroupNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - deleteSnapshot
```
public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
```
    Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
    
    Specified by:
    
    deleteSnapshot in interface AmazonMemoryDB
    
    Parameters:
    
    deleteSnapshotRequest -
    
    Returns:
    
    Result of the DeleteSnapshot operation returned by the service.
    
    Throws:
    
    SnapshotNotFoundException
    
    InvalidSnapshotStateException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - deleteSubnetGroup
```
public DeleteSubnetGroupResult deleteSubnetGroup(DeleteSubnetGroupRequest request)
```
    Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
    
    Specified by:
    
    deleteSubnetGroup in interface AmazonMemoryDB
    
    Parameters:
    
    deleteSubnetGroupRequest -
    
    Returns:
    
    Result of the DeleteSubnetGroup operation returned by the service.
    
    Throws:
    
    SubnetGroupInUseException
    
    SubnetGroupNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
    
    Specified by:
    
    deleteUser in interface AmazonMemoryDB
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    InvalidUserStateException
    
    UserNotFoundException
    
    InvalidParameterValueException
    
    See Also:
    
    AWS API Documentation
  - describeACLs
```
public DescribeACLsResult describeACLs(DescribeACLsRequest request)
```
    Returns a list of ACLs
    
    Specified by:
    
    describeACLs in interface AmazonMemoryDB
    
    Parameters:
    
    describeACLsRequest -
    
    Returns:
    
    Result of the DescribeACLs operation returned by the service.
    
    Throws:
    
    ACLNotFoundException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeClusters
```
public DescribeClustersResult describeClusters(DescribeClustersRequest request)
```
    Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
    
    Specified by:
    
    describeClusters in interface AmazonMemoryDB
    
    Parameters:
    
    describeClustersRequest -
    
    Returns:
    
    Result of the DescribeClusters operation returned by the service.
    
    Throws:
    
    ClusterNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeEngineVersions
```
public DescribeEngineVersionsResult describeEngineVersions(DescribeEngineVersionsRequest request)
```
    Returns a list of the available Redis engine versions.
    
    Specified by:
    
    describeEngineVersions in interface AmazonMemoryDB
    
    Parameters:
    
    describeEngineVersionsRequest -
    
    Returns:
    
    Result of the DescribeEngineVersions operation returned by the service.
    
    Throws:
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
```
    Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
    
    Specified by:
    
    describeEvents in interface AmazonMemoryDB
    
    Parameters:
    
    describeEventsRequest -
    
    Returns:
    
    Result of the DescribeEvents operation returned by the service.
    
    Throws:
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeParameterGroups
```
public DescribeParameterGroupsResult describeParameterGroups(DescribeParameterGroupsRequest request)
```
    Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
    
    Specified by:
    
    describeParameterGroups in interface AmazonMemoryDB
    
    Parameters:
    
    describeParameterGroupsRequest -
    
    Returns:
    
    Result of the DescribeParameterGroups operation returned by the service.
    
    Throws:
    
    ParameterGroupNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeParameters
```
public DescribeParametersResult describeParameters(DescribeParametersRequest request)
```
    Returns the detailed parameter list for a particular parameter group.
    
    Specified by:
    
    describeParameters in interface AmazonMemoryDB
    
    Parameters:
    
    describeParametersRequest -
    
    Returns:
    
    Result of the DescribeParameters operation returned by the service.
    
    Throws:
    
    ParameterGroupNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeReservedNodes
```
public DescribeReservedNodesResult describeReservedNodes(DescribeReservedNodesRequest request)
```
    Returns information about reserved nodes for this account, or about a specified reserved node.
    
    Specified by:
    
    describeReservedNodes in interface AmazonMemoryDB
    
    Parameters:
    
    describeReservedNodesRequest -
    
    Returns:
    
    Result of the DescribeReservedNodes operation returned by the service.
    
    Throws:
    
    ReservedNodeNotFoundException - The requested node does not exist.
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeReservedNodesOfferings
```
public DescribeReservedNodesOfferingsResult describeReservedNodesOfferings(DescribeReservedNodesOfferingsRequest request)
```
    Lists available reserved node offerings.
    
    Specified by:
    
    describeReservedNodesOfferings in interface AmazonMemoryDB
    
    Parameters:
    
    describeReservedNodesOfferingsRequest -
    
    Returns:
    
    Result of the DescribeReservedNodesOfferings operation returned by the service.
    
    Throws:
    
    ReservedNodesOfferingNotFoundException - The requested node offering does not exist.
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeServiceUpdates
```
public DescribeServiceUpdatesResult describeServiceUpdates(DescribeServiceUpdatesRequest request)
```
    Returns details of the service updates
    
    Specified by:
    
    describeServiceUpdates in interface AmazonMemoryDB
    
    Parameters:
    
    describeServiceUpdatesRequest -
    
    Returns:
    
    Result of the DescribeServiceUpdates operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeSnapshots
```
public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
```
    Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.
    
    Specified by:
    
    describeSnapshots in interface AmazonMemoryDB
    
    Parameters:
    
    describeSnapshotsRequest -
    
    Returns:
    
    Result of the DescribeSnapshots operation returned by the service.
    
    Throws:
    
    SnapshotNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - describeSubnetGroups
```
public DescribeSubnetGroupsResult describeSubnetGroups(DescribeSubnetGroupsRequest request)
```
    Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
    
    Specified by:
    
    describeSubnetGroups in interface AmazonMemoryDB
    
    Parameters:
    
    describeSubnetGroupsRequest -
    
    Returns:
    
    Result of the DescribeSubnetGroups operation returned by the service.
    
    Throws:
    
    SubnetGroupNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    See Also:
    
    AWS API Documentation
  - describeUsers
```
public DescribeUsersResult describeUsers(DescribeUsersRequest request)
```
    Returns a list of users.
    
    Specified by:
    
    describeUsers in interface AmazonMemoryDB
    
    Parameters:
    
    describeUsersRequest -
    
    Returns:
    
    Result of the DescribeUsers operation returned by the service.
    
    Throws:
    
    UserNotFoundException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - failoverShard
```
public FailoverShardResult failoverShard(FailoverShardRequest request)
```
    Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large scale operational events, Amazon may block this API.
    
    Specified by:
    
    failoverShard in interface AmazonMemoryDB
    
    Parameters:
    
    failoverShardRequest -
    
    Returns:
    
    Result of the FailoverShard operation returned by the service.
    
    Throws:
    
    APICallRateForCustomerExceededException
    
    InvalidClusterStateException
    
    ShardNotFoundException
    
    ClusterNotFoundException
    
    TestFailoverNotAvailableException
    
    InvalidKMSKeyException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - listAllowedNodeTypeUpdates
```
public ListAllowedNodeTypeUpdatesResult listAllowedNodeTypeUpdates(ListAllowedNodeTypeUpdatesRequest request)
```
    Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.
    
    Specified by:
    
    listAllowedNodeTypeUpdates in interface AmazonMemoryDB
    
    Parameters:
    
    listAllowedNodeTypeUpdatesRequest -
    
    Returns:
    
    Result of the ListAllowedNodeTypeUpdates operation returned by the service.
    
    Throws:
    
    ClusterNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterCombinationException
    
    InvalidParameterValueException
    
    See Also:
    
    AWS API Documentation
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. For more information, see Tagging your MemoryDB resources
    
    Specified by:
    
    listTags in interface AmazonMemoryDB
    
    Parameters:
    
    listTagsRequest -
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    Throws:
    
    ClusterNotFoundException
    
    InvalidClusterStateException
    
    ParameterGroupNotFoundException
    
    SubnetGroupNotFoundException
    
    SnapshotNotFoundException
    
    InvalidARNException
    
    ServiceLinkedRoleNotFoundException
    
    UserNotFoundException
    
    ACLNotFoundException
    
    See Also:
    
    AWS API Documentation
  - purchaseReservedNodesOffering
```
public PurchaseReservedNodesOfferingResult purchaseReservedNodesOffering(PurchaseReservedNodesOfferingRequest request)
```
    Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.
    
    Specified by:
    
    purchaseReservedNodesOffering in interface AmazonMemoryDB
    
    Parameters:
    
    purchaseReservedNodesOfferingRequest -
    
    Returns:
    
    Result of the PurchaseReservedNodesOffering operation returned by the service.
    
    Throws:
    
    ReservedNodesOfferingNotFoundException - The requested node offering does not exist.
    
    ReservedNodeAlreadyExistsException - You already have a reservation with the given identifier.
    
    ReservedNodeQuotaExceededException - The request cannot be processed because it would exceed the user's node quota.
    
    ServiceLinkedRoleNotFoundException
    
    TagQuotaPerResourceExceededException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - resetParameterGroup
```
public ResetParameterGroupResult resetParameterGroup(ResetParameterGroupRequest request)
```
    Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.
    
    Specified by:
    
    resetParameterGroup in interface AmazonMemoryDB
    
    Parameters:
    
    resetParameterGroupRequest -
    
    Returns:
    
    Result of the ResetParameterGroup operation returned by the service.
    
    Throws:
    
    InvalidParameterGroupStateException
    
    ParameterGroupNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see Resource-level permissions.
    
    For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags.
    
    Specified by:
    
    tagResource in interface AmazonMemoryDB
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ClusterNotFoundException
    
    ParameterGroupNotFoundException
    
    SubnetGroupNotFoundException
    
    InvalidClusterStateException
    
    SnapshotNotFoundException
    
    UserNotFoundException
    
    ACLNotFoundException
    
    TagQuotaPerResourceExceededException
    
    InvalidARNException
    
    ServiceLinkedRoleNotFoundException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Use this operation to remove tags on a resource
    
    Specified by:
    
    untagResource in interface AmazonMemoryDB
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ClusterNotFoundException
    
    InvalidClusterStateException
    
    ParameterGroupNotFoundException
    
    SubnetGroupNotFoundException
    
    SnapshotNotFoundException
    
    InvalidARNException
    
    TagNotFoundException
    
    ServiceLinkedRoleNotFoundException
    
    UserNotFoundException
    
    ACLNotFoundException
    
    See Also:
    
    AWS API Documentation
  - updateACL
```
public UpdateACLResult updateACL(UpdateACLRequest request)
```
    Changes the list of users that belong to the Access Control List.
    
    Specified by:
    
    updateACL in interface AmazonMemoryDB
    
    Parameters:
    
    updateACLRequest -
    
    Returns:
    
    Result of the UpdateACL operation returned by the service.
    
    Throws:
    
    ACLNotFoundException
    
    UserNotFoundException
    
    DuplicateUserNameException
    
    DefaultUserRequiredException
    
    InvalidACLStateException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - updateCluster
```
public UpdateClusterResult updateCluster(UpdateClusterRequest request)
```
    Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
    
    Specified by:
    
    updateCluster in interface AmazonMemoryDB
    
    Parameters:
    
    updateClusterRequest -
    
    Returns:
    
    Result of the UpdateCluster operation returned by the service.
    
    Throws:
    
    ClusterNotFoundException
    
    InvalidClusterStateException
    
    InvalidNodeStateException
    
    ParameterGroupNotFoundException
    
    InvalidVPCNetworkStateException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidKMSKeyException
    
    NodeQuotaForClusterExceededException
    
    ClusterQuotaForCustomerExceededException
    
    ShardsPerClusterQuotaExceededException
    
    NodeQuotaForCustomerExceededException
    
    NoOperationException
    
    InvalidACLStateException
    
    ACLNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - updateParameterGroup
```
public UpdateParameterGroupResult updateParameterGroup(UpdateParameterGroupRequest request)
```
    Updates 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 AmazonMemoryDB
    
    Parameters:
    
    updateParameterGroupRequest -
    
    Returns:
    
    Result of the UpdateParameterGroup operation returned by the service.
    
    Throws:
    
    ParameterGroupNotFoundException
    
    InvalidParameterGroupStateException
    
    ServiceLinkedRoleNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - updateSubnetGroup
```
public UpdateSubnetGroupResult updateSubnetGroup(UpdateSubnetGroupRequest request)
```
    Updates a subnet group. For more information, see Updating a subnet group
    
    Specified by:
    
    updateSubnetGroup in interface AmazonMemoryDB
    
    Parameters:
    
    updateSubnetGroupRequest -
    
    Returns:
    
    Result of the UpdateSubnetGroup operation returned by the service.
    
    Throws:
    
    SubnetGroupNotFoundException
    
    SubnetQuotaExceededException
    
    SubnetInUseException
    
    InvalidSubnetException
    
    ServiceLinkedRoleNotFoundException
    
    SubnetNotAllowedException
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Changes user password(s) and/or access string.
    
    Specified by:
    
    updateUser in interface AmazonMemoryDB
    
    Parameters:
    
    updateUserRequest -
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    Throws:
    
    UserNotFoundException
    
    InvalidUserStateException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonMemoryDB
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonMemoryDB
    
    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 AmazonMemoryDB
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonMemoryDBClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.memorydb.AmazonMemoryDB

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Field Detail

configFactory

Method Detail

builder

batchUpdateCluster

copySnapshot

createACL

createCluster

createParameterGroup

createSnapshot

createSubnetGroup

createUser

deleteACL

deleteCluster

deleteParameterGroup

deleteSnapshot

deleteSubnetGroup

deleteUser

describeACLs

describeClusters

describeEngineVersions

describeEvents

describeParameterGroups

describeParameters

describeReservedNodes

describeReservedNodesOfferings

describeServiceUpdates

describeSnapshots

describeSubnetGroups

describeUsers

failoverShard

listAllowedNodeTypeUpdates

listTags

purchaseReservedNodesOffering

resetParameterGroup

tagResource

untagResource

updateACL

updateCluster

updateParameterGroup

updateSubnetGroup

updateUser

getCachedResponseMetadata

shutdown