Package software.amazon.awscdk.services.kms

Class KeyLookupOptions.Builder

java.lang.Object
software.amazon.awscdk.services.kms.KeyLookupOptions.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<KeyLookupOptions>
Enclosing interface:
KeyLookupOptions
@Stability(Stable) public static final class KeyLookupOptions.Builder extends Object implements software.amazon.jsii.Builder<KeyLookupOptions>
A builder for KeyLookupOptions

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • aliasName

      @Stability(Stable) public KeyLookupOptions.Builder aliasName(String aliasName)
      Sets the value of KeyLookupOptions.getAliasName()
      Parameters:
      aliasName - The alias name of the Key. This parameter is required. Must be in the format alias/<AliasName>.
      Returns:
      this

    • returnDummyKeyOnMissing

      @Stability(Stable) public KeyLookupOptions.Builder returnDummyKeyOnMissing(Boolean returnDummyKeyOnMissing)
      Sets the value of KeyLookupOptions.getReturnDummyKeyOnMissing()
      Parameters:
      returnDummyKeyOnMissing - Whether to return a dummy key if the key was not found. If it is set to true and the key was not found, a dummy key with a key id '1234abcd-12ab-34cd-56ef-1234567890ab' will be returned. The value of the dummy key id can also be referenced using the Key.DEFAULT_DUMMY_KEY_ID variable, and you can check if the key is a dummy key by using the Key.isLookupDummy() method.
      Returns:
      this

    • build

      @Stability(Stable) public KeyLookupOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<KeyLookupOptions>
      Returns:
      a new instance of KeyLookupOptions
      Throws:
      NullPointerException - if any required attribute was not provided