Interface ISecretsManagerSecretOptions

Options for referencing a secret value from Secrets Manager.

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ISecretsManagerSecretOptions

Syntax (vb)

Public Interface ISecretsManagerSecretOptions

Remarks

ExampleMetadata: infused

Examples

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" })
            });

Synopsis

Properties

JsonField	The key of a JSON field to retrieve.
VersionId	Specifies the unique identifier of the version of the secret you want to use.
VersionStage	Specifies the secret version that you want to retrieve by the staging label attached to the version.

Properties

JsonField

The key of a JSON field to retrieve.

string? JsonField { get; }

Property Value

string

Remarks

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

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

VersionId

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

string? VersionId { get; }

Property Value

string

Remarks

Can specify at most one of versionId and versionStage.

Default: AWSCURRENT

VersionStage

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

string? VersionStage { get; }

Property Value

string

Remarks

Can specify at most one of versionId and versionStage.

Default: AWSCURRENT