diff --git a/docs/index.md b/docs/index.md index 974c71afa..bb29f191c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,7 +24,7 @@ To authenticate CloudQuery with your AWS account you can use any of the followin ## Configuration -The following configuration section can be automaticlly generated by `cloudquery init aws`: +The following configuration section can be automatically generated by `cloudquery init aws`: ```hcl provider "aws" { @@ -48,7 +48,7 @@ provider "aws" { } ``` -By default cloudquery will fetch all configuration from **all** resources in **all** regions in the **default** account. You can change this behaviour with the following arguments: +By default, CloudQuery will fetch all configuration from **all** resources in **all** regions in the **default** account. You can change this behavior with the following arguments: ### Arguments @@ -56,7 +56,7 @@ By default cloudquery will fetch all configuration from **all** resources in **a - `regions` **(Optional)** - limit fetching to specific regions. - `max_retries` **(Optional)** - The maximum number of times that a request will be retried for failures. Defaults to 5 retry attempts. - `max_backoff` **(Optional)** - The maximum back off delay between attempts. The backoff delays exponentially with a jitter based on the number of attempts. Defaults to 60 seconds. -- `aws_debug` **(Optiona)** - This will print very verbose/debug output from AWS SDK. Defaults to false. +- `aws_debug` **(Optional)** - This will print very verbose/debug output from AWS SDK. Defaults to false. ### Assume Role @@ -80,6 +80,23 @@ provider "aws" { } ``` +### Assume Role with MFA + +In order to assume role with MFA, you need to request temporary credentials using STS "get-session-token". + +```bash +aws sts get-session-token --serial-number --token-code --duration-seconds 3600 +``` + +export the temporary credentials to your environment variables. + +```bash +export AWS_ACCESS_KEY_ID= +export AWS_SECRET_ACCESS_KEY= +export AWS_SESSION_TOKEN= +``` + + ## Query Examples ### Find all public facing load balancers