aws-cdk-lib.SecretsManagerSecretOptions

SecretsManagerSecretOptions Struct

Options for referencing a secret value from Secrets Manager.

Source

core/lib/secret-value.ts

Example

new codebuild.BitBucketSourceCredentials(this, 'CodeBuildBitBucketCreds', {
  username: SecretValue.secretsManager('my-bitbucket-creds', { jsonField: 'username' }),
  password: SecretValue.secretsManager('my-bitbucket-creds', { jsonField: 'password' }),
});

Properties

jsonField?optionalstringjson_field?optionalstrjsonField?optionalStringJsonField?optionalstringJsonField?optional*string#

The key of a JSON field to retrieve.

Default: returns all the content stored in the Secrets Manager secret.

This can only be used if the secret stores a JSON object.

versionId?optionalstringversion_id?optionalstrversionId?optionalStringVersionId?optionalstringVersionId?optional*string= AWSCURRENT#

Specifies the unique identifier of the version of the secret you want to use.

Can specify at most one of versionId and versionStage.

versionStage?optionalstringversion_stage?optionalstrversionStage?optionalStringVersionStage?optionalstringVersionStage?optional*string= AWSCURRENT#

Specifies the secret version that you want to retrieve by the staging label attached to the version.

Can specify at most one of versionId and versionStage.