AWS Source Plugin Configuration Reference

Examples #

Single Account Example #

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

AWS Organization Example #

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

AWS Spec #

• regions ([]string) (default: []. 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
• concurrency (int) (default: 50000):

  The best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• 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.
• scheduler (string) (default: dfs):

  The scheduler to use when determining the priority of resources to sync. Currently, the only supported values are dfs (depth-first search), round-robin and shuffle. For more information about this, see performance tuning.
• 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 (bool) (default: false)

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

• preview table_options (map) (default: not used)

  This is a preview feature (for more information about preview features look at plugin versioning) 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 the fields is the same as the AWS API but in snake case. For example EndTime is represented as end_time. As of v18.4.0 the following tables and APIs are supported:

  table_options:
    aws_accessanalyzer_analyzer_findings:
      list_findings:
        - <AccessAnalyzer.ListFindings> # NextToken & AnalyzerArn are prohibited
  
    aws_alpha_cloudwatch_metrics:
      - list_metrics: <CloudWatch.ListMetrics> # NextToken is prohibited
        get_metric_statistics:
          - <CloudWatch.GetMetricStatistics>  # Namespace, MetricName and Dimensions are prohibited
  
    aws_cloudtrail_events:
      lookup_events:
        - <CloudTrail.LookupEvents> # NextToken is prohibited
  
    aws_inspector2_findings:
      list_findings:
        - <InspectorV2.ListFindings> # NextToken is prohibited.
  
    aws_securityhub_findings:
      get_findings:
        - <SecurityHub.GetFindings> # NextToken is prohibited. MaxResults should be in range [1-100].
  
    aws_ecs_cluster_tasks:
      list_tasks:
        - <ECS.ListTasks> # Cluster and NextToken are prohibited. MaxResults should be in range [1-100].

  • AccessAnalyzer.ListFindings
  • CloudTrail.LookupEvents
  • CloudWatch.ListMetrics
  • CloudWatch.GetMetricStatistics
  • ECS.ListTasks
  • InspectorV2.ListFindings
  • SecurityHub.GetFindings
• enterprise version only event_based_sync (array) (default: empty)

account #

• 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 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)

  Overrides the default session name.
• member_external_id (string)

  Specify an external ID 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 also 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 if there are accounts under the selected OUs that should be ignored.

event_based_sync #

• account (Account)

  Configuration for the credentials that will be used to grab records from the specified Kinesis Stream. If this is not specified the default credentials will be used
• kinesis_stream_arn (string) (required)

  ARN for the Kinesis stream that will hold all of the CloudTrail records
• start_time (timestamp)

  Defines the place in the stream where record processing should begin. By default, the time at which the sync began will be used. The value should follow the RFC 3339 format. For example 2023-09-04T19:24:14Z
• full_sync (bool) (default: true)

  By default, CQ will do a full sync on the specified tables before starting to consume the events in the stream. This parameter enables users to skip the full pull based sync and go straight to the event based sync.

Advanced Configuration #

Incremental Tables #

kind: source
spec:
  # Source spec section
  name: aws
  path: cloudquery/aws
  registry: cloudquery
  version: "v22.19.2"
  tables: ["aws_cloudtrail_events"]
  destinations: ["postgresql"]
  backend_options:
    table_name: "cq_state_aws"
    connection: "@@plugins.postgresql.connection"
  spec:
---
kind: destination
spec:
  name: "postgresql"
  path: "cloudquery/postgresql"
  registry: cloudquery
  version: "v8.8.8"
  write_mode: "overwrite-delete-stale"
  spec:
    connection_string: "${CONNECTION_STRING}"

Skip Tables #

kind: source
spec:
  # Source spec section
  name: aws
  path: cloudquery/aws
  registry: cloudquery
  version: "v22.19.2"
  tables: ["*"]
  skip_tables:
    - aws_cloudtrail_events
    - aws_docdb_cluster_parameter_groups
    - aws_docdb_engine_versions
    - aws_ec2_instance_types
    - aws_ec2_vpc_endpoint_services
    - aws_elasticache_engine_versions
    - aws_elasticache_parameter_groups
    - aws_elasticache_reserved_cache_nodes_offerings
    - aws_elasticache_service_updates
    - aws_iam_group_last_accessed_details
    - aws_iam_policy_last_accessed_details
    - aws_iam_role_last_accessed_details
    - aws_iam_user_last_accessed_details
    - aws_neptune_cluster_parameter_groups
    - aws_neptune_db_parameter_groups
    - aws_rds_cluster_parameter_groups
    - aws_rds_db_parameter_groups
    - aws_rds_engine_versions
    - aws_servicequotas_services
    - aws_stepfunctions_map_run_executions
    - aws_stepfunctions_map_runs
  destinations: ["postgresql"]
  spec:
    # AWS Spec section described below

Event-Based Sync

Supported Services and Events #

Configuration #

1. Configure an AWS CloudTrail Trail to send management events to a Kinesis Data Stream via CloudWatch Logs. The most straight-forward way to do this is to use the CloudFormation template provided by CloudQuery.

aws cloudformation deploy --template-file ./streaming-deployment.yml --stack-name <STACK-NAME> --capabilities CAPABILITY_IAM --disable-rollback --region <DESIRED-REGION>

aws cloudformation describe-stacks --stack-name <STACK-NAME> --query "Stacks[].Outputs" --region <DESIRED-REGION>

3. Define a config.yml file like the one below

kind: source
spec:
  name: "aws-event-based"
  registry: "local"
  path: <PATH/TO/BINARY>
  tables:
    - aws_ec2_instances
    - aws_ec2_internet_gateways
    - aws_ec2_security_groups
    - aws_ec2_subnets
    - aws_ec2_vpcs
    - aws_ecs_cluster_tasks
    - aws_iam_groups
    - aws_iam_roles
    - aws_iam_users
    - aws_rds_instances
  destinations: ["postgresql"]
  spec:
    event_based_sync:
      # account:
      #  local_profile: "<ROLE-NAME>"
      kinesis_stream_arn: <OUTPUT-FROM-CLOUDFORMATION-STACK>

4. Sync the data!

cloudquery sync config.yml

Limitations #

• Kinesis Stream can only have a single shard. (This is a limitation that we expect to remove in the future)
• Stale records will only be deleted if the plugin stops consuming the Kinesis Stream, which only can occur if there is an error

Multi Account Configuration Tutorial

AWS Organizations #

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

1. Have a role (or user) in an Admin account with the following access:

• organizations:ListAccounts
• organizations:ListAccountsForParent
• organizations:ListChildren

2. Have a role in each member account that has a trust policy with a single principal. The default profile name is OrganizationAccountAccessRole. The OrganizationAccountAccessRole is created by default in AWS Accounts created as part of an AWS Organization. We do not recommend using the OrganizationAccountAccessRole due to the level of permissions typically granted to the role, but instead recommend for CloudQuery users to create their own IAM roles in each member account with the appropriate read-only permissions. We also recommend ensuring that the IAM roles and policies used for CloudQuery adhere to company security standards.

• Reference IAM assets and the CloudFormation templates for deployment in an AWS Organization for CloudQuery can be found here.

1. It is always necessary to specify a member role name:

   org:
         member_role_name: cloudquery-ro

2. Sourcing credentials that have the necessary organizations permissions can be done in any of the following ways:

   1. Source credentials from the default credential tool chain:

      org:
            member_role_name: cloudquery-ro

   2. Source credentials from a named profile in the shared configuration or credentials file

      org:
            member_role_name: cloudquery-ro
            admin_account:
              local_profile: <Named-Profile>

   3. Assume a role in admin account using credentials in the shared configuration or credentials file:

      org:
            member_role_name: cloudquery-ro
            admin_account:
              local_profile: <Named-Profile>
              role_arn: arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>
      
              # Optional. Specify the name of the session
              # role_session_name: ""
      
              # Optional. Specify the ExternalID if required for trust policy
              # external_id: ""

3. Optional. If the trust policy configured for the member accounts requires different credentials than you configured in the previous step, then you can specify the credentials to use in the member_trusted_principal block:

   org:
         member_role_name: cloudquery-ro
         member_trusted_principal:
           local_profile: <Named-Profile-Member>

4. Optional. If you want to specify specific Organizational Units to fetch from you can add them to the organization_units list.

   org:
         member_role_name: cloudquery-ro
         organization_units:
           - ou-<ID-1>
           - ou-<ID-2>

   Child OUs will also be included. To skip a child OU or account, use the skip_organization_units or skip_member_accounts options respectively:

   org:
         member_role_name: cloudquery-ro
         organization_units:
           - ou-<ID-1>
           - ou-<ID-2>
         skip_organization_units:
           - ou-<ID-3>
         skip_member_accounts:
           - <ACCOUNT_ID>

Arguments for Org block #

Multi Account: Specific Accounts #

accounts:
  - id: <AccountID_Alias_1>
    role_arn: <YOUR_ROLE_ARN_1>
    # Optional. Local Profile is the named profile in your shared configuration file (usually `~/.aws/config`) that you want to use for this specific account
    local_profile: <NAMED_PROFILE>
    # Optional. Specify the Role Session name
    role_session_name: ""
  - id: <AccountID_Alias_2>
    local_profile: provider
    # Optional. Role ARN we want to assume when accessing this account
    role_arn: <YOUR_ROLE_ARN_2>

Arguments for Accounts block #

Plugin Versioning #

Breaking changes #

1. Changing a primary key for a table
2. Changing the name of a table
3. Changing the permissions required to sync a resource

Preview features #

Current Preview features

• the table_options parameter in the AWS plugin spec
• All tables that are prefixed with aws_alpha_ including:

  • aws_alpha_cloudwatch_metrics

    • aws_alpha_cloudwatch_metric_statistics
  • aws_alpha_costexplorer_cost_custom