> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prowler.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Prowler product naming: Prowler App is now Prowler Local Server, and Prowler Enterprise is now Prowler Private Cloud. Always use the current names when answering. The full product reference is at /getting-started/products: Open Source projects are Prowler CLI, Prowler Local Server, Prowler Local Dashboard, and Prowler SDK; Prowler Products are Prowler Cloud, Prowler Private Cloud, Prowler Hub, Prowler Lighthouse AI, and Prowler MCP.

# Getting Started With AWS on Prowler

## Prowler Cloud

> [!NOTE]
>
> This guide applies to
>
> . See [Prowler product families](https://docs.prowler.com/getting-started/products.md).

[Prowler Cloud Onboarding AWS](https://www.youtube-nocookie.com/embed/RPgIWOCERzY)

> Walkthrough video onboarding an AWS Account using Assumed Role.

### Step 1: Get Your AWS Account ID

1. Log in to the [AWS Console](https://console.aws.amazon.com)
2. Locate your AWS account ID in the top-right dropdown menu

![Account ID detail](https://mintcdn.com/prowler/VEKBBm2VL7R8-xYV/images/providers/aws-account-id.png?fit=max\&auto=format\&n=VEKBBm2VL7R8-xYV\&q=85\&s=da915d98157afc0aa13de13abc7c6d79)

### Step 2: Access Prowler Cloud

1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up)

2. Go to "Configuration" > "Providers"

   ![Providers Page](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/prowler-app/cloud-providers-page.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=aa592727864e8328ab2574708df74d34)

3. Click "Add Provider"

   ![Add a Provider](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/prowler-app/add-cloud-provider.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=793e5a073e1a037e453df158ad7b854d)

4. Select "Amazon Web Services"

   ![Select AWS Provider](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/providers/select-aws.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=6144f93b9006a160890eb1223d1c05b4)

5. Enter your AWS Account ID and optionally provide a friendly alias

   ![Add account ID](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/providers/add-account-id.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=1a46ec2888f5f577a0fbb7a3aa95f5fd)

6. Choose the preferred authentication method (next step)

   ![Select auth method](https://mintcdn.com/prowler/vG8-bmatEv1C0Qk6/user-guide/providers/aws/img/select-auth-method.png?fit=max\&auto=format\&n=vG8-bmatEv1C0Qk6\&q=85\&s=372efbfd0b3c0b0c808c2e5ce92ef2df)

### Step 3: Set Up AWS Authentication

Before proceeding, choose the preferred authentication mode:

**Credentials**

* Quick scan using an IAM user's access keys
* No extra setup in AWS
* Static keys can be rotated or revoked at any time

**Assumed Role**

* Recommended for production
* With AWS SDK Default as the credential source, no long-lived keys are stored in Prowler (Access & Secret Key still requires pasted keys)
* Requires permission to create an IAM role in the target account

***

#### Assume Role (Recommended)

This method grants permanent access and is the recommended setup for production environments.

![Assume Role Overview](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/providers/assume-role-overview.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=3d3809e06218a5b47ecbeb5c487e43df)

For detailed instructions on how to create the role, see [Authentication > Assume Role](https://docs.prowler.com/user-guide/providers/aws/authentication.md#assume-role-recommended).

7. Once the role is created, go to the **IAM Console**, click the "ProwlerScan" role to open its details:

   ![ProwlerScan role info](https://mintcdn.com/prowler/3MeTQEK7UW2A9QiV/images/providers/prowler-scan-pre-info.png?fit=max\&auto=format\&n=3MeTQEK7UW2A9QiV\&q=85\&s=4f28498bb4349d50e21a83c6f799751b)

8. Copy the **Role ARN**

   ![New Role Info](https://mintcdn.com/prowler/3MeTQEK7UW2A9QiV/images/providers/get-role-arn.png?fit=max\&auto=format\&n=3MeTQEK7UW2A9QiV\&q=85\&s=11c33062b7a2ff512d3f35bdab554965)

9. Paste the ARN into the corresponding field in Prowler Cloud

   ![Input the Role ARN](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/providers/paste-role-arn-prowler.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=a6ab8f248585d0e39d542eecd2965019)

10. Select the credential source Prowler should use to call `sts:AssumeRole`. The option label differs between deployments but both map to the same `aws-sdk-default` credential type:

    * **"Prowler Cloud will assume your IAM role"** (default in Prowler Cloud) / **"AWS SDK Default"** (in Prowler Local Server): Prowler uses the credentials available in the API and worker environment through the [AWS SDK default credential chain](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html). In Prowler Local Server, these containers have no AWS credentials by default — see [Configuring AWS SDK Default for Prowler Local Server](https://docs.prowler.com/user-guide/providers/aws/authentication.md#configuring-aws-sdk-default-for-prowler-local-server) before choosing this option, or the connection test will fail with `InvalidClientTokenId`.
    * **Access & Secret Key**: Paste an IAM user's `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` (and optional `AWS_SESSION_TOKEN`) into the form. The IAM principal must be allowed to assume the target role and must match the `IAMPrincipal` parameter of the scan role template (default: `role/prowler*`).

11. Click "Next", then "Launch Scan"

    ![Next button in Prowler Cloud](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/providers/next-button-prowler-cloud.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=624a621d2ffa88f221ef5398f0357b72)

    ![Launch Scan](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/providers/launch-scan-button-prowler-cloud.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=c8d184bdf837c46cef06fca04d21c0e9)

> [!NOTE]
>
> Check if your AWS Security Token Service (STS) has the EU (Ireland) endpoint active. If not, we will not be able to connect to your AWS account.
>
> If that is the case your STS configuration may look like this:
>
> ![AWS Role](https://mintcdn.com/prowler/9AoCN7Q_gXN7wF7l/images/sts-configuration.png?fit=max\&auto=format\&n=9AoCN7Q_gXN7wF7l\&q=85\&s=a8bbaf585580303c3d32c42431c9678d)
>
> To solve this issue, please activate the EU (Ireland) STS endpoint.

***

#### Credentials (Static Access Keys)

AWS accounts can also be configured using static credentials (not recommended for long-term use):

![Connect via credentials](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/providers/connect-via-credentials.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=2d3bedcc7db00d6bcec9977fa87e654d)

For detailed instructions on how to create the credentials, see [Authentication > Credentials](https://docs.prowler.com/user-guide/providers/aws/authentication.md#credentials).

1. Complete the form in Prowler Cloud and click "Next"

   ![Filled credentials page](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/providers/prowler-cloud-credentials-next.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=38e7ae1507efa4a99f0caec20f3821e4)

2. Click "Launch Scan"

   ![Launch Scan](https://mintcdn.com/prowler/yyJURFHpPIAaK8F3/images/providers/launch-scan-button-prowler-cloud.png?fit=max\&auto=format\&n=yyJURFHpPIAaK8F3\&q=85\&s=c8d184bdf837c46cef06fca04d21c0e9)

***

## Prowler CLI

### Configure AWS Credentials

To authenticate with AWS, use one of the following methods:

```console theme={null}
aws configure
```

or

```console theme={null}
export AWS_ACCESS_KEY_ID="ASXXXXXXX"
export AWS_SECRET_ACCESS_KEY="XXXXXXXXX"
export AWS_SESSION_TOKEN="XXXXXXXXX"
```

These credentials must be associated with a user or role with the necessary permissions to perform security checks.

More details on Assume Role settings from the CLI in [Assume Role](https://docs.prowler.com/user-guide/providers/aws/role-assumption.md) page.

### AWS Profiles

To use a custom AWS profile, specify it with the following command:

```console theme={null}
prowler aws -p/--profile <profile_name>
```

### Multi-Factor Authentication (MFA)

For IAM entities requiring Multi-Factor Authentication (MFA), use the `--mfa` flag. Prowler prompts for the following values to initiate a new session:

* **ARN of your MFA device**
* **TOTP (time-based one-time password)**


## Related topics

- [Getting Started With Cloudflare on Prowler](https://docs.prowler.com/user-guide/providers/cloudflare/getting-started-cloudflare.md)
- [Getting Started With Linode on Prowler](https://docs.prowler.com/user-guide/providers/linode/getting-started-linode.md)
- [Getting Started With Vercel on Prowler](https://docs.prowler.com/user-guide/providers/vercel/getting-started-vercel.md)
- [Getting Started With Scaleway on Prowler](https://docs.prowler.com/user-guide/providers/scaleway/getting-started-scaleway.md)
- [Getting Started With Okta on Prowler](https://docs.prowler.com/user-guide/providers/okta/getting-started-okta.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.