Skip to content

Latest commit

 

History

History
663 lines (620 loc) · 28.9 KB

community.missing_collection.aws_waf_info_module.rst

File metadata and controls

663 lines (620 loc) · 28.9 KB
Raw

community.missing_collection.aws_waf_info

Get Information about AWS WAF Classic (V1).

Version added: 0.1.0

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 the rule group.

aliases: rule_group_id
list_activated_rules_in_rule_group
boolean
    Choices:
  • no
  • yes
do you want to get list of activated_rules_in_rule_group for given id?
list_byte_match_sets
boolean
    Choices:
  • no
  • yes
do you want to get byte_match_sets?
list_geo_match_sets
boolean
    Choices:
  • no
  • yes
do you want to get list of geo_match_sets?
list_ip_sets
boolean
    Choices:
  • no
  • yes
do you want to get ip_sets?
list_logging_configurations
boolean
    Choices:
  • no
  • yes
do you want to get logging_configurations?
list_rate_based_rules
boolean
    Choices:
  • no
  • yes
do you want to get rate_based_rules?
list_regex_match_sets
boolean
    Choices:
  • no
  • yes
do you want to get regex_match_sets?
list_rule_groups
boolean
    Choices:
  • no
  • yes
do you want to get rule_groups?
list_rules
boolean
    Choices:
  • no
  • yes
do you want to get rules?
list_size_constraint_sets
boolean
    Choices:
  • no
  • yes
do you want to get size_constraint_sets?
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 activated_rules_in_rule_group"
  aws_waf_info:
    list_activated_rules_in_rule_group: true
    id: 'rule_group_id'

- name: "get byte_match_sets"
  aws_waf_info:
    list_byte_match_sets: true

- name: "get list of geo_match_sets"
  aws_waf_info:
    list_geo_match_sets: true

- name: "get ip_sets"
  aws_waf_info:
    list_ip_sets: true

- name: "get logging_configurations"
  aws_waf_info:
    list_logging_configurations: true

- name: "get rate_based_rules"
  aws_waf_info:
    list_rate_based_rules: true

- name: "get regex_match_sets"
  aws_waf_info:
    list_regex_match_sets: true

- name: "get rule_groups"
  aws_waf_info:
    list_rule_groups: true

- name: "get rules"
  aws_waf_info:
    list_rules: true

- name: "get size_constraint_sets"
  aws_waf_info:
    list_size_constraint_sets: true

Return Values

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

Key Returned Description
activated_rules_in_rule_group
list
when `list_activated_rules_in_rule_group` is defined and success.
list of activated_rules_in_rule_group.
byte_match_sets
list
when `list_byte_match_sets` is defined and success.
get of byte_match_sets.
geo_match_sets
list
when `list_geo_match_sets` is defined and success.
list of geo_match_sets.
ip_sets
list
when `list_ip_sets` is defined and success.
list of ip_sets.
logging_configurations
list
when `list_logging_configurations` is defined and success.
list of logging_configurations.
rate_based_rules
list
when `list_rate_based_rules` is defined and success.
list of rate_based_rules.
regex_match_sets
list
when `list_regex_match_sets` is defined and success.
list of regex_match_sets.
rule_groups
list
when `list_rule_groups` is defined and success.
list of rule_groups.
rules
list
when `list_rules` is defined and success.
list of rules.
size_constraint_sets
list
when `list_size_constraint_sets` is defined and success.
list of size_constraint_sets.


Status

Authors