AbstractAmazonMemoryDB (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.memorydb.AbstractAmazonMemoryDB

All Implemented Interfaces:

AmazonMemoryDB

Direct Known Subclasses:

AbstractAmazonMemoryDBAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonMemoryDB
extends Object
implements AmazonMemoryDB
```
Abstract implementation of AmazonMemoryDB. 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.memorydb.AmazonMemoryDB
  ENDPOINT_PREFIX

Method Summary

All 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.
`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.
`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.
`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 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - batchUpdateCluster
```
public BatchUpdateClusterResult batchUpdateCluster(BatchUpdateClusterRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the BatchUpdateCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - copySnapshot
```
public CopySnapshotResult copySnapshot(CopySnapshotRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Makes a copy of an existing snapshot.
    
    Specified by:
    
    copySnapshot in interface AmazonMemoryDB
    
    Returns:
    
    Result of the CopySnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createACL
```
public CreateACLResult createACL(CreateACLRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
    
    Specified by:
    
    createACL in interface AmazonMemoryDB
    
    Returns:
    
    Result of the CreateACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCluster
```
public CreateClusterResult createCluster(CreateClusterRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
    
    Specified by:
    
    createCluster in interface AmazonMemoryDB
    
    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: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the CreateParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSnapshot
```
public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Creates a copy of an entire cluster at a specific moment in time.
    
    Specified by:
    
    createSnapshot in interface AmazonMemoryDB
    
    Returns:
    
    Result of the CreateSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSubnetGroup
```
public CreateSubnetGroupResult createSubnetGroup(CreateSubnetGroupRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the CreateSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
    
    Specified by:
    
    createUser in interface AmazonMemoryDB
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteACL
```
public DeleteACLResult deleteACL(DeleteACLRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the DeleteACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCluster
```
public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Deletes a cluster. It also deletes all associated nodes and node endpoints
    
    Specified by:
    
    deleteCluster in interface AmazonMemoryDB
    
    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: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the DeleteParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSnapshot
```
public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the DeleteSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSubnetGroup
```
public DeleteSubnetGroupResult deleteSubnetGroup(DeleteSubnetGroupRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the DeleteSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
    
    Specified by:
    
    deleteUser in interface AmazonMemoryDB
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeACLs
```
public DescribeACLsResult describeACLs(DescribeACLsRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Returns a list of ACLs
    
    Specified by:
    
    describeACLs in interface AmazonMemoryDB
    
    Returns:
    
    Result of the DescribeACLs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeClusters
```
public DescribeClustersResult describeClusters(DescribeClustersRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the DescribeClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEngineVersions
```
public DescribeEngineVersionsResult describeEngineVersions(DescribeEngineVersionsRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Returns a list of the available Redis engine versions.
    
    Specified by:
    
    describeEngineVersions in interface AmazonMemoryDB
    
    Returns:
    
    Result of the DescribeEngineVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    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: AmazonMemoryDB
    
    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
    
    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: AmazonMemoryDB
    
    Returns the detailed parameter list for a particular parameter group.
    
    Specified by:
    
    describeParameters in interface AmazonMemoryDB
    
    Returns:
    
    Result of the DescribeParameters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeServiceUpdates
```
public DescribeServiceUpdatesResult describeServiceUpdates(DescribeServiceUpdatesRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Returns details of the service updates
    
    Specified by:
    
    describeServiceUpdates in interface AmazonMemoryDB
    
    Returns:
    
    Result of the DescribeServiceUpdates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSnapshots
```
public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the DescribeSnapshots operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSubnetGroups
```
public DescribeSubnetGroupsResult describeSubnetGroups(DescribeSubnetGroupsRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the DescribeSubnetGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUsers
```
public DescribeUsersResult describeUsers(DescribeUsersRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Returns a list of users.
    
    Specified by:
    
    describeUsers in interface AmazonMemoryDB
    
    Returns:
    
    Result of the DescribeUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - failoverShard
```
public FailoverShardResult failoverShard(FailoverShardRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Used to failover a shard
    
    Specified by:
    
    failoverShard in interface AmazonMemoryDB
    
    Returns:
    
    Result of the FailoverShard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAllowedNodeTypeUpdates
```
public ListAllowedNodeTypeUpdatesResult listAllowedNodeTypeUpdates(ListAllowedNodeTypeUpdatesRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the ListAllowedNodeTypeUpdates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resetParameterGroup
```
public ResetParameterGroupResult resetParameterGroup(ResetParameterGroupRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    Returns:
    
    Result of the ResetParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    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: AmazonMemoryDB
    
    Use this operation to remove tags on a resource
    
    Specified by:
    
    untagResource in interface AmazonMemoryDB
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateACL
```
public UpdateACLResult updateACL(UpdateACLRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Changes the list of users that belong to the Access Control List.
    
    Specified by:
    
    updateACL in interface AmazonMemoryDB
    
    Returns:
    
    Result of the UpdateACL operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateCluster
```
public UpdateClusterResult updateCluster(UpdateClusterRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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
    
    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: AmazonMemoryDB
    
    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
    
    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: AmazonMemoryDB
    
    Updates a subnet group. For more information, see Updating a subnet group
    
    Specified by:
    
    updateSubnetGroup in interface AmazonMemoryDB
    
    Returns:
    
    Result of the UpdateSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    Changes user password(s) and/or access string.
    
    Specified by:
    
    updateUser in interface AmazonMemoryDB
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonMemoryDB
    
    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 AmazonMemoryDB
    
    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 AbstractAmazonMemoryDB

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

batchUpdateCluster

copySnapshot

createACL

createCluster

createParameterGroup

createSnapshot

createSubnetGroup

createUser

deleteACL

deleteCluster

deleteParameterGroup

deleteSnapshot

deleteSubnetGroup

deleteUser

describeACLs

describeClusters

describeEngineVersions

describeEvents

describeParameterGroups

describeParameters

describeServiceUpdates

describeSnapshots

describeSubnetGroups

describeUsers

failoverShard

listAllowedNodeTypeUpdates

listTags

resetParameterGroup

tagResource

untagResource

updateACL

updateCluster

updateParameterGroup

updateSubnetGroup

updateUser

shutdown

getCachedResponseMetadata