software.amazon.cryptography.keystore

Class KeyStore

java.lang.Object

software.amazon.cryptography.keystore.KeyStore

public class KeyStore
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeyStore.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyStore(software.amazon.cryptography.keystore.KeyStore.BuilderImpl builder)

Method Summary

Modifier and Type	Method and Description
static KeyStore.Builder	builder()
CreateKeyOutput	CreateKey(CreateKeyInput input) Create a new Branch Key in the Key Store.
CreateKeyStoreOutput	CreateKeyStore(CreateKeyStoreInput input) Create the DynamoDB table that backs this Key Store based on the Key Store configuration.
GetActiveBranchKeyOutput	GetActiveBranchKey(GetActiveBranchKeyInput input) Get the ACTIVE version for a particular Branch Key from the Key Store.
GetBeaconKeyOutput	GetBeaconKey(GetBeaconKeyInput input) Get a Beacon Key from the Key Store.
GetBranchKeyVersionOutput	GetBranchKeyVersion(GetBranchKeyVersionInput input) Get a particular version of a Branch Key from the Key Store.
GetKeyStoreInfoOutput	GetKeyStoreInfo() Returns the configuration information for a Key Store.
protected IKeyStoreClient	impl()
VersionKeyOutput	VersionKey(VersionKeyInput input) Create a new ACTIVE version of an existing Branch Key in the Key Store, and set the previously ACTIVE version to DECRYPT_ONLY.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyStore

protected KeyStore(software.amazon.cryptography.keystore.KeyStore.BuilderImpl builder)

Method Detail

builder

public static KeyStore.Builder builder()

CreateKey

public CreateKeyOutput CreateKey(CreateKeyInput input)

Create a new Branch Key in the Key Store. Additionally create a Beacon Key that is tied to this Branch Key.

Returns:

Outputs for Branch Key creation.

CreateKeyStore

public CreateKeyStoreOutput CreateKeyStore(CreateKeyStoreInput input)

Create the DynamoDB table that backs this Key Store based on the Key Store configuration. If a table already exists, validate it is configured as expected.

Returns:

Outputs for Key Store DynamoDB table creation.

GetActiveBranchKey

public GetActiveBranchKeyOutput GetActiveBranchKey(GetActiveBranchKeyInput input)

Get the ACTIVE version for a particular Branch Key from the Key Store.

Parameters:

input - Inputs for getting a Branch Key's ACTIVE version.

Returns:

Outputs for getting a Branch Key's ACTIVE version.

GetBeaconKey

public GetBeaconKeyOutput GetBeaconKey(GetBeaconKeyInput input)

Get a Beacon Key from the Key Store.

Parameters:

input - Inputs for getting a Beacon Key

Returns:

Outputs for getting a Beacon Key

GetBranchKeyVersion

public GetBranchKeyVersionOutput GetBranchKeyVersion(GetBranchKeyVersionInput input)

Get a particular version of a Branch Key from the Key Store.

Parameters:

input - Inputs for getting a version of a Branch Key.

Returns:

Outputs for getting a version of a Branch Key.

GetKeyStoreInfo

public GetKeyStoreInfoOutput GetKeyStoreInfo()

Returns the configuration information for a Key Store.

Returns:

The configuration information for a Key Store.

VersionKey

public VersionKeyOutput VersionKey(VersionKeyInput input)

Create a new ACTIVE version of an existing Branch Key in the Key Store, and set the previously ACTIVE version to DECRYPT_ONLY.

Parameters:

input - Inputs for versioning a Branch Key.

Returns:

Outputs for versioning a Branch Key.

impl

protected IKeyStoreClient impl()