@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonMemoryDBClient extends AmazonWebServiceClient implements AmazonMemoryDB
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| 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.
|
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonMemoryDBClientBuilder builder()
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.
batchUpdateCluster in interface AmazonMemoryDBbatchUpdateClusterRequest - ServiceUpdateNotFoundExceptionInvalidParameterValueExceptionpublic CopySnapshotResult copySnapshot(CopySnapshotRequest request)
Makes a copy of an existing snapshot.
copySnapshot in interface AmazonMemoryDBcopySnapshotRequest - SnapshotAlreadyExistsExceptionSnapshotNotFoundExceptionSnapshotQuotaExceededExceptionInvalidSnapshotStateExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionTagQuotaPerResourceExceededExceptionpublic CreateACLResult createACL(CreateACLRequest request)
Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
createACL in interface AmazonMemoryDBcreateACLRequest - UserNotFoundExceptionDuplicateUserNameExceptionACLAlreadyExistsExceptionDefaultUserRequiredExceptionACLQuotaExceededExceptionInvalidParameterValueExceptionTagQuotaPerResourceExceededExceptionpublic CreateClusterResult createCluster(CreateClusterRequest request)
Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
createCluster in interface AmazonMemoryDBcreateClusterRequest - ClusterAlreadyExistsExceptionSubnetGroupNotFoundExceptionClusterQuotaForCustomerExceededExceptionNodeQuotaForClusterExceededExceptionNodeQuotaForCustomerExceededExceptionParameterGroupNotFoundExceptionInsufficientClusterCapacityExceptionInvalidVPCNetworkStateExceptionServiceLinkedRoleNotFoundExceptionShardsPerClusterQuotaExceededExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionInvalidCredentialsExceptionTagQuotaPerResourceExceededExceptionACLNotFoundExceptionInvalidACLStateExceptionpublic 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.
createParameterGroup in interface AmazonMemoryDBcreateParameterGroupRequest - ParameterGroupQuotaExceededExceptionParameterGroupAlreadyExistsExceptionInvalidParameterGroupStateExceptionServiceLinkedRoleNotFoundExceptionTagQuotaPerResourceExceededExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
Creates a copy of an entire cluster at a specific moment in time.
createSnapshot in interface AmazonMemoryDBcreateSnapshotRequest - SnapshotAlreadyExistsExceptionClusterNotFoundExceptionInvalidClusterStateExceptionSnapshotQuotaExceededExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterCombinationExceptionInvalidParameterValueExceptionTagQuotaPerResourceExceededExceptionpublic 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.
createSubnetGroup in interface AmazonMemoryDBcreateSubnetGroupRequest - SubnetGroupAlreadyExistsExceptionSubnetGroupQuotaExceededExceptionSubnetQuotaExceededExceptionInvalidSubnetExceptionServiceLinkedRoleNotFoundExceptionSubnetNotAllowedExceptionTagQuotaPerResourceExceededExceptionpublic CreateUserResult createUser(CreateUserRequest request)
Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
createUser in interface AmazonMemoryDBcreateUserRequest - UserAlreadyExistsExceptionUserQuotaExceededExceptionDuplicateUserNameExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionTagQuotaPerResourceExceededExceptionpublic 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).
deleteACL in interface AmazonMemoryDBdeleteACLRequest - ACLNotFoundExceptionInvalidACLStateExceptionInvalidParameterValueExceptionpublic DeleteClusterResult deleteCluster(DeleteClusterRequest request)
Deletes a cluster. It also deletes all associated nodes and node endpoints
deleteCluster in interface AmazonMemoryDBdeleteClusterRequest - ClusterNotFoundExceptionInvalidClusterStateExceptionSnapshotAlreadyExistsExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
deleteParameterGroup in interface AmazonMemoryDBdeleteParameterGroupRequest - InvalidParameterGroupStateExceptionParameterGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
deleteSnapshot in interface AmazonMemoryDBdeleteSnapshotRequest - SnapshotNotFoundExceptionInvalidSnapshotStateExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic DeleteSubnetGroupResult deleteSubnetGroup(DeleteSubnetGroupRequest request)
Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
deleteSubnetGroup in interface AmazonMemoryDBdeleteSubnetGroupRequest - SubnetGroupInUseExceptionSubnetGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionpublic DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
deleteUser in interface AmazonMemoryDBdeleteUserRequest - InvalidUserStateExceptionUserNotFoundExceptionInvalidParameterValueExceptionpublic DescribeACLsResult describeACLs(DescribeACLsRequest request)
Returns a list of ACLs
describeACLs in interface AmazonMemoryDBdescribeACLsRequest - ACLNotFoundExceptionInvalidParameterCombinationExceptionpublic 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.
describeClusters in interface AmazonMemoryDBdescribeClustersRequest - ClusterNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic DescribeEngineVersionsResult describeEngineVersions(DescribeEngineVersionsRequest request)
Returns a list of the available Redis engine versions.
describeEngineVersions in interface AmazonMemoryDBdescribeEngineVersionsRequest - ServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
describeEvents in interface AmazonMemoryDBdescribeEventsRequest - ServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
describeParameterGroups in interface AmazonMemoryDBdescribeParameterGroupsRequest - ParameterGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic DescribeParametersResult describeParameters(DescribeParametersRequest request)
Returns the detailed parameter list for a particular parameter group.
describeParameters in interface AmazonMemoryDBdescribeParametersRequest - ParameterGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic DescribeServiceUpdatesResult describeServiceUpdates(DescribeServiceUpdatesRequest request)
Returns details of the service updates
describeServiceUpdates in interface AmazonMemoryDBdescribeServiceUpdatesRequest - InvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
describeSnapshots in interface AmazonMemoryDBdescribeSnapshotsRequest - SnapshotNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
describeSubnetGroups in interface AmazonMemoryDBdescribeSubnetGroupsRequest - SubnetGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionpublic DescribeUsersResult describeUsers(DescribeUsersRequest request)
Returns a list of users.
describeUsers in interface AmazonMemoryDBdescribeUsersRequest - UserNotFoundExceptionInvalidParameterCombinationExceptionpublic FailoverShardResult failoverShard(FailoverShardRequest request)
Used to failover a shard
failoverShard in interface AmazonMemoryDBfailoverShardRequest - APICallRateForCustomerExceededExceptionInvalidClusterStateExceptionShardNotFoundExceptionClusterNotFoundExceptionTestFailoverNotAvailableExceptionInvalidKMSKeyExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
listAllowedNodeTypeUpdates in interface AmazonMemoryDBlistAllowedNodeTypeUpdatesRequest - ClusterNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterCombinationExceptionInvalidParameterValueExceptionpublic 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
listTags in interface AmazonMemoryDBlistTagsRequest - ClusterNotFoundExceptionInvalidClusterStateExceptionParameterGroupNotFoundExceptionSubnetGroupNotFoundExceptionSnapshotNotFoundExceptionInvalidARNExceptionServiceLinkedRoleNotFoundExceptionUserNotFoundExceptionACLNotFoundExceptionpublic 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.
resetParameterGroup in interface AmazonMemoryDBresetParameterGroupRequest - InvalidParameterGroupStateExceptionParameterGroupNotFoundExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
tagResource in interface AmazonMemoryDBtagResourceRequest - ClusterNotFoundExceptionParameterGroupNotFoundExceptionSubnetGroupNotFoundExceptionInvalidClusterStateExceptionSnapshotNotFoundExceptionUserNotFoundExceptionACLNotFoundExceptionTagQuotaPerResourceExceededExceptionInvalidARNExceptionServiceLinkedRoleNotFoundExceptionpublic UntagResourceResult untagResource(UntagResourceRequest request)
Use this operation to remove tags on a resource
untagResource in interface AmazonMemoryDBuntagResourceRequest - ClusterNotFoundExceptionInvalidClusterStateExceptionParameterGroupNotFoundExceptionSubnetGroupNotFoundExceptionSnapshotNotFoundExceptionInvalidARNExceptionTagNotFoundExceptionServiceLinkedRoleNotFoundExceptionUserNotFoundExceptionACLNotFoundExceptionpublic UpdateACLResult updateACL(UpdateACLRequest request)
Changes the list of users that belong to the Access Control List.
updateACL in interface AmazonMemoryDBupdateACLRequest - ACLNotFoundExceptionUserNotFoundExceptionDuplicateUserNameExceptionDefaultUserRequiredExceptionInvalidACLStateExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
updateCluster in interface AmazonMemoryDBupdateClusterRequest - ClusterNotFoundExceptionInvalidClusterStateExceptionInvalidNodeStateExceptionParameterGroupNotFoundExceptionInvalidVPCNetworkStateExceptionServiceLinkedRoleNotFoundExceptionInvalidKMSKeyExceptionNodeQuotaForClusterExceededExceptionClusterQuotaForCustomerExceededExceptionShardsPerClusterQuotaExceededExceptionNodeQuotaForCustomerExceededExceptionNoOperationExceptionInvalidACLStateExceptionACLNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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.
updateParameterGroup in interface AmazonMemoryDBupdateParameterGroupRequest - ParameterGroupNotFoundExceptionInvalidParameterGroupStateExceptionServiceLinkedRoleNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic UpdateSubnetGroupResult updateSubnetGroup(UpdateSubnetGroupRequest request)
Updates a subnet group. For more information, see Updating a subnet group
updateSubnetGroup in interface AmazonMemoryDBupdateSubnetGroupRequest - SubnetGroupNotFoundExceptionSubnetQuotaExceededExceptionSubnetInUseExceptionInvalidSubnetExceptionServiceLinkedRoleNotFoundExceptionSubnetNotAllowedExceptionpublic UpdateUserResult updateUser(UpdateUserRequest request)
Changes user password(s) and/or access string.
updateUser in interface AmazonMemoryDBupdateUserRequest - UserNotFoundExceptionInvalidUserStateExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionpublic 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 the request.
getCachedResponseMetadata in interface AmazonMemoryDBrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonMemoryDBshutdown in class AmazonWebServiceClient