firewall_metadatas
Creates, updates, deletes, gets or lists a firewall_metadatas resource.
Overview
| Name | firewall_metadatas |
| Type | Resource |
| Id | aws.network_firewall.firewall_metadatas |
Fields
The following fields are returned by SELECT queries:
- describe_firewall_metadata
| Name | Datatype | Description |
|---|---|---|
description | string | A description of the firewall. (pattern: <code>^.*$</code>) |
firewall_arn | string | The Amazon Resource Name (ARN) of the firewall. (pattern: <code>^arn:aws.*</code>) |
firewall_policy_arn | string | The Amazon Resource Name (ARN) of the firewall policy. (pattern: <code>^arn:aws.*</code>) |
status | string | The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY. (PROVISIONING, DELETING, READY) |
supported_availability_zones | object | The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined. |
transit_gateway_attachment_id | string | The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls. (pattern: <code>^tgw-attach-[0-9a-z]+$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_firewall_metadata | select | region | Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_firewall_metadata
Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
SELECT
description,
firewall_arn,
firewall_policy_arn,
status,
supported_availability_zones,
transit_gateway_attachment_id
FROM aws.network_firewall.firewall_metadatas
WHERE region = '{{ region }}' -- required
;