AWS Source Plugin Configuration Reference

Simple Example

This example connects a single AWS account in one region to a Postgres destination. The (top level) source spec section is described in the Source Spec Reference.

kind: source
spec:
  # Source spec section
  name: aws
  path: cloudquery/aws
  version: "v17.3.1"
  tables: ["aws_s3_buckets"]
  destinations: ["postgresql"]
  spec: 
    # AWS Spec section described below
    regions: 
      - us-east-1
    accounts:
      - id: "account1"
        local_profile: "account1"
    aws_debug: false

AWS Organization Example

CloudQuery supports discovery of AWS Accounts via AWS Organizations. This means that as Accounts get added or removed from your organization CloudQuery will be able to handle new or removed accounts without any configuration changes.

kind: source
spec:
  name: aws
  registry: github
  path: cloudquery/aws
  version: "v17.3.1"
  tables: ['aws_s3_buckets']
  destinations: ["postgresql"]
  spec:
    aws_debug: false
    org:
      admin_account:
        local_profile: "<NAMED_PROFILE>"
      member_role_name: OrganizationAccountAccessRole
    regions:
      - '*'

For full details, see the Multi Account Configuration Tutorial.

AWS Spec

This is the (nested) spec used by the AWS source plugin.

regions ([]string) (default: Empty. Will use all enabled regions)

Regions to use.
accounts ([]account) (default: current account)

List of all accounts to fetch information from
org (org) (default: not used)

In AWS organization mode, CloudQuery will source all accounts underneath automatically
initialization_concurrency (int) (default: 4)

During initialization the AWS source plugin fetches information about each account and region. This setting controls how many accounts can be initialized concurrently. Only configurations with many accounts (either hardcoded or discovered via Organizations) should require modifying this setting, to either lower it to avoid rate limit errors, or to increase it to speed up the initialization process.
aws_debug (bool) (default: false)

If true, will log AWS debug logs, including retries and other request/response metadata
max_retries (int) (default: 10)

Defines the maximum number of times an API request will be retried
max_backoff (int) (default: 30)

Defines the duration between retry attempts
custom_endpoint_url (string) (default: not used)

The base URL endpoint the SDK API clients will use to make API calls to. The SDK will suffix URI path and query elements to this endpoint
custom_endpoint_hostname_immutable (bool) (default: not used)

Specifies if the endpoint's hostname can be modified by the SDK's API client. When using something like LocalStack make sure to set it equal to True
custom_endpoint_partition_id (string) (default: not used)

The AWS partition the endpoint belongs to
custom_endpoint_signing_region (string) (default: not used)

The region that should be used for signing the request to the endpoint
use_paid_apis (boolean) (default: false)

When set to true plugin will sync data from APIs that incur a fee. Currently only aws_costexplorer* tables require this flag to be set to true.

experimental table_options (map) (default: not used)

This is an experimental feature that enables users to override the default options for specific tables. The root of the object takes a table name, and the next level takes an API method name. The final level is the actual input object as defined by the API. The format of the table_options object is as follows:

table_options:
  <table_name>:
    <api_method_name>:
      - <input_object>

A list of <input_object> objects should be provided. CloudQuery will iterate through these to make multiple API calls. This is useful for APIs like CloudTrail's LookupEvents that only supports a single event type per call. For example:

  table_options:
    aws_cloudtrail_events:
      lookup_events:
        - start_time: 2023-05-01T20:20:52Z
          end_time:   2023-05-03T20:20:52Z
          lookup_attributes:
            - attribute_key: EventName
              attribute_value: RunInstances
        - start_time: 2023-05-01T20:20:52Z
          end_time:   2023-05-03T20:20:52Z
          lookup_attributes:
            - attribute_key: EventName
              attribute_value: StartInstances
        - start_time: 2023-05-01T20:20:52Z
          end_time:   2023-05-03T20:20:52Z
          lookup_attributes:
            - attribute_key: EventName
              attribute_value: StopInstances

The naming for all of the fields is the same as the AWS API but in snake case. For example EndTime is represented as end_time. As of v17.3.0 the following tables and APIs are supported:

table_options:
  aws_accessanalyzer_analyzer_findings:
    list_findings:
      - <[ListFindings](https://docs.aws.amazon.com/access-analyzer/latest/APIReference/API_ListFindings.html)>
  aws_cloudtrail_events:
    lookup_events:
      - <[LookupEvents](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_LookupEvents.html)>
  aws_inspector2_findings:
    list_findings:
      - <[ListFindings](https://docs.aws.amazon.com/inspector/v2/APIReference/API_ListFindings.html)>

account

This is used to specify one or more accounts to extract information from. Note that it should be an array of objects, each with the following fields:

id (string) (required)

Will be used as an alias in the source plugin and in the logs
local_profile (string) (default: will use current credentials)

Local profile (opens in a new tab) to use to authenticate this account with. Please note this should be set to the name of the profile. For example, with the following credentials file:
```
[default]
aws_access_key_id=xxxx
aws_secret_access_key=xxxx

[user1]
aws_access_key_id=xxxx
aws_secret_access_key=xxxx
```
local_profile should be set to either default or user1.
role_arn (string)

If specified will use this to assume role
role_session_name (string)

If specified will use this session name when assume role to role_arn
external_id (string)

If specified will use this when assuming role to role_arn
default_region (string) (default: us-east-1)

If specified, this region will be used as the default region for the account.
regions (string)

Regions to use for this account. Defaults to global regions setting.

org

admin_account (Account)

Configuration for how to grab credentials from an Admin account
member_trusted_principal (Account)

Configuration for how to specify the principle to use in order to assume a role in the member accounts
member_role_name (string) (required)

Role name that CloudQuery should use to assume a role in the member account from the admin account. Note: This is not a full ARN, it is just the name
member_role_session_name (string)

Override the default Session name.
member_external_id (string)

Specify an ExternalID for use in the trust policy
member_regions ([]string)

Limit fetching resources within this specific account to only these regions. This will override any regions specified in the provider block. You can specify all regions by using the * character as the only argument in the array
organization_units ([]string)

List of Organizational Units that CloudQuery should use to source accounts from. If you specify an OU, CloudQuery will not traverse nested OUs
skip_organization_units ([]string)

List of Organizational Units to skip. This is useful in conjunction with organization_units if there are child OUs that should be ignored.
skip_member_accounts ([]string)

List of OU member accounts to skip. This is useful in conjunction with organization_units if there are accounts under the selected OUs that should be ignored.

Overview Multi Account Configuration