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' }),
});

codebuild.BitBucketSourceCredentials(self, "CodeBuildBitBucketCreds",
    username=SecretValue.secrets_manager("my-bitbucket-creds", json_field="username"),
    password=SecretValue.secrets_manager("my-bitbucket-creds", json_field="password")
)

BitBucketSourceCredentials.Builder.create(this, "CodeBuildBitBucketCreds")
        .username(SecretValue.secretsManager("my-bitbucket-creds", SecretsManagerSecretOptions.builder().jsonField("username").build()))
        .password(SecretValue.secretsManager("my-bitbucket-creds", SecretsManagerSecretOptions.builder().jsonField("password").build()))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
new BitBucketSourceCredentials(this, "CodeBuildBitBucketCreds", new BitBucketSourceCredentialsProps {
    Username = SecretValue.SecretsManager("my-bitbucket-creds", new SecretsManagerSecretOptions { JsonField = "username" }),
    Password = SecretValue.SecretsManager("my-bitbucket-creds", new SecretsManagerSecretOptions { JsonField = "password" })
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
codebuild.NewBitBucketSourceCredentials(this, jsii.String("CodeBuildBitBucketCreds"), &BitBucketSourceCredentialsProps{
	Username: awscdk.SecretValue_SecretsManager(jsii.String("my-bitbucket-creds"), &SecretsManagerSecretOptions{
		JsonField: jsii.String("username"),
	}),
	Password: awscdk.SecretValue_*SecretsManager(jsii.String("my-bitbucket-creds"), &SecretsManagerSecretOptions{
		JsonField: jsii.String("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.