software.amazon.cryptography.materialproviders.model

Interface CreateAwsKmsHierarchicalKeyringInput.Builder

Enclosing class:

CreateAwsKmsHierarchicalKeyringInput

public static interface CreateAwsKmsHierarchicalKeyringInput.Builder

Method Summary

Modifier and Type	Method and Description
java.lang.String	branchKeyId()
CreateAwsKmsHierarchicalKeyringInput.Builder	branchKeyId(java.lang.String branchKeyId)
IBranchKeyIdSupplier	branchKeyIdSupplier()
CreateAwsKmsHierarchicalKeyringInput.Builder	branchKeyIdSupplier(IBranchKeyIdSupplier branchKeyIdSupplier)
CreateAwsKmsHierarchicalKeyringInput	build()
CacheType	cache()
CreateAwsKmsHierarchicalKeyringInput.Builder	cache(CacheType cache)
KeyStore	keyStore()
CreateAwsKmsHierarchicalKeyringInput.Builder	keyStore(KeyStore keyStore)
java.lang.String	partitionId()
CreateAwsKmsHierarchicalKeyringInput.Builder	partitionId(java.lang.String partitionId)
long	ttlSeconds()
CreateAwsKmsHierarchicalKeyringInput.Builder	ttlSeconds(long ttlSeconds)

Method Detail

branchKeyId

CreateAwsKmsHierarchicalKeyringInput.Builder branchKeyId(java.lang.String branchKeyId)

Parameters:

branchKeyId - The identifier for the single Branch Key responsible for wrapping and unwrapping the data key. Either a Branch Key ID or Branch Key Supplier must be specified.

branchKeyId

java.lang.String branchKeyId()

Returns:

The identifier for the single Branch Key responsible for wrapping and unwrapping the data key. Either a Branch Key ID or Branch Key Supplier must be specified.

branchKeyIdSupplier

CreateAwsKmsHierarchicalKeyringInput.Builder branchKeyIdSupplier(IBranchKeyIdSupplier branchKeyIdSupplier)

Parameters:

branchKeyIdSupplier - A Branch Key Supplier which determines what Branch Key to use to wrap and unwrap the data key. Either a Branch Key ID or Branch Key Supplier must be specified.

branchKeyIdSupplier

IBranchKeyIdSupplier branchKeyIdSupplier()

Returns:

A Branch Key Supplier which determines what Branch Key to use to wrap and unwrap the data key. Either a Branch Key ID or Branch Key Supplier must be specified.

keyStore

CreateAwsKmsHierarchicalKeyringInput.Builder keyStore(KeyStore keyStore)

Parameters:

keyStore - The Key Store which contains the Branch Key(s) responsible for wrapping and unwrapping data keys.

keyStore

KeyStore keyStore()

Returns:

The Key Store which contains the Branch Key(s) responsible for wrapping and unwrapping data keys.

ttlSeconds

CreateAwsKmsHierarchicalKeyringInput.Builder ttlSeconds(long ttlSeconds)

Parameters:

ttlSeconds - How many seconds the Branch Key material is allowed to be reused within the local cache before it is re-retrieved from Amazon DynamoDB and re-authenticated with AWS KMS.

ttlSeconds

long ttlSeconds()

Returns:

How many seconds the Branch Key material is allowed to be reused within the local cache before it is re-retrieved from Amazon DynamoDB and re-authenticated with AWS KMS.

cache

CreateAwsKmsHierarchicalKeyringInput.Builder cache(CacheType cache)

Parameters:

cache - Sets the type of cache for this Hierarchical Keyring. By providing an already initialized 'Shared' cache, users can determine the scope of the cache. That is, if the cache is shared across other Cryptographic Material Providers, for instance other Hierarchical Keyrings or Caching Cryptographic Materials Managers (Caching CMMs). If any other type of cache in the CacheType union is provided, the Hierarchical Keyring will initialize a cache of that type, to be used with only this Hierarchical Keyring. If not set, a DefaultCache is initialized to be used with only this Hierarchical Keyring with entryCapacity = 1000.

cache

CacheType cache()

Returns:

Sets the type of cache for this Hierarchical Keyring. By providing an already initialized 'Shared' cache, users can determine the scope of the cache. That is, if the cache is shared across other Cryptographic Material Providers, for instance other Hierarchical Keyrings or Caching Cryptographic Materials Managers (Caching CMMs). If any other type of cache in the CacheType union is provided, the Hierarchical Keyring will initialize a cache of that type, to be used with only this Hierarchical Keyring. If not set, a DefaultCache is initialized to be used with only this Hierarchical Keyring with entryCapacity = 1000.

partitionId

CreateAwsKmsHierarchicalKeyringInput.Builder partitionId(java.lang.String partitionId)

Parameters:

partitionId - Partition ID to distinguish Cryptographic Material Providers (i.e: Keyrings) writing to a cache. If the Partition ID is the same for two Hierarchical Keyrings (or another Material Provider), they can share the same cache entries in the cache.

partitionId

java.lang.String partitionId()

Returns:

Partition ID to distinguish Cryptographic Material Providers (i.e: Keyrings) writing to a cache. If the Partition ID is the same for two Hierarchical Keyrings (or another Material Provider), they can share the same cache entries in the cache.

build

CreateAwsKmsHierarchicalKeyringInput build()