View Source AWS.MemoryDB (aws-elixir v1.0.4)
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.
Link to this section Summary
Functions
Apply the service update to a list of clusters supplied.
Makes a copy of an existing snapshot.
Creates an Access Control List.
Creates a cluster.
Creates a new multi-Region cluster.
Creates a new MemoryDB parameter group.
Creates a copy of an entire cluster at a specific moment in time.
Creates a subnet group.
Creates a MemoryDB user.
Deletes an Access Control List.
Deletes a cluster.
Deletes an existing multi-Region cluster.
Deletes the specified parameter group.
Deletes an existing snapshot.
Deletes a subnet group.
Deletes a user.
Returns a list of ACLs.
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
Returns a list of the available Redis OSS engine versions.
Returns events related to clusters, security groups, and parameter groups.
Returns details about one or more multi-Region clusters.
Returns a list of parameter group descriptions.
Returns the detailed parameter list for a particular parameter group.
Returns information about reserved nodes for this account, or about a specified reserved node.
Lists available reserved node offerings.
Returns details of the service updates.
Returns information about cluster snapshots.
Returns a list of subnet group descriptions.
Returns a list of users.
Used to failover a shard.
Lists the allowed updates for a multi-Region cluster.
Lists all available node types that you can scale to from your cluster's current node type.
Lists all tags currently on a named resource.
Allows you to purchase a reserved node offering.
Modifies the parameters of a parameter group to the engine or system default value.
A tag is a key-value pair where the key and value are case-sensitive.
Use this operation to remove tags on a resource.
Changes the list of users that belong to the Access Control List.
Modifies the settings for a cluster.
Updates the configuration of an existing multi-Region cluster.
Updates the parameters of a parameter group.
Updates a subnet group.
Changes user password(s) and/or access string.
Link to this section Functions
Apply the service update to a list of clusters supplied.
For more information on service updates and applying them, see Applying the service updates.
Makes a copy of an existing snapshot.
Creates an Access Control List.
For more information, see Authenticating users with Access Contol Lists (ACLs).
Creates a cluster.
All nodes in the cluster run the same protocol-compliant engine software.
Creates a new multi-Region cluster.
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.
Creates a copy of an entire cluster at a specific moment in time.
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.
Creates a MemoryDB user.
For more information, see Authenticating users with Access Contol Lists (ACLs).
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).
Deletes a cluster.
It also deletes all associated nodes and node endpoints.
CreateSnapshot permission is required to create a final snapshot.
Without this permission, the API call will fail with an Access Denied
exception.
Deletes an existing multi-Region cluster.
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.
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.
Deletes a subnet group.
You cannot delete a default subnet group or one that is associated with any clusters.
Deletes a user.
The user will be removed from all ACLs and in turn removed from all clusters.
Returns a list of ACLs.
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
Returns a list of the available Redis OSS engine versions.
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.
Returns details about one or more multi-Region clusters.
Returns a list of parameter group descriptions.
If a parameter group name is specified, the list contains only the descriptions for that group.
Returns the detailed parameter list for a particular parameter group.
Returns information about reserved nodes for this account, or about a specified reserved node.
Lists available reserved node offerings.
Returns details of the service updates.
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.
Returns a list of subnet group descriptions.
If a subnet group name is specified, the list contains only the description of that group.
Returns a list of users.
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.
list_allowed_multi_region_cluster_updates(client, input, options \\ [])
View SourceLists the allowed updates for a multi-Region cluster.
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.
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.
Allows you to purchase a reserved node offering.
Reserved nodes are not eligible for cancellation and are non-refundable.
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.
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
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.
Use this operation to remove tags on a resource.
Changes the list of users that belong to the Access Control List.
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.
Updates the configuration of an existing multi-Region cluster.
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.
Updates a subnet group.
For more information, see Updating a subnet group
Changes user password(s) and/or access string.