Class SecretsManagerSecretOptions
Options for referencing a secret value from Secrets Manager.
Inheritance
Implements
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SecretsManagerSecretOptions : Object, ISecretsManagerSecretOptions
Syntax (vb)
Public Class SecretsManagerSecretOptions
Inherits Object
Implements 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
Constructors
SecretsManagerSecretOptions() |
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. |
Constructors
SecretsManagerSecretOptions()
public SecretsManagerSecretOptions()
Properties
JsonField
The key of a JSON field to retrieve.
public string JsonField { get; set; }
Property Value
System.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.
public string VersionId { get; set; }
Property Value
System.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.
public string VersionStage { get; set; }
Property Value
System.String
Remarks
Can specify at most one of versionId
and versionStage
.
Default: AWSCURRENT