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,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exclude_characters ⇒ String

A string of the characters that you don’t want in the password.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 757

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_lowercase ⇒ Boolean

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

Returns:

  • (Boolean) 


757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 757

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_numbers ⇒ Boolean

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

Returns:

  • (Boolean) 


757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 757

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_punctuation ⇒ Boolean

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) 


757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 757

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_uppercase ⇒ Boolean

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

Returns:

  • (Boolean) 


757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 757

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_space ⇒ Boolean

Specifies whether to include the space character. If you include this switch, the password can contain space characters.

Returns:

  • (Boolean) 


757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 757

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_length ⇒ Integer

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

Returns:

  • (Integer) 


757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 757

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_type ⇒ Boolean

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) 


757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 757

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