Skip to content

Latest commit

 

History

History
629 lines (587 loc) · 27.4 KB

community.missing_collection.aws_guardduty_info_module.rst

File metadata and controls

629 lines (587 loc) · 27.4 KB
Raw

community.missing_collection.aws_guardduty_info

Get Information about Amazon GuardDuty.

Version added: 0.0.6

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
ec2_url
string
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
id
string
id of detector.
list_detectors
boolean
    Choices:
  • no
  • yes
do you want to get list of detectors?
list_filters
boolean
    Choices:
  • no
  • yes
do you want to get list of filters for given id?
list_findings
boolean
    Choices:
  • no
  • yes
do you want to get list of findings for given id?
list_invitations
boolean
    Choices:
  • no
  • yes
do you want to get list of invitation?
list_ip_sets
boolean
    Choices:
  • no
  • yes
do you want to get list of ip_sets for given id?
list_members
boolean
    Choices:
  • no
  • yes
do you want to get list of members for given id?
list_organization_admin_accounts
boolean
    Choices:
  • no
  • yes
do you want to get list of organization admin accounts?
list_publishing_destinations
boolean
    Choices:
  • no
  • yes
do you want to get list of publishing destinations for given id?
list_threat_intel_sets
boolean
    Choices:
  • no
  • yes
do you want to get list of threat intel sets for given id?
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

- name: "get list of detectors"
  aws_guardduty_info:
    list_detectors: true

- name: "get list of filters"
  aws_guardduty_info:
    list_filters: true
    id: 'test'

- name: "get list of findings"
  aws_guardduty_info:
    list_findings: true
    id: 'test'

- name: "get list of invitations"
  aws_guardduty_info:
    list_invitations: true

- name: "get list of ip_sets"
  aws_guardduty_info:
    list_ip_sets: true
    id: 'test'

- name: "get list of members"
  aws_guardduty_info:
    list_members: true
    id: 'test'

- name: "get list of organization admin accounts"
  aws_guardduty_info:
    list_organization_admin_accounts: true

- name: "get list of publishing destinations"
  aws_guardduty_info:
    list_publishing_destinations: true
    id: 'test'

- name: "get list of threat intel sets"
  aws_guardduty_info:
    list_threat_intel_sets: true
    id: 'test'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
detectors
list
when `list_detectors` is defined and success.
list of detectors.
filters
list
when `list_filters` is defined and success.
list of filters.
findings
list
when `list_findings` is defined and success.
list of findings.
invitations
list
when `list_invitations` is defined and success.
list of invitations.
ip_sets
list
when `list_ip_sets` is defined and success.
list of ip sets.
members
list
when `list_members` is defined and success.
list of members.
organization_admin_accounts
list
when `list_organization_admin_accounts` is defined and success.
list of organization admin accounts.
publishing_destinations
list
when `list_publishing_destinations` is defined and success.
list of publishing destinations.
threat_intel_sets
list
when `list_threat_intel_sets` is defined and success.
list of threat intel sets.


Status

Authors