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 of the characters that you don't want in the password.

Returns:

  • (String)

769
770
771
772
773
774
775
776
777
778
779
780
# File 'lib/aws-sdk-secretsmanager/types.rb', line 769

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 whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

Returns:

  • (Boolean)

769
770
771
772
773
774
775
776
777
778
779
780
# File 'lib/aws-sdk-secretsmanager/types.rb', line 769

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 whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

Returns:

  • (Boolean)

769
770
771
772
773
774
775
776
777
778
779
780
# File 'lib/aws-sdk-secretsmanager/types.rb', line 769

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

Returns:

  • (Boolean)

769
770
771
772
773
774
775
776
777
778
779
780
# File 'lib/aws-sdk-secretsmanager/types.rb', line 769

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 whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

Returns:

  • (Boolean)

769
770
771
772
773
774
775
776
777
778
779
780
# File 'lib/aws-sdk-secretsmanager/types.rb', line 769

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 whether to include the space character. If you include this switch, the password can contain space characters.

Returns:

  • (Boolean)

769
770
771
772
773
774
775
776
777
778
779
780
# File 'lib/aws-sdk-secretsmanager/types.rb', line 769

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 length of the password. If you don't include this parameter, the default length is 32 characters.

Returns:

  • (Integer)

769
770
771
772
773
774
775
776
777
778
779
780
# File 'lib/aws-sdk-secretsmanager/types.rb', line 769

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

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.

Returns:

  • (Boolean)

769
770
771
772
773
774
775
776
777
778
779
780
# File 'lib/aws-sdk-secretsmanager/types.rb', line 769

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