Class: Aws::IAM::AccountPasswordPolicy

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-iam/account_password_policy.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ AccountPasswordPolicy

Returns a new instance of AccountPasswordPolicy.

Options Hash (options):



15
16
17
18
19
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 15

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#allow_users_to_change_password ⇒ Boolean

Specifies whether IAM users are allowed to change their own password.

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 57

def allow_users_to_change_password
  data.allow_users_to_change_password
end

#client ⇒ Client

Returns:



92
93
94
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 92

def client
  @client
end

#data ⇒ Types::PasswordPolicy

Returns the data for this Aws::IAM::AccountPasswordPolicy. Calls Client#get_account_password_policy if #data_loaded? is ‘false`.

Returns:



112
113
114
115
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 112

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



120
121
122
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 120

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


.delete()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:

  • (EmptyStructure) 


131
132
133
134
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 131

def delete(options = {})
  resp = @client.(options)
  resp.data
end

#expire_passwords ⇒ Boolean

Indicates whether passwords in the account expire. Returns true if MaxPasswordAge is contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 65

def expire_passwords
  data.expire_passwords
end

#hard_expiry ⇒ Boolean

Specifies whether IAM users are prevented from setting a new password after their password has expired.

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 85

def hard_expiry
  data.hard_expiry
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


210
211
212
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 210

def identifiers
  {}
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::IAM::AccountPasswordPolicy. Returns ‘self` making it possible to chain methods.

.reload.data

Returns:

  • (self) 


102
103
104
105
106
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 102

def load
  resp = @client.
  @data = resp.password_policy
  self
end

#max_password_age ⇒ Integer

The number of days that an IAM user password is valid.

Returns:

  • (Integer) 


71
72
73
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 71

def max_password_age
  data.max_password_age
end

#minimum_password_length ⇒ Integer

Minimum length to require for IAM user passwords.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 25

def minimum_password_length
  data.minimum_password_length
end

#password_reuse_prevention ⇒ Integer

Specifies the number of previous passwords that IAM users are prevented from reusing.

Returns:

  • (Integer) 


78
79
80
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 78

def password_reuse_prevention
  data.password_reuse_prevention
end

#require_lowercase_characters ⇒ Boolean

Specifies whether to require lowercase characters for IAM user passwords.

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 51

def require_lowercase_characters
  data.require_lowercase_characters
end

#require_numbers ⇒ Boolean

Specifies whether to require numbers for IAM user passwords.

Returns:

  • (Boolean) 


37
38
39
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 37

def require_numbers
  data.require_numbers
end

#require_symbols ⇒ Boolean

Specifies whether to require symbols for IAM user passwords.

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 31

def require_symbols
  data.require_symbols
end

#require_uppercase_characters ⇒ Boolean

Specifies whether to require uppercase characters for IAM user passwords.

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 44

def require_uppercase_characters
  data.require_uppercase_characters
end

#update(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


.update({
  minimum_password_length: 1,
  require_symbols: false,
  require_numbers: false,
  require_uppercase_characters: false,
  require_lowercase_characters: false,
  allow_users_to_change_password: false,
  max_password_age: 1,
  password_reuse_prevention: 1,
  hard_expiry: false,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :minimum_password_length (Integer) —

    The minimum number of characters allowed in an IAM user password.

    Default value: 6

  • :require_symbols (Boolean) —

    Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:

    ! @ # $ % ^ & * ( ) _ + - = [ ] \{ \} | ‘

    Default value: false

  • :require_numbers (Boolean) —

    Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

    Default value: false

  • :require_uppercase_characters (Boolean) —

    Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).

    Default value: false

  • :require_lowercase_characters (Boolean) —

    Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).

    Default value: false

  • :allow_users_to_change_password (Boolean) —

    Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see [Letting IAM Users Change Their Own Passwords] in the *IAM User Guide*.

    Default value: false

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/HowToPwdIAMUser.html

  • :max_password_age (Integer) —

    The number of days that an IAM user password is valid. The default value of 0 means IAM user passwords never expire.

    Default value: 0

  • :password_reuse_prevention (Integer) —

    Specifies the number of previous passwords that IAM users are prevented from reusing. The default value of 0 means IAM users are not prevented from reusing previous passwords.

    Default value: 0

  • :hard_expiry (Boolean) —

    Prevents IAM users from setting a new password after their password has expired.

    Default value: false

Returns:

  • (EmptyStructure) 


203
204
205
206
 
# File 'lib/aws-sdk-iam/account_password_policy.rb', line 203

def update(options = {})
  resp = @client.(options)
  resp.data
end