Class AwsSecretsManagerSecretsProvider
java.lang.Object
codes.grow.packages.awssecretsmanager.secrets.BaseSecretsProvider
codes.grow.packages.awssecretsmanager.AwsSecretsManagerSecretsProvider
- All Implemented Interfaces:
SecretsProvider,AutoCloseable
SecretsProvider (SPEC section 3) over AWS Secrets Manager. Capabilities: write,
versions, delete.
- Names are flat AWS secret names that may contain
/:path + "/" + namewhen a path is given. get(name, version)readsVersionId = version(stage labels: useAwsSecretsManagerClient.getSecretValue(String, GetSecretValueOptions)). A secret scheduled for deletion counts as missing.setstores UTF-8 text asSecretStringand other bytes asSecretBinary; it creates the secret when missing (with description and tags) and returns the new version id.casis not supported (ValidationException).deleteschedules deletion with the recovery window (default 30 days);permanentdeletes 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 underpath(non-recursive).
-
Field Summary
FieldsModifier and TypeFieldDescriptionCapabilities declared to the conformance runner.Fields inherited from interface codes.grow.packages.awssecretsmanager.secrets.SecretsProvider
NUMBER -
Method Summary
Modifier and TypeMethodDescriptionclient()Returns the client this provider uses.voidclose()Stops the watchers of this provider.protected Optional<SecretMetadata> fetchMetadata(String name, GetOptions opts) Reads metadata.protected Optional<SecretValue> fetchSecret(String name, GetOptions opts) Reads one secret.static StringReturnspath/namewhen a path is given, otherwisename.Returns every secret directly underpath(non-recursive), keyed by full name, read withBatchGetSecretValue.getMany(List<String> names, GetOptions opts) Returns the present secrets in request order (BatchGetSecretValuein chunks of 20; per-name reads when aversionis requested).protected List<SecretMetadata> listSecrets(String path) Lists secrets under a prefix or folder (order does not matter; the base class sorts).protected StringputSecret(String name, byte[] value, SetOptions opts) Writes a secret.intReturns the recovery window ofdelete()in days.protected voidremoveSecret(String name, DeleteOptions opts) Deletes a secret.static SecretMetadataConverts a description into SPEC metadata.Methods inherited from class codes.grow.packages.awssecretsmanager.secrets.BaseSecretsProvider
delete, ensureOpen, get, isClosed, list, metadata, set, toBytes, watchMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface codes.grow.packages.awssecretsmanager.secrets.SecretsProvider
asyncExecutor, delete, deleteAsync, exists, exists, existsAsync, get, getAllAsync, getAsync, getBool, getBool, getBoolAsync, getJson, getJson, getJson, getJsonAsync, getMany, getManyAsync, getNumber, getNumber, getNumberAsync, getString, getString, getStringAsync, list, listAsync, loadEnv, loadEnv, metadata, metadataAsync, require, require, requireAsync, set, setAsync, watch
-
Field Details
-
CAPABILITIES
Capabilities declared to the conformance runner.
-
-
Method Details
-
client
Returns the client this provider uses.- Returns:
- the client
-
recoveryWindowDays
public int recoveryWindowDays()Returns the recovery window ofdelete()in days.- Returns:
- the window
-
fullName
Returnspath/namewhen a path is given, otherwisename.- Parameters:
name- secret namepath- folder, may be null- Returns:
- the full name
-
toMetadata
Converts a description into SPEC metadata.- Parameters:
d- the description- Returns:
- the metadata
-
fetchSecret
Description copied from class:BaseSecretsProviderReads one secret.- Specified by:
fetchSecretin classBaseSecretsProvider- Parameters:
name- full secret name (validated, non-empty)opts- version / path- Returns:
- the value, or empty when missing
-
listSecrets
Description copied from class:BaseSecretsProviderLists secrets under a prefix or folder (order does not matter; the base class sorts).- Specified by:
listSecretsin classBaseSecretsProvider- Parameters:
path- prefix or folder,""for the root- Returns:
- the metadata with full names
-
getAll
Returns every secret directly underpath(non-recursive), keyed by full name, read withBatchGetSecretValue.- Specified by:
getAllin interfaceSecretsProvider- Overrides:
getAllin classBaseSecretsProvider- Parameters:
path- folder / prefix; empty for the root- Returns:
- full name to value
-
getMany
Returns the present secrets in request order (BatchGetSecretValuein chunks of 20; per-name reads when aversionis requested).- Parameters:
names- full secret namesopts- version / path applied to each- Returns:
- name to value
-
putSecret
Description copied from class:BaseSecretsProviderWrites a secret.- Specified by:
putSecretin classBaseSecretsProvider- Parameters:
name- full secret namevalue- bytes to storeopts- path / cas / tags / description- Returns:
- the new version, or
""
-
removeSecret
Description copied from class:BaseSecretsProviderDeletes a secret.- Specified by:
removeSecretin classBaseSecretsProvider- Parameters:
name- full secret nameopts- path / versions / permanent
-
fetchMetadata
Description copied from class:BaseSecretsProviderReads metadata.- Specified by:
fetchMetadatain classBaseSecretsProvider- Parameters:
name- full secret nameopts- version / path- Returns:
- the metadata, or empty when missing
-
close
public void close()Stops the watchers of this provider. Idempotent.- Specified by:
closein interfaceAutoCloseable- Overrides:
closein classBaseSecretsProvider
-