Package software.amazon.awscdk

Interface SecretsManagerSecretOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SecretsManagerSecretOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:22.322Z")
@Stability(Stable)
public interface SecretsManagerSecretOptions
extends software.amazon.jsii.JsiiSerializable

Options for referencing a secret value from Secrets Manager.

Example:

 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SecretsManagerSecretOptions.Builder	A builder for SecretsManagerSecretOptions
static final class	SecretsManagerSecretOptions.Jsii$Proxy	An implementation for SecretsManagerSecretOptions

Method Summary

Modifier and Type	Method	Description
static SecretsManagerSecretOptions.Builder	builder()
default String	getJsonField()	The key of a JSON field to retrieve.
default String	getVersionId()	Specifies the unique identifier of the version of the secret you want to use.
default String	getVersionStage()	Specifies the secret version that you want to retrieve by the staging label attached to the version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getJsonField

@Stability(Stable)
@Nullable
default String getJsonField()

The key of a JSON field to retrieve.

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

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

getVersionId

@Stability(Stable)
@Nullable
default String getVersionId()

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

Can specify at most one of versionId and versionStage.

Default: AWSCURRENT

getVersionStage

@Stability(Stable)
@Nullable
default String getVersionStage()

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.

Default: AWSCURRENT

builder

@Stability(Stable)
static SecretsManagerSecretOptions.Builder builder()

Returns:

a SecretsManagerSecretOptions.Builder of SecretsManagerSecretOptions