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)

Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Required permissions: `secretsmanager:GetRandomPassword`. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Constructors

Link copied to clipboard
constructor(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 of the characters that you don't want in the password.

Link copied to clipboard

Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

Link copied to clipboard
val excludeNumbers: Boolean? = null

Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

Link copied to clipboard

Specifies whether to exclude the following punctuation characters from the password: `! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~`. If you don't include this switch, the password can contain punctuation.

Link copied to clipboard

Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

Link copied to clipboard

The JSON key name for the key/value pair, where the value is the generated password. This pair is added 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 whether to include the space character. If you include this switch, the password can contain space characters.

Link copied to clipboard
val passwordLength: Int? = null

The length of the password. If you don't include this parameter, the default length is 32 characters.

Link copied to clipboard

Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.

Link copied to clipboard

A template that the generated string must match. When you make a change to this property, a new secret version is created.