Class: Ansible::Ruby::Modules::Iam

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Iam

Defined in:

lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb

Instance Method Summary

• #access_key_ids ⇒ Object^?

  A list of the keys that you want impacted by the access_key_state paramter.

• #access_key_state ⇒ :create, ...

  When type is user, it creates, removes, deactivates or activates a user’s access key(s).

• #groups ⇒ Object^?

  A list of groups the user should belong to.

• #iam_type ⇒ :user, ...

  Type of IAM resource.

• #key_count ⇒ String^?

  When access_key_state is create it will ensure this quantity of keys are present.

• #name ⇒ String

  Name of IAM resource to create or identify.

• #new_name ⇒ Object^?

  When state is update, will replace name with new_name on IAM resource.

• #new_path ⇒ Object^?

  When state is update, will replace the path with new_path on the IAM resource.

• #password ⇒ String^?

  When type is user and state is present, define the users login password.

• #path ⇒ String^?

  When creating or updating, specify the desired path of the resource.

• #state ⇒ :present, ...

  Whether to create, delete or update the IAM resource.

• #update_password ⇒ :always, ...

  C(always) will update passwords if they differ.

Methods inherited from Base

#to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#access_key_ids ⇒ Object^?

Returns A list of the keys that you want impacted by the access_key_state paramter.

Returns:

• (Object, nil) —

  A list of the keys that you want impacted by the access_key_state paramter.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 40

attribute :access_key_ids

#access_key_state ⇒ :create, ...

Returns When type is user, it creates, removes, deactivates or activates a user’s access key(s). Note that actions apply only to keys specified.

Returns:

• (:create, :remove, :active, :inactive, nil) —

  When type is user, it creates, removes, deactivates or activates a user’s access key(s). Note that actions apply only to keys specified.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 32

attribute :access_key_state

#groups ⇒ Object^?

Returns A list of groups the user should belong to. When update, will gracefully remove groups not listed.

Returns:

• (Object, nil) —

  A list of groups the user should belong to. When update, will gracefully remove groups not listed.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 43

attribute :groups

#iam_type ⇒ :user, ...

Returns Type of IAM resource.

Returns:

• (:user, :group, :role) —

  Type of IAM resource

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 10

attribute :iam_type

#key_count ⇒ String^?

Returns When access_key_state is create it will ensure this quantity of keys are present. Defaults to 1.

Returns:

• (String, nil) —

  When access_key_state is create it will ensure this quantity of keys are present. Defaults to 1.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 36

attribute :key_count

#name ⇒ String

Returns Name of IAM resource to create or identify.

Returns:

• (String) —

  Name of IAM resource to create or identify

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 14

attribute :name

#new_name ⇒ Object^?

Returns When state is update, will replace name with new_name on IAM resource.

Returns:

• (Object, nil) —

  When state is update, will replace name with new_name on IAM resource

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 18

attribute :new_name

#new_path ⇒ Object^?

Returns When state is update, will replace the path with new_path on the IAM resource.

Returns:

• (Object, nil) —

  When state is update, will replace the path with new_path on the IAM resource

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 21

attribute :new_path

#password ⇒ String^?

Returns When type is user and state is present, define the users login password. Also works with update. Note that always returns changed.

Returns:

• (String, nil) —

  When type is user and state is present, define the users login password. Also works with update. Note that always returns changed.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 46

attribute :password

#path ⇒ String^?

Returns When creating or updating, specify the desired path of the resource. If state is present, it will replace the current path to match what is passed in when they do not match.

Returns:

• (String, nil) —

  When creating or updating, specify the desired path of the resource. If state is present, it will replace the current path to match what is passed in when they do not match.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 28

attribute :path

#state ⇒ :present, ...

Returns Whether to create, delete or update the IAM resource. Note, roles cannot be updated.

Returns:

• (:present, :absent, :update) —

  Whether to create, delete or update the IAM resource. Note, roles cannot be updated.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 24

attribute :state

#update_password ⇒ :always, ...

Returns C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.

Returns:

• (:always, :on_create, nil) —

  C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/iam.rb', line 50

attribute :update_password