AWS KMS code examples for the SDK for Java 2.x

Overview

Shows how to use the AWS SDK for Java 2.x 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 javav2 folder.

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

Get started

• Hello AWS KMS (ListKeys)

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.

• CreateAlias
• CreateGrant
• CreateKey
• Decrypt
• DeleteAlias
• DescribeKey
• DisableKey
• EnableKey
• Encrypt
• ListAliases
• ListGrants
• ListKeyPolicies
• ListKeys
• RevokeGrant
• ScheduleKeyDeletion
• Sign
• TagResource

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

Run the examples

Instructions

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

Hello AWS KMS

This example shows you how to get started using AWS KMS.

Learn the basics

This example shows you how to do the following:

• Create a KMS key.
• List KMS keys for your account and get details about them.
• Enable and disable KMS keys.
• Generate a symmetric data key that can be used for client-side encryption.
• Generate an asymmetric key used to digitally sign data.
• Tag keys.
• Delete KMS keys.

<!--custom.basic_prereqs.kms_Scenario_Basics.start--> <!--custom.basic_prereqs.kms_Scenario_Basics.end--> <!--custom.basics.kms_Scenario_Basics.start--> <!--custom.basics.kms_Scenario_Basics.end-->

Tests

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

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

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

Additional resources

• AWS KMS Developer Guide
• AWS KMS API Reference
• SDK for Java 2.x 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