Skip to main content

Runs collector plugins and sends the result to fixcore.

Project description

fix-plugin-aws

An AWS collector plugin for Fix.

Usage

For details on how to edit configuration, please see the documentation.

When the collector is enabled (fixworker.collector = [aws]) it will automatically collect any accounts the AWS boto3 SDK can authenticate for. By default it will check for environment variables like AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY or AWS_SESSION_TOKEN.

If Fix should assume an IAM role that role can be given via fixworker.aws.role = SomeRoleName.

The collector will scrape resources in all regions unless regions are specified using e.g. fixworker.aws.region = [us-east-1, us-west-2].

Scraping multiple accounts

If the given credentials are allowed to assume the specified role in other accounts of your AWS organisation, Fix can collect multiple accounts at the same time. To do so provide the account IDs to the fixworker.aws.account configuration.

Scraping the entire organisation

Instead of giving a list of account IDs manually you could also specify fixworker.aws.scrape_org, which will make Fix try to get the list of all accounts using the ListAccounts API.

If certain accounts are to be excluded from that list they can be specified using the fixworker.aws.scrape_exclude_account config option.

Miscellaneous Options

When collecting multiple accounts Fix by default will collect the accounts it finds in the org as well as the one it is currently authenticated as. If you do not want it to scrape the account that was used to get the list of all org accounts (e.g. your root account) you can specify fixworker.aws.dont_scrape_current.

If instead of using the current credentials you would like Fix to assume the specified role (fixworker.aws.role) even for the current account you can specify the options fixworker.aws.assume_current and fixworker.aws.dont_scrape_current. This would make it so that Fix does not scrape the current account using default credentials but instead assume the specified IAM role even for the current account.

License

See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fixinventory_plugin_aws-4.1.0.tar.gz (295.7 kB view details)

Uploaded Source

Built Distribution

fixinventory_plugin_aws-4.1.0-py3-none-any.whl (352.6 kB view details)

Uploaded Python 3

File details

Details for the file fixinventory_plugin_aws-4.1.0.tar.gz.

File metadata

File hashes

Hashes for fixinventory_plugin_aws-4.1.0.tar.gz
Algorithm Hash digest
SHA256 b7591d20cc70236664e7ee2ba7ece282cc4265b82c575a959c8f9f871bceb4e5
MD5 267db05bf0ae4e2b57efd8a5a52817cd
BLAKE2b-256 3c1ed6edc23b98677e3b3766f0b795094b178fb9ca4ac1753c863c3e3617a654

See more details on using hashes here.

File details

Details for the file fixinventory_plugin_aws-4.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for fixinventory_plugin_aws-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2047063136fd0ea3aa2f44d185bccf7dc0ba5c0701b40ee9a0b1ae8db730a63
MD5 74f38a283e44bf07b2d284c056fa7012
BLAKE2b-256 af2f85f70fe00755ca7710a66a9b537e2a563274e7e66d6d5dc3202ecd453cb4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page