Type Members

1.  final case class Aws(region: String, multiRegionKey: Boolean = false, auditLogging: Boolean = false, retries: RetryConfig = RetryConfig(), disableSslVerification: Boolean = false, endpointOverride: Option[String] = None) extends KmsConfig with Product with Serializable

   Stores the configuration for AWS KMS.

   Stores the configuration for AWS KMS. This configuration is mandatory if we want to protect Canton's private keys using an AWS KMS.

   region

   defines the AWS region to be use (e.g. us-east-1)

   multiRegionKey

   flag to enable multiRegion keys (Canton will generate single region keys by default)

   auditLogging

   when enabled, all calls to KMS will be logged. Defaults to false.

   retries

   retry configuration

   disableSslVerification

   When set to true, SSL verification is disabled. Mostly for testing purposes. Can only be used if non-standard-config is enabled.

   endpointOverride

   the [optional] endpoint for a proxy to be used by the KMS client.

2.  final case class CreateKeyRetriesConfig(interval: NonNegativeDuration = waitCreateIntervalDefault, timeout: NonNegativeDuration = waitCreateTimeoutDefault) extends Product with Serializable

   Retry configuration when waiting for a newly created key to exist

   Retry configuration when waiting for a newly created key to exist

   interval

   interval between retries

   timeout

   maximum amount of time to wait for the key to be created

3.  final case class ExponentialBackoffConfig(initialDelay: NonNegativeFiniteDuration = initialDelayDefault, maxDelay: NonNegativeDuration = maxDelayDefault, maxRetries: Int = retry.Forever) extends Product with Serializable

   Exponential backoff configuration for retries of network failures

   Exponential backoff configuration for retries of network failures

   initialDelay

   initial delay before the first retry

   maxDelay

   max delay between retries

   maxRetries

   max number of retries

4.  final case class Gcp(locationId: String, projectId: String, keyRingId: String, retries: RetryConfig = RetryConfig()) extends KmsConfig with Product with Serializable

   Stores the configuration for GCP KMS.

   Stores the configuration for GCP KMS. This configuration is mandatory if we want to protect Canton's private keys using a GCP KMS.

   locationId

   defines the GCP region to use (e.g. us-east1)

   projectId

   defines a GCP project to use (e.g. gcp-kms-testing)

   keyRingId

   defines a key-ring to where keys will be added. This can be created as a multi-region key-ring, which enables multi-region keys

   retries

   retry configuration

5.  final case class RetryConfig(failures: ExponentialBackoffConfig = ExponentialBackoffConfig(), createKey: CreateKeyRetriesConfig = CreateKeyRetriesConfig()) extends Product with Serializable

   Retry configuration for KMS operations

   Retry configuration for KMS operations

   failures

   exponential backoff retry configuration for retryable failures

   createKey

   fixed rate retry configuration when waiting for a newly created key to exist in the KMS