Skip to main content

AWS

This config type is used to scrape information about your AWS infrastructure.

logLevel: ""
schedule: "@every 15m"
retention:
changes:
- name: CreateRole
age: 30d # Any change older than 30 days is removed
count: 50 # Only 50 last changes will be retained
aws:
- region:
- eu-west-2
- us-east-1
- af-south-1
- ap-south-1
- eu-central-1
compliance: true
patch_states: false
trusted_advisor_check: false
patch_details: false
cost_reporting:
s3_bucket_path: s3://flanksource-cost-reports/query-results
database: athenacurcfn_flanksource_report
table: flanksource_report
region: af-south-1
inventory: true
exclude:
- Amazon EC2 Reserved Instances Optimization
- Savings Plan
transform:
exclude:
- jsonpath: $.tags
- jsonpath: $.privateDnsNameOptionsOnLaunch
- jsonpath: outpostArn
- jsonpath: mapCustomerOwnedIpOnLaunch
- jsonpath: subnetArn

Scraper

FieldDescriptionSchemeRequired
logLevelSpecify the level of logging.stringfalse
scheduleSpecify the interval to scrape in cron format. Defaults to every 60 minutes.stringfalse
fullSet to true to extract changes from scraped configurations. Defaults to false.boolfalse
retentionSettings for retaining changes, analysis and scraped itemsRetention
awsSpecifies the list of AWS configurations to scrape.[]AWSfalse

AWS

FieldDescriptionSchemeRequired
idA static value or JSONPath expression to use as the ID for the resource.stringtrue
nameA static value or JSONPath expression to use as the Name for the resource. Default value is the id.stringfalse
itemsA JSONPath expression to use to extract individual items from the resourcestringfalse
typeA static value or JSONPath expression to use as the type for the resource.stringtrue
transformSpecify field to transform resultTransformfalse
formatFormat of config item, defaults to JSON, available options are JSONstringfalse
timestampFormatTimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is RFC3339.stringfalse
createFieldsCreateFields is a list of JSONPath expression used to identify the created time of the config. If multiple fields are specified, the first non-empty value will be used[]stringfalse
deleteFieldsDeleteFields is a JSONPath expression used to identify the deleted time of the config. If multiple fields are specified, the first non-empty value will be used[]stringfalse
complianceToggle scraping of compliance metadatabool
patch_statesSet boolean value for scraping of patch state status, and reportbool
trusted_advisor_checkSet boolean value for enabling/disabling trusted advisorbool
patch_detailsSet boolean value to enable/disable scraping of patch detailsbool
cost_reportingSpecify cost reporting for scraping of dataCostReporting
cloud_trailSet CloudTrail specificationsCloudTrail
includeSpecify AWS resources to include for scraping[]string
excludeSpecify AWS resources to exclude from scraping[]string
inventoryToggle scrape of metadata for AWS resourcesbool

CloudTrail (cloudtrail)

FieldDescriptionSchemeRequired
excludeSet events to be excluded from scraping[]string
max_ageSet maximum age of events for scrapingstring

Cost Reporting (cost_reporting)

FieldDescriptionSchemeRequired
s3_bucket_pathSet path for S3 bucket to scrape published AWS billing reportsstring
tableSpecify table containing cost and usage datastring
databaseSpecify database containing cost and usage datastring
regionSpecify region for S3 bucketstring

Supported Resources

  • Account
  • CloudTrail
  • Config Rules
  • Cost & Usage Reporting
  • EBS
  • EC2
  • ECR
  • EFS
  • EKS
  • IAM
  • Load Balancers
  • RDS
  • Route53
  • Subnet
  • Trusted Advisor
  • VPC