AWS CDK Reference

Appearance

v2.274.0

SecretsManagerSecretOptions Struct ​

Options for referencing a secret value from Secrets Manager.

Source
core/lib/secret-value.ts

Example ​

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

Properties ​

jsonFieldstringjson_fieldstrjsonFieldStringJsonFieldstringJsonField*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.

versionIdstringversion_idstrversionIdStringVersionIdstringVersionId*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.

versionStagestringversion_stagestrversionStageStringVersionStagestringVersionStage*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.