Class EncryptionConfiguration


  • public final class EncryptionConfiguration
    extends Object
    Definition of CMK for the factory.
    • Constructor Detail

      • EncryptionConfiguration

        public EncryptionConfiguration()
    • Method Detail

      • keyName

        public String keyName()
        Get the keyName property: The name of the key in Azure Key Vault to use as Customer Managed Key.
        Returns:
        the keyName value.
      • withKeyName

        public EncryptionConfiguration withKeyName​(String keyName)
        Set the keyName property: The name of the key in Azure Key Vault to use as Customer Managed Key.
        Parameters:
        keyName - the keyName value to set.
        Returns:
        the EncryptionConfiguration object itself.
      • vaultBaseUrl

        public String vaultBaseUrl()
        Get the vaultBaseUrl property: The url of the Azure Key Vault used for CMK.
        Returns:
        the vaultBaseUrl value.
      • withVaultBaseUrl

        public EncryptionConfiguration withVaultBaseUrl​(String vaultBaseUrl)
        Set the vaultBaseUrl property: The url of the Azure Key Vault used for CMK.
        Parameters:
        vaultBaseUrl - the vaultBaseUrl value to set.
        Returns:
        the EncryptionConfiguration object itself.
      • keyVersion

        public String keyVersion()
        Get the keyVersion property: The version of the key used for CMK. If not provided, latest version will be used.
        Returns:
        the keyVersion value.
      • withKeyVersion

        public EncryptionConfiguration withKeyVersion​(String keyVersion)
        Set the keyVersion property: The version of the key used for CMK. If not provided, latest version will be used.
        Parameters:
        keyVersion - the keyVersion value to set.
        Returns:
        the EncryptionConfiguration object itself.
      • identity

        public CmkIdentityDefinition identity()
        Get the identity property: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.
        Returns:
        the identity value.
      • withIdentity

        public EncryptionConfiguration withIdentity​(CmkIdentityDefinition identity)
        Set the identity property: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.
        Parameters:
        identity - the identity value to set.
        Returns:
        the EncryptionConfiguration object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.