Documentation

sts_assume_role - Assume a role using AWS Security Token Service and obtain temporary credentials

New in version 2.0.

Synopsis

Assume a role using AWS Security Token Service and obtain temporary credentials

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
      duration_seconds
      		 no
        The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
        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.
          external_id
          		 no
            A unique identifier that is used by third parties to assume a role in their customers' accounts.
            mfa_serial_number
            		 no
              he identification number of the MFA device that is associated with the user who is making the AssumeRole call.
              mfa_token
              		 no
                The value provided by the MFA device, if the trust policy of the role being assumed requires MFA.
                policy
                		 no
                  Supplemental policy to use in addition to assumed role's policies.
                  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
                      role_arn
                      		 yes
                        The Amazon Resource Name (ARN) of the role that the caller is assuming (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs)
                        role_session_name
                        		 yes
                          Name of the role's session - will be used by CloudTrail
                          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
                            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

                            # Note: These examples do not set authentication details, see the AWS Guide for details.

# Assume an existing role (more details: http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
sts_assume_role:
  role_arn: "arn:aws:iam::123456789012:role/someRole"
  role_session_name: "someRoleSession"
register: assumed_role

# Use the assumed role above to tag an instance in account 123456789012
ec2_tag:
  aws_access_key: "{{ assumed_role.sts_creds.access_key }}"
  aws_secret_key: "{{ assumed_role.sts_creds.secret_key }}"
  security_token: "{{ assumed_role.sts_creds.session_token }}"
  resource: i-xyzxyz01
  state: present
  tags:
    MyNewTag: value

                            Notes

                            Note

                            In order to use the assumed role in a following playbook task you must pass the access_key, access_secret and access_token

                            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 an Extras Module

                            For more information on what this means please read Extras Modules

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