Interface KeyLookupOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
KeyLookupOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:17.463Z") @Stability(Stable) public interface KeyLookupOptions extends software.amazon.jsii.JsiiSerializable
Properties for looking up an existing Key.

Example:

 IKey myKeyLookup = Key.fromLookup(this, "MyKeyLookup", KeyLookupOptions.builder()
         .aliasName("alias/KeyAlias")
         .build());
 Role role = Role.Builder.create(this, "MyRole")
         .assumedBy(new ServicePrincipal("lambda.amazonaws.com"))
         .build();
 myKeyLookup.grantEncryptDecrypt(role);
 
  • Method Details

    • getAliasName

      @Stability(Stable) @NotNull String getAliasName()
      The alias name of the Key.

      Must be in the format alias/<AliasName>.

    • getReturnDummyKeyOnMissing

      @Stability(Stable) @Nullable default Boolean getReturnDummyKeyOnMissing()
      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.

      Default: false

    • builder

      @Stability(Stable) static KeyLookupOptions.Builder builder()
      Returns:
      a KeyLookupOptions.Builder of KeyLookupOptions