Class: Ansible::Ruby::Modules::Iam_policy

Inherits:
Base show all
Includes:
Helpers::Aws
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/iam_policy.rb,
lib/ansible/ruby/modules/custom/cloud/core/amazon/iam_policy.rb

Overview

Allows uploading or removing IAM policies for IAM users, groups or roles.

Instance Method Summary collapse

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, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#iam_name ⇒ String

Returns Name of IAM resource you wish to target for policy actions. In other words, the user name, group name or role name.

Returns:

  • (String) —

    Name of IAM resource you wish to target for policy actions. In other words, the user name, group name or role name.



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

attribute :iam_name

#iam_type ⇒ :user, ...

Returns Type of IAM resource.

Returns:

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

    Type of IAM resource



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

attribute :iam_type

#policy_document ⇒ String?

Returns The path to the properly json formatted policy file (mutually exclusive with C(policy_json)).

Returns:

  • (String, nil) —

    The path to the properly json formatted policy file (mutually exclusive with C(policy_json))



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

attribute :policy_document

#policy_json ⇒ String?

Returns A properly json formatted policy as string (mutually exclusive with C(policy_document), see github.com/ansible/ansible/issues/7005#issuecomment-42894813 on how to use it properly).

Returns:



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

attribute :policy_json

#policy_name ⇒ String

Returns The name label for the policy to create or remove.

Returns:

  • (String) —

    The name label for the policy to create or remove.



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

attribute :policy_name

#skip_duplicates ⇒ String?

Returns By default the module looks for any policies that match the document you pass in, if there is a match it will not make a new policy object with the same rules. You can override this by specifying false which would allow for two policy objects with different names but same rules.

Returns:

  • (String, nil) —

    By default the module looks for any policies that match the document you pass in, if there is a match it will not make a new policy object with the same rules. You can override this by specifying false which would allow for two policy objects with different names but same rules.



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

attribute :skip_duplicates

#state ⇒ :present, :absent

Returns Whether to create or delete the IAM policy.

Returns:

  • (:present, :absent) —

    Whether to create or delete the IAM policy.



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

attribute :state