There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.
Code examples for Amazon RDS using AWS SDKs
The following code examples show you how to use Amazon Relational Database Service (Amazon RDS) with an AWS software development kit (SDK).
Actions are code excerpts from larger programs and must be run in context. While actions
show you how to call individual service functions, you can see actions in context in their related scenarios and
cross-service examples.
Scenarios are code examples that show you how to accomplish a specific task by
calling multiple functions within the same service.
Cross-service examples are sample applications that work across multiple AWS services.
Get started
The following code examples show how to get started using Amazon RDS.
- .NET
-
- AWS SDK for .NET
-
using System;
using System.Threading.Tasks;
using Amazon.RDS;
using Amazon.RDS.Model;
namespace RDSActions;
public static class HelloRds
{
static async Task Main(string[] args)
{
var rdsClient = new AmazonRDSClient();
Console.WriteLine($"Hello Amazon RDS! Following are some of your DB instances:");
Console.WriteLine();
// You can use await and any of the async methods to get a response.
// Let's get the first twenty DB instances.
var response = await rdsClient.DescribeDBInstancesAsync(
new DescribeDBInstancesRequest()
{
MaxRecords = 20 // Must be between 20 and 100.
});
foreach (var instance in response.DBInstances)
{
Console.WriteLine($"\tDB name: {instance.DBName}");
Console.WriteLine($"\tArn: {instance.DBInstanceArn}");
Console.WriteLine($"\tIdentifier: {instance.DBInstanceIdentifier}");
Console.WriteLine();
}
}
}
- C++
-
- SDK for C++
-
Code for the CMakeLists.txt CMake file.
# Set the minimum required version of CMake for this project.
cmake_minimum_required(VERSION 3.13)
# Set the AWS service components used by this project.
set(SERVICE_COMPONENTS rds)
# Set this project's name.
project("hello_rds")
# Set the C++ standard to use to build this target.
# At least C++ 11 is required for the AWS SDK for C++.
set(CMAKE_CXX_STANDARD 11)
# Use the MSVC variable to determine if this is a Windows build.
set(WINDOWS_BUILD ${MSVC})
if (WINDOWS_BUILD) # Set the location where CMake can find the installed libraries for the AWS SDK.
string(REPLACE ";" "/aws-cpp-sdk-all;" SYSTEM_MODULE_PATH "${CMAKE_SYSTEM_PREFIX_PATH}/aws-cpp-sdk-all")
list(APPEND CMAKE_PREFIX_PATH ${SYSTEM_MODULE_PATH})
endif ()
# Find the AWS SDK for C++ package.
find_package(AWSSDK REQUIRED COMPONENTS ${SERVICE_COMPONENTS})
if (WINDOWS_BUILD)
# Copy relevant AWS SDK for C++ libraries into the current binary directory for running and debugging.
# set(BIN_SUB_DIR "/Debug") # If you are building from the command line, you may need to uncomment this
# and set the proper subdirectory to the executables' location.
AWSSDK_CPY_DYN_LIBS(SERVICE_COMPONENTS "" ${CMAKE_CURRENT_BINARY_DIR}${BIN_SUB_DIR})
endif ()
add_executable(${PROJECT_NAME}
hello_rds.cpp)
target_link_libraries(${PROJECT_NAME}
${AWSSDK_LINK_LIBRARIES})
Code for the hello_rds.cpp source file.
#include <aws/core/Aws.h>
#include <aws/rds/RDSClient.h>
#include <aws/rds/model/DescribeDBInstancesRequest.h>
#include <iostream>
/*
* A "Hello Rds" starter application which initializes an Amazon Relational Database Service (Amazon RDS) client and
* describes the Amazon RDS instances.
*
* main function
*
* Usage: 'hello_rds'
*
*/
int main(int argc, char **argv) {
Aws::SDKOptions options;
// Optionally change the log level for debugging.
// options.loggingOptions.logLevel = Utils::Logging::LogLevel::Debug;
Aws::InitAPI(options); // Should only be called once.
int result = 0;
{
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::RDS::RDSClient rdsClient(clientConfig);
Aws::String marker;
std::vector<Aws::String> instanceDBIDs;
do {
Aws::RDS::Model::DescribeDBInstancesRequest request;
if (!marker.empty()) {
request.SetMarker(marker);
}
Aws::RDS::Model::DescribeDBInstancesOutcome outcome =
rdsClient.DescribeDBInstances(request);
if (outcome.IsSuccess()) {
for (auto &instance: outcome.GetResult().GetDBInstances()) {
instanceDBIDs.push_back(instance.GetDBInstanceIdentifier());
}
marker = outcome.GetResult().GetMarker();
} else {
result = 1;
std::cerr << "Error with RDS::DescribeDBInstances. "
<< outcome.GetError().GetMessage()
<< std::endl;
break;
}
} while (!marker.empty());
std::cout << instanceDBIDs.size() << " RDS instances found." << std::endl;
for (auto &instanceDBID: instanceDBIDs) {
std::cout << " Instance: " << instanceDBID << std::endl;
}
}
Aws::ShutdownAPI(options); // Should only be called once.
return result;
}
- Go
-
- SDK for Go V2
-
package main
import (
"context"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/config"
"github.com/aws/aws-sdk-go-v2/service/rds"
)
// main uses the AWS SDK for Go V2 to create an Amazon Relational Database Service (Amazon RDS)
// client and list up to 20 DB instances in your account.
// This example uses the default settings specified in your shared credentials
// and config files.
func main() {
sdkConfig, err := config.LoadDefaultConfig(context.TODO())
if err != nil {
fmt.Println("Couldn't load default configuration. Have you set up your AWS account?")
fmt.Println(err)
return
}
rdsClient := rds.NewFromConfig(sdkConfig)
const maxInstances = 20
fmt.Printf("Let's list up to %v DB instances.\n", maxInstances)
output, err := rdsClient.DescribeDBInstances(context.TODO(),
&rds.DescribeDBInstancesInput{MaxRecords: aws.Int32(maxInstances)})
if err != nil {
fmt.Printf("Couldn't list DB instances: %v\n", err)
return
}
if len(output.DBInstances) == 0 {
fmt.Println("No DB instances found.")
} else {
for _, instance := range output.DBInstances {
fmt.Printf("DB instance %v has database %v.\n", *instance.DBInstanceIdentifier,
*instance.DBName)
}
}
}
- Java
-
- SDK for Java 2.x
-
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.rds.RdsClient;
import software.amazon.awssdk.services.rds.model.DescribeDbInstancesResponse;
import software.amazon.awssdk.services.rds.model.DBInstance;
import software.amazon.awssdk.services.rds.model.RdsException;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DescribeDBInstances {
public static void main(String[] args) {
Region region = Region.US_EAST_1;
RdsClient rdsClient = RdsClient.builder()
.region(region)
.build();
describeInstances(rdsClient);
rdsClient.close();
}
public static void describeInstances(RdsClient rdsClient) {
try {
DescribeDbInstancesResponse response = rdsClient.describeDBInstances();
List<DBInstance> instanceList = response.dbInstances();
for (DBInstance instance : instanceList) {
System.out.println("Instance ARN is: " + instance.dbInstanceArn());
System.out.println("The Engine is " + instance.engine());
System.out.println("Connection endpoint is" + instance.endpoint().address());
}
} catch (RdsException e) {
System.out.println(e.getLocalizedMessage());
System.exit(1);
}
}
}
