Class AwsSecretsManagerSecretsProvider

java.lang.Object
codes.grow.packages.awssecretsmanager.secrets.BaseSecretsProvider
codes.grow.packages.awssecretsmanager.AwsSecretsManagerSecretsProvider
All Implemented Interfaces:
SecretsProvider, AutoCloseable

public final class AwsSecretsManagerSecretsProvider extends BaseSecretsProvider
SecretsProvider (SPEC section 3) over AWS Secrets Manager. Capabilities: write, versions, delete.
  • Names are flat AWS secret names that may contain /: path + "/" + name when a path is given.
  • get(name, version) reads VersionId = version (stage labels: use AwsSecretsManagerClient.getSecretValue(String, GetSecretValueOptions)). A secret scheduled for deletion counts as missing.
  • set stores UTF-8 text as SecretString and other bytes as SecretBinary; it creates the secret when missing (with description and tags) and returns the new version id. cas is not supported (ValidationException).
  • delete schedules deletion with the recovery window (default 30 days); permanent deletes immediately. A name scheduled for deletion cannot be written again until it is restored or purged.
  • list(prefix) matches names by string prefix (recursive); getAll(path) returns the secrets directly under path (non-recursive).
  • Field Details

    • CAPABILITIES

      public static final List<String> CAPABILITIES
      Capabilities declared to the conformance runner.
  • Method Details

    • client

      public AwsSecretsManagerClient client()
      Returns the client this provider uses.
      Returns:
      the client
    • recoveryWindowDays

      public int recoveryWindowDays()
      Returns the recovery window of delete() in days.
      Returns:
      the window
    • fullName

      public static String fullName(String name, String path)
      Returns path/name when a path is given, otherwise name.
      Parameters:
      name - secret name
      path - folder, may be null
      Returns:
      the full name
    • toMetadata

      public static SecretMetadata toMetadata(SecretDescription d)
      Converts a description into SPEC metadata.
      Parameters:
      d - the description
      Returns:
      the metadata
    • fetchSecret

      protected Optional<SecretValue> fetchSecret(String name, GetOptions opts)
      Description copied from class: BaseSecretsProvider
      Reads one secret.
      Specified by:
      fetchSecret in class BaseSecretsProvider
      Parameters:
      name - full secret name (validated, non-empty)
      opts - version / path
      Returns:
      the value, or empty when missing
    • listSecrets

      protected List<SecretMetadata> listSecrets(String path)
      Description copied from class: BaseSecretsProvider
      Lists secrets under a prefix or folder (order does not matter; the base class sorts).
      Specified by:
      listSecrets in class BaseSecretsProvider
      Parameters:
      path - prefix or folder, "" for the root
      Returns:
      the metadata with full names
    • getAll

      public Map<String,SecretValue> getAll(String path)
      Returns every secret directly under path (non-recursive), keyed by full name, read with BatchGetSecretValue.
      Specified by:
      getAll in interface SecretsProvider
      Overrides:
      getAll in class BaseSecretsProvider
      Parameters:
      path - folder / prefix; empty for the root
      Returns:
      full name to value
    • getMany

      public Map<String,SecretValue> getMany(List<String> names, GetOptions opts)
      Returns the present secrets in request order (BatchGetSecretValue in chunks of 20; per-name reads when a version is requested).
      Parameters:
      names - full secret names
      opts - version / path applied to each
      Returns:
      name to value
    • putSecret

      protected String putSecret(String name, byte[] value, SetOptions opts)
      Description copied from class: BaseSecretsProvider
      Writes a secret.
      Specified by:
      putSecret in class BaseSecretsProvider
      Parameters:
      name - full secret name
      value - bytes to store
      opts - path / cas / tags / description
      Returns:
      the new version, or ""
    • removeSecret

      protected void removeSecret(String name, DeleteOptions opts)
      Description copied from class: BaseSecretsProvider
      Deletes a secret.
      Specified by:
      removeSecret in class BaseSecretsProvider
      Parameters:
      name - full secret name
      opts - path / versions / permanent
    • fetchMetadata

      protected Optional<SecretMetadata> fetchMetadata(String name, GetOptions opts)
      Description copied from class: BaseSecretsProvider
      Reads metadata.
      Specified by:
      fetchMetadata in class BaseSecretsProvider
      Parameters:
      name - full secret name
      opts - version / path
      Returns:
      the metadata, or empty when missing
    • close

      public void close()
      Stops the watchers of this provider. Idempotent.
      Specified by:
      close in interface AutoCloseable
      Overrides:
      close in class BaseSecretsProvider