Documentation

iam_policy - Manage IAM policies for users, groups, and roles

New in version 2.0.

Synopsis

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

Requirements (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
aws_access_key
no
    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

    aliases: ec2_access_key, access_key
    aws_secret_key
    no
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

      aliases: ec2_secret_key, secret_key
      ec2_url
      no
        Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
        iam_name
        yes
          Name of IAM resource you wish to target for policy actions. In other words, the user name, group name or role name.
          iam_type
          yes
          • user
          • group
          • role
          Type of IAM resource
          policy_document
          no
            The path to the properly json formatted policy file (mutually exclusive with policy_json)
            policy_json
            no
              A properly json formatted policy as string (mutually exclusive with policy_document, see https://github.com/ansible/ansible/issues/7005#issuecomment-42894813 on how to use it properly)
              policy_name
              yes
                The name label for the policy to create or remove.
                profile
                (added in 1.6)
                no
                  uses a boto profile. Only works with boto >= 2.24.0
                  region
                  no
                    The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

                    aliases: aws_region, ec2_region
                    security_token
                    (added in 1.6)
                    no
                      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

                      aliases: access_token
                      skip_duplicates
                      no /
                        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.
                        state
                        yes
                        • present
                        • absent
                        Whether to create or delete the IAM policy.
                        validate_certs
                        (added in 1.5)
                        no yes
                        • yes
                        • no
                        When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

                        Examples

                        # Create a policy with the name of 'Admin' to the group 'administrators'
                        tasks:
                        - name: Assign a policy called Admin to the administrators group
                          iam_policy:
                            iam_type: group
                            iam_name: administrators
                            policy_name: Admin
                            state: present
                            policy_document: admin_policy.json
                        
                        # Advanced example, create two new groups and add a READ-ONLY policy to both
                        # groups.
                        task:
                        - name: Create Two Groups, Mario and Luigi
                          iam:
                            iam_type: group
                            name: "{{ item }}"
                            state: present
                          with_items:
                             - Mario
                             - Luigi
                          register: new_groups
                        
                        - name: Apply READ-ONLY policy to new groups that have been recently created
                          iam_policy:
                            iam_type: group
                            iam_name: "{{ item.created_group.group_name }}"
                            policy_name: "READ-ONLY"
                            policy_document: readonlypolicy.json
                            state: present
                          with_items: new_groups.results
                        
                        # Create a new S3 policy with prefix per user
                        tasks:
                        - name: Create S3 policy from template
                          iam_policy:
                            iam_type: user
                            iam_name: "{{ item.user }}"
                            policy_name: "s3_limited_access_{{ item.prefix }}"
                            state: present
                            policy_json: " {{ lookup( 'template', 's3_policy.json.j2') }} "
                            with_items:
                              - user: s3_user
                                prefix: s3_user_prefix
                        

                        Notes

                        Note

                        Currently boto does not support the removal of Managed Policies, the module will not work removing/adding managed policies.

                        Note

                        If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION

                        Note

                        Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html

                        Note

                        AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

                        This is a Core Module

                        For more information on what this means please read Core Modules

                        For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.