AWS KMS code examples for the SDK for Ruby

Overview

Shows how to use the AWS SDK for Ruby to work with AWS Key Management Service (AWS KMS).

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

AWS KMS is an encryption and key management service scaled for 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 ruby folder.

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

Single actions

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

• CreateKey
• Decrypt
• Encrypt
• ReEncrypt

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

Run the examples

Instructions

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

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.

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

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.

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

Contribute

Code examples thrive on community contribution.

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

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

Additional resources

• AWS KMS Developer Guide
• AWS KMS API Reference
• SDK for Ruby AWS KMS reference

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

---

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

SPDX-License-Identifier: Apache-2.0