ansible.builtin.sts_assume_role (v2.6.20) — module

Install Ansible via pip

Install with pip install ansible==2.6.20

Description

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

Requirements

• boto3
• botocore
• python >= 2.6

Inputs

    
policy:
    description:
    - Supplemental policy to use in addition to assumed role's policies.

region:
    aliases:
    - aws_region
    - ec2_region
    description:
    - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
    type: str

profile:
    aliases:
    - aws_profile
    description:
    - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
      and I(security_token) options.
    type: str

role_arn:
    description:
    - 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)
    required: true

mfa_token:
    description:
    - The value provided by the MFA device, if the trust policy of the role being assumed
      requires MFA.

aws_config:
    description:
    - A dictionary to modify the botocore configuration.
    - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
    type: dict

external_id:
    description:
    - A unique identifier that is used by third parties to assume a role in their customers'
      accounts.

endpoint_url:
    aliases:
    - ec2_url
    - aws_endpoint_url
    - s3_url
    description:
    - 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.
    type: str

aws_ca_bundle:
    description:
    - The location of a CA Bundle to use when validating SSL certificates.
    - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
      from the controller if not run locally.'
    type: path

aws_access_key:
    aliases:
    - ec2_access_key
    - access_key
    description:
    - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
      or C(EC2_ACCESS_KEY) environment variable is used.
    - The I(aws_access_key) and I(profile) options are mutually exclusive.
    type: str

aws_secret_key:
    aliases:
    - ec2_secret_key
    - secret_key
    description:
    - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
      or C(EC2_SECRET_KEY) environment variable is used.
    - The I(aws_secret_key) and I(profile) options are mutually exclusive.
    type: str

security_token:
    aliases:
    - aws_session_token
    - session_token
    - aws_security_token
    - access_token
    description:
    - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
      or C(EC2_SECURITY_TOKEN) environment variable is used.
    - The I(security_token) and I(profile) options are mutually exclusive.
    - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
    type: str

validate_certs:
    default: true
    description:
    - When set to "no", SSL certificates will not be validated for communication with
      the AWS APIs.
    type: bool

duration_seconds:
    description:
    - 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.

mfa_serial_number:
    description:
    - The identification number of the MFA device that is associated with the user who
      is making the AssumeRole call.

role_session_name:
    description:
    - Name of the role's session - will be used by CloudTrail
    required: true

debug_botocore_endpoint_logs:
    default: 'no'
    description:
    - Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
      API calls made during a task, outputing the set to the resource_actions key in the
      task results. Use the aws_resource_action callback to output to total list made
      during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
      be used.
    type: bool

Outputs

changed:
  description: True if obtaining the credentials succeeds
  returned: always
  type: bool
sts_creds:
  description: The temporary security credentials, which include an access key ID,
    a secret access key, and a security (or session) token
  returned: always
  sample:
    access_key: XXXXXXXXXXXXXXXXXXXX
    expiration: '2017-11-11T11:11:11+00:00'
    secret_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    session_token: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  type: dict
sts_user:
  description: The Amazon Resource Name (ARN) and the assumed role ID
  returned: always
  sample:
    arn: ARO123EXAMPLE123:Bob
    assumed_role_id: arn:aws:sts::123456789012:assumed-role/demo/Bob
  type: dict