software.amazon.awscdk.services.secretsmanager

Interface SecretStringGenerator

All Known Implementing Classes:

SecretStringGenerator.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:44.627Z")
public interface SecretStringGenerator

Configuration to generate secrets such as passwords automatically.

Example:

 // Default secret
 Secret secret = new Secret(this, "Secret");
 // Using the default secret
 // Using the default secret
 User.Builder.create(this, "User")
         .password(secret.getSecretValue())
         .build();
 // Templated secret
 Secret templatedSecret = Secret.Builder.create(this, "TemplatedSecret")
         .generateSecretString(SecretStringGenerator.builder()
                 .secretStringTemplate(JSON.stringify(Map.of("username", "user")))
                 .generateStringKey("password")
                 .build())
         .build();
 // Using the templated secret
 // Using the templated secret
 User.Builder.create(this, "OtherUser")
         .userName(templatedSecret.secretValueFromJson("username").toString())
         .password(templatedSecret.secretValueFromJson("password"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SecretStringGenerator.Builder	builder()
default java.lang.String	getExcludeCharacters() A string that includes characters that shouldn't be included in the generated password.
default java.lang.Boolean	getExcludeLowercase() Specifies that the generated password shouldn't include lowercase letters.
default java.lang.Boolean	getExcludeNumbers() Specifies that the generated password shouldn't include digits.
default java.lang.Boolean	getExcludePunctuation() Specifies that the generated password shouldn't include punctuation characters.
default java.lang.Boolean	getExcludeUppercase() Specifies that the generated password shouldn't include uppercase letters.
default java.lang.String	getGenerateStringKey() The JSON key name that's used to add the generated password to the JSON structure specified by the ``secretStringTemplate`` parameter.
default java.lang.Boolean	getIncludeSpace() Specifies that the generated password can include the space character.
default java.lang.Number	getPasswordLength() The desired length of the generated password.
default java.lang.Boolean	getRequireEachIncludedType() Specifies whether the generated password must include at least one of every allowed character type.
default java.lang.String	getSecretStringTemplate() A properly structured JSON string that the generated password can be added to.

Method Detail

getExcludeCharacters

default java.lang.String getExcludeCharacters()

A string that includes characters that shouldn't be included in the generated password.

The string can be a minimum of 0 and a maximum of 4096 characters long.

Default: no exclusions

getExcludeLowercase

default java.lang.Boolean getExcludeLowercase()

Specifies that the generated password shouldn't include lowercase letters.

Default: false

getExcludeNumbers

default java.lang.Boolean getExcludeNumbers()

Specifies that the generated password shouldn't include digits.

Default: false

getExcludePunctuation

default java.lang.Boolean getExcludePunctuation()

Specifies that the generated password shouldn't include punctuation characters.

Default: false

getExcludeUppercase

default java.lang.Boolean getExcludeUppercase()

Specifies that the generated password shouldn't include uppercase letters.

Default: false

getGenerateStringKey

default java.lang.String getGenerateStringKey()

The JSON key name that's used to add the generated password to the JSON structure specified by the ``secretStringTemplate`` parameter.

If you specify generateStringKey then secretStringTemplate must be also be specified.

getIncludeSpace

default java.lang.Boolean getIncludeSpace()

Specifies that the generated password can include the space character.

Default: false

getPasswordLength

default java.lang.Number getPasswordLength()

The desired length of the generated password.

Default: 32

getRequireEachIncludedType

default java.lang.Boolean getRequireEachIncludedType()

Specifies whether the generated password must include at least one of every allowed character type.

Default: true

getSecretStringTemplate

default java.lang.String getSecretStringTemplate()

A properly structured JSON string that the generated password can be added to.

The generateStringKey is combined with the generated random string and inserted into the JSON structure that's specified by this parameter. The merged JSON string is returned as the completed SecretString of the secret. If you specify secretStringTemplate then generateStringKey must be also be specified.

builder

static SecretStringGenerator.Builder builder()

Returns:

a SecretStringGenerator.Builder of SecretStringGenerator