Try Spotterdescribe AWS Network Firewall policies
| "added in version" 4.0.0 of community.aws"
Authors: Mark Chappell (@tremble)
Install with ansible-galaxy collection install community.aws:==4.3.0
collections:
- name: community.aws
version: 4.3.0A module for describing AWS Network Firewall policies.
# Describe all Firewall policies in an account
- community.aws.networkfirewall_policy_info: {}
# Describe a Firewall policy by ARN
- community.aws.networkfirewall_policy_info:
arn: arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy
# Describe a Firewall policy by name
- community.aws.networkfirewall_policy_info:
name: ExamplePolicy
arn:
description:
- The ARN of the Network Firewall policy.
- Mutually exclusive with I(name).
required: false
type: str
name:
description:
- The name of the Network Firewall policy.
- Mutually exclusive with I(arn).
required: false
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Uses a boto profile. Only works with boto >= 2.24.0.
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
aws_ca_bundle:
description:
- 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.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- 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 I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- 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 I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN
environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
type: bool
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
policies:
contains:
policy:
contains:
stateful_engine_options:
contains:
rule_order:
description:
- How rule group evaluation will be ordered.
- For more information on rule evaluation ordering see the AWS documentation
U(https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html).
example: DEFAULT_ACTION_ORDER
returned: success
type: str
description:
- Extra options describing how the stateful rules should be handled.
returned: success
type: dict
stateful_rule_group_references:
contains:
priority:
description:
- An integer that indicates the order in which to run the stateful rule
groups in a single policy.
- This only applies to policies that specify the STRICT_ORDER rule order
in the stateful engine options settings.
example: 1234
returned: success
type: int
resource_arn:
description: The ARN of the rule group.
example: arn:aws:network-firewall:us-east-1:aws-managed:stateful-rulegroup/AbusedLegitMalwareDomainsActionOrder
returned: success
type: str
description: Information about the stateful rule groups attached to the
policy.
elements: dict
returned: success
type: list
stateless_custom_actions:
contains:
action_definition:
contains:
publish_metric_action:
contains:
dimensions:
contains:
value:
description: A value of the CustomAction dimension to set
on the metrics.
example: ExampleRule
returned: success
type: str
description:
- The values of the CustomAction dimension to set on the metrics.
- The dimensions of a metric are used to identify unique streams
of data.
elements: dict
returned: success
type: list
description:
- Definition of a custom metric to be published to CloudWatch.
- U(https://docs.aws.amazon.com/network-firewall/latest/developerguide/monitoring-cloudwatch.html)
returned: success
type: dict
description: The action to perform.
returned: success
type: dict
action_name:
description: A name for the action.
example: ExampleAction
returned: success
type: str
description:
- A description of additional custom actions available for use as default
rules to apply to stateless packets.
elements: dict
returned: success
type: list
stateless_default_actions:
description: The default actions to take on a packet that doesn't match
any stateful rules.
elements: str
example:
- aws:alert_strict
returned: success
type: list
stateless_fragment_default_actions:
description: The actions to take on a packet if it doesn't match any of
the stateless rules in the policy.
elements: str
example:
- aws:pass
returned: success
type: list
stateless_rule_group_references:
contains:
priority:
description:
- An integer that indicates the order in which to run the stateless
rule groups in a single policy.
example: 12345
returned: success
type: str
resource_arn:
description: The ARN of the rule group.
example: arn:aws:network-firewall:us-east-1:123456789012:stateless-rulegroup/ExampleGroup
returned: success
type: str
description: Information about the stateful rule groups attached to the
policy.
elements: dict
returned: success
type: list
description: The details of the policy
returned: success
type: dict
policy_metadata:
contains:
consumed_stateful_rule_capacity:
description: The total number of capacity units used by the stateful rule
groups.
example: 165
returned: success
type: int
consumed_stateless_rule_capacity:
description: The total number of capacity units used by the stateless rule
groups.
example: 2010
returned: success
type: int
firewall_policy_arn:
description: The ARN of the policy.
example: arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy
returned: success
type: str
firewall_policy_id:
description: The unique ID of the policy.
example: 12345678-abcd-1234-5678-123456789abc
returned: success
type: str
firewall_policy_name:
description: The name of the policy.
example: ExamplePolicy
returned: success
type: str
firewall_policy_status:
description: The current status of the policy.
example: ACTIVE
returned: success
type: str
number_of_associations:
description: The number of firewalls the policy is associated to.
example: 1
returned: success
type: int
tags:
description: A dictionary representing the tags associated with the policy.
example:
tagName: Some Value
returned: success
type: dict
description: Metadata about the policy
returned: success
type: dict
description: The details of the policies
elements: dict
returned: success
type: list
policy_list:
description: A list of ARNs of the matching policies.
elements: str
example:
- arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/Example1
- arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/Example2
returned: When a policy name isn't specified
type: list