<!--Generated by WRITEME on 2023-05-18 22:38:29.552540 (UTC)-->
# Amazon RDS code examples for the SDK for Ruby

## Overview

Shows how to use the AWS SDK for Ruby 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.*

## ⚠ Important

* Running this code might result in charges to your AWS account.
* 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

For prerequisites, see the [README](../../README.md#Prerequisites) in the `ruby` folder.


<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Single actions

Code excerpts that show you how to call individual service functions.

* [Create a snapshot of a DB instance](create_snapshot.rb#L4) (`CreateDBSnapshot`)
* [Describe DB instances](list_instances.rb#L4) (`DescribeDBInstances`)
* [Describe DB parameter groups](list_parameter_groups.rb#L4) (`DescribeDBParameterGroups`)
* [Describe parameters in a DB parameter group](list_parameter_groups.rb#L4) (`DescribeDBParameters`)
* [Describe snapshots of DB instances](list_instance_snapshots.rb#L6) (`DescribeDBSnapshots`)

## Run the examples

### Instructions

<!--custom.instructions.start-->
The quickest way to interact with this example code is to invoke a [Single Action](#single-actions) from your command line. For example, `ruby some_example.rb` will invoke `some_example.rb`.
<!--custom.instructions.end-->


### Tests

⚠ Running tests might result in charges to your AWS account.


To find instructions for running these tests, see the [README](../../README.md#Tests)
in the `ruby` folder.


<!--custom.tests.start-->

## Contribute
Code examples thrive on community contribution.

To learn more about the contributing process, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
<!--custom.tests.end-->

## Additional resources

<!--custom.resources.start-->
* [More Ruby Amazon RDS code examples](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/ruby_rds_code_examples.html)
* [SDK for Ruby Developer Guide](https://aws.amazon.com/developer/language/ruby/)
* [SDK for Ruby Amazon RDS Module](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS.html)
* [Amazon RDS Developer 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)
<!--custom.resources.end-->

---

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0