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

Linear Supertypes
Serializable, Product, Equals, EnterpriseOnlyCantonConfigValidation, PredicatedCantonConfigValidation, CustomCantonConfigValidation, CantonConfigValidation, KmsConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Aws
  2. Serializable
  3. Product
  4. Equals
  5. EnterpriseOnlyCantonConfigValidation
  6. PredicatedCantonConfigValidation
  7. CustomCantonConfigValidation
  8. CantonConfigValidation
  9. KmsConfig
  10. AnyRef
  11. 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 allowThisInCommunity: Boolean
    Attributes
    protected
    Definition Classes
    EnterpriseOnlyCantonConfigValidation → PredicatedCantonConfigValidation
  5. def allowThisInEnterprise: Boolean
    Attributes
    protected
    Definition Classes
    PredicatedCantonConfigValidation
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val auditLogging: Boolean
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  9. val disableSslVerification: Boolean
  10. def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]

    Returns all validation errors that are specific to this Canton configuration class.

    Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.

    Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.

    Attributes
    protected
    Definition Classes
    PredicatedCantonConfigValidation → CustomCantonConfigValidation
  11. val endpointOverride: Option[String]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val multiRegionKey: Boolean
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val region: String
  21. val retries: RetryConfig

    Retry configuration for KMS operations

    Retry configuration for KMS operations

    Definition Classes
    Aws → KmsConfig
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def validate[T >: Aws.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
    Definition Classes
    CantonConfigValidation
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. 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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from EnterpriseOnlyCantonConfigValidation

Inherited from PredicatedCantonConfigValidation

Inherited from CustomCantonConfigValidation

Inherited from CantonConfigValidation

Inherited from KmsConfig

Inherited from AnyRef

Inherited from Any

Ungrouped