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

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. For more details, see AWS Pricing and Free Tier.
• 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

Prerequisites

For prerequisites, see the README in the ruby folder.

Get started

• Hello Amazon RDS (DescribeDBInstances)

Single actions

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

• CreateDBSnapshot
• DescribeDBInstances
• DescribeDBParameterGroups
• DescribeDBParameters
• DescribeDBSnapshots

Run the examples

Instructions

The quickest way to interact with this example code is to invoke a Single Action from your command line. For example, ruby some_example.rb will invoke some_example.rb.

Hello Amazon RDS

This example shows you how to get started using Amazon RDS.

ruby hello/hello_rds.rb

Tests

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

To find instructions for running these tests, see the README in the ruby folder.

Contribute

Code examples thrive on community contribution.

To learn more about the contributing process, see CONTRIBUTING.md.

Additional resources

• Amazon RDS User Guide
• Amazon RDS API Reference
• SDK for Ruby Amazon RDS reference

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

SPDX-License-Identifier: Apache-2.0