You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SecretsManager::Types::GetRandomPasswordRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecretsManager::Types::GetRandomPasswordRequest
- Defined in:
- (unknown)
Overview
When passing GetRandomPasswordRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
password_length: 1,
exclude_characters: "ExcludeCharactersType",
exclude_numbers: false,
exclude_punctuation: false,
exclude_uppercase: false,
exclude_lowercase: false,
include_space: false,
require_each_included_type: false,
}
Instance Attribute Summary collapse
-
#exclude_characters ⇒ String
A string that includes characters that should not be included in the generated password.
-
#exclude_lowercase ⇒ Boolean
Specifies that the generated password should not include lowercase letters.
-
#exclude_numbers ⇒ Boolean
Specifies that the generated password should not include digits.
-
#exclude_punctuation ⇒ Boolean
Specifies that the generated password should not include punctuation characters.
-
#exclude_uppercase ⇒ Boolean
Specifies that the generated password should not include uppercase letters.
-
#include_space ⇒ Boolean
Specifies that the generated password can include the space character.
-
#password_length ⇒ Integer
The desired length of the generated password.
-
#require_each_included_type ⇒ Boolean
A boolean value that specifies whether the generated password must include at least one of every allowed character type.
Instance Attribute Details
#exclude_characters ⇒ String
A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
#exclude_lowercase ⇒ Boolean
Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
#exclude_numbers ⇒ Boolean
Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
#exclude_punctuation ⇒ Boolean
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.
The following are the punctuation characters that can be included in
the generated password if you don\'t explicitly exclude them with
ExcludeCharacters
or ExcludePunctuation
:
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
#exclude_uppercase ⇒ Boolean
Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
#include_space ⇒ Boolean
Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
#password_length ⇒ Integer
The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
#require_each_included_type ⇒ Boolean
A boolean value that specifies whether the generated password must
include at least one of every allowed character type. The default value
is True
and the operation requires at least one of every character
type.