View Source AWS.NetworkFirewall (aws-elixir v1.0.7)
This is the API Reference for Network Firewall.
This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.
The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
To view the complete list of Amazon Web Services Regions where Network Firewall is available, see Service endpoints and quotas in the Amazon Web Services General Reference.
To access Network Firewall using the IPv4 REST API endpoint:
https://network-firewall..amazonaws.com
To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API
endpoint:
https://network-firewall..aws.api
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs. For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.
Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 7.0.3. For information about Suricata, see the Suricata website and the Suricata User Guide.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:
* Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.
* Use custom lists of known bad domains to limit the types of domain names that your applications can access.
* Perform deep packet inspection on traffic entering or leaving your VPC.
* Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.
To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
To start using Network Firewall, do the following:
1. (Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.
2. In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.
3. In Network Firewall, define the firewall behavior as follows:
1.
Create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
2.
Create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
4. In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.
5. In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.
After your firewall is established, you can add firewall endpoints for new Availability Zones by following the prior steps for the Amazon VPC setup and firewall subnet definitions. You can also add endpoints to Availability Zones that you're using in the firewall, either for the same VPC or for another VPC, by following the prior steps for the Amazon VPC setup, and defining the new VPC subnets as VPC endpoint associations.
Link to this section Summary
Functions
Accepts a transit gateway attachment request for Network Firewall.
Associates the specified Availability Zones with a transit gateway-attached firewall.
Associates a FirewallPolicy
to a Firewall
.
Associates the specified subnets in the Amazon VPC to the firewall.
Creates an Network Firewall Firewall
and accompanying FirewallStatus
for a
VPC.
Creates the firewall policy for the firewall according to the specifications.
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
Creates an Network Firewall TLS inspection configuration.
Creates a firewall endpoint for an Network Firewall firewall.
Deletes the specified Firewall
and its FirewallStatus
.
Deletes the specified FirewallPolicy
.
Deletes a transit gateway attachment from a Network Firewall.
Deletes a resource policy that you created in a PutResourcePolicy
request.
Deletes the specified RuleGroup
.
Deletes the specified TLSInspectionConfiguration
.
Deletes the specified VpcEndpointAssociation
.
Returns the data objects for the specified firewall.
Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
Returns the data objects for the specified firewall policy.
Returns key information about a specific flow operation.
Returns the logging configuration for the specified firewall.
Retrieves a resource policy that you created in a PutResourcePolicy
request.
Returns the data objects for the specified rule group.
High-level information about a rule group, returned by operations like create and describe.
Returns detailed information for a stateful rule group.
Returns the data objects for the specified TLS inspection configuration.
Returns the data object for the specified VPC endpoint association.
Removes the specified Availability Zone associations from a transit gateway-attached firewall.
Removes the specified subnet associations from the firewall.
The results of a COMPLETED
analysis report generated with
StartAnalysisReport
.
Returns a list of all traffic analysis reports generated within the last 30 days.
Retrieves the metadata for the firewall policies that you have defined.
Retrieves the metadata for the firewalls that you have defined.
Returns the results of a specific flow operation.
Returns a list of all flow operations ran in a specific firewall.
Retrieves the metadata for the rule groups that you have defined.
Retrieves the metadata for the TLS inspection configurations that you have defined.
Retrieves the tags associated with the specified resource.
Retrieves the metadata for the VPC endpoint associations that you have defined.
Creates or updates an IAM policy for your rule group, firewall policy, or firewall.
Rejects a transit gateway attachment request for Network Firewall.
Generates a traffic analysis report for the timeframe and traffic type you specify.
Begins capturing the flows in a firewall, according to the filters you define.
Begins the flushing of traffic from the firewall, according to the filters you define.
Adds the specified tags to the specified resource.
Removes the tags with the specified keys from the specified resource.
Modifies the AvailabilityZoneChangeProtection
setting for a transit
gateway-attached firewall.
Enables specific types of firewall analysis on a specific firewall you define.
Modifies the flag, DeleteProtection
, which indicates whether it is possible
to delete the firewall.
Modifies the description for the specified firewall.
A complex type that contains settings for encryption of your firewall resources.
Updates the properties of the specified firewall policy.
Modifies the flag, ChangeProtection
, which indicates whether it
is possible to change the firewall.
Sets the logging configuration for the specified firewall.
Updates the rule settings for the specified rule group.
Updates the TLS inspection configuration settings for the specified TLS inspection configuration.
Link to this section Functions
accept_network_firewall_transit_gateway_attachment(client, input, options \\ [])
View SourceAccepts a transit gateway attachment request for Network Firewall.
When you accept the attachment request, Network Firewall creates the necessary routing components to enable traffic flow between the transit gateway and firewall endpoints.
You must accept a transit gateway attachment to complete the creation of a
transit gateway-attached firewall, unless auto-accept is enabled on the transit
gateway. After acceptance, use DescribeFirewall
to verify the firewall status.
To reject an attachment instead of accepting it, use
RejectNetworkFirewallTransitGatewayAttachment
.
It can take several minutes for the attachment acceptance to complete and the firewall to become available.
Associates the specified Availability Zones with a transit gateway-attached firewall.
For each Availability Zone, Network Firewall creates a firewall endpoint to process traffic. You can specify one or more Availability Zones where you want to deploy the firewall.
After adding Availability Zones, you must update your transit gateway route
tables to direct traffic through the new firewall endpoints. Use
DescribeFirewall
to monitor the status of the new endpoints.
Associates a FirewallPolicy
to a Firewall
.
A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
Associates the specified subnets in the Amazon VPC to the firewall.
You can specify one subnet for each of the Availability Zones that the VPC spans.
This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.
Creates an Network Firewall Firewall
and accompanying FirewallStatus
for a
VPC.
The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.
After you create a firewall, you can provide additional settings, like the logging configuration.
To update the settings for a firewall, you use the operations that apply to the
settings
themselves, for example UpdateLoggingConfiguration
, AssociateSubnets
, and
UpdateFirewallDeleteProtection
.
To manage a firewall's tags, use the standard Amazon Web Services resource
tagging operations, ListTagsForResource
, TagResource
, and UntagResource
.
To retrieve information about firewalls, use ListFirewalls
and
DescribeFirewall
.
To generate a report on the last 30 days of traffic monitored by a firewall, use
StartAnalysisReport
.
Creates the firewall policy for the firewall according to the specifications.
An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
You provide your rule group specification in your request using either
RuleGroup
or Rules
.
create_t_l_s_inspection_configuration(client, input, options \\ [])
View SourceCreates an Network Firewall TLS inspection configuration.
Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.
To update the settings for a TLS inspection configuration, use
UpdateTLSInspectionConfiguration
.
To manage a TLS inspection configuration's tags, use the standard Amazon Web
Services resource tagging operations, ListTagsForResource
, TagResource
, and
UntagResource
.
To retrieve information about TLS inspection configurations, use
ListTLSInspectionConfigurations
and DescribeTLSInspectionConfiguration
.
For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
Creates a firewall endpoint for an Network Firewall firewall.
This type of firewall endpoint is independent of the firewall endpoints that you
specify in the Firewall
itself, and you define it in addition to those
endpoints after the firewall has been created. You can define a VPC endpoint
association using a different VPC than the one you used in the firewall
specifications.
Deletes the specified Firewall
and its FirewallStatus
.
This operation requires the firewall's DeleteProtection
flag to be
FALSE
. You can't revert this operation.
You can check whether a firewall is
in use by reviewing the route tables for the Availability Zones where you have
firewall subnet mappings. Retrieve the subnet mappings by calling
DescribeFirewall
.
You define and update the route tables through Amazon VPC. As needed, update the
route tables for the
zones to remove the firewall endpoints. When the route tables no longer use the
firewall endpoints,
you can remove the firewall safely.
To delete a firewall, remove the delete protection if you need to using
UpdateFirewallDeleteProtection
,
then delete the firewall by calling DeleteFirewall
.
Deletes the specified FirewallPolicy
.
delete_network_firewall_transit_gateway_attachment(client, input, options \\ [])
View SourceDeletes a transit gateway attachment from a Network Firewall.
Either the firewall owner or the transit gateway owner can delete the attachment.
After you delete a transit gateway attachment, raffic will no longer flow through the firewall endpoints.
After you initiate the delete operation, use DescribeFirewall
to monitor the
deletion status.
Deletes a resource policy that you created in a PutResourcePolicy
request.
Deletes the specified RuleGroup
.
delete_t_l_s_inspection_configuration(client, input, options \\ [])
View SourceDeletes the specified TLSInspectionConfiguration
.
Deletes the specified VpcEndpointAssociation
.
You can check whether an endpoint association is
in use by reviewing the route tables for the Availability Zones where you have
the endpoint subnet mapping.
You can retrieve the subnet mapping by calling DescribeVpcEndpointAssociation
.
You define and update the route tables through Amazon VPC. As needed, update the
route tables for the
Availability Zone to remove the firewall endpoint for the association. When the
route tables no longer use the firewall endpoint,
you can remove the endpoint association safely.
Returns the data objects for the specified firewall.
Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
Returns the data objects for the specified firewall policy.
Returns key information about a specific flow operation.
Returns the logging configuration for the specified firewall.
Retrieves a resource policy that you created in a PutResourcePolicy
request.
Returns the data objects for the specified rule group.
High-level information about a rule group, returned by operations like create and describe.
You can use the information provided in the metadata to retrieve and manage a
rule group.
You can retrieve all objects for a rule group by calling DescribeRuleGroup
.
Returns detailed information for a stateful rule group.
For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.
To modify how threat information appears in summaries, use the
SummaryConfiguration
parameter in UpdateRuleGroup
.
describe_t_l_s_inspection_configuration(client, input, options \\ [])
View SourceReturns the data objects for the specified TLS inspection configuration.
Returns the data object for the specified VPC endpoint association.
Removes the specified Availability Zone associations from a transit gateway-attached firewall.
This removes the firewall endpoints from these Availability Zones and stops traffic filtering in those zones. Before removing an Availability Zone, ensure you've updated your transit gateway route tables to redirect traffic appropriately.
If AvailabilityZoneChangeProtection
is enabled, you must first disable it
using UpdateAvailabilityZoneChangeProtection
.
To verify the status of your Availability Zone changes, use DescribeFirewall
.
Removes the specified subnet associations from the firewall.
This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.
The results of a COMPLETED
analysis report generated with
StartAnalysisReport
.
For more information, see AnalysisTypeReportResult
.
Returns a list of all traffic analysis reports generated within the last 30 days.
Retrieves the metadata for the firewall policies that you have defined.
Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.
Retrieves the metadata for the firewalls that you have defined.
If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.
Depending on your setting for max results and the number of firewalls, a single call might not return the full list.
Returns the results of a specific flow operation.
Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
Returns a list of all flow operations ran in a specific firewall.
You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations.
Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
Retrieves the metadata for the rule groups that you have defined.
Depending on your setting for max results and the number of rule groups, a single call might not return the full list.
list_t_l_s_inspection_configurations(client, input, options \\ [])
View SourceRetrieves the metadata for the TLS inspection configurations that you have defined.
Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.
Retrieves the tags associated with the specified resource.
Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
Retrieves the metadata for the VPC endpoint associations that you have defined.
If you specify a fireawll, this returns only the endpoint associations for that firewall.
Depending on your setting for max results and the number of associations, a single call might not return the full list.
Creates or updates an IAM policy for your rule group, firewall policy, or firewall.
Use this to share these resources between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
For information about using sharing with Network Firewall resources, see Sharing Network Firewall resources in the Network Firewall Developer Guide.
Use this operation to create or update a resource policy for your Network Firewall rule group, firewall policy, or firewall. In the resource policy, you specify the accounts that you want to share the Network Firewall resource with and the operations that you want the accounts to be able to perform.
When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared resource.
*
GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
*
- Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see Resource Access Manager User Guide.
reject_network_firewall_transit_gateway_attachment(client, input, options \\ [])
View SourceRejects a transit gateway attachment request for Network Firewall.
When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints.
Only the firewall owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment.
Use DescribeFirewall
to monitor the rejection status. To accept the attachment
instead of rejecting it, use AcceptNetworkFirewallTransitGatewayAttachment
.
Once rejected, you cannot reverse this action. To establish connectivity, you must create a new transit gateway-attached firewall.
Generates a traffic analysis report for the timeframe and traffic type you specify.
For information on the contents of a traffic analysis report, see
AnalysisReport
.
Begins capturing the flows in a firewall, according to the filters you define.
Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table. Unlike snapshots, captures are a time-boxed view.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
To avoid encountering operation limits, you should avoid starting captures with
broad filters, like wide IP ranges.
Instead, we recommend you define more specific criteria with FlowFilters
, like
narrow IP ranges, ports, or protocols.
Begins the flushing of traffic from the firewall, according to the filters you define.
When the operation starts, impacted flows are temporarily marked as timed out before the Suricata engine prunes, or flushes, the flows from the firewall table.
While the flush completes, impacted flows are processed as midstream traffic. This may result in a temporary increase in midstream traffic metrics. We recommend that you double check your stream exception policy before you perform a flush operation.
Adds the specified tags to the specified resource.
Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
Removes the tags with the specified keys from the specified resource.
Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
update_availability_zone_change_protection(client, input, options \\ [])
View SourceModifies the AvailabilityZoneChangeProtection
setting for a transit
gateway-attached firewall.
When enabled, this setting prevents accidental changes to the firewall's Availability Zone configuration. This helps protect against disrupting traffic flow in production environments.
When enabled, you must disable this protection before using
AssociateAvailabilityZones
or DisassociateAvailabilityZones
to modify the
firewall's Availability Zone configuration.
Enables specific types of firewall analysis on a specific firewall you define.
Modifies the flag, DeleteProtection
, which indicates whether it is possible
to delete the firewall.
If the flag is set to TRUE
, the firewall is protected
against deletion. This setting helps protect against accidentally deleting a
firewall
that's in use.
Modifies the description for the specified firewall.
Use the description to help you identify the firewall when you're working with it.
update_firewall_encryption_configuration(client, input, options \\ [])
View SourceA complex type that contains settings for encryption of your firewall resources.
Updates the properties of the specified firewall policy.
update_firewall_policy_change_protection(client, input, options \\ [])
View SourceModifies the flag, ChangeProtection
, which indicates whether it
is possible to change the firewall.
If the flag is set to TRUE
, the firewall is protected
from changes. This setting helps protect against accidentally changing a
firewall that's in use.
Sets the logging configuration for the specified firewall.
To change the logging configuration, retrieve the LoggingConfiguration
by
calling DescribeLoggingConfiguration
, then change it and provide
the modified object to this update call. You must change the logging
configuration one
LogDestinationConfig
at a time inside the retrieved LoggingConfiguration
object.
You can perform only one of the following actions in any call to
UpdateLoggingConfiguration
:
*
Create a new log destination object by adding a single
LogDestinationConfig
array element to
LogDestinationConfigs
.
*
Delete a log destination object by removing a single
LogDestinationConfig
array element from
LogDestinationConfigs
.
*
Change the LogDestination
setting in a single
LogDestinationConfig
array element.
You can't change the LogDestinationType
or LogType
in a
LogDestinationConfig
. To change these settings, delete the existing
LogDestinationConfig
object and create a new one, using two separate calls
to this update operation.
Updates the rule settings for the specified rule group.
You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.
To update a rule group, first call DescribeRuleGroup
to retrieve the
current RuleGroup
object, update the object as needed, and then provide
the updated object to this call.
update_t_l_s_inspection_configuration(client, input, options \\ [])
View SourceUpdates the TLS inspection configuration settings for the specified TLS inspection configuration.
You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration.
To update a TLS inspection configuration, first call
DescribeTLSInspectionConfiguration
to retrieve the
current TLSInspectionConfiguration
object, update the object as needed, and
then provide
the updated object to this call.