Class: Aws::SecretsManager::Types::GetRandomPasswordRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-secretsmanager/types.rb

Overview

Note:

When making an API call, you may pass GetRandomPasswordRequest data as a 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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exclude_charactersString

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.

Returns:

  • (String)

748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/aws-sdk-secretsmanager/types.rb', line 748

class GetRandomPasswordRequest < Struct.new(
  :password_length,
  :exclude_characters,
  :exclude_numbers,
  :exclude_punctuation,
  :exclude_uppercase,
  :exclude_lowercase,
  :include_space,
  :require_each_included_type)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_lowercaseBoolean

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.

Returns:

  • (Boolean)

748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/aws-sdk-secretsmanager/types.rb', line 748

class GetRandomPasswordRequest < Struct.new(
  :password_length,
  :exclude_characters,
  :exclude_numbers,
  :exclude_punctuation,
  :exclude_uppercase,
  :exclude_lowercase,
  :include_space,
  :require_each_included_type)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_numbersBoolean

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.

Returns:

  • (Boolean)

748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/aws-sdk-secretsmanager/types.rb', line 748

class GetRandomPasswordRequest < Struct.new(
  :password_length,
  :exclude_characters,
  :exclude_numbers,
  :exclude_punctuation,
  :exclude_uppercase,
  :exclude_lowercase,
  :include_space,
  :require_each_included_type)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_punctuationBoolean

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`:

“ ! “ # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~ “

Returns:

  • (Boolean)

748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/aws-sdk-secretsmanager/types.rb', line 748

class GetRandomPasswordRequest < Struct.new(
  :password_length,
  :exclude_characters,
  :exclude_numbers,
  :exclude_punctuation,
  :exclude_uppercase,
  :exclude_lowercase,
  :include_space,
  :require_each_included_type)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_uppercaseBoolean

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.

Returns:

  • (Boolean)

748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/aws-sdk-secretsmanager/types.rb', line 748

class GetRandomPasswordRequest < Struct.new(
  :password_length,
  :exclude_characters,
  :exclude_numbers,
  :exclude_punctuation,
  :exclude_uppercase,
  :exclude_lowercase,
  :include_space,
  :require_each_included_type)
  SENSITIVE = []
  include Aws::Structure
end

#include_spaceBoolean

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.

Returns:

  • (Boolean)

748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/aws-sdk-secretsmanager/types.rb', line 748

class GetRandomPasswordRequest < Struct.new(
  :password_length,
  :exclude_characters,
  :exclude_numbers,
  :exclude_punctuation,
  :exclude_uppercase,
  :exclude_lowercase,
  :include_space,
  :require_each_included_type)
  SENSITIVE = []
  include Aws::Structure
end

#password_lengthInteger

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

Returns:

  • (Integer)

748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/aws-sdk-secretsmanager/types.rb', line 748

class GetRandomPasswordRequest < Struct.new(
  :password_length,
  :exclude_characters,
  :exclude_numbers,
  :exclude_punctuation,
  :exclude_uppercase,
  :exclude_lowercase,
  :include_space,
  :require_each_included_type)
  SENSITIVE = []
  include Aws::Structure
end

#require_each_included_typeBoolean

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.

Returns:

  • (Boolean)

748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/aws-sdk-secretsmanager/types.rb', line 748

class GetRandomPasswordRequest < Struct.new(
  :password_length,
  :exclude_characters,
  :exclude_numbers,
  :exclude_punctuation,
  :exclude_uppercase,
  :exclude_lowercase,
  :include_space,
  :require_each_included_type)
  SENSITIVE = []
  include Aws::Structure
end