software.amazon.cryptography.keystore.model

Interface KMSConfiguration.Builder

Enclosing class:

KMSConfiguration

public static interface KMSConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
KMSConfiguration	build()
Discovery	discovery()
KMSConfiguration.Builder	discovery(Discovery discovery)
java.lang.String	kmsKeyArn()
KMSConfiguration.Builder	kmsKeyArn(java.lang.String kmsKeyArn)
java.lang.String	kmsMRKeyArn()
KMSConfiguration.Builder	kmsMRKeyArn(java.lang.String kmsMRKeyArn)
MRDiscovery	mrDiscovery()
KMSConfiguration.Builder	mrDiscovery(MRDiscovery mrDiscovery)

Method Detail

kmsKeyArn

KMSConfiguration.Builder kmsKeyArn(java.lang.String kmsKeyArn)

Parameters:

kmsKeyArn - Key Store is restricted to only this KMS Key ARN. If a different KMS Key ARN is encountered when creating, versioning, or getting a Branch Key or Beacon Key, KMS is never called and an exception is thrown. While a Multi-Region Key (MKR) may be provided, the whole ARN, including the Region, is persisted in Branch Keys and MUST strictly equal this value to be considered valid.

kmsKeyArn

java.lang.String kmsKeyArn()

Returns:

Key Store is restricted to only this KMS Key ARN. If a different KMS Key ARN is encountered when creating, versioning, or getting a Branch Key or Beacon Key, KMS is never called and an exception is thrown. While a Multi-Region Key (MKR) may be provided, the whole ARN, including the Region, is persisted in Branch Keys and MUST strictly equal this value to be considered valid.

kmsMRKeyArn

KMSConfiguration.Builder kmsMRKeyArn(java.lang.String kmsMRKeyArn)

Parameters:

kmsMRKeyArn - If an MRK ARN is provided, and the Key Store table holds an MRK ARN, then those two ARNs may differ in region, although they must be otherwise equal. If either ARN is not an MRK ARN, then mrkKmsKeyArn behaves exactly as kmsKeyArn.

kmsMRKeyArn

java.lang.String kmsMRKeyArn()

Returns:

If an MRK ARN is provided, and the Key Store table holds an MRK ARN, then those two ARNs may differ in region, although they must be otherwise equal. If either ARN is not an MRK ARN, then mrkKmsKeyArn behaves exactly as kmsKeyArn.

discovery

KMSConfiguration.Builder discovery(Discovery discovery)

Parameters:

discovery - The Key Store can use the KMS Key ARNs already persisted in the Backing Table. The VersionKey and CreateKey Operations are NOT supported and will fail with a runtime exception. There is no Multi-Region logic with this configuration; if a Multi-Region Key is encountered, and the region in the ARN is not the region of the KMS Client, requests will Fail with KMS Exceptions.

discovery

Discovery discovery()

Returns:

The Key Store can use the KMS Key ARNs already persisted in the Backing Table. The VersionKey and CreateKey Operations are NOT supported and will fail with a runtime exception. There is no Multi-Region logic with this configuration; if a Multi-Region Key is encountered, and the region in the ARN is not the region of the KMS Client, requests will Fail with KMS Exceptions.

mrDiscovery

KMSConfiguration.Builder mrDiscovery(MRDiscovery mrDiscovery)

Parameters:

mrDiscovery - The Key Store can use the KMS Key ARNs already persisted in the Backing Table. The VersionKey and CreateKey Operations are NOT supported and will fail with a runtime exception. If a Multi-Region Key is encountered, the region in the ARN is changed to the configured region.

mrDiscovery

MRDiscovery mrDiscovery()

Returns:

The Key Store can use the KMS Key ARNs already persisted in the Backing Table. The VersionKey and CreateKey Operations are NOT supported and will fail with a runtime exception. If a Multi-Region Key is encountered, the region in the ARN is changed to the configured region.

build

KMSConfiguration build()