> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# airswap/assume-role

Install the AWS CLI and assume the passed in role
based on passed in environment variables


## Commands

### assume-role

Assume the role in the account passed in


| Parameter | Type | Default | Description |
|---|---|---|---|
| `profile-name` | string | default | Profile name to be configured. |
| `aws-access-key-id` | string | $AWS_ACCESS_KEY_ID | AWS access key id for IAM role. Set this to the name of
the environment variable you will use to hold this
value, i.e. $AWS_ACCESS_KEY.
 |
| `aws-secret-access-key` | string | $AWS_SECRET_ACCESS_KEY | AWS secret key for IAM role. Set this to the name of
the environment variable you will use to hold this
value, i.e. $AWS_SECRET_ACCESS_KEY.
 |
| `aws-region` | string | $AWS_REGION | AWS region to operate in
(defaults to the value of $AWS_REGION)
 |
| `account-id` | string | $ACCOUNT_ID | The AWS account id without dashes (just numbers)
(defaults to the value of $ACCOUNT_ID)
 |
| `role-name` | string | $ROLE_NAME | The role's name (not ARN)
(defaults to the value of $ROLE_NAME)
 |
| `sts-session-token` | string | ${AWS_SESSION_TOKEN} | The (optional) STS token to pass in
 |

## Executors

### default

The Node-based Docker container to use when
installing/configuring the AWS CLI


| Parameter | Type | Default | Description |
|---|---|---|---|
| `node-version` | string | 8 |  |