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

Inherits:

Base

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

Includes:

Helpers::Aws

Defined in:

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

Overview

Allows for the management of IAM users, user API keys, groups, roles.

Instance Method Summary

• #access_key_ids ⇒ Object^?

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

• #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.

• #trust_policy ⇒ Object^?

  The inline (JSON or YAML) trust policy document that grants an entity permission to assume the role.

• #trust_policy_filepath ⇒ Object^?

  The path to the trust policy document that grants an entity permission to assume the role.

• #update_password ⇒ :always, ...

  C(always) will update passwords if they differ.

Methods included from Helpers::Aws

included

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#access_key_ids ⇒ Object^?

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

attribute :access_key_ids

#access_key_state ⇒ :create, ...

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

attribute :access_key_state

#groups ⇒ Object^?

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

attribute :groups

#iam_type ⇒ :user, ...

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

attribute :iam_type

#key_count ⇒ String^?

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

attribute :key_count

#name ⇒ String

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

attribute :name

#new_name ⇒ Object^?

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

attribute :new_name

#new_path ⇒ Object^?

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

attribute :new_path

#password ⇒ String^?

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

attribute :password

#path ⇒ String^?

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

attribute :path

#state ⇒ :present, ...

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

attribute :state

#trust_policy ⇒ Object^?

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

attribute :trust_policy

#trust_policy_filepath ⇒ Object^?

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

attribute :trust_policy_filepath

#update_password ⇒ :always, ...

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

attribute :update_password