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 collapse
-
#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
Methods inherited from Base
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?
Returns A list of the keys that you want impacted by the access_key_state parameter.
48 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 48 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.
40 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 40 attribute :access_key_state |
#groups ⇒ Object?
Returns A list of groups the user should belong to. When update, will gracefully remove groups not listed.
51 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 51 attribute :groups |
#iam_type ⇒ :user, ...
Returns Type of IAM resource.
12 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 12 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.
44 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 44 attribute :key_count |
#name ⇒ String
Returns Name of IAM resource to create or identify.
16 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 16 attribute :name |
#new_name ⇒ Object?
Returns When state is update, will replace name with new_name on IAM resource.
20 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 20 attribute :new_name |
#new_path ⇒ Object?
Returns When state is update, will replace the path with new_path on the IAM resource.
23 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 23 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.
54 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 54 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.
30 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 30 attribute :path |
#state ⇒ :present, ...
Returns Whether to create, delete or update the IAM resource. Note, roles cannot be updated.
26 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 26 attribute :state |
#trust_policy ⇒ Object?
Returns The inline (JSON or YAML) trust policy document that grants an entity permission to assume the role. Mutually exclusive with C(trust_policy_filepath).
34 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 34 attribute :trust_policy |
#trust_policy_filepath ⇒ Object?
Returns The path to the trust policy document that grants an entity permission to assume the role. Mutually exclusive with C(trust_policy).
37 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 37 attribute :trust_policy_filepath |
#update_password ⇒ :always, ...
Returns C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.
58 |
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/iam.rb', line 58 attribute :update_password |