software.amazon.awscdk.services.secretsmanager

Interface SecretStringGenerator

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SecretStringGenerator.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:38.288Z")
 @Stability(value=Experimental)
public interface SecretStringGenerator
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration to generate secrets such as passwords automatically.

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 String	getExcludeCharacters() (experimental) A string that includes characters that shouldn't be included in the generated password.
default Boolean	getExcludeLowercase() (experimental) Specifies that the generated password shouldn't include lowercase letters.
default Boolean	getExcludeNumbers() (experimental) Specifies that the generated password shouldn't include digits.
default Boolean	getExcludePunctuation() (experimental) Specifies that the generated password shouldn't include punctuation characters.
default Boolean	getExcludeUppercase() (experimental) Specifies that the generated password shouldn't include uppercase letters.
default String	getGenerateStringKey() (experimental) The JSON key name that's used to add the generated password to the JSON structure specified by the ``secretStringTemplate`` parameter.
default Boolean	getIncludeSpace() (experimental) Specifies that the generated password can include the space character.
default Number	getPasswordLength() (experimental) The desired length of the generated password.
default Boolean	getRequireEachIncludedType() (experimental) Specifies whether the generated password must include at least one of every allowed character type.
default String	getSecretStringTemplate() (experimental) A properly structured JSON string that the generated password can be added to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getExcludeCharacters

@Stability(value=Experimental)
 @Nullable
default String getExcludeCharacters()

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

@Stability(value=Experimental)
 @Nullable
default Boolean getExcludeLowercase()

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

Default: false

getExcludeNumbers

@Stability(value=Experimental)
 @Nullable
default Boolean getExcludeNumbers()

(experimental) Specifies that the generated password shouldn't include digits.

Default: false

getExcludePunctuation

@Stability(value=Experimental)
 @Nullable
default Boolean getExcludePunctuation()

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

Default: false

getExcludeUppercase

@Stability(value=Experimental)
 @Nullable
default Boolean getExcludeUppercase()

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

Default: false

getGenerateStringKey

@Stability(value=Experimental)
 @Nullable
default String getGenerateStringKey()

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

@Stability(value=Experimental)
 @Nullable
default Boolean getIncludeSpace()

(experimental) Specifies that the generated password can include the space character.

Default: false

getPasswordLength

@Stability(value=Experimental)
 @Nullable
default Number getPasswordLength()

(experimental) The desired length of the generated password.

Default: 32

getRequireEachIncludedType

@Stability(value=Experimental)
 @Nullable
default Boolean getRequireEachIncludedType()

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

Default: true

getSecretStringTemplate

@Stability(value=Experimental)
 @Nullable
default String getSecretStringTemplate()

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

@Stability(value=Experimental)
static SecretStringGenerator.Builder builder()

Returns:

a SecretStringGenerator.Builder of SecretStringGenerator