@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonMemoryDB
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonMemoryDB instead.
MemoryDB is a fully managed, Redis OSS-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 OSS, a popular open source data store, enabling you to leverage Redis OSS’ flexible and friendly data structures, APIs, and commands.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
BatchUpdateClusterResult |
batchUpdateCluster(BatchUpdateClusterRequest batchUpdateClusterRequest)
Apply the service update to a list of clusters supplied.
|
CopySnapshotResult |
copySnapshot(CopySnapshotRequest copySnapshotRequest)
Makes a copy of an existing snapshot.
|
CreateACLResult |
createACL(CreateACLRequest createACLRequest)
Creates an Access Control List.
|
CreateClusterResult |
createCluster(CreateClusterRequest createClusterRequest)
Creates a cluster.
|
CreateParameterGroupResult |
createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest)
Creates a new MemoryDB parameter group.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a copy of an entire cluster at a specific moment in time.
|
CreateSubnetGroupResult |
createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest)
Creates a subnet group.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a MemoryDB user.
|
DeleteACLResult |
deleteACL(DeleteACLRequest deleteACLRequest)
Deletes an Access Control List.
|
DeleteClusterResult |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes a cluster.
|
DeleteParameterGroupResult |
deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest)
Deletes the specified parameter group.
|
DeleteSnapshotResult |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes an existing snapshot.
|
DeleteSubnetGroupResult |
deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest)
Deletes a subnet group.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user.
|
DescribeACLsResult |
describeACLs(DescribeACLsRequest describeACLsRequest)
Returns a list of ACLs
|
DescribeClustersResult |
describeClusters(DescribeClustersRequest describeClustersRequest)
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 describeEngineVersionsRequest)
Returns a list of the available Redis OSS engine versions.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, security groups, 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.
|
DescribeReservedNodesResult |
describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns information about reserved nodes for this account, or about a specified reserved node.
|
DescribeReservedNodesOfferingsResult |
describeReservedNodesOfferings(DescribeReservedNodesOfferingsRequest describeReservedNodesOfferingsRequest)
Lists available reserved node offerings.
|
DescribeServiceUpdatesResult |
describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)
Returns details of the service updates
|
DescribeSnapshotsResult |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Returns information about cluster snapshots.
|
DescribeSubnetGroupsResult |
describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest)
Returns a list of subnet group descriptions.
|
DescribeUsersResult |
describeUsers(DescribeUsersRequest describeUsersRequest)
Returns a list of users.
|
FailoverShardResult |
failoverShard(FailoverShardRequest failoverShardRequest)
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 listAllowedNodeTypeUpdatesRequest)
Lists all available node types that you can scale to from your cluster's current node type.
|
ListTagsResult |
listTags(ListTagsRequest listTagsRequest)
Lists all tags currently on a named resource.
|
PurchaseReservedNodesOfferingResult |
purchaseReservedNodesOffering(PurchaseReservedNodesOfferingRequest purchaseReservedNodesOfferingRequest)
Allows you to purchase a reserved node offering.
|
ResetParameterGroupResult |
resetParameterGroup(ResetParameterGroupRequest resetParameterGroupRequest)
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 tagResourceRequest)
A tag is a key-value pair where the key and value are case-sensitive.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Use this operation to remove tags on a resource
|
UpdateACLResult |
updateACL(UpdateACLRequest updateACLRequest)
Changes the list of users that belong to the Access Control List.
|
UpdateClusterResult |
updateCluster(UpdateClusterRequest updateClusterRequest)
Modifies the settings for a cluster.
|
UpdateParameterGroupResult |
updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest)
Updates the parameters of a parameter group.
|
UpdateSubnetGroupResult |
updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest)
Updates a subnet group.
|
UpdateUserResult |
updateUser(UpdateUserRequest updateUserRequest)
Changes user password(s) and/or access string.
|
static final String ENDPOINT_PREFIX
BatchUpdateClusterResult batchUpdateCluster(BatchUpdateClusterRequest batchUpdateClusterRequest)
Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
batchUpdateClusterRequest - ServiceUpdateNotFoundExceptionInvalidParameterValueExceptionCopySnapshotResult copySnapshot(CopySnapshotRequest copySnapshotRequest)
Makes a copy of an existing snapshot.
copySnapshotRequest - SnapshotAlreadyExistsExceptionSnapshotNotFoundExceptionSnapshotQuotaExceededExceptionInvalidSnapshotStateExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionTagQuotaPerResourceExceededExceptionCreateACLResult createACL(CreateACLRequest createACLRequest)
Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
createACLRequest - UserNotFoundExceptionDuplicateUserNameExceptionACLAlreadyExistsExceptionDefaultUserRequiredExceptionACLQuotaExceededExceptionInvalidParameterValueExceptionTagQuotaPerResourceExceededExceptionCreateClusterResult createCluster(CreateClusterRequest createClusterRequest)
Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
createClusterRequest - ClusterAlreadyExistsExceptionSubnetGroupNotFoundExceptionClusterQuotaForCustomerExceededExceptionNodeQuotaForClusterExceededExceptionNodeQuotaForCustomerExceededExceptionParameterGroupNotFoundExceptionInsufficientClusterCapacityExceptionInvalidVPCNetworkStateExceptionServiceLinkedRoleNotFoundExceptionShardsPerClusterQuotaExceededExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionInvalidCredentialsExceptionTagQuotaPerResourceExceededExceptionACLNotFoundExceptionInvalidACLStateExceptionCreateParameterGroupResult createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest)
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.
createParameterGroupRequest - ParameterGroupQuotaExceededExceptionParameterGroupAlreadyExistsExceptionInvalidParameterGroupStateExceptionServiceLinkedRoleNotFoundExceptionTagQuotaPerResourceExceededExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionCreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a copy of an entire cluster at a specific moment in time.
createSnapshotRequest - SnapshotAlreadyExistsExceptionClusterNotFoundExceptionInvalidClusterStateExceptionSnapshotQuotaExceededExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterCombinationExceptionInvalidParameterValueExceptionTagQuotaPerResourceExceededExceptionCreateSubnetGroupResult createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest)
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.
createSubnetGroupRequest - SubnetGroupAlreadyExistsExceptionSubnetGroupQuotaExceededExceptionSubnetQuotaExceededExceptionInvalidSubnetExceptionServiceLinkedRoleNotFoundExceptionSubnetNotAllowedExceptionTagQuotaPerResourceExceededExceptionCreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
createUserRequest - UserAlreadyExistsExceptionUserQuotaExceededExceptionDuplicateUserNameExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionTagQuotaPerResourceExceededExceptionDeleteACLResult deleteACL(DeleteACLRequest deleteACLRequest)
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).
deleteACLRequest - ACLNotFoundExceptionInvalidACLStateExceptionInvalidParameterValueExceptionDeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes a cluster. It also deletes all associated nodes and node endpoints
deleteClusterRequest - ClusterNotFoundExceptionInvalidClusterStateExceptionSnapshotAlreadyExistsExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDeleteParameterGroupResult deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest)
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.
deleteParameterGroupRequest - InvalidParameterGroupStateExceptionParameterGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
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.
deleteSnapshotRequest - SnapshotNotFoundExceptionInvalidSnapshotStateExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDeleteSubnetGroupResult deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest)
Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
deleteSubnetGroupRequest - SubnetGroupInUseExceptionSubnetGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionDeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
deleteUserRequest - InvalidUserStateExceptionUserNotFoundExceptionInvalidParameterValueExceptionDescribeACLsResult describeACLs(DescribeACLsRequest describeACLsRequest)
Returns a list of ACLs
describeACLsRequest - ACLNotFoundExceptionInvalidParameterCombinationExceptionDescribeClustersResult describeClusters(DescribeClustersRequest describeClustersRequest)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
describeClustersRequest - ClusterNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDescribeEngineVersionsResult describeEngineVersions(DescribeEngineVersionsRequest describeEngineVersionsRequest)
Returns a list of the available Redis OSS engine versions.
describeEngineVersionsRequest - ServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
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.
describeEventsRequest - ServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDescribeParameterGroupsResult describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest)
Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
describeParameterGroupsRequest - ParameterGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDescribeParametersResult describeParameters(DescribeParametersRequest describeParametersRequest)
Returns the detailed parameter list for a particular parameter group.
describeParametersRequest - ParameterGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDescribeReservedNodesResult describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest)
Returns information about reserved nodes for this account, or about a specified reserved node.
describeReservedNodesRequest - ReservedNodeNotFoundException - The requested node does not exist.ServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDescribeReservedNodesOfferingsResult describeReservedNodesOfferings(DescribeReservedNodesOfferingsRequest describeReservedNodesOfferingsRequest)
Lists available reserved node offerings.
describeReservedNodesOfferingsRequest - ReservedNodesOfferingNotFoundException - The requested node offering does not exist.ServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDescribeServiceUpdatesResult describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)
Returns details of the service updates
describeServiceUpdatesRequest - InvalidParameterValueExceptionInvalidParameterCombinationExceptionDescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
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.
describeSnapshotsRequest - SnapshotNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionDescribeSubnetGroupsResult describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest)
Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
describeSubnetGroupsRequest - SubnetGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionDescribeUsersResult describeUsers(DescribeUsersRequest describeUsersRequest)
Returns a list of users.
describeUsersRequest - UserNotFoundExceptionInvalidParameterCombinationExceptionFailoverShardResult failoverShard(FailoverShardRequest failoverShardRequest)
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.
failoverShardRequest - APICallRateForCustomerExceededExceptionInvalidClusterStateExceptionShardNotFoundExceptionClusterNotFoundExceptionTestFailoverNotAvailableExceptionInvalidKMSKeyExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionListAllowedNodeTypeUpdatesResult listAllowedNodeTypeUpdates(ListAllowedNodeTypeUpdatesRequest listAllowedNodeTypeUpdatesRequest)
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.
listAllowedNodeTypeUpdatesRequest - ClusterNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterCombinationExceptionInvalidParameterValueExceptionListTagsResult listTags(ListTagsRequest listTagsRequest)
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
listTagsRequest - ClusterNotFoundExceptionInvalidClusterStateExceptionParameterGroupNotFoundExceptionSubnetGroupNotFoundExceptionSnapshotNotFoundExceptionInvalidARNExceptionServiceLinkedRoleNotFoundExceptionUserNotFoundExceptionACLNotFoundExceptionPurchaseReservedNodesOfferingResult purchaseReservedNodesOffering(PurchaseReservedNodesOfferingRequest purchaseReservedNodesOfferingRequest)
Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.
purchaseReservedNodesOfferingRequest - 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.ServiceLinkedRoleNotFoundExceptionTagQuotaPerResourceExceededExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionResetParameterGroupResult resetParameterGroup(ResetParameterGroupRequest resetParameterGroupRequest)
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.
resetParameterGroupRequest - InvalidParameterGroupStateExceptionParameterGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionTagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - ClusterNotFoundExceptionParameterGroupNotFoundExceptionSubnetGroupNotFoundExceptionInvalidClusterStateExceptionSnapshotNotFoundExceptionUserNotFoundExceptionACLNotFoundExceptionTagQuotaPerResourceExceededExceptionInvalidARNExceptionServiceLinkedRoleNotFoundExceptionUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Use this operation to remove tags on a resource
untagResourceRequest - ClusterNotFoundExceptionInvalidClusterStateExceptionParameterGroupNotFoundExceptionSubnetGroupNotFoundExceptionSnapshotNotFoundExceptionInvalidARNExceptionTagNotFoundExceptionServiceLinkedRoleNotFoundExceptionUserNotFoundExceptionACLNotFoundExceptionUpdateACLResult updateACL(UpdateACLRequest updateACLRequest)
Changes the list of users that belong to the Access Control List.
updateACLRequest - ACLNotFoundExceptionUserNotFoundExceptionDuplicateUserNameExceptionDefaultUserRequiredExceptionInvalidACLStateExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionUpdateClusterResult updateCluster(UpdateClusterRequest updateClusterRequest)
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.
updateClusterRequest - ClusterNotFoundExceptionInvalidClusterStateExceptionInvalidNodeStateExceptionParameterGroupNotFoundExceptionInvalidVPCNetworkStateExceptionServiceLinkedRoleNotFoundExceptionInvalidKMSKeyExceptionNodeQuotaForClusterExceededExceptionClusterQuotaForCustomerExceededExceptionShardsPerClusterQuotaExceededExceptionNodeQuotaForCustomerExceededExceptionNoOperationExceptionInvalidACLStateExceptionACLNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionUpdateParameterGroupResult updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest)
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.
updateParameterGroupRequest - ParameterGroupNotFoundExceptionInvalidParameterGroupStateExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionUpdateSubnetGroupResult updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest)
Updates a subnet group. For more information, see Updating a subnet group
updateSubnetGroupRequest - SubnetGroupNotFoundExceptionSubnetQuotaExceededExceptionSubnetInUseExceptionInvalidSubnetExceptionServiceLinkedRoleNotFoundExceptionSubnetNotAllowedExceptionUpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
Changes user password(s) and/or access string.
updateUserRequest - UserNotFoundExceptionInvalidUserStateExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionvoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.