Amazon RDS code examples for the SDK for Kotlin

Overview

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

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

Code examples

Prerequisites

For prerequisites, see the README in the kotlin folder.

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

Basics

Code examples that show you how to perform the essential operations within a service.

• Learn the basics

Single actions

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

• CreateDBInstance
• DeleteDBInstance
• DescribeAccountAttributes
• DescribeDBInstances
• ModifyDBInstance

<!--custom.examples.start-->

Custom Examples

• Create an Amazon RDS snapshot (CreateDBSnapshot command)

<!--custom.examples.end-->

Run the examples

Instructions

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

Learn the basics

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

Tests

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

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

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

Additional resources

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

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

---

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

SPDX-License-Identifier: Apache-2.0