SecretGenerateSecretString

data class SecretGenerateSecretString(val excludeCharacters: String? = null, val excludeLowercase: Boolean? = null, val excludeNumbers: Boolean? = null, val excludePunctuation: Boolean? = null, val excludeUppercase: Boolean? = null, val generateStringKey: String? = null, val includeSpace: Boolean? = null, val passwordLength: Int? = null, val requireEachIncludedType: Boolean? = null, val secretStringTemplate: String? = null)

Constructors

Link copied to clipboard
fun SecretGenerateSecretString(excludeCharacters: String? = null, excludeLowercase: Boolean? = null, excludeNumbers: Boolean? = null, excludePunctuation: Boolean? = null, excludeUppercase: Boolean? = null, generateStringKey: String? = null, includeSpace: Boolean? = null, passwordLength: Int? = null, requireEachIncludedType: Boolean? = null, secretStringTemplate: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A string that excludes characters in the generated password. By default, all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters.

Link copied to clipboard

Specifies the generated password should not include lowercase letters. By default, ecrets Manager disables this parameter, and the generated password can include lowercase False, and the generated password can include lowercase letters.

Link copied to clipboard
val excludeNumbers: Boolean? = null

Specifies that the generated password should exclude digits. By default, Secrets Manager does not enable the parameter, False, and the generated password can include digits.

Link copied to clipboard

Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.

Link copied to clipboard

Specifies that the generated password should not include uppercase letters. The default behavior is False, and the generated password can include uppercase letters.

Link copied to clipboard

The JSON key name used to add the generated password to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate.

Link copied to clipboard
val includeSpace: Boolean? = null

Specifies that the generated password can include the space character. By default, Secrets Manager disables this parameter, and the generated password doesn't include space

Link copied to clipboard
val passwordLength: Int? = null

The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

Link copied to clipboard

Specifies whether the generated password must include at least one of every allowed character type. By default, Secrets Manager enables this parameter, and the generated password includes at least one of every character type.

Link copied to clipboard

A properly structured JSON string that the generated password can be added to. If you specify this parameter, then you must also specify GenerateStringKey.