SecretsManagerSecretOptions

class aws_cdk.core.SecretsManagerSecretOptions(*, json_field=None, version_id=None, version_stage=None)

Bases: object

Options for referencing a secret value from Secrets Manager.

Parameters

  • json_field (Optional[str]) – 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.

  • version_id (Optional[str]) – 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

  • version_stage (Optional[str]) – 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

Example:

secret = SecretValue.secrets_manager("secretId",
    json_field="password",  # optional: key of a JSON field to retrieve (defaults to all content),
    version_id="id",  # optional: id of the version (default AWSCURRENT)
    version_stage="stage"
)

Attributes

json_field

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.

Return type

Optional[str]

version_id

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

Return type

Optional[str]

version_stage

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

Return type

Optional[str]