community.aws.networkfirewall module – manage AWS Network Firewall firewalls
Note
This module is part of the community.aws collection (version 9.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.networkfirewall.
New in community.aws 4.0.0
Synopsis
A module for creating, updating and deleting AWS Network Firewall firewalls.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The ARN of the firewall. Exactly one of arn or name must be provided. |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
When delete_protection=True, the firewall is protected from deletion. Defaults to Choices:
|
|
A description for the firewall. |
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The name of the firewall. Cannot be updated after creation. Exactly one of arn or name must be provided. |
|
The ARN of the Network Firewall policy to use for the firewall. Required when creating a new firewall. |
|
When policy_change_protection=True, the firewall is protected from changes to which policy is attached to the firewall. Defaults to Choices:
|
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
If purge_subnets=true, existing subnets will be removed from the firewall as necessary to match exactly what is defined by subnets. Choices:
|
|
If If the Tag keys beginning with Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Create or remove the firewall. Choices:
|
|
When subnet_change_protection=True, the firewall is protected from changes to which subnets is attached to the firewall. Defaults to Choices:
|
|
The ID of the subnets to which the firewall will be associated. Required when creating a new firewall. |
|
A dictionary representing the tags to be applied to the resource. If the |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
On creation, whether to wait for the firewall to reach the On deletion, whether to wait for the firewall to reach the On update, whether to wait for the firewall to reach the Choices:
|
|
Maximum time, in seconds, to wait for the firewall to reach the expected state. Defaults to 600 seconds. |
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# Create an AWS Network Firewall
- community.aws.networkfirewall:
name: 'ExampleFirewall'
state: present
policy: 'ExamplePolicy'
subnets:
- 'subnet-123456789abcdef01'
# Create an AWS Network Firewall with various options, don't wait for creation
# to finish.
- community.aws.networkfirewall:
name: 'ExampleFirewall'
state: present
delete_protection: true
description: "An example Description"
policy: 'ExamplePolicy'
policy_change_protection: true
subnets:
- 'subnet-123456789abcdef01'
- 'subnet-abcdef0123456789a'
subnet_change_protection: true
tags:
ExampleTag: Example Value
another_tag: another_example
wait: false
# Delete an AWS Network Firewall
- community.aws.networkfirewall:
state: absent
name: 'ExampleFirewall'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The full details of the firewall Returned: success |
|
The details of the firewall Returned: success |
|
A flag indicating whether it is possible to delete the firewall. Returned: success Sample: |
|
A description of the firewall. Returned: success Sample: |
|
The ARN of the firewall. Returned: success Sample: |
|
A unique ID for the firewall. Returned: success Sample: |
|
The name of the firewall. Returned: success Sample: |
|
The ARN of the firewall policy used by the firewall. Returned: success Sample: |
|
A flag indicating whether it is possible to change which firewall policy is used by the firewall. Returned: success Sample: |
|
A flag indicating whether it is possible to change which subnets the firewall endpoints are in. Returned: success Sample: |
|
A list representing the subnets the firewall endpoints are in. Returned: success |
|
The ID of the subnet. Returned: success Sample: |
|
A list of the subnets the firewall endpoints are in. Returned: success Sample: |
|
The tags associated with the firewall. Returned: success Sample: |
|
The ID of the VPC that the firewall is used by. Returned: success Sample: |
|
Metadata about the firewall Returned: success |
|
A short summary of the synchronization status of the policy and rule groups. Returned: success Sample: |
|
A short summary of the status of the firewall endpoints. Returned: success Sample: |
|
A description, broken down by availability zone, of the status of the firewall endpoints as well as the synchronization status of the policies and rule groups. Returned: success Sample: |