SIGN IN SIGN UP

Welcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.

0 0 1 Java
2023-02-20 18:02:48 -05:00
# Amazon RDS code examples for the SDK for C++
## Overview
Shows how to use the AWS SDK for C++ to work with Amazon Relational Database Service (Amazon RDS).
<!--custom.overview.start-->
<!--custom.overview.end-->
_Amazon RDS is a web service that makes it easier to set up, operate, and scale a relational database in the cloud._
2023-02-20 18:02:48 -05:00
## ⚠ Important
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
2023-02-20 18:02:48 -05:00
* 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
<!--custom.important.start-->
<!--custom.important.end-->
## Code examples
### Prerequisites
Before using the code examples, first complete the installation and setup steps
for [Getting started](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html) in the AWS SDK for
C++ Developer Guide.
This section covers how to get and build the SDK, and how to build your own code by using the SDK with a
sample Hello World-style application.
Next, for information on code example structures and how to build and run the examples, see [Getting started with the AWS SDK for C++ code examples](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started-code-examples.html).
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->
### Get started
- [Hello Amazon RDS](hello_rds/CMakeLists.txt#L4) (`DescribeDBInstances`)
### Basics
Code examples that show you how to perform the essential operations within a service.
- [Learn the basics](getting_started_with_db_instances.cpp)
2023-02-20 18:02:48 -05:00
### Single actions
Code excerpts that show you how to call individual service functions.
- [CreateDBInstance](getting_started_with_db_instances.cpp#L481)
- [CreateDBParameterGroup](getting_started_with_db_instances.cpp#L313)
- [CreateDBSnapshot](getting_started_with_db_instances.cpp#L559)
- [DeleteDBInstance](getting_started_with_db_instances.cpp#L873)
- [DeleteDBParameterGroup](getting_started_with_db_instances.cpp#L927)
- [DescribeDBEngineVersions](getting_started_with_db_instances.cpp#L698)
- [DescribeDBInstances](getting_started_with_db_instances.cpp#L752)
- [DescribeDBParameterGroups](getting_started_with_db_instances.cpp#L256)
- [DescribeDBParameters](getting_started_with_db_instances.cpp#L639)
- [DescribeDBSnapshots](getting_started_with_db_instances.cpp#L597)
- [DescribeOrderableDBInstanceOptions](getting_started_with_db_instances.cpp#L792)
- [ModifyDBParameterGroup](getting_started_with_db_instances.cpp#L382)
2023-02-20 18:02:48 -05:00
### Scenarios
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.
- [Create an Aurora Serverless work item tracker](../../example_code/cross-service/serverless-aurora)
2023-02-20 18:02:48 -05:00
<!--custom.examples.start-->
<!--custom.examples.end-->
2023-02-20 18:02:48 -05:00
## Run the examples
2023-02-20 18:02:48 -05:00
### Instructions
2023-02-20 18:02:48 -05:00
2024-02-08 15:35:59 -05:00
An executable is built for each source file in this folder. These executables are located in the build folder and have
"run_" prepended to the source file name, minus the suffix. See the "main" function in the source file for further instructions.
2023-02-20 18:02:48 -05:00
For example, to run the action in the source file "my_action.cpp", execute the following command from within the build folder. The command
will display any required arguments.
```
./run_my_action
```
2023-02-20 18:02:48 -05:00
2024-02-08 15:35:59 -05:00
If the source file is in a different folder, instructions can be found in the README in that
folder.
2023-02-20 18:02:48 -05:00
<!--custom.instructions.start-->
<!--custom.instructions.end-->
#### Hello Amazon RDS
This example shows you how to get started using Amazon RDS.
#### Learn the basics
2023-02-20 18:02:48 -05:00
This example shows you how to do the following:
- Create a custom DB parameter group and set parameter values.
- Create a DB instance that's configured to use the parameter group. The DB instance also contains a database.
- Take a snapshot of the instance.
- Delete the instance and parameter group.
<!--custom.basic_prereqs.rds_Scenario_GetStartedInstances.start-->
<!--custom.basic_prereqs.rds_Scenario_GetStartedInstances.end-->
<!--custom.basics.rds_Scenario_GetStartedInstances.start-->
<!--custom.basics.rds_Scenario_GetStartedInstances.end-->
#### Create an Aurora Serverless work item tracker
This example shows you how to create a web application that tracks work items in an Amazon Aurora Serverless database and uses Amazon Simple Email Service (Amazon SES) (Amazon SES) to send reports.
<!--custom.scenario_prereqs.cross_RDSDataTracker.start-->
<!--custom.scenario_prereqs.cross_RDSDataTracker.end-->
2023-02-20 18:02:48 -05:00
<!--custom.scenarios.cross_RDSDataTracker.start-->
<!--custom.scenarios.cross_RDSDataTracker.end-->
2023-02-20 18:02:48 -05:00
### Tests
⚠ Running tests might result in charges to your AWS account.
```sh
cd <BUILD_DIR>
cmake <path-to-root-of-this-source-code> -DBUILD_TESTS=ON
make
ctest
```
<!--custom.tests.start-->
<!--custom.tests.end-->
## Additional resources
- [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html)
- [Amazon RDS API Reference](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/Welcome.html)
- [SDK for C++ Amazon RDS reference](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-rds/html/annotated.html)
2023-02-20 18:02:48 -05:00
<!--custom.resources.start-->
<!--custom.resources.end-->
---
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0