MemoryDB code examples for the SDK for Java

Overview

This README discusses how to run and test the AWS SDK for Java (v2) examples for Amazon MemoryDB for Redis.

Amazon MemoryDB for Redis is a Redis-compatible, durable, in-memory database service that delivers ultra-fast performance.

⚠️ Important

• The SDK for Java examples perform AWS operations for the account and AWS Region for which you've specified credentials. Running these examples might incur charges on your account. For details about the charges that you can expect for a given service and API operation, see AWS Pricing.
• Running the tests might result in charges to your AWS account.
• We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
• This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Code examples

The credential provider used in all code examples is the default credentials provider. For more information, see Using credentials.

Single actions

The following examples use the MemoryDbClient object:

• Create a cluster (createCluster command)
• Create a snapshot (createSnapshot command)
• Delete a snapshot (deleteCluster command)
• Describe a cluster (describeClusters command)
• Describe a snapshot (describeSnapshots command)
• Describe a specific cluster (describeClusters command)

Run the MemoryDB Java files

Some of these examples perform destructive operations on AWS resources, such as deleting a cluster. Be very careful when running an operation that deletes or modifies AWS resources in your account. We recommend creating separate test-only resources when experimenting with these examples.

To run these examples, set up your development environment. For more information, see Get started with the SDK for Java.

Test the MemoryDB Java files

You can test the Java code examples for Amazon MemoryDB for Redis by running a test file named MemoryDBTest. This file uses JUnit 5 to run the JUnit tests and is located in the src/test/java folder. For more information, see https://junit.org/junit5/.

You can run the JUnit tests from an IDE, such as IntelliJ, or from the command line. As each test runs, you can view messages that inform you if the various tests succeed or fail. For example, the following message informs you that Test 3 passed.

Test 3 passed

WARNING: Running these JUnit tests manipulates real Amazon resources and might incur charges on your account.

Properties file

Before running the JUnit tests, you must define values in the config.properties file located in the resources folder. This file contains values that are required to run the JUnit tests. For example, you define a crawler name used in the tests. If you do not define all values, the JUnit tests fail.

Define these values to successfully run the JUnit tests:

• clusterName - The name of the cluster.
• nodeType - The compute and memory capacity of the nodes in the cluster.
• subnetGroupName - The name of the subnet group to be used for the cluster.
• aclName - The name of the Access Control List to associate with the cluster.
• snapShotName - The name of the snapshot.

Additional resources

• Developer Guide - AWS SDK for Java.
• Developer Guide - Amazon MemoryDB for Redis.

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0