@secret-kernel/provider-aws-parameter-store
v0.1.0-alpha.7
Published
AWS Parameter Store provider for Secret Kernel.
Maintainers
Readme
@secret-kernel/provider-aws-parameter-store
AWS Parameter Store provider for Secret Kernel.
npm install @secret-kernel/contracts @secret-kernel/provider-aws-parameter-storeUsage
import { createAwsParameterStoreClient } from '@secret-kernel/provider-aws-parameter-store';
const client = createAwsParameterStoreClient(
{
env: 'prod',
prefix: 'app',
},
{
region: 'us-east-1',
},
);
const secret = await client.getSecret('database/password');The provider reads decrypted SecureString values from AWS Parameter Store using WithDecryption: true.
Options
region: AWS region. Default:us-east-1, not the SDK's region chain —AWS_REGIONand the shared config file are not read. Passingundefined,nullor blank text throwsSecretKernelConfigurationError.credentials: explicit AWS credentials. When omitted, the AWS SDK default credential chain is used.client: custom SSM-compatible client (@aws-sdk/client-ssm).clientOptions: extra options passed to the AWS SDK client.physicalNameSeparator: separator used for the physical AWS parameter name. Supported values are/,_and-. Default:/.
By default, the provider keeps the logical Secret Kernel name as an AWS parameter path, such as /dev/app/database/password.
With physicalNameSeparator: '_', /dev/app/database/password becomes dev_app_database_password.
