Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

Link copied to clipboard

Makes a copy of an existing snapshot.

Link copied to clipboard
inline suspend fun MemoryDbClient.createAcl(crossinline block: CreateAclRequest.Builder.() -> Unit): CreateAclResponse

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun MemoryDbClient.createUser(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse

Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

Link copied to clipboard
inline suspend fun MemoryDbClient.deleteAcl(crossinline block: DeleteAclRequest.Builder.() -> Unit): DeleteAclResponse

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).

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MemoryDbClient.deleteUser(crossinline block: DeleteUserRequest.Builder.() -> Unit): DeleteUserResponse

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

Link copied to clipboard

Returns a list of ACLs

Link copied to clipboard

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

Link copied to clipboard

Returns a list of the available Redis engine versions.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Returns the detailed parameter list for a particular parameter group.

Link copied to clipboard

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

Link copied to clipboard

Lists available reserved node offerings.

Link copied to clipboard

Returns details of the service updates

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Returns a list of users.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun MemoryDbClient.listTags(crossinline block: ListTagsRequest.Builder.() -> Unit): ListTagsResponse

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun MemoryDbClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

Link copied to clipboard

Use this operation to remove tags on a resource

Link copied to clipboard
inline suspend fun MemoryDbClient.updateAcl(crossinline block: UpdateAclRequest.Builder.() -> Unit): UpdateAclResponse

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Updates a subnet group. For more information, see Updating a subnet group

Link copied to clipboard
inline suspend fun MemoryDbClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

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

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.