Class: Aws::IAM::AccountPasswordPolicy
- Inherits:
-
Object
- Object
- Aws::IAM::AccountPasswordPolicy
- Defined in:
- gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#allow_users_to_change_password ⇒ Boolean
Specifies whether IAM users are allowed to change their own password.
-
#expire_passwords ⇒ Boolean
Indicates whether passwords in the account expire.
-
#hard_expiry ⇒ Boolean
Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired.
-
#max_password_age ⇒ Integer
The number of days that an IAM user password is valid.
-
#minimum_password_length ⇒ Integer
Minimum length to require for IAM user passwords.
-
#password_reuse_prevention ⇒ Integer
Specifies the number of previous passwords that IAM users are prevented from reusing.
-
#require_lowercase_characters ⇒ Boolean
Specifies whether IAM user passwords must contain at least one lowercase character (a to z).
-
#require_numbers ⇒ Boolean
Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
-
#require_symbols ⇒ Boolean
Specifies whether IAM user passwords must contain at least one of the following symbols:.
-
#require_uppercase_characters ⇒ Boolean
Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).
Actions collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::PasswordPolicy
Returns the data for this AccountPasswordPolicy.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(options = {}) ⇒ AccountPasswordPolicy
constructor
A new instance of AccountPasswordPolicy.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current AccountPasswordPolicy.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::IAM::Client] #wait_until instead
Constructor Details
#initialize(options = {}) ⇒ AccountPasswordPolicy
Returns a new instance of AccountPasswordPolicy.
18 19 20 21 22 23 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 18 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#allow_users_to_change_password ⇒ Boolean
Specifies whether IAM users are allowed to change their own password.
Gives IAM users permissions to iam:ChangePassword
for only their
user and to the iam:GetAccountPasswordPolicy
action. This option
does not attach a permissions policy to each user, rather the
permissions are applied at the account-level for all users by IAM.
69 70 71 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 69 def allow_users_to_change_password data[:allow_users_to_change_password] end |
#client ⇒ Client
108 109 110 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 108 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
.
130 131 132 133 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 130 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
138 139 140 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 138 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
248 249 250 251 252 253 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 248 def delete( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.delete_account_password_policy() end resp.data end |
#expire_passwords ⇒ Boolean
Indicates whether passwords in the account expire. Returns true if
MaxPasswordAge
contains a value greater than 0. Returns false if
MaxPasswordAge is 0 or not present.
77 78 79 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 77 def expire_passwords data[:expire_passwords] end |
#hard_expiry ⇒ Boolean
Specifies whether IAM users are prevented from setting a new password
via the Amazon Web Services Management Console after their password
has expired. The IAM user cannot access the console until an
administrator resets the password. IAM users with iam:ChangePassword
permission and active access keys can reset their own expired console
password using the CLI or API.
101 102 103 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 101 def hard_expiry data[:hard_expiry] 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.
account_password_policy.reload.data
118 119 120 121 122 123 124 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 118 def load resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.get_account_password_policy end @data = resp.password_policy self end |
#max_password_age ⇒ Integer
The number of days that an IAM user password is valid.
83 84 85 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 83 def max_password_age data[:max_password_age] end |
#minimum_password_length ⇒ Integer
Minimum length to require for IAM user passwords.
29 30 31 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 29 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.
90 91 92 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 90 def password_reuse_prevention data[:password_reuse_prevention] end |
#require_lowercase_characters ⇒ Boolean
Specifies whether IAM user passwords must contain at least one lowercase character (a to z).
59 60 61 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 59 def require_lowercase_characters data[:require_lowercase_characters] end |
#require_numbers ⇒ Boolean
Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
45 46 47 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 45 def require_numbers data[:require_numbers] end |
#require_symbols ⇒ Boolean
Specifies whether IAM user passwords must contain at least one of the following symbols:
! @ # $ % ^ & * ( ) _ + - = [ ] \{ \} | '
38 39 40 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 38 def require_symbols data[:require_symbols] end |
#require_uppercase_characters ⇒ Boolean
Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).
52 53 54 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 52 def require_uppercase_characters data[:require_uppercase_characters] end |
#update(options = {}) ⇒ EmptyStructure
353 354 355 356 357 358 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 353 def update( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.update_account_password_policy() end resp.data end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::IAM::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged.
Waiter polls an API operation until a resource enters a desired state.
Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true
resource.wait_until() {|resource| condition}
Example
instance.wait_until(max_attempts:10, delay:5) do |instance|
instance.state.name == 'running'
end
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/account_password_policy.rb', line 222 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |