Packages

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. 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.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Aws
  2. Serializable
  3. Product
  4. Equals
  5. KmsConfig
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Aws(region: String, multiRegionKey: Boolean = false, auditLogging: Boolean = false, retries: RetryConfig = RetryConfig(), disableSslVerification: Boolean = false, endpointOverride: Option[String] = None)

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val auditLogging: Boolean
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. val disableSslVerification: Boolean
  8. val endpointOverride: Option[String]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val multiRegionKey: Boolean
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val region: String
  18. val retries: RetryConfig

    Retry configuration for KMS operations

    Retry configuration for KMS operations

    Definition Classes
    AwsKmsConfig
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from KmsConfig

Inherited from AnyRef

Inherited from Any

Ungrouped