AWS.MemoryDB — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

batchUpdateCluster(params = {}, callback) ⇒ AWS.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.

copySnapshot(params = {}, callback) ⇒ AWS.Request

Makes a copy of an existing snapshot.

createCluster(params = {}, callback) ⇒ AWS.Request

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

createParameterGroup(params = {}, callback) ⇒ AWS.Request

createSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a copy of an entire cluster at a specific moment in time.

createSubnetGroup(params = {}, callback) ⇒ AWS.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.

deleteCluster(params = {}, callback) ⇒ AWS.Request

Deletes a cluster. It also deletes all associated nodes and node endpoints

Note: CreateSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.

deleteParameterGroup(params = {}, callback) ⇒ AWS.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.

deleteSnapshot(params = {}, callback) ⇒ AWS.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.

deleteSubnetGroup(params = {}, callback) ⇒ AWS.Request

Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.

deleteUser(params = {}, callback) ⇒ AWS.Request

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

describeClusters(params = {}, callback) ⇒ AWS.Request

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

describeEngineVersions(params = {}, callback) ⇒ AWS.Request

Returns a list of the available Redis OSS engine versions.

describeEvents(params = {}, callback) ⇒ AWS.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.

describeParameterGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.

describeParameters(params = {}, callback) ⇒ AWS.Request

Returns the detailed parameter list for a particular parameter group.

describeReservedNodes(params = {}, callback) ⇒ AWS.Request

Returns information about reserved nodes for this account, or about a specified reserved node.

describeReservedNodesOfferings(params = {}, callback) ⇒ AWS.Request

Lists available reserved node offerings.

describeServiceUpdates(params = {}, callback) ⇒ AWS.Request

Returns details of the service updates

describeSnapshots(params = {}, callback) ⇒ AWS.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.

describeSubnetGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.

describeUsers(params = {}, callback) ⇒ AWS.Request

failoverShard(params = {}, callback) ⇒ AWS.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.

listAllowedNodeTypeUpdates(params = {}, callback) ⇒ AWS.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.

listTags(params = {}, callback) ⇒ AWS.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

purchaseReservedNodesOffering(params = {}, callback) ⇒ AWS.Request

Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.

resetParameterGroup(params = {}, callback) ⇒ AWS.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.

tagResource(params = {}, callback) ⇒ AWS.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.

untagResource(params = {}, callback) ⇒ AWS.Request

Use this operation to remove tags on a resource

updateACL(params = {}, callback) ⇒ AWS.Request

Changes the list of users that belong to the Access Control List.

updateCluster(params = {}, callback) ⇒ AWS.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.

updateParameterGroup(params = {}, callback) ⇒ AWS.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.

updateSubnetGroup(params = {}, callback) ⇒ AWS.Request

updateUser(params = {}, callback) ⇒ AWS.Request

Changes user password(s) and/or access string.