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.<region>.amazonaws.com
To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint: https://network-firewall.<region>.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 8.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:
(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.
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.
In Network Firewall, define the firewall behavior as follows:
Create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
Create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
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.
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.
", "operations": { "AcceptNetworkFirewallTransitGatewayAttachment": "Accepts 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.
", "AssociateFirewallPolicy": "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.
", "AssociateSubnets": "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.
For a proxy mode firewall, use this operation to add Availability Zones to the firewall. For each subnet, specify a NAT gateway in NatGatewayCreateMappings in the same Availability Zone. You can't add an Availability Zone that the firewall already uses. The firewall keeps working in its other Availability Zones while Network Firewall sets up the new one. If Network Firewall can't set up the new Availability Zone, it removes the Availability Zone from the firewall. It also deletes the NAT gateway that it created there. The Availability Zone's Attachment status shows the reason. You can then add the Availability Zone again.
Creates a Network Firewall container association. The association monitors container lifecycle events in your Amazon ECS or Amazon EKS clusters and resolves running container addresses for use in firewall rules.
", "CreateFirewall": "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.
To create a proxy mode firewall, specify VpcEndpoint and NatGatewayCreateMappings instead of VpcId and SubnetMappings. A proxy mode firewall is an explicit forward proxy. Your clients send HTTP and HTTPS proxy requests to the firewall's proxy DNS name, which DescribeFirewall returns in each Availability Zone's Attachment. The firewall evaluates proxy traffic with the stateful rules in its firewall policy, and sends allowed traffic out through the NAT gateway in the same Availability Zone. Your clients don't need route table changes. In each Availability Zone, the firewall has one endpoint and one NAT gateway, which Network Firewall creates for you.
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.
", "CreateFirewallPolicyV2": "Creates a Next Generation policy according to the specifications.
A Next Generation policy defines the behavior of a firewall in a collection of firewall engine and IPS engine rule groups and other settings. You can use one firewall policy for multiple firewalls. For more information, see Next Generation policies in the Network Firewall Developer Guide.
", "CreateRuleGroup": "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.
Creates 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.
", "CreateVpcEndpointAssociation": "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 a container association. The resource transitions to a DELETING state. Deletion is asynchronous - Network Firewall returns immediately while cleanup proceeds in the background. You can't delete a container association while a rule group references it.
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.
Deleting a proxy mode firewall detaches its NAT gateways. To also delete the NAT gateways that Network Firewall created for the firewall, specify DeleteAssociatedNatGateways.
Deletes the specified FirewallPolicy.
", "DeleteFirewallPolicyV2": "Deletes the specified FirewallPolicyV2.
", "DeleteNetworkFirewallTransitGatewayAttachment": "Deletes 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, traffic will no longer flow through the firewall endpoints.
After you initiate the delete operation, use DescribeFirewall to monitor the deletion status.
", "DeleteProxy": "Deletes the specified proxy.
Detaches a Proxy configuration from a NAT Gateway.
", "DeleteResourcePolicy": "Deletes a resource policy that you created in a PutResourcePolicy request.
", "DeleteRuleGroup": "Deletes the specified RuleGroup.
", "DeleteTLSInspectionConfiguration": "Deletes the specified TLSInspectionConfiguration.
", "DeleteVpcEndpointAssociation": "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.
", "DescribeContainerAssociation": "Retrieves the configuration and status of a container association.
", "DescribeFirewall": "Returns the data objects for the specified firewall.
", "DescribeFirewallMetadata": "Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
", "DescribeFirewallPolicy": "Returns the data objects for the specified firewall policy.
", "DescribeFirewallPolicyV2": "Returns the data objects for the specified Next Generation policy.
", "DescribeFlowOperation": "Returns key information about a specific flow operation.
", "DescribeLoggingConfiguration": "Returns the logging configuration for the specified firewall.
", "DescribeProxy": "Returns the data objects for the specified proxy.
", "DescribeResourcePolicy": "Retrieves a resource policy that you created in a PutResourcePolicy request.
", "DescribeRuleGroup": "Returns the data objects for the specified rule group.
", "DescribeRuleGroupMetadata": "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.
", "DescribeRuleGroupSummary": "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.
Returns the data objects for the specified TLS inspection configuration.
", "DescribeVpcEndpointAssociation": "Returns the data object for the specified VPC endpoint association.
", "DisassociateAvailabilityZones": "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.
", "DisassociateSubnets": "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.
For a proxy mode firewall, this also removes the firewall's proxy DNS record in the Availability Zone and detaches the Availability Zone's NAT gateway from the firewall. Network Firewall keeps the NAT gateway. You can't remove the firewall's last Availability Zone. To do that, delete the firewall. If a VPC endpoint association exists in the Availability Zone, delete it first.
", "GetAnalysisReportResults": "The results of a COMPLETED analysis report generated with StartAnalysisReport.
For more information, see AnalysisTypeReportResult.
", "ListAnalysisReports": "Returns a list of all traffic analysis reports generated within the last 30 days.
", "ListContainerAssociations": "Lists the container associations in your account and Region. Use the NextToken parameter in subsequent requests to retrieve additional results.
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.
", "ListFirewallPoliciesV2": "Retrieves the metadata for the Next Generation 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.
", "ListFirewalls": "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.
", "ListFlowOperationResults": "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.
", "ListFlowOperations": "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.
", "ListRuleGroups": "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.
", "ListTLSInspectionConfigurations": "Retrieves 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.
", "ListTagsForResource": "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.
", "ListVpcEndpointAssociations": "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.
", "PutResourcePolicy": "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.
AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see Resource Access Manager User Guide.
", "RejectNetworkFirewallTransitGatewayAttachment": "Rejects 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 transit gateway 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.
", "StartFlowCapture": "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.
", "UntagResource": "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.
", "UpdateAvailabilityZoneChangeProtection": "Modifies 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.
", "UpdateContainerAssociation": "Updates the monitoring configurations and description of a container association. You can't change the container type after creation. Provide an update token to enable optimistic concurrency control.
", "UpdateFirewallAnalysisSettings": "Enables specific types of firewall analysis on a specific firewall you define.
", "UpdateFirewallDeleteProtection": "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.
", "UpdateFirewallEncryptionConfiguration": "A complex type that contains settings for encryption of your firewall resources.
", "UpdateFirewallPolicy": "Updates the properties of the specified firewall policy.
", "UpdateFirewallPolicyChangeProtection": "Modifies 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.
Updates the properties of the specified Next Generation policy.
", "UpdateLoggingConfiguration": "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.
Modifies the proxy settings of a proxy mode firewall. Use this operation to change the ports and protocols on which the firewall's proxy listens for traffic. The new listeners take effect without recreating the firewall.
The ProxySettings that you provide replace the firewall's current proxy settings. If you created the firewall with your own CertificateArn and DomainName, you must specify the same values in every request. You can't change or remove them.
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.
", "UpdateSubnetChangeProtection": "", "UpdateTLSInspectionConfiguration": "Updates 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.
" }, "shapes": { "AWSAccountId": { "base": null, "refs": { "Firewall$TransitGatewayOwnerAccountId": "The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.
" } }, "AZSyncState": { "base": "The status of the firewall endpoint defined by a VpcEndpointAssociation.
Whether Network Firewall automatically accepts the earlier application-layer hooks that a connection must pass to reach this rule's hook. Because the firewall engine is drop by default, accepting prior hooks lets you author a single rule for the hook you care about, instead of also authoring a rule for each earlier hook. This setting accepts the earlier application-layer hooks only; it doesn't accept the TCP layer. For more information, see Rule groups for a firewall using a Next Generation policy in the Network Firewall Developer Guide.
" } }, "ActionDefinition": { "base": "A custom action to use in stateless rule actions settings. This is used in CustomAction.
", "refs": { "CustomAction$ActionDefinition": "The custom action associated with the action name.
" } }, "ActionName": { "base": null, "refs": { "CustomAction$ActionName": "The descriptive name of the custom action. You can't change the name of a custom action after you create it.
" } }, "ActionScope": { "base": null, "refs": { "FirewallRule$ActionScope": "The scope that controls how much of the matched traffic the action applies to. The valid scopes depend on the action: ACCEPT supports all four scopes, and DROP, REJECT, REJECT_DST, and REJECT_BOTH support only PACKET and FLOW.
PACKET - The current packet only.
HOOK - The current hook only. The firewall engine evaluates the connection again at the next hook.
TX - The current transaction. The firewall engine continues to evaluate later transactions on the connection.
FLOW - The entire connection. For an accept action, the connection skips the firewall engine's remaining hooks and advances to the IPS engine.
In a Suricata-compatible rule string, you write the scope in lowercase, for example accept:flow.
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
", "refs": { "Addresses$member": null, "Flow$SourceAddress": null, "Flow$DestinationAddress": null, "FlowFilter$SourceAddress": null, "FlowFilter$DestinationAddress": null, "Route53ResolvedIPValidationAddresses$member": null } }, "AddressDefinition": { "base": null, "refs": { "Address$AddressDefinition": "Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
" } }, "Addresses": { "base": null, "refs": { "MatchAttributes$Sources": "The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
", "MatchAttributes$Destinations": "The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
", "ServerCertificateScope$Sources": "The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.
", "ServerCertificateScope$Destinations": "The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.
" } }, "Age": { "base": null, "refs": { "Flow$Age": "Returned as info about age of the flows identified by the flow operation.
", "FlowOperation$MinimumFlowAgeInSeconds": "The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.
The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.
We recommend setting this value to at least 1 minute (60 seconds) to reduce chance of capturing flows that are not yet established.
The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.
Specifies whether the rule also generates an alert log for the traffic that it matches. Turning on alerting adds a secondary alert action to the rule, so that Network Firewall logs the match in addition to taking the rule's primary action.
" } }, "AnalysisReport": { "base": "A report that captures key activity from the last 30 days of network traffic monitored by your firewall.
You can generate up to one report per traffic type, per 30 day period. For example, when you successfully create an HTTP traffic report, you cannot create another HTTP traffic report until 30 days pass. Alternatively, if you generate a report that combines metrics on both HTTP and HTTPS traffic, you cannot create another report for either traffic type until 30 days pass.
", "refs": { "AnalysisReports$member": null } }, "AnalysisReportId": { "base": null, "refs": { "AnalysisReport$AnalysisReportId": "The unique ID of the query that ran when you requested an analysis report.
", "GetAnalysisReportResultsRequest$AnalysisReportId": "The unique ID of the query that ran when you requested an analysis report.
", "StartAnalysisReportResponse$AnalysisReportId": "The unique ID of the query that ran when you requested an analysis report.
" } }, "AnalysisReportNextToken": { "base": null, "refs": { "GetAnalysisReportResultsRequest$NextToken": "When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Retrieves the results of a traffic analysis report.
" } }, "AnalysisReports": { "base": null, "refs": { "ListAnalysisReportsResponse$AnalysisReports": "The id and ReportTime associated with a requested analysis report. Does not provide the status of the analysis report.
The analysis result for Network Firewall's stateless rule group analyzer. Every time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup on a stateless rule group, Network Firewall analyzes the stateless rule groups in your account and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in a list of analysis results.
The AnalysisResult data type is not related to traffic analysis reports you generate using StartAnalysisReport. For information on traffic analysis report results, see AnalysisTypeReportResult.
The list of analysis results for AnalyzeRuleGroup. If you set AnalyzeRuleGroup to TRUE in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in the list of analysis results.
The results of a COMPLETED analysis report generated with StartAnalysisReport.
For an example of traffic analysis report results, see the response syntax of GetAnalysisReportResults.
", "refs": { "AnalysisReportResults$member": null } }, "AssociateAvailabilityZonesRequest": { "base": null, "refs": {} }, "AssociateAvailabilityZonesResponse": { "base": null, "refs": {} }, "AssociateFirewallPolicyRequest": { "base": null, "refs": {} }, "AssociateFirewallPolicyResponse": { "base": null, "refs": {} }, "AssociateSubnetsRequest": { "base": null, "refs": {} }, "AssociateSubnetsResponse": { "base": null, "refs": {} }, "AssociationSyncState": { "base": null, "refs": { "VpcEndpointAssociationStatus$AssociationSyncState": "The list of the Availability Zone sync states for all subnets that are defined by the firewall.
" } }, "Attachment": { "base": "The definition and status of the firewall endpoint for a single subnet. In each configured subnet, Network Firewall instantiates a firewall endpoint to handle network traffic.
This data type is used for any firewall endpoint type:
For Firewall.SubnetMappings, this Attachment is part of the FirewallStatus sync states information. You define firewall subnets using CreateFirewall and AssociateSubnets.
For VpcEndpointAssociation, this Attachment is part of the VpcEndpointAssociationStatus sync states information. You define these subnets using CreateVpcEndpointAssociation.
The configuration and status for a single firewall subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic.
" } }, "AttachmentId": { "base": null, "refs": { "TransitGatewayAttachmentSyncState$AttachmentId": "The unique identifier of the transit gateway attachment.
" } }, "AttachmentStatus": { "base": null, "refs": { "Attachment$Status": "The current status of the firewall endpoint instantiation in the subnet.
When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.
The name of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "DescribeFlowOperationResponse$AvailabilityZone": "The name of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "ListFlowOperationResultsRequest$AvailabilityZone": "The name of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "ListFlowOperationResultsResponse$AvailabilityZone": "The name of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "ListFlowOperationsRequest$AvailabilityZone": "The name of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "StartFlowCaptureRequest$AvailabilityZone": "The name of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "StartFlowFlushRequest$AvailabilityZone": "The name of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "SupportedAvailabilityZones$key": null, "SyncStates$key": null } }, "AvailabilityZoneId": { "base": null, "refs": { "DescribeFlowOperationRequest$AvailabilityZoneId": "The ID of the Availability Zone where the firewall is located. For example, use2-az1. Availability Zone IDs are the same in every Amazon Web Services account, so use this parameter when you coordinate resources across accounts. Specify either AvailabilityZone or AvailabilityZoneId, not both. If you specify both, the request fails.
The ID of the Availability Zone where the firewall is located. For example, use2-az1.
The ID of the Availability Zone where the firewall is located. For example, use2-az1. Availability Zone IDs are the same in every Amazon Web Services account, so use this parameter when you coordinate resources across accounts. Specify either AvailabilityZone or AvailabilityZoneId, not both. If you specify both, the request fails.
The ID of the Availability Zone where the firewall is located. For example, use2-az1.
The ID of the Availability Zone where the firewall is located. For example, use2-az1. Availability Zone IDs are the same in every Amazon Web Services account, so use this parameter when you coordinate resources across accounts. Specify either AvailabilityZone or AvailabilityZoneId, not both. If you specify both, the request fails.
The ID of the Availability Zone where the firewall is located. For example, use2-az1. Availability Zone IDs are the same in every Amazon Web Services account, so use this parameter when you coordinate resources across accounts. Specify either AvailabilityZone or AvailabilityZoneId, not both. If you specify both, the request fails.
The ID of the Availability Zone where the firewall is located. For example, use2-az1. Availability Zone IDs are the same in every Amazon Web Services account, so use this parameter when you coordinate resources across accounts. Specify either AvailabilityZone or AvailabilityZoneId, not both. If you specify both, the request fails.
Defines the mapping between an Availability Zone and a firewall endpoint for a transit gateway-attached firewall. Each mapping represents where the firewall can process traffic. You use these mappings when calling CreateFirewall, AssociateAvailabilityZones, and DisassociateAvailabilityZones.
To retrieve the current Availability Zone mappings for a firewall, use DescribeFirewall.
The ID of the Availability Zone where the firewall endpoint is located. For example, us-east-2a. The Availability Zone must be in the same Region as the transit gateway.
Required. The Availability Zones where you want to create firewall endpoints. You must specify at least one Availability Zone.
", "AssociateAvailabilityZonesResponse$AvailabilityZoneMappings": "The Availability Zones where Network Firewall created firewall endpoints. Each mapping specifies an Availability Zone where the firewall processes traffic.
", "CreateFirewallRequest$AvailabilityZoneMappings": "Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.
You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.
Required. The Availability Zones to remove from the firewall's configuration.
", "DisassociateAvailabilityZonesResponse$AvailabilityZoneMappings": "The remaining Availability Zones where the firewall has endpoints after the disassociation.
", "Firewall$AvailabilityZoneMappings": "The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.
" } }, "AvailabilityZoneMetadata": { "base": "High-level information about an Availability Zone where the firewall has an endpoint defined.
", "refs": { "SupportedAvailabilityZones$value": null } }, "AzSubnet": { "base": null, "refs": { "Attachment$SubnetId": "The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
", "AzSubnets$member": null } }, "AzSubnets": { "base": null, "refs": { "DisassociateSubnetsRequest$SubnetIds": "The unique identifiers for the subnets that you want to disassociate.
" } }, "Boolean": { "base": null, "refs": { "CreateFirewallPolicyRequest$DryRun": "Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection.
Default value: FALSE
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, set DryRun to TRUE.
Specifies whether to delete the NAT gateways that Network Firewall created for a proxy mode firewall when you delete the firewall. You can choose from the following values:
FALSE - Network Firewall detaches the NAT gateways from the firewall and keeps them. This is the default.
TRUE - Network Firewall also deletes the NAT gateways. The firewall status stays DELETING until they're deleted. You need permission to call the Amazon EC2 DeleteNatGateway action.
You can't specify TRUE for a firewall that isn't a proxy mode firewall.
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you must first disable this protection before adding or removing Availability Zones.
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun to TRUE.
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
Specifies whether an accepted connection bypasses the IPS engine. By default, traffic that the firewall engine accepts advances to the IPS engine for threat inspection. When you turn on this setting for an accept rule, the accepted traffic goes straight to its destination without IPS inspection. You can set the bypass only on accept rules, and it uses the same scope as the rule's accept action; only the flow and packet scopes support a bypass. For more information, see Rule groups for a firewall using a Next Generation policy in the Network Firewall Developer Guide.
Returns the number of bytes received or transmitted in a specific flow.
" } }, "CIDRCount": { "base": null, "refs": { "CIDRSummary$AvailableCIDRCount": "The number of CIDR blocks available for use by the IP set references in a firewall.
", "CIDRSummary$UtilizedCIDRCount": "The number of CIDR blocks used by the IP set references in a firewall.
", "DescribeContainerAssociationResponse$ResolvedCidrCount": "The number of CIDR blocks resolved from the monitored containers.
", "IPSetMetadata$ResolvedCIDRCount": "Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
Summarizes the CIDR blocks used by the IP set references in a firewall. Network Firewall calculates the number of CIDRs by taking an aggregated count of all CIDRs used by the IP sets you are referencing.
", "refs": { "CapacityUsageSummary$CIDRs": "Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
" } }, "CapacityUsageSummary": { "base": "The capacity usage summary of the resources used by the ReferenceSets in a firewall.
", "refs": { "FirewallStatus$CapacityUsageSummary": "Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
" } }, "Certificates": { "base": null, "refs": { "TLSInspectionConfigurationResponse$Certificates": "A list of the certificates associated with the TLS inspection configuration.
" } }, "CheckCertificateRevocationStatusActions": { "base": "Defines the actions to take on the SSL/TLS connection if the certificate presented by the server in the connection has a revoked or unknown status.
", "refs": { "ServerCertificateConfiguration$CheckCertificateRevocationStatus": "When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration.
Provides analysis details for the identified rule.
", "AnalysisTypeReportResult$Protocol": "The type of traffic captured by the analysis report.
", "NatGatewayAllocationIdList$member": null, "NatGatewayCreateMapping$SubnetId": "The ID of the subnet where Network Firewall creates the NAT gateway. The subnet must be in the firewall's VPC and can't be one of the firewall endpoint subnets. Each mapping must be in a different Availability Zone.
", "NatGatewayPrivateIpList$member": null, "RuleIdList$member": null, "RuleSummary$SID": "The unique identifier (Signature ID) of the Suricata rule.
", "RuleSummary$Msg": "The contents taken from the rule's msg field.
", "RuleSummary$Metadata": "The contents of the rule's metadata.
", "RuleTargets$member": null, "StatefulActions$member": null, "StatelessActions$member": null, "SubnetMapping$SubnetId": "The unique identifier for the subnet.
", "TlsCertificateData$CertificateSerial": "The serial number of the certificate.
", "TlsCertificateData$Status": "The status of the certificate.
" } }, "ConfigurationSyncState": { "base": null, "refs": { "FirewallStatus$ConfigurationSyncStateSummary": "The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.
When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.
This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.
The most recent time that Network Firewall updated the container association.
" } }, "ContainerAssociationStatus": { "base": null, "refs": { "CreateContainerAssociationResponse$Status": "The current status of the container association. For a new container association, the status is CREATING.
The current status of the container association. After deletion is initiated, the status is DELETING.
The current status of the container association.
", "UpdateContainerAssociationResponse$Status": "The current status of the container association.
" } }, "ContainerAssociationSummary": { "base": "The metadata for a container association returned by ListContainerAssociations. Contains the ARN and name that you use to identify the container association in other operations.
The container association metadata objects for the account and Region.
" } }, "ContainerAttribute": { "base": "A key-value filter pair used in container association monitoring configurations to narrow which containers are tracked. The key must match exactly. The value can be an exact value or a wildcard pattern.
", "refs": { "ContainerAttributes$member": null } }, "ContainerAttributeKey": { "base": null, "refs": { "ContainerAttribute$Key": "The attribute key to filter on. For Amazon EKS, specify namespace to filter by namespace, or specify a Kubernetes label key. For Amazon ECS, specify a container instance attribute name. Keys don't support wildcards.
Valid characters are letters, numbers, spaces, hyphens (-), underscores (_), periods (.), forward slashes (/), and colons (:).
The attribute value to match. You can specify an exact value, such as payments-api, or a wildcard pattern, such as payments-*.
Valid characters are letters, numbers, spaces, hyphens (-), underscores (_), periods (.), forward slashes (/), colons (:), asterisks (*), and backslashes (\\).
Network Firewall evaluates the value using the following rules:
An asterisk (*) matches zero or more characters. For example, payments-* matches payments-, payments-api, and payments-api-v2, and *-prod matches web-prod.
The pattern must match the entire value. For example, payments-* doesn't match my-payments-api. To match a value that contains payments anywhere, use *payments*.
Matching is case sensitive. For example, Payments-* doesn't match payments-api.
To match a literal asterisk, escape it with a backslash (\\*). To match a literal backslash, use \\\\. A backslash followed by any other character matches a literal backslash followed by that character.
A wildcard pattern matches only containers that have the attribute. For example, a filter with key app and value * matches every container that has an app label, but doesn't match a container without an app label.
A value that doesn't contain * or \\ matches only that exact value.
A value can contain at most 10 unescaped asterisks. Escaped asterisks (\\*) don't count toward this limit. A value can't end with a single unescaped backslash.
Key-value pairs that filter which containers are tracked. For Amazon EKS, you can filter by namespace and Kubernetes labels. For Amazon ECS, you can filter by container instance attributes (EC2 launch type only).
Attribute values can contain wildcard patterns, for example payments-*. Attribute keys must match exactly.
Contains the monitoring configuration for a single cluster in a container association. Specifies the cluster ARN and optional attribute filters to narrow which containers are tracked.
", "refs": { "ContainerMonitoringConfigurations$member": null } }, "ContainerMonitoringConfigurations": { "base": null, "refs": { "CreateContainerAssociationRequest$ContainerMonitoringConfigurations": "The monitoring configurations for the container association. Each configuration specifies an Amazon ECS or Amazon EKS cluster to monitor and optional attribute filters to narrow which containers are tracked.
", "CreateContainerAssociationResponse$ContainerMonitoringConfigurations": "The monitoring configurations for the container association.
", "DescribeContainerAssociationResponse$ContainerMonitoringConfigurations": "The monitoring configurations for the container association.
", "UpdateContainerAssociationRequest$ContainerMonitoringConfigurations": "The updated monitoring configurations for the container association. Each configuration specifies an Amazon ECS or Amazon EKS cluster to monitor and optional attribute filters.
", "UpdateContainerAssociationResponse$ContainerMonitoringConfigurations": "The monitoring configurations for the container association.
" } }, "ContainerMonitoringType": { "base": null, "refs": { "CreateContainerAssociationRequest$Type": "The type of containers to monitor. You can't change the container type after creation. Valid values:
ECS - Amazon Elastic Container Service
EKS - Amazon Elastic Kubernetes Service
The container type. Valid values:
ECS - Amazon Elastic Container Service
EKS - Amazon Elastic Kubernetes Service
The container type. Valid values:
ECS - Amazon Elastic Container Service
EKS - Amazon Elastic Kubernetes Service
The container type. This value must match the existing type and can't be changed. Valid values:
ECS - Amazon Elastic Container Service
EKS - Amazon Elastic Kubernetes Service
The container type. Valid values:
ECS - Amazon Elastic Container Service
EKS - Amazon Elastic Kubernetes Service
The number of attempts made to access a domain.
", "UniqueSources$Count": "The number of unique source IP addresses that connected to a domain.
" } }, "CreateContainerAssociationRequest": { "base": null, "refs": {} }, "CreateContainerAssociationResponse": { "base": null, "refs": {} }, "CreateFirewallPolicyRequest": { "base": null, "refs": {} }, "CreateFirewallPolicyResponse": { "base": null, "refs": {} }, "CreateFirewallPolicyV2Request": { "base": null, "refs": {} }, "CreateFirewallPolicyV2Response": { "base": null, "refs": {} }, "CreateFirewallRequest": { "base": null, "refs": {} }, "CreateFirewallResponse": { "base": null, "refs": {} }, "CreateRuleGroupRequest": { "base": null, "refs": {} }, "CreateRuleGroupResponse": { "base": null, "refs": {} }, "CreateTLSInspectionConfigurationRequest": { "base": null, "refs": {} }, "CreateTLSInspectionConfigurationResponse": { "base": null, "refs": {} }, "CreateTime": { "base": null, "refs": { "DescribeProxyResource$CreateTime": "Time the Proxy was created.
" } }, "CreateVpcEndpointAssociationRequest": { "base": null, "refs": {} }, "CreateVpcEndpointAssociationResponse": { "base": null, "refs": {} }, "CustomAction": { "base": "An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify.
You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.
You can use custom actions in the following places:
In a rule group's StatelessRulesAndCustomActions specification. The custom actions are available for use by name inside the StatelessRulesAndCustomActions where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes.
In a FirewallPolicy specification, in StatelessCustomActions. The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.
The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.
Defines an array of individual custom action definitions that are available for use by the stateless rules in this StatelessRulesAndCustomActions specification. You name each custom action that you define, and then you can use it by name in your StatelessRule RuleDefinition Actions specification.
The action that Network Firewall takes when the DNS resolution recorded for a destination IP address has expired from the resolved IP cache. This applies when Network Firewall still sees traffic to that IP address after the expiry. Network Firewall keeps a resolution for longer than the DNS record's time to live (TTL). Valid values are the following:
CONTINUE – Treats the expired resolution as still valid and doesn't block the connection because of expiry.
DROP – Silently blocks traffic to the IP address after its resolution has expired, without sending any response to the client.
REJECT – Blocks traffic to the IP address after its resolution has expired and sends a TCP reset (RST) to the client. Network Firewall drops non-TCP traffic instead of resetting it.
The ID of the Route 53 Resolver DNS Firewall rule group that determines which VPCs' DNS resolutions count for resolved IP validation. A destination IP address counts as resolved for a domain only when the Route 53 Resolver returned it in a DNS response within a VPC that's associated with this rule group. Associate the rule group with the VPCs that send traffic to the firewall. The ID must match the pattern ^rslvr-frg-[0-9a-f]+$. It must also exist and be accessible from your account. Network Firewall validates this when you create or update the policy.
Changing this value swaps the managed rule group association. Network Firewall processes the swap asynchronously. Each policy can have only one managed Route 53 Resolver DNS Firewall association. While a swap is in progress, Network Firewall rejects further changes to this setting. Wait until the swap completes, then retry. The change may also require a restart of the stateful engine. When this occurs, existing connections will be treated according to your stream exception policy configuration.
" } }, "DecryptionAction": { "base": null, "refs": { "ServerCertificateConfiguration$DefaultDecryptionBehavior": "What the firewall does with SSL/TLS traffic that doesn't match any scope in this server certificate configuration. This setting applies only to proxy mode firewalls. If you don't specify a value, the firewall uses BYPASS. You can choose from the following values:
BYPASS - The firewall doesn't decrypt the traffic.
DECRYPT - The firewall decrypts the traffic for inspection. You can use DECRYPT only if every scope in the configuration sets DeploymentMode to EXPLICIT_PROXY_ONLY.
Whether the firewall decrypts traffic that matches this scope. You can choose from the following values:
DECRYPT - The firewall decrypts the traffic for inspection.
BYPASS - The firewall doesn't decrypt the traffic.
Network Firewall plans to augment the active threat defense managed rule group with an additional deep threat inspection capability. When this capability is released, Amazon Web Services will analyze service logs of network traffic processed by these rule groups to identify threat indicators across customers. Amazon Web Services will use these threat indicators to improve the active threat defense managed rule groups and protect the security of Amazon Web Services customers and services.
Customers can opt-out of deep threat inspection at any time through the Network Firewall console or API. When customers opt out, Network Firewall will not use the network traffic processed by those customers' active threat defense rule groups for rule group improvement.
Time the Proxy was deleted.
" } }, "DeleteVpcEndpointAssociationRequest": { "base": null, "refs": {} }, "DeleteVpcEndpointAssociationResponse": { "base": null, "refs": {} }, "DescribeContainerAssociationRequest": { "base": null, "refs": {} }, "DescribeContainerAssociationResponse": { "base": null, "refs": {} }, "DescribeFirewallMetadataRequest": { "base": null, "refs": {} }, "DescribeFirewallMetadataResponse": { "base": null, "refs": {} }, "DescribeFirewallPolicyRequest": { "base": null, "refs": {} }, "DescribeFirewallPolicyResponse": { "base": null, "refs": {} }, "DescribeFirewallPolicyV2Request": { "base": null, "refs": {} }, "DescribeFirewallPolicyV2Response": { "base": null, "refs": {} }, "DescribeFirewallRequest": { "base": null, "refs": {} }, "DescribeFirewallResponse": { "base": null, "refs": {} }, "DescribeFlowOperationRequest": { "base": null, "refs": {} }, "DescribeFlowOperationResponse": { "base": null, "refs": {} }, "DescribeLoggingConfigurationRequest": { "base": null, "refs": {} }, "DescribeLoggingConfigurationResponse": { "base": null, "refs": {} }, "DescribeProxyRequest": { "base": null, "refs": {} }, "DescribeProxyResource": { "base": "Proxy attached to a NAT gateway.
", "refs": { "DescribeProxyResponse$Proxy": "Proxy attached to a NAT gateway.
" } }, "DescribeProxyResponse": { "base": null, "refs": {} }, "DescribeResourcePolicyRequest": { "base": null, "refs": {} }, "DescribeResourcePolicyResponse": { "base": null, "refs": {} }, "DescribeRuleGroupMetadataRequest": { "base": null, "refs": {} }, "DescribeRuleGroupMetadataResponse": { "base": null, "refs": {} }, "DescribeRuleGroupRequest": { "base": null, "refs": {} }, "DescribeRuleGroupResponse": { "base": null, "refs": {} }, "DescribeRuleGroupSummaryRequest": { "base": null, "refs": {} }, "DescribeRuleGroupSummaryResponse": { "base": null, "refs": {} }, "DescribeTLSInspectionConfigurationRequest": { "base": null, "refs": {} }, "DescribeTLSInspectionConfigurationResponse": { "base": null, "refs": {} }, "DescribeVpcEndpointAssociationRequest": { "base": null, "refs": {} }, "DescribeVpcEndpointAssociationResponse": { "base": null, "refs": {} }, "Description": { "base": null, "refs": { "CreateContainerAssociationRequest$Description": "A description of the container association.
", "CreateContainerAssociationResponse$Description": "A description of the container association.
", "CreateFirewallPolicyRequest$Description": "A description of the firewall policy.
", "CreateFirewallPolicyV2Request$Description": "A description of the firewall policy.
", "CreateFirewallRequest$Description": "A description of the firewall.
", "CreateRuleGroupRequest$Description": "A description of the rule group.
", "CreateTLSInspectionConfigurationRequest$Description": "A description of the TLS inspection configuration.
", "CreateVpcEndpointAssociationRequest$Description": "A description of the VPC endpoint association.
", "DescribeContainerAssociationResponse$Description": "A description of the container association.
", "DescribeFirewallMetadataResponse$Description": "A description of the firewall.
", "DescribeRuleGroupMetadataResponse$Description": "Returns the metadata objects for the specified rule group.
", "DescribeRuleGroupSummaryResponse$Description": "A description of the rule group.
", "Firewall$Description": "A description of the firewall.
", "FirewallPolicyResponse$Description": "A description of the firewall policy.
", "FirewallPolicyV2Response$Description": "A description of the Next Generation policy.
", "RuleGroupResponse$Description": "A description of the rule group.
", "TLSInspectionConfigurationResponse$Description": "A description of the TLS inspection configuration.
", "UpdateContainerAssociationRequest$Description": "A description of the container association. When omitted, the existing description remains unchanged. To clear the description, pass an empty string.
", "UpdateContainerAssociationResponse$Description": "A description of the container association.
", "UpdateFirewallDescriptionRequest$Description": "The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.
", "UpdateFirewallDescriptionResponse$Description": "A description of the firewall.
", "UpdateFirewallPolicyRequest$Description": "A description of the firewall policy.
", "UpdateFirewallPolicyV2Request$Description": "A description of the firewall policy.
", "UpdateRuleGroupRequest$Description": "A description of the rule group.
", "UpdateTLSInspectionConfigurationRequest$Description": "A description of the TLS inspection configuration.
", "VpcEndpointAssociation$Description": "A description of the VPC endpoint association.
" } }, "Destination": { "base": null, "refs": { "FirewallRule$DestIPs": "The destination IP addresses and address ranges to inspect for, in CIDR notation. A firewall rule always compiles to a forward-direction rule, so you express inbound compared to outbound traffic through the source and destination addresses.
", "Header$Destination": "The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
" } }, "Dimension": { "base": "The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics CustomAction. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.
Network Firewall sets the dimension name to CustomAction and you provide the dimension value.
For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.
", "refs": { "Dimensions$member": null } }, "DimensionValue": { "base": null, "refs": { "Dimension$Value": "The value to use in the custom metric dimension.
" } }, "Dimensions": { "base": null, "refs": { "PublishMetricAction$Dimensions": "" } }, "DisassociateAvailabilityZonesRequest": { "base": null, "refs": {} }, "DisassociateAvailabilityZonesResponse": { "base": null, "refs": {} }, "DisassociateSubnetsRequest": { "base": null, "refs": {} }, "DisassociateSubnetsResponse": { "base": null, "refs": {} }, "DnsName": { "base": null, "refs": { "Attachment$DnsName": "The proxy DNS name of a proxy mode firewall. Your clients send proxy requests to the firewall at this name. It's your ProxySettings DomainName if you specified one, or a name that Network Firewall generates in the format proxy-id.nfw.region.amazonaws.com.
The firewall has one proxy DNS name for every Availability Zone and VPC that it serves. In each Availability Zone, the name resolves to the firewall endpoint in that Availability Zone, so traffic stays in your client's Availability Zone. Your clients must use the VPC's Route 53 Resolver.
", "NatGatewayAttachment$DnsName": "The proxy DNS name of the firewall in this Availability Zone. This is the same as the DnsName of the firewall's Attachment.
The most frequently accessed domains.
" } }, "DomainMatch": { "base": "The domains that a ServerCertificateScope matches for SSL/TLS inspection on a proxy mode firewall.
", "refs": { "ServerCertificateScope$DomainMatch": "The domains that this scope matches, based on the host name in the client's HTTP CONNECT request. Domain matching applies only to proxy mode firewalls. If you specify DomainMatch, you must set DeploymentMode to EXPLICIT_PROXY_ONLY. If you don't specify DomainMatch, the scope matches traffic by its source, destination, ports, and protocols only.
A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.
Returns TRUE when the firewall monitoring dashboard is enabled on the firewall. Returns FALSE when the firewall monitoring dashboard is not enabled on the firewall.
A boolean that lets you enable or disable the detailed firewall monitoring dashboard on the firewall.
The monitoring dashboard provides comprehensive visibility into your firewall's flow logs and alert logs. After you enable detailed monitoring, you can access these dashboards directly from the Monitoring page of the Network Firewall console.
Specify TRUE to enable the the detailed monitoring dashboard on the firewall. Specify FALSE to disable the the detailed monitoring dashboard on the firewall.
A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.
Returns TRUE when the firewall monitoring dashboard is enabled on the firewall. Returns FALSE when the firewall monitoring dashboard is not enabled on the firewall.
When true, prevents TCP and TLS packets from reaching destination servers until TLS Inspection has evaluated Server Name Indication (SNI) rules. Requires an associated TLS Inspection configuration.
" } }, "EnabledAnalysisType": { "base": null, "refs": { "AnalysisReport$AnalysisType": "The type of traffic that will be used to generate a report.
", "EnabledAnalysisTypes$member": null, "GetAnalysisReportResultsResponse$AnalysisType": "The type of traffic that will be used to generate a report.
", "StartAnalysisReportRequest$AnalysisType": "The type of traffic that will be used to generate a report.
" } }, "EnabledAnalysisTypes": { "base": null, "refs": { "CreateFirewallRequest$EnabledAnalysisTypes": "An optional setting indicating the specific traffic analysis types to enable on the firewall.
", "Firewall$EnabledAnalysisTypes": "An optional setting indicating the specific traffic analysis types to enable on the firewall.
", "UpdateFirewallAnalysisSettingsRequest$EnabledAnalysisTypes": "An optional setting indicating the specific traffic analysis types to enable on the firewall.
", "UpdateFirewallAnalysisSettingsResponse$EnabledAnalysisTypes": "An optional setting indicating the specific traffic analysis types to enable on the firewall.
" } }, "EncryptionConfiguration": { "base": "A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
", "refs": { "CreateFirewallPolicyRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your firewall policy resources.
", "CreateFirewallPolicyV2Request$EncryptionConfiguration": "A complex type that contains settings for encryption of your firewall policy resources.
", "CreateFirewallRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your firewall resources.
", "CreateRuleGroupRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your rule group resources.
", "CreateTLSInspectionConfigurationRequest$EncryptionConfiguration": null, "Firewall$EncryptionConfiguration": "A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
", "FirewallPolicyResponse$EncryptionConfiguration": "A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
", "FirewallPolicyV2Response$EncryptionConfiguration": "A complex type that contains the Amazon Web Services KMS encryption configuration settings for your Next Generation policy.
", "RuleGroupResponse$EncryptionConfiguration": "A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
", "TLSInspectionConfigurationResponse$EncryptionConfiguration": "A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
", "UpdateFirewallEncryptionConfigurationRequest$EncryptionConfiguration": null, "UpdateFirewallEncryptionConfigurationResponse$EncryptionConfiguration": null, "UpdateFirewallPolicyRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your firewall policy resources.
", "UpdateFirewallPolicyV2Request$EncryptionConfiguration": "A complex type that contains settings for encryption of your firewall policy resources.
", "UpdateRuleGroupRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your rule group resources.
", "UpdateTLSInspectionConfigurationRequest$EncryptionConfiguration": "A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
" } }, "EncryptionType": { "base": null, "refs": { "EncryptionConfiguration$Type": "The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
" } }, "EndTime": { "base": null, "refs": { "GetAnalysisReportResultsResponse$EndTime": "The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
" } }, "ErrorMessage": { "base": null, "refs": { "InsufficientCapacityException$Message": null, "InternalServerError$Message": null, "InvalidOperationException$Message": null, "InvalidRequestException$Message": null, "InvalidResourcePolicyException$Message": null, "InvalidTokenException$Message": null, "LimitExceededException$Message": null, "LogDestinationPermissionException$Message": null, "ResourceNotFoundException$Message": null, "ResourceOwnerCheckException$Message": null, "ThrottlingException$Message": null, "UnsupportedOperationException$Message": null } }, "FailureCode": { "base": null, "refs": { "DescribeProxyResource$FailureCode": "Failure code for cases when the Proxy fails to attach or update.
" } }, "FailureMessage": { "base": null, "refs": { "DescribeProxyResource$FailureMessage": "Failure message for cases when the Proxy fails to attach or update.
" } }, "Firewall": { "base": "A firewall defines the behavior of a firewall, the main VPC where the firewall is used, the Availability Zones where the firewall can be used, and one subnet to use for a firewall endpoint within each of the Availability Zones. The Availability Zones are defined implicitly in the subnet specifications.
In addition to the firewall endpoints that you define in this Firewall specification, you can create firewall endpoints in VpcEndpointAssociation resources for any VPC, in any Availability Zone where the firewall is already in use.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both the firewall and firewall status by calling DescribeFirewall.
", "refs": { "CreateFirewallResponse$Firewall": "The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
", "DeleteFirewallResponse$Firewall": null, "DescribeFirewallResponse$Firewall": "The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
" } }, "FirewallMetadata": { "base": "High-level information about a firewall, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall.
", "refs": { "Firewalls$member": null } }, "FirewallPolicies": { "base": null, "refs": { "ListFirewallPoliciesResponse$FirewallPolicies": "The metadata for the firewall policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.
" } }, "FirewallPoliciesV2": { "base": null, "refs": { "ListFirewallPoliciesV2Response$FirewallPoliciesV2": "The metadata for the Next Generation policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.
" } }, "FirewallPolicy": { "base": "The firewall policy defines the behavior of a firewall using a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
This, along with FirewallPolicyResponse, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
", "refs": { "CreateFirewallPolicyRequest$FirewallPolicy": "The rule groups and policy actions to use in the firewall policy.
", "DescribeFirewallPolicyResponse$FirewallPolicy": "The policy for the specified firewall policy.
", "UpdateFirewallPolicyRequest$FirewallPolicy": "The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.
A configuration error that Network Firewall detected for a firewall policy.
", "refs": { "FirewallPolicyErrors$member": null } }, "FirewallPolicyErrorCode": { "base": null, "refs": { "FirewallPolicyError$Code": "The error code identifies the type of error. Valid values are the following:
DNS_FIREWALL_RULE_GROUP_UNAVAILABLE – The Amazon Route 53 Resolver DNS Firewall rule group that resolved IP validation references is unavailable, for example, because it was deleted or is no longer accessible from your account. Update the rule group ID or remove the resolved IP validation configuration.
ROUTE53_RESOLVED_IP_VALIDATION_MISSING – An associated stateful rule group uses the aws_route_53_resolved_domain keyword, but the policy doesn't have resolved IP validation configured. The affected rules are inactive until you add resolved IP validation to the policy or remove the keyword rules.
The ID of the resource that the error relates to, when applicable. For example, for DNS_FIREWALL_RULE_GROUP_UNAVAILABLE this is the Amazon Route 53 Resolver DNS Firewall rule group ID.
Any configuration errors that apply to the firewall policy. Network Firewall detects these errors asynchronously, after you create or update the policy, so an error can appear after the request that caused it has already succeeded. Each entry describes the problem and how to resolve it, and Network Firewall clears it automatically after you resolve the problem.
", "FirewallPolicyV2Response$Errors": "Any configuration errors that apply to the Next Generation policy. Network Firewall detects these errors asynchronously, after you create or update the policy, so an error can appear after the request that caused it has already succeeded. Each entry describes the problem and how to resolve it, and Network Firewall clears it automatically after you resolve the problem.
" } }, "FirewallPolicyMetadata": { "base": "High-level information about a firewall policy, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
", "refs": { "FirewallPolicies$member": null } }, "FirewallPolicyResponse": { "base": "The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
", "refs": { "CreateFirewallPolicyResponse$FirewallPolicyResponse": "The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
", "DeleteFirewallPolicyResponse$FirewallPolicyResponse": "The object containing the definition of the FirewallPolicyResponse that you asked to delete.
", "DescribeFirewallPolicyResponse$FirewallPolicyResponse": "The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
", "UpdateFirewallPolicyResponse$FirewallPolicyResponse": "The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
" } }, "FirewallPolicyV2": { "base": "The object that defines a Next Generation policy. This, along with the FirewallPolicyV2Response, define the policy.
A Next Generation policy defines how the firewall engine and IPS engine inspect and control your VPC network traffic. You define the policy as a firewall section and an IPS section, each a collection of rule groups, along with policy-wide settings such as the policy mode and default actions. For more information, see Next Generation policies in the Network Firewall Developer Guide.
", "refs": { "CreateFirewallPolicyV2Request$FirewallPolicyV2": "The rule groups and other settings that define the Next Generation policy.
", "DescribeFirewallPolicyV2Response$FirewallPolicyV2": "The rule groups and other settings that define the specified Next Generation policy.
", "UpdateFirewallPolicyV2Request$FirewallPolicyV2": "The updated rule groups and other settings that define the Next Generation policy.
" } }, "FirewallPolicyV2Metadata": { "base": "High-level information about a Next Generation policy, returned in a list of policies. To retrieve the policy's full properties, rule groups, and settings, use the Next Generation policy describe operation.
", "refs": { "FirewallPoliciesV2$member": null } }, "FirewallPolicyV2Response": { "base": "The high-level properties of a Next Generation policy. This includes the policy's identity, status, consumed capacity, and association count. Network Firewall returns this object in response to the Next Generation policy operations. To retrieve the policy's rule groups and settings, use the FirewallPolicyV2 object.
The high-level properties of the Next Generation policy. This, along with the FirewallPolicyV2, define the policy. You can retrieve all objects for a Next Generation policy by calling DescribeFirewallPolicyV2.
", "DeleteFirewallPolicyV2Response$FirewallPolicyV2Response": "The high-level properties of the Next Generation policy that you asked to delete.
", "DescribeFirewallPolicyV2Response$FirewallPolicyV2Response": "The high-level properties of the Next Generation policy. This, along with the FirewallPolicyV2, define the policy.
", "UpdateFirewallPolicyV2Response$FirewallPolicyV2Response": "The high-level properties of the Next Generation policy. This, along with the FirewallPolicyV2, define the policy. You can retrieve all objects for a Next Generation policy by calling DescribeFirewallPolicyV2.
" } }, "FirewallRule": { "base": "A single structured firewall engine rule, for use in a firewall engine rule group or as an embedded rule in a Next Generation policy. A firewall rule accepts, drops, or rejects traffic at a connection-state hook. For more information about authoring firewall engine rules, see Rule groups for a firewall using a Next Generation policy in the Network Firewall Developer Guide.
", "refs": { "FirewallRules$member": null } }, "FirewallRuleAction": { "base": null, "refs": { "FirewallRule$Action": "The action that the firewall engine takes on traffic that matches the rule. The firewall engine supports the following actions:
ACCEPT - Allow the traffic.
DROP - Block the traffic and discontinue inspection.
REJECT - Block the traffic and send a TCP reset packet back to the client.
REJECT_DST - Block the traffic and send a TCP reset packet to the destination.
REJECT_BOTH - Block the traffic and send a TCP reset packet to both the client and the destination.
You combine the action with an action scope, for example accept:flow. To send accepted traffic straight to its destination and skip the IPS engine, pair an accept action with the BypassIPSEnabled setting. For more information, see Rule groups for a firewall using a Next Generation policy in the Network Firewall Developer Guide.
The object that defines a firewall engine rule group, for use in a Next Generation policy. A firewall engine rule group provides access-control rules that the firewall engine evaluates at connection-state hooks. You provide the rules as a Suricata-compatible rule string, as structured firewall rules, or generated from a list of domain names. For more information, see Rule groups for a firewall using a Next Generation policy in the Network Firewall Developer Guide.
", "refs": { "CreateRuleGroupRequest$FirewallRuleGroup": "An object that defines the rules in a firewall engine rule group, for use in a Next Generation policy.
", "DescribeRuleGroupResponse$FirewallRuleGroup": "The object that defines the rules in a firewall engine rule group, for use in a Next Generation policy.
", "FirewallRuleGroupEntry$InlineRuleGroup": "A firewall engine rule group defined directly in the policy, instead of referenced by ARN. Provide either InlineRuleGroup to embed a rule group or ResourceArn to reference an existing rule group. An embedded rule group can't use a domain list rules source; to filter on a domain list, reference a standalone rule group by ARN instead.
An object that defines the rules in a firewall engine rule group, for use in a Next Generation policy.
" } }, "FirewallRuleGroupEntries": { "base": null, "refs": { "FirewallPolicyV2$FirewallRuleGroupEntries": "The firewall section of the policy—the rule groups that the firewall engine evaluates. Each entry references an existing firewall engine rule group or embeds a rule group directly in the policy, and each entry has a unique priority that sets its evaluation order within the section.
" } }, "FirewallRuleGroupEntry": { "base": "A single entry in the firewall section of a Next Generation policy. An entry either references an existing firewall engine rule group by ARN or embeds a rule group directly in the policy, and it carries the priority that sets the rule group's evaluation order within the firewall section.
", "refs": { "FirewallRuleGroupEntries$member": null } }, "FirewallRuleProtocol": { "base": null, "refs": { "FirewallRule$Protocol": "The protocol of the rule's hook. The protocol is derived from the hook and must match the hook's protocol prefix. Network Firewall rejects a rule whose protocol doesn't match its hook.
" } }, "FirewallRules": { "base": null, "refs": { "FirewallRulesSource$FirewallRules": "An array of individual firewall engine rules, provided as structured rules rather than as a rule string.
" } }, "FirewallRulesSource": { "base": "The source of the rules for a firewall engine rule group. You provide the rules as a single Suricata-compatible rule string, as a list of structured firewall rules, or as a list of domain names to generate rules from.
", "refs": { "FirewallRuleGroup$RulesSource": "The stateful inspection criteria for the firewall engine rule group.
" } }, "FirewallStatus": { "base": "Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.
", "refs": { "CreateFirewallResponse$FirewallStatus": "Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.
", "DeleteFirewallResponse$FirewallStatus": null, "DescribeFirewallResponse$FirewallStatus": "Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.
" } }, "FirewallStatusValue": { "base": null, "refs": { "DescribeFirewallMetadataResponse$Status": "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.
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.
The readiness of the configured firewall endpoint to handle network traffic.
" } }, "Firewalls": { "base": null, "refs": { "ListFirewallsResponse$Firewalls": "The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.
" } }, "FirstAccessed": { "base": null, "refs": { "AnalysisTypeReportResult$FirstAccessed": "The date and time any domain was first accessed (within the last 30 day period).
" } }, "Flags": { "base": null, "refs": { "TCPFlagField$Flags": "Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the Masks setting.
For the flags that are specified in the masks setting, the following must be true for the packet to match:
The ones that are set in this flags setting must be set in the packet.
The ones that are not set in this flags setting must also not be set in the packet.
The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
" } }, "Flow": { "base": "Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple Flows arrays are returned.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "refs": { "FlowFilters$member": null } }, "FlowFilters": { "base": null, "refs": { "FlowOperation$FlowFilters": "Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "StartFlowCaptureRequest$FlowFilters": "Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
", "StartFlowFlushRequest$FlowFilters": "Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
" } }, "FlowOperation": { "base": "Contains information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the 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.
", "refs": { "DescribeFlowOperationResponse$FlowOperation": "Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.
" } }, "FlowOperationId": { "base": null, "refs": { "DescribeFlowOperationRequest$FlowOperationId": "A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
", "DescribeFlowOperationResponse$FlowOperationId": "A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
", "FlowOperationMetadata$FlowOperationId": "A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
", "ListFlowOperationResultsRequest$FlowOperationId": "A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
", "ListFlowOperationResultsResponse$FlowOperationId": "A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
", "StartFlowCaptureResponse$FlowOperationId": "A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
", "StartFlowFlushResponse$FlowOperationId": "A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
" } }, "FlowOperationMetadata": { "base": "An array of objects with metadata about the requested FlowOperation.
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.
Defines the type of FlowOperation.
Defines the type of FlowOperation.
An optional string that defines whether any or all operation types are returned.
" } }, "FlowOperations": { "base": null, "refs": { "ListFlowOperationsResponse$FlowOperations": "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.
" } }, "FlowRequestTimestamp": { "base": null, "refs": { "DescribeFlowOperationResponse$FlowRequestTimestamp": "A timestamp indicating when the Suricata engine identified flows impacted by an operation.
", "FlowOperationMetadata$FlowRequestTimestamp": "A timestamp indicating when the Suricata engine identified flows impacted by an operation.
", "ListFlowOperationResultsResponse$FlowRequestTimestamp": "A timestamp indicating when the Suricata engine identified flows impacted by an operation.
" } }, "FlowTimeouts": { "base": "Describes the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle and Network Firewall removes the flow entry from its flow table. When you update this value, existing connections will be treated according to your stream exception policy configuration.
", "refs": { "StatefulEngineOptions$FlowTimeouts": "Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.
", "StatefulEngineOptionsV2$FlowTimeouts": "The amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.
" } }, "Flows": { "base": null, "refs": { "ListFlowOperationResultsResponse$Flows": "Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple Flows arrays are returned.
Whether you want to apply allow, reject, alert, or drop behavior to the domains in your target list.
When logging is enabled and you choose Alert, traffic that matches the domain specifications generates an alert in the firewall's logs. Then, traffic either passes, is rejected, or drops based on other rules in the firewall policy.
The basic rule criteria for Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a match for the corresponding StatefulRule.
", "refs": { "StatefulRule$Header": "The stateful inspection criteria for this rule, used to inspect traffic flows.
" } }, "Hits": { "base": "Attempts made to a access domain.
", "refs": { "AnalysisTypeReportResult$Hits": "The number of attempts made to access a observed domain.
" } }, "HookKey": { "base": null, "refs": { "FirewallRule$Hook": "The connection-state hook at which the firewall engine evaluates the rule. The hook encodes both the protocol and the connection state, for example a TCP hook or a TLS client_hello hook. For the hooks that the firewall engine supports and how they map to the connection lifecycle, see Rule groups for a firewall using a Next Generation policy in the Network Firewall Developer Guide and the Suricata firewall mode documentation.
The IP address type of the Firewall subnet in the Availability Zone. You can't change the IP address type after you create the subnet.
", "SubnetMapping$IPAddressType": "The subnet's IP address type. You can't change the IP address type after you create the subnet.
" } }, "IPSet": { "base": "A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.
", "refs": { "IPSets$value": null } }, "IPSetArn": { "base": null, "refs": { "IPSetMetadataMap$key": null } }, "IPSetMetadata": { "base": "General information about the IP set.
", "refs": { "IPSetMetadataMap$value": null } }, "IPSetMetadataMap": { "base": null, "refs": { "CIDRSummary$IPSetReferences": "The list of the IP set references used by a firewall.
" } }, "IPSetReference": { "base": "Configures one or more IP set references for a Suricata-compatible rule group. This is used in CreateRuleGroup or UpdateRuleGroup. An IP set reference is a rule variable that references resources that you create and manage in another Amazon Web Services service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the resource you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall, see Using IP set references in the Network Firewall Developer Guide.
Network Firewall currently supports Amazon VPC prefix lists and resource groups in IP set references.
", "refs": { "IPSetReferenceMap$value": null } }, "IPSetReferenceMap": { "base": null, "refs": { "ReferenceSets$IPSetReferences": "The list of IP set references.
" } }, "IPSetReferenceName": { "base": null, "refs": { "IPSetReferenceMap$key": null } }, "IPSets": { "base": null, "refs": { "PolicyVariables$RuleVariables": "The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.
A list of IP addresses and address ranges, in CIDR notation.
" } }, "IdentifiedType": { "base": null, "refs": { "AnalysisResult$IdentifiedType": "The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:
STATELESS_RULE_FORWARDING_ASYMMETRICALLY
Cause: One or more stateless rules with the action pass or forward are forwarding traffic asymmetrically. Specifically, the rule's set of source IP addresses or their associated port numbers, don't match the set of destination IP addresses or their associated port numbers.
To mitigate: Make sure that there's an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.
STATELESS_RULE_CONTAINS_TCP_FLAGS
Cause: At least one stateless rule with the action pass orforward contains TCP flags that are inconsistent in the forward and return directions.
To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:
Remove unnecessary TCP flag inspections from the rules.
If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example SYN and ACK flags used in a 3-way TCP handshake.
Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.
", "refs": {} }, "InternalServerError": { "base": "Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.
", "refs": {} }, "InvalidOperationException": { "base": "The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
", "refs": {} }, "InvalidRequestException": { "base": "The operation failed because of a problem with your request. Examples include:
You specified an unsupported parameter name or value.
You tried to update a property with a value that isn't among the available types.
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
The policy statement failed validation.
", "refs": {} }, "InvalidTokenException": { "base": "The token you provided is stale or isn't valid for the operation.
", "refs": {} }, "IpsRuleGroup": { "base": "The object that defines an IPS engine rule group, for use in a Next Generation policy. An IPS engine rule group provides threat-detection rules that the IPS engine evaluates in the context of the traffic flow. You provide the rules as a Suricata-compatible rule string. For more information, see Rule groups for a firewall using a Next Generation policy in the Network Firewall Developer Guide.
", "refs": { "CreateRuleGroupRequest$IpsRuleGroup": "An object that defines the rules in an IPS engine rule group, for use in a Next Generation policy.
", "DescribeRuleGroupResponse$IpsRuleGroup": "The object that defines the rules in an IPS engine rule group, for use in a Next Generation policy.
", "IpsRuleGroupEntry$InlineRuleGroup": "An IPS engine rule group defined directly in the policy, instead of referenced by ARN. Provide either InlineRuleGroup to embed a rule group or ResourceArn to reference an existing rule group.
An object that defines the rules in an IPS engine rule group, for use in a Next Generation policy.
" } }, "IpsRuleGroupEntries": { "base": null, "refs": { "FirewallPolicyV2$IpsRuleGroupEntries": "The IPS section of the policy—the rule groups that the IPS engine evaluates. Each entry references an existing IPS engine rule group or embeds a rule group directly in the policy. IPS section entries don't use a priority.
" } }, "IpsRuleGroupEntry": { "base": "A single entry in the IPS section of a Next Generation policy. An entry either references an existing IPS engine rule group by ARN or embeds a rule group directly in the policy. IPS section entries don't use a priority.
", "refs": { "IpsRuleGroupEntries$member": null } }, "IpsRuleGroupOverride": { "base": "The setting that allows the policy owner to change the behavior of an IPS engine rule group within a Next Generation policy.
", "refs": { "IpsRuleGroupEntry$Override": "The setting that allows the policy owner to change the behavior of the IPS engine rule group within this policy, such as changing a managed rule group's action from DROP to ALERT.
The source of the rules for an IPS engine rule group.
", "refs": { "IpsRuleGroup$RulesSource": "The stateful inspection criteria for the IPS engine rule group.
" } }, "KeyId": { "base": null, "refs": { "EncryptionConfiguration$KeyId": "The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
" } }, "Keyword": { "base": null, "refs": { "RuleOption$Keyword": "The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.
The date and time any domain was last accessed (within the last 30 day period).
" } }, "LastUpdateTime": { "base": null, "refs": { "DescribeRuleGroupMetadataResponse$LastModifiedTime": "A timestamp indicating when the rule group was last modified.
", "FirewallPolicyResponse$LastModifiedTime": "The last time that the firewall policy was changed.
", "FirewallPolicyV2Response$LastModifiedTime": "The last time that the Next Generation policy was changed.
", "RuleGroupResponse$LastModifiedTime": "The last time that the rule group was changed.
", "TLSInspectionConfigurationResponse$LastModifiedTime": "The last time that the TLS inspection configuration was changed.
" } }, "LimitExceededException": { "base": "Unable to perform the operation because doing so would violate a limit setting.
", "refs": {} }, "ListAnalysisReportsRequest": { "base": null, "refs": {} }, "ListAnalysisReportsResponse": { "base": null, "refs": {} }, "ListContainerAssociationsRequest": { "base": null, "refs": {} }, "ListContainerAssociationsResponse": { "base": null, "refs": {} }, "ListFirewallPoliciesRequest": { "base": null, "refs": {} }, "ListFirewallPoliciesResponse": { "base": null, "refs": {} }, "ListFirewallPoliciesV2Request": { "base": null, "refs": {} }, "ListFirewallPoliciesV2Response": { "base": null, "refs": {} }, "ListFirewallsRequest": { "base": null, "refs": {} }, "ListFirewallsResponse": { "base": null, "refs": {} }, "ListFlowOperationResultsRequest": { "base": null, "refs": {} }, "ListFlowOperationResultsResponse": { "base": null, "refs": {} }, "ListFlowOperationsRequest": { "base": null, "refs": {} }, "ListFlowOperationsResponse": { "base": null, "refs": {} }, "ListRuleGroupsRequest": { "base": null, "refs": {} }, "ListRuleGroupsResponse": { "base": null, "refs": {} }, "ListTLSInspectionConfigurationsRequest": { "base": null, "refs": {} }, "ListTLSInspectionConfigurationsResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "ListVpcEndpointAssociationsRequest": { "base": null, "refs": {} }, "ListVpcEndpointAssociationsResponse": { "base": null, "refs": {} }, "ListenerProperties": { "base": null, "refs": { "DescribeProxyResource$ListenerProperties": "Listener properties for HTTP and HTTPS traffic.
", "ProxySettings$ListenerProperties": "The listeners of the firewall's proxy. Specify at least one listener, and at most one HTTP listener and one HTTPS listener. Each listener needs a port from 1 to 65535, and the two listeners must use different ports.
If you don't specify listeners when you create the firewall, the firewall listens for HTTP on port 3128 and HTTPS on port 8443.
" } }, "ListenerProperty": { "base": "Open port for taking HTTP or HTTPS traffic.
", "refs": { "ListenerProperties$member": null } }, "ListenerPropertyType": { "base": null, "refs": { "ListenerProperty$Type": "Selection of HTTP or HTTPS traffic.
" } }, "ListingName": { "base": null, "refs": { "DescribeRuleGroupMetadataResponse$ListingName": "The display name of the product listing for this rule group.
" } }, "LogDestinationConfig": { "base": "Defines where Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
Network Firewall generates logs for stateful rule groups. You can save alert, flow, and TLS log types.
", "refs": { "LogDestinationConfigs$member": null } }, "LogDestinationConfigs": { "base": null, "refs": { "LoggingConfiguration$LogDestinationConfigs": "Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.
" } }, "LogDestinationMap": { "base": null, "refs": { "LogDestinationConfig$LogDestination": "The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix.
The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts:
\"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\" }
For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group:
\"LogDestination\": { \"logGroup\": \"alert-log-group\" }
For a Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream:
\"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\" }
Unable to send logs to a configured logging destination.
", "refs": {} }, "LogDestinationType": { "base": null, "refs": { "LogDestinationConfig$LogDestinationType": "The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.
" } }, "LogType": { "base": null, "refs": { "LogDestinationConfig$LogType": "The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
ALERT - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see StatefulRule.
FLOW - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.
TLS - Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
Defines how Network Firewall performs logging for a Firewall.
", "refs": { "DescribeLoggingConfigurationResponse$LoggingConfiguration": null, "UpdateLoggingConfigurationRequest$LoggingConfiguration": "Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.
", "UpdateLoggingConfigurationResponse$LoggingConfiguration": null } }, "MatchAttributes": { "base": "Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.
", "refs": { "RuleDefinition$MatchAttributes": "Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.
" } }, "NatGatewayAllocationIdList": { "base": null, "refs": { "NatGatewayCreateMapping$AllocationIds": "The allocation IDs of the Elastic IP addresses for a public NAT gateway, from 1 to 8. For each allocation ID, specify one address in PrivateIps. If you don't specify this, Network Firewall creates a private NAT gateway.
The NAT gateway that's attached to a proxy mode firewall in an Availability Zone, and the status of the attachment. Traffic that the firewall allows in the Availability Zone leaves through this NAT gateway.
", "refs": { "NatGatewayAttachmentsList$member": null } }, "NatGatewayAttachmentStatus": { "base": null, "refs": { "NatGatewayAttachment$Status": "The status of the NAT gateway attachment. READY means that the NAT gateway is attached and the firewall can send traffic through it. Other values are CREATING, UPDATING, DELETING, and FAILED.
The NAT gateway that's attached to a proxy mode firewall in the Availability Zone, and the status of the attachment. To get NAT gateway details, such as IP addresses, use the Amazon EC2 DescribeNatGateways action.
A proxy mode firewall is READY when at least one Availability Zone's firewall endpoint and NAT gateway attachment are READY.
A NAT gateway that Network Firewall creates for a proxy mode firewall in one Availability Zone. You use this in CreateFirewall and AssociateSubnets.
To create a public NAT gateway, specify AllocationIds, and one PrivateIps address for each Elastic IP address. To create a private NAT gateway, specify only PrivateIps. You must specify at least one of them. Each Elastic IP address and private IP address can appear only once in a request.
The NAT gateway is a resource in your account. To change its IP addresses, use Amazon EC2 NAT gateway actions.
", "refs": { "NatGatewayCreateMappingsList$member": null } }, "NatGatewayCreateMappingsList": { "base": null, "refs": { "AssociateSubnetsRequest$NatGatewayCreateMappings": "The NAT gateways that Network Firewall creates for the Availability Zones that you add to a proxy mode firewall. For a proxy mode firewall, you must specify one mapping for each Availability Zone in SubnetMappings, and no other Availability Zones. Each NAT gateway subnet must be in the firewall's VPC and can't be one of the firewall endpoint subnets.
You can't specify this for a firewall that isn't a proxy mode firewall.
", "CreateFirewallRequest$NatGatewayCreateMappings": "The NAT gateways that Network Firewall creates for a proxy mode firewall, one for each Availability Zone. When you specify this, you create a proxy mode firewall. Destinations see the IP address of the NAT gateway in the client's Availability Zone as the source of the traffic.
Specify one mapping for each Availability Zone in VpcEndpoint, and no other Availability Zones. Each NAT gateway subnet must be in the VpcEndpoint VPC and can't be one of the firewall endpoint subnets.
You need permission to call the Amazon EC2 CreateNatGateway action.
If Network Firewall can't set up an Availability Zone, for example because Amazon EC2 rejects the NAT gateway, it removes the Availability Zone from the firewall. It also deletes the NAT gateway that it created there. The Availability Zone's Attachment status is FAILED, and its status message explains why. You can add the Availability Zone again with AssociateSubnets. If no Availability Zone can be set up, the firewall status is FAILED.
The NAT gateways that you specified for Network Firewall to create for a proxy mode firewall. To get the IDs and status of the NAT gateways that are attached to the firewall, see NatGatewayAttachments in the firewall's SyncStates.
The NAT Gateway the proxy is attached to.
", "DeleteProxyResponse$NatGatewayId": "The NAT Gateway the Proxy was attached to.
", "DescribeProxyResource$NatGatewayId": "The NAT Gateway for the proxy.
", "NatGatewayAttachment$NatGatewayId": "The ID of the NAT gateway.
" } }, "NatGatewayPort": { "base": null, "refs": { "ListenerProperty$Port": "Port for processing traffic.
" } }, "NatGatewayPrivateIpList": { "base": null, "refs": { "NatGatewayCreateMapping$PrivateIps": "The private IPv4 addresses of the NAT gateway. The addresses must be in the subnet that you specify and can't be the subnet's reserved addresses.
For a public NAT gateway, you must specify exactly one address for each Elastic IP address in AllocationIds, even if you specify only one. For a private NAT gateway, specify from 1 to 8 addresses. The first address is the primary address.
The number of VpcEndpointAssociation resources that use this firewall.
The number of firewalls that are associated with this firewall policy.
", "FirewallPolicyV2Response$NumberOfAssociations": "The number of firewalls that are associated with the Next Generation policy.
", "RuleGroupResponse$NumberOfAssociations": "The number of firewall policies that use this rule group.
", "TLSInspectionConfigurationResponse$NumberOfAssociations": "The number of firewall policies that use this TLS inspection configuration.
" } }, "OverrideAction": { "base": null, "refs": { "IpsRuleGroupOverride$Action": "The action that changes the rule group from DROP to ALERT. This only applies to managed rule groups.
The action that changes the rule group from DROP to ALERT. This only applies to managed rule groups.
Returns the total number of data packets received or transmitted in a flow.
" } }, "PaginationMaxResults": { "base": null, "refs": { "GetAnalysisReportResultsRequest$MaxResults": "The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.
", "refs": { "SyncStateConfig$value": null } }, "PerObjectSyncStatus": { "base": null, "refs": { "PerObjectStatus$SyncStatus": "Indicates whether this object is in sync with the version indicated in the update token.
" } }, "PolicyDefaultAction": { "base": null, "refs": { "FirewallPolicyV2$FirewallDefaultAction": "The action that the firewall engine takes on traffic that doesn't match any firewall engine rule at a hook. The firewall engine is drop by default. You can set the default action to one of the following:
DROP - Block the traffic.
ACCEPT - Allow the traffic.
REJECT - Block the traffic and send a TCP reset packet back to the client.
ALERT - Allow the traffic and generate an alert log for the traffic that reaches the default action at every hook. This is distinct from setting the policy mode to MONITOR.
For more information, see Next Generation policies in the Network Firewall Developer Guide.
" } }, "PolicyMode": { "base": null, "refs": { "FirewallPolicyV2$PolicyMode": "Indicates whether the policy's engines enforce their verdicts or only report them. In ENFORCE mode, the firewall engine and IPS engine apply their verdicts to traffic. In MONITOR mode, the engines evaluate traffic and generate logs and metrics, but don't block traffic, so you can observe how a policy would behave before you enforce it. For more information, see Next Generation policies in the Network Firewall Developer Guide.
The IAM policy for the resource.
", "PutResourcePolicyRequest$Policy": "The IAM policy statement that lists the accounts that you want to share your Network Firewall resources with and the operations that you want the accounts to be able to perform.
For a rule group resource, you can specify the following operations in the Actions section of the statement:
network-firewall:CreateFirewallPolicy
network-firewall:UpdateFirewallPolicy
network-firewall:ListRuleGroups
For a firewall policy resource, you can specify the following operations in the Actions section of the statement:
network-firewall:AssociateFirewallPolicy
network-firewall:ListFirewallPolicies
For a firewall resource, you can specify the following operations in the Actions section of the statement:
network-firewall:CreateVpcEndpointAssociation
network-firewall:DescribeFirewallMetadata
network-firewall:ListFirewalls
In the Resource section of the statement, you specify the ARNs for the Network Firewall resources that you want to share with the account that you specified in Arn.
Contains variables that you can use to override default Suricata settings in your firewall policy.
", "refs": { "FirewallPolicy$PolicyVariables": "Contains variables that you can use to override default Suricata settings in your firewall policy.
", "FirewallPolicyV2$PolicyVariables": "Contains variables that you can use to override default Suricata settings in your Next Generation policy.
" } }, "Port": { "base": null, "refs": { "FirewallRule$SourcePorts": "The source ports to inspect for.
", "FirewallRule$DestPorts": "The destination ports to inspect for.
", "Flow$SourcePort": "The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts settings.
The lower limit of the port range. This must be less than or equal to the ToPort specification.
The upper limit of the port range. This must be greater than or equal to the FromPort specification.
The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
If not specified, this matches with any source port.
This setting is only used for protocols 6 (TCP) and 17 (UDP).
", "MatchAttributes$DestinationPorts": "The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
This setting is only used for protocols 6 (TCP) and 17 (UDP).
", "ServerCertificateScope$SourcePorts": "The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.
You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.
The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.
You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.
A set of port ranges for use in the rules in a rule group.
", "refs": { "PortSets$value": null } }, "PortSets": { "base": null, "refs": { "RuleVariables$PortSets": "A list of port ranges.
" } }, "Priority": { "base": null, "refs": { "FirewallRuleGroupEntry$Priority": "The priority of the rule group entry within the firewall section. Network Firewall evaluates the firewall section's entries in order of increasing priority value. Each entry in the firewall section must have a unique priority.
", "StatefulRuleGroupReference$Priority": "An integer setting that indicates the order in which to run the stateful rule groups in a single FirewallPolicy. This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings.
Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.
", "StatelessRule$Priority": "Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group.
Each stateless rule group uses exactly one StatelessRulesAndCustomActions object, and each StatelessRulesAndCustomActions contains exactly one StatelessRules object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single StatelessRules object.
You can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on.
", "StatelessRuleGroupReference$Priority": "An integer setting that indicates the order in which to run the stateless rule groups in a single FirewallPolicy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
" } }, "PrivateDNSName": { "base": null, "refs": { "DescribeProxyResource$PrivateDNSName": "The private DNS name of the Proxy.
" } }, "ProductId": { "base": null, "refs": { "DescribeRuleGroupMetadataResponse$ProductId": "The unique identifier for the product listing associated with this rule group.
" } }, "ProtocolNumber": { "base": null, "refs": { "ProtocolNumbers$member": null } }, "ProtocolNumbers": { "base": null, "refs": { "MatchAttributes$Protocols": "The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.
", "ServerCertificateScope$Protocols": "The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.
Network Firewall currently supports only TCP.
" } }, "ProtocolString": { "base": null, "refs": { "Flow$Protocol": "The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.
", "ProtocolStrings$member": null } }, "ProtocolStrings": { "base": null, "refs": { "FlowFilter$Protocols": "The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.
" } }, "ProxyDomainName": { "base": null, "refs": { "ProxySettings$DomainName": "The domain name that your clients use to reach the firewall's proxy. The name must have at least two labels and at most 253 characters. It can't contain a wildcard or use the proxy-id.nfw.region.amazonaws.com format, and the certificate in CertificateArn must cover it. If you don't specify this, Network Firewall generates a domain name.
Network Firewall creates the Route 53 private hosted zones that resolve this name to the firewall endpoints, so you don't need to configure DNS. A VPC can have only one private hosted zone with a given name. If a VPC that the firewall serves already has one with this name, Network Firewall can't set up the Availability Zones in that VPC.
If you specify DomainName, you must also specify CertificateArn. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
Current modification status of the Proxy.
" } }, "ProxySettings": { "base": "The proxy settings of a proxy mode firewall: the ports and protocols on which the firewall's proxy listens for traffic, and optionally your own domain name and certificate.
", "refs": { "CreateFirewallRequest$ProxySettings": "The proxy settings for a proxy mode firewall: the ports and protocols on which the firewall's proxy listens for traffic, and optionally your own domain name and certificate. If you don't specify listeners, the firewall listens for HTTP on port 3128 and HTTPS on port 8443.
To change the listeners later, use UpdateProxySettings.
The proxy settings of a proxy mode firewall: its listeners and, if you specified them, your own CertificateArn and DomainName.
The proxy settings to set on the firewall. These replace the current proxy settings. Specify at least one listener, and at most one HTTP listener and one HTTPS listener, on different ports. If the firewall uses your own CertificateArn and DomainName, specify the same values that you used to create the firewall.
The updated proxy settings for the firewall.
" } }, "ProxyState": { "base": null, "refs": { "DescribeProxyResource$ProxyState": "Current attachment/detachment status of the Proxy.
" } }, "PublishMetricAction": { "base": "Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.
", "refs": { "ActionDefinition$PublishMetricAction": "Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.
You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.
" } }, "PutResourcePolicyRequest": { "base": null, "refs": {} }, "PutResourcePolicyResponse": { "base": null, "refs": {} }, "ReferenceSets": { "base": "Contains a set of IP set references.
", "refs": { "FirewallRuleGroup$ReferenceSets": "The list of a rule group's reference sets. Firewall engine rule groups don't support IP set references (reference sets); this setting applies to IPS engine rule groups. To use CIDR ranges in firewall engine rules, use rule variables instead.
", "IpsRuleGroup$ReferenceSets": "The list of a rule group's reference sets.
", "RuleGroup$ReferenceSets": "The list of a rule group's reference sets.
" } }, "RejectNetworkFirewallTransitGatewayAttachmentRequest": { "base": null, "refs": {} }, "RejectNetworkFirewallTransitGatewayAttachmentResponse": { "base": null, "refs": {} }, "ReportTime": { "base": null, "refs": { "AnalysisReport$ReportTime": "The date and time the analysis report was ran.
", "GetAnalysisReportResultsResponse$ReportTime": "The date and time the analysis report was ran.
" } }, "ResourceArn": { "base": null, "refs": { "AssociateAvailabilityZonesRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "AssociateAvailabilityZonesResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "AssociateFirewallPolicyRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "AssociateFirewallPolicyRequest$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the firewall policy.
", "AssociateFirewallPolicyResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "AssociateFirewallPolicyResponse$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the firewall policy.
", "AssociateSubnetsRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "AssociateSubnetsResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "ContainerAssociationSummary$Arn": "The Amazon Resource Name (ARN) of the container association.
", "ContainerMonitoringConfiguration$ClusterArn": "The ARN of the Amazon ECS or Amazon EKS cluster to monitor. The cluster must be in the same Region and account as the container association.
", "CreateContainerAssociationResponse$ContainerAssociationArn": "The Amazon Resource Name (ARN) of the container association.
", "CreateFirewallRequest$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
", "CreateVpcEndpointAssociationRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "DeleteContainerAssociationRequest$ContainerAssociationArn": "The Amazon Resource Name (ARN) of the container association.
You must specify the ARN or the name, and you can specify both.
", "DeleteContainerAssociationResponse$ContainerAssociationArn": "The Amazon Resource Name (ARN) of the container association.
", "DeleteFirewallPolicyRequest$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
", "DeleteFirewallPolicyV2Request$FirewallPolicyV2Arn": "The Amazon Resource Name (ARN) of the Next Generation policy.
You must specify the ARN or the name, and you can specify both.
", "DeleteFirewallRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "DeleteProxyRequest$ProxyArn": "The Amazon Resource Name (ARN) of a proxy.
You must specify the ARN or the name, and you can specify both.
", "DeleteProxyResponse$ProxyArn": "The Amazon Resource Name (ARN) of a proxy.
", "DeleteResourcePolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete.
", "DeleteRuleGroupRequest$RuleGroupArn": "The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
", "DeleteTLSInspectionConfigurationRequest$TLSInspectionConfigurationArn": "The Amazon Resource Name (ARN) of the TLS inspection configuration.
You must specify the ARN or the name, and you can specify both.
", "DeleteVpcEndpointAssociationRequest$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
", "DescribeContainerAssociationRequest$ContainerAssociationArn": "The Amazon Resource Name (ARN) of the container association.
You must specify the ARN or the name, and you can specify both.
", "DescribeContainerAssociationResponse$ContainerAssociationArn": "The Amazon Resource Name (ARN) of the container association.
", "DescribeFirewallMetadataRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "DescribeFirewallMetadataResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "DescribeFirewallMetadataResponse$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the firewall policy.
", "DescribeFirewallPolicyRequest$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
", "DescribeFirewallPolicyV2Request$FirewallPolicyV2Arn": "The Amazon Resource Name (ARN) of the Next Generation policy.
You must specify the ARN or the name, and you can specify both.
", "DescribeFirewallRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "DescribeFlowOperationRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "DescribeFlowOperationRequest$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
", "DescribeFlowOperationResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "DescribeFlowOperationResponse$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
", "DescribeLoggingConfigurationRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "DescribeLoggingConfigurationResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "DescribeProxyRequest$ProxyArn": "The Amazon Resource Name (ARN) of a proxy.
You must specify the ARN or the name, and you can specify both.
", "DescribeProxyResource$ProxyArn": "The Amazon Resource Name (ARN) of a proxy.
", "DescribeProxyResource$ProxyConfigurationArn": "The Amazon Resource Name (ARN) of a proxy configuration.
", "DescribeResourcePolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve.
", "DescribeRuleGroupMetadataRequest$RuleGroupArn": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeRuleGroupMetadataResponse$RuleGroupArn": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeRuleGroupRequest$RuleGroupArn": "The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
", "DescribeRuleGroupSummaryRequest$RuleGroupArn": "Required. The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
", "DescribeTLSInspectionConfigurationRequest$TLSInspectionConfigurationArn": "The Amazon Resource Name (ARN) of the TLS inspection configuration.
You must specify the ARN or the name, and you can specify both.
", "DescribeVpcEndpointAssociationRequest$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
", "DisassociateAvailabilityZonesRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "DisassociateAvailabilityZonesResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "DisassociateSubnetsRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "DisassociateSubnetsResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "Firewall$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "Firewall$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
", "FirewallMetadata$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "FirewallPolicy$TLSInspectionConfigurationArn": "The Amazon Resource Name (ARN) of the TLS inspection configuration.
", "FirewallPolicyMetadata$Arn": "The Amazon Resource Name (ARN) of the firewall policy.
", "FirewallPolicyResponse$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the firewall policy.
If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
The Amazon Resource Name (ARN) of the TLS inspection configuration to use to decrypt traffic for inspection. Next Generation policies support session holding only. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
", "FirewallPolicyV2Metadata$Arn": "The Amazon Resource Name (ARN) of the Next Generation policy.
", "FirewallPolicyV2Response$FirewallPolicyV2Arn": "The Amazon Resource Name (ARN) of the Next Generation policy.
", "FirewallRuleGroupEntry$ResourceArn": "The Amazon Resource Name (ARN) of an existing firewall engine rule group to reference in this entry. Provide either ResourceArn to reference an existing rule group or InlineRuleGroup to embed a rule group in the policy.
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "IPSetReference$ReferenceArn": "The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
", "IpsRuleGroupEntry$ResourceArn": "The Amazon Resource Name (ARN) of an existing IPS engine rule group to reference in this entry. Provide either ResourceArn to reference an existing rule group or InlineRuleGroup to embed a rule group in the policy.
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "ListFlowOperationResultsRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "ListFlowOperationResultsRequest$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
", "ListFlowOperationResultsResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "ListFlowOperationResultsResponse$VpcEndpointAssociationArn": "", "ListFlowOperationsRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "ListFlowOperationsRequest$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
", "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
", "ListVpcEndpointAssociationsRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
If you don't specify this, Network Firewall retrieves all VPC endpoint associations that you have defined.
", "ProxySettings$CertificateArn": "The Amazon Resource Name (ARN) of the certificate that the firewall's HTTPS proxy listener presents to clients. The certificate must be an Certificate Manager (ACM) certificate in the same account and Region as the firewall. Its subject alternative names must cover DomainName, either exactly or with a wildcard that matches exactly one label. For example, *.example.com covers proxy.example.com. If you don't specify this, Network Firewall uses a certificate that it manages for a domain name that it generates.
You manage and renew the certificate in ACM, and Network Firewall uses renewed certificates automatically. While the firewall uses the certificate, you can't delete it from ACM. Your clients must trust the certificate's certificate authority.
If you specify CertificateArn, you must also specify DomainName. You can set them only when you create the firewall. When you call UpdateProxySettings, specify the same values.
The Amazon Resource Name (ARN) of the account that you want to share your Network Firewall resources with.
", "RuleGroupMetadata$Arn": "The Amazon Resource Name (ARN) of the rule group.
", "RuleGroupResponse$RuleGroupArn": "The Amazon Resource Name (ARN) of the rule group.
If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..
", "ServerCertificate$ResourceArn": "The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection.
", "ServerCertificateConfiguration$CertificateAuthorityArn": "The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
The following limitations apply:
You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
You can't use certificates issued by Private Certificate Authority.
For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with TLS inspection configurations in the Network Firewall Developer Guide.
For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
", "SourceMetadata$SourceArn": "The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
", "StartAnalysisReportRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "StartFlowCaptureRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "StartFlowCaptureRequest$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
", "StartFlowCaptureResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "StartFlowFlushRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "StartFlowFlushRequest$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
", "StartFlowFlushResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "StatefulRuleGroupReference$ResourceArn": "The Amazon Resource Name (ARN) of the stateful rule group.
", "StatelessRuleGroupReference$ResourceArn": "The Amazon Resource Name (ARN) of the stateless rule group.
", "TLSInspectionConfigurationMetadata$Arn": "The Amazon Resource Name (ARN) of the TLS inspection configuration.
", "TLSInspectionConfigurationResponse$TLSInspectionConfigurationArn": "The Amazon Resource Name (ARN) of the TLS inspection configuration.
", "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
", "TlsCertificateData$CertificateArn": "The Amazon Resource Name (ARN) of the certificate.
", "TlsInterceptProperties$PcaArn": "Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.
", "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UpdateAvailabilityZoneChangeProtectionRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateAvailabilityZoneChangeProtectionResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateContainerAssociationRequest$ContainerAssociationArn": "The Amazon Resource Name (ARN) of the container association.
You must specify the ARN or the name, and you can specify both.
", "UpdateContainerAssociationResponse$ContainerAssociationArn": "The Amazon Resource Name (ARN) of the container association.
", "UpdateFirewallAnalysisSettingsRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallAnalysisSettingsResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallDeleteProtectionRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallDeleteProtectionResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateFirewallDescriptionRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallDescriptionResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateFirewallEncryptionConfigurationRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateFirewallEncryptionConfigurationResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateFirewallPolicyChangeProtectionRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallPolicyChangeProtectionResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateFirewallPolicyRequest$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallPolicyV2Request$FirewallPolicyV2Arn": "The Amazon Resource Name (ARN) of the Next Generation policy.
You must specify the ARN or the name, and you can specify both.
", "UpdateLoggingConfigurationRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateLoggingConfigurationResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateProxySettingsRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateProxySettingsResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateRuleGroupRequest$RuleGroupArn": "The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
", "UpdateSubnetChangeProtectionRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateSubnetChangeProtectionResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateTLSInspectionConfigurationRequest$TLSInspectionConfigurationArn": "The Amazon Resource Name (ARN) of the TLS inspection configuration.
", "VpcEndpointAssociation$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
", "VpcEndpointAssociation$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "VpcEndpointAssociationMetadata$VpcEndpointAssociationArn": "The Amazon Resource Name (ARN) of a VPC endpoint association.
" } }, "ResourceId": { "base": null, "refs": { "Firewall$FirewallId": "The unique identifier for the firewall.
", "FirewallPolicyResponse$FirewallPolicyId": "The unique identifier for the firewall policy.
", "FirewallPolicyV2Response$FirewallPolicyV2Id": "The unique identifier of the Next Generation policy. Network Firewall assigns this identifier when you create the policy.
", "RuleGroupResponse$RuleGroupId": "The unique identifier for the rule group.
", "TLSInspectionConfigurationResponse$TLSInspectionConfigurationId": "A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
", "VpcEndpointAssociation$VpcEndpointAssociationId": "The unique identifier of the VPC endpoint association.
" } }, "ResourceManagedStatus": { "base": null, "refs": { "ListRuleGroupsRequest$Scope": "The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.
Indicates the general category of the Amazon Web Services managed rule group.
" } }, "ResourceName": { "base": null, "refs": { "AssociateAvailabilityZonesRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "AssociateAvailabilityZonesResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "AssociateFirewallPolicyRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "AssociateFirewallPolicyResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "AssociateSubnetsRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "AssociateSubnetsResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "ContainerAssociationSummary$Name": "The descriptive name of the container association.
", "CreateContainerAssociationRequest$ContainerAssociationName": "The descriptive name of the container association. You can't change the name of a container association after you create it.
", "CreateContainerAssociationResponse$ContainerAssociationName": "The descriptive name of the container association.
", "CreateFirewallPolicyRequest$FirewallPolicyName": "The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
", "CreateFirewallPolicyV2Request$FirewallPolicyV2Name": "The descriptive name of the Next Generation policy. You can't change the name of a firewall policy after you create it.
", "CreateFirewallRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "CreateRuleGroupRequest$RuleGroupName": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
", "CreateTLSInspectionConfigurationRequest$TLSInspectionConfigurationName": "The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
", "DeleteContainerAssociationRequest$ContainerAssociationName": "The descriptive name of the container association.
You must specify the ARN or the name, and you can specify both.
", "DeleteContainerAssociationResponse$ContainerAssociationName": "The descriptive name of the container association.
", "DeleteFirewallPolicyRequest$FirewallPolicyName": "The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
You must specify the ARN or the name, and you can specify both.
", "DeleteFirewallPolicyV2Request$FirewallPolicyV2Name": "The descriptive name of the Next Generation policy. You can't change the name of a firewall policy after you create it.
You must specify the ARN or the name, and you can specify both.
", "DeleteFirewallRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "DeleteProxyRequest$ProxyName": "The descriptive name of the proxy. You can't change the name of a proxy after you create it.
You must specify the ARN or the name, and you can specify both.
", "DeleteProxyResponse$ProxyName": "The descriptive name of the proxy. You can't change the name of a proxy after you create it.
", "DeleteRuleGroupRequest$RuleGroupName": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
", "DeleteTLSInspectionConfigurationRequest$TLSInspectionConfigurationName": "The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeContainerAssociationRequest$ContainerAssociationName": "The descriptive name of the container association.
You must specify the ARN or the name, and you can specify both.
", "DescribeContainerAssociationResponse$ContainerAssociationName": "The descriptive name of the container association.
", "DescribeFirewallPolicyRequest$FirewallPolicyName": "The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeFirewallPolicyV2Request$FirewallPolicyV2Name": "The descriptive name of the Next Generation policy. You can't change the name of a firewall policy after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeFirewallRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeLoggingConfigurationRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeProxyRequest$ProxyName": "The descriptive name of the proxy. You can't change the name of a proxy after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeProxyResource$ProxyName": "The descriptive name of the proxy. You can't change the name of a proxy after you create it.
", "DescribeProxyResource$ProxyConfigurationName": "The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
", "DescribeRuleGroupMetadataRequest$RuleGroupName": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeRuleGroupMetadataResponse$RuleGroupName": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeRuleGroupRequest$RuleGroupName": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeRuleGroupSummaryRequest$RuleGroupName": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
", "DescribeRuleGroupSummaryResponse$RuleGroupName": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
", "DescribeTLSInspectionConfigurationRequest$TLSInspectionConfigurationName": "The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
You must specify the ARN or the name, and you can specify both.
", "DisassociateAvailabilityZonesRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "DisassociateAvailabilityZonesResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "DisassociateSubnetsRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "DisassociateSubnetsResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "Firewall$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "FirewallMetadata$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "FirewallPolicyMetadata$Name": "The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
", "FirewallPolicyResponse$FirewallPolicyName": "The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
", "FirewallPolicyV2Metadata$Name": "The descriptive name of the Next Generation policy. You can't change the name of a firewall policy after you create it.
", "FirewallPolicyV2Response$FirewallPolicyV2Name": "The descriptive name of the Next Generation policy. You can't change the name of a firewall policy after you create it.
", "GetAnalysisReportResultsRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "ListAnalysisReportsRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "RuleGroupMetadata$Name": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
", "RuleGroupResponse$RuleGroupName": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
", "StartAnalysisReportRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "SyncStateConfig$key": null, "TLSInspectionConfigurationMetadata$Name": "The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
", "TLSInspectionConfigurationResponse$TLSInspectionConfigurationName": "The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
", "UpdateAvailabilityZoneChangeProtectionRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateAvailabilityZoneChangeProtectionResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateContainerAssociationRequest$ContainerAssociationName": "The descriptive name of the container association.
You must specify the ARN or the name, and you can specify both.
", "UpdateContainerAssociationResponse$ContainerAssociationName": "The descriptive name of the container association.
", "UpdateFirewallAnalysisSettingsRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallAnalysisSettingsResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallDeleteProtectionRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallDeleteProtectionResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateFirewallDescriptionRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallDescriptionResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateFirewallEncryptionConfigurationRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateFirewallEncryptionConfigurationResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateFirewallPolicyChangeProtectionRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallPolicyChangeProtectionResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateFirewallPolicyRequest$FirewallPolicyName": "The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallPolicyV2Request$FirewallPolicyV2Name": "The descriptive name of the Next Generation policy. You can't change the name of a firewall policy after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateLoggingConfigurationRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateLoggingConfigurationResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateProxySettingsRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateProxySettingsResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateRuleGroupRequest$RuleGroupName": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateSubnetChangeProtectionRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateSubnetChangeProtectionResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateTLSInspectionConfigurationRequest$TLSInspectionConfigurationName": "The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
" } }, "ResourceNotFoundException": { "base": "Unable to locate a resource using the parameters that you provided.
", "refs": {} }, "ResourceOwnerCheckException": { "base": "Unable to change the resource because your account doesn't own it.
", "refs": {} }, "ResourceStatus": { "base": null, "refs": { "FirewallPolicyResponse$FirewallPolicyStatus": "The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.
", "FirewallPolicyV2Response$FirewallPolicyV2Status": "The current status of the Next Generation policy. A policy must be in the ACTIVE state before you can use it in a firewall.
Detailed information about the current status of a rule group.
", "TLSInspectionConfigurationResponse$TLSInspectionConfigurationStatus": "Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
" } }, "ResourceStatusMessage": { "base": null, "refs": { "FirewallPolicyResponse$StatusMessage": "Additional detail about the firewall policy's current status, when applicable. For example, while an Amazon Route 53 Resolver DNS Firewall rule group change is in progress, the status is UPDATING and this message is \"A DNS Firewall rule group change is in progress.\"
Additional information about the current status of the Next Generation policy.
" } }, "RevocationCheckAction": { "base": null, "refs": { "CheckCertificateRevocationStatusActions$RevokedStatusAction": "Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status.
PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.
Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate.
PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.
The policy-level configuration for resolved IP validation. When you set this on a firewall policy, you require that the destination IP address of a connection is one that the Amazon Route 53 Resolver returned in a DNS response for a domain. The Route 53 Resolver must have returned the response in a VPC that's associated with the Route 53 Resolver DNS Firewall rule group identified by DNSFirewallRuleGroupId. At the policy level, this verifies that the destination IP address was resolved for some domain. To match specific domains, also configure stateful rule groups that use the AWS_ROUTE_53_RESOLVED_DOMAIN target type or the aws_route_53_resolved_domain rule keyword.
Enabling or disabling resolved IP validation, or changing DNSFirewallRuleGroupId, may require a restart of the stateful engine in order to apply the change. When this occurs, existing connections will be treated according to your stream exception policy configuration. Changes to Action, DNSExpiryExceptionPolicy, SourceIPRanges, and BypassDestinationValidationIPRanges don't require a restart.
The settings that enable resolved IP validation for the policy. Resolved IP validation verifies that a connection's destination IP address is one that the Amazon Route 53 Resolver returned in a DNS response for a domain. A VPC that's associated with the Route 53 Resolver DNS Firewall rule group that you specify must send the response. This checks how the destination IP address was obtained, instead of relying only on the domain that the client asserts in its TLS Server Name Indication (SNI) or HTTP Host header. For more information, see Route53ResolvedIPValidation.
The settings that enable resolved IP validation for the Next Generation policy. Resolved IP validation verifies that a connection's destination IP address is one that the Amazon Route 53 Resolver returned in a DNS response for a domain. A VPC that's associated with the Route 53 Resolver DNS Firewall rule group that you specify must send the response. This checks how the destination IP address was obtained, instead of relying only on the domain that the client asserts in its TLS Server Name Indication (SNI) or HTTP Host header. For more information, see Route53ResolvedIPValidation.
The action that Network Firewall takes for a connection whose destination IP address fails resolved IP validation. A destination IP address fails validation when the Route 53 Resolver didn't return it in a DNS response in an associated VPC. Valid values are the following:
ALERT – Tags the matching connection in the firewall's flow logs without blocking it, when you enable logging. Use this to observe the effect of resolved IP validation before you enforce it.
DROP – Silently blocks the connection without sending any response to the client.
REJECT – Blocks the connection and sends a TCP reset (RST) to the client. Because a TCP reset applies only to TCP connections, Network Firewall drops non-TCP traffic instead of resetting it.
The destination IP address ranges that are exempt from the policy-level resolved IP check. Network Firewall doesn't apply the Action in this configuration to a connection whose destination falls in these ranges, even if the Route 53 Resolver didn't return that IP address in an associated VPC. Specify each entry as an IPv4 or IPv6 address or CIDR range, up to 100 entries.
This exemption applies only to the policy-level check. Stateful rules that use the AWS_ROUTE_53_RESOLVED_DOMAIN target type or the aws_route_53_resolved_domain keyword still evaluate connections to these destinations and match them independently of this list.
The client source IP address ranges whose connections are subject to resolved IP validation. Specify each entry as an IPv4 or IPv6 address or CIDR range, up to 100 entries. If you omit this field, resolved IP validation applies to the CIDR ranges of the firewall's VPC and of any additional VPCs attached to the firewall. Specifying an empty list is not the same as omitting the field: an empty list means that Network Firewall doesn't validate any source addresses.
This scope applies to the policy-level check only. Stateful rules that use the AWS_ROUTE_53_RESOLVED_DOMAIN target type or the aws_route_53_resolved_domain keyword still evaluate their destinations regardless of SourceIPRanges.
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A match setting with no criteria specified has a value of 1.
A match setting with Any specified has a value of 1.
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting [\"UDP\"] and a source setting [\"10.0.0.0/24\"] each have a value of 1. A protocol setting [\"UDP\",\"TCP\"] has a value of 2. A source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting [\"UDP\",\"TCP\"], source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
", "DescribeRuleGroupMetadataResponse$Capacity": "The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
The number of capacity units currently consumed by the policy's stateless rules.
", "FirewallPolicyResponse$ConsumedStatefulRuleCapacity": "The number of capacity units currently consumed by the policy's stateful rules.
", "FirewallPolicyResponse$ConsumedStatefulDomainCapacity": "The total number of domain name specifications across all domain list rule groups in the firewall policy that use the stateful-domain-rulegroup resource type.
The number of firewall engine rule capacity units that the policy's firewall section currently consumes.
", "FirewallPolicyV2Response$ConsumedIpsRuleCapacity": "The number of IPS engine rule capacity units that the policy's IPS section currently consumes.
", "FirewallPolicyV2Response$ConsumedIpsDomainCapacity": "The number of IPS domain list capacity units that the policy's IPS section currently consumes.
", "RuleGroupResponse$Capacity": "The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
The number of capacity units currently consumed by the rule group rules.
" } }, "RuleDefinition": { "base": "The inspection criteria and action for a single stateless rule. Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.
", "refs": { "StatelessRule$RuleDefinition": "Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
" } }, "RuleDescriptionText": { "base": null, "refs": { "RuleMetadata$RuleDescription": "A description of the rule, up to 512 characters. The description can span multiple lines. A description line can't itself look like a firewall rule; to disable a rule, set RuleEnabled to FALSE instead.
Specifies whether the rule is active. The default is TRUE. When you set this to FALSE, Network Firewall keeps the rule in the rule group but doesn't evaluate it against traffic and doesn't count it toward the rule group's consumed capacity.
The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
", "refs": { "CreateRuleGroupRequest$RuleGroup": "An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
", "UpdateRuleGroupRequest$RuleGroup": "An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
High-level information about a rule group, returned by ListRuleGroups. You can use the information provided in the metadata to retrieve and manage a rule group.
", "refs": { "RuleGroups$member": null } }, "RuleGroupResponse": { "base": "The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
", "refs": { "CreateRuleGroupResponse$RuleGroupResponse": "The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
", "DeleteRuleGroupResponse$RuleGroupResponse": "The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
", "DescribeRuleGroupResponse$RuleGroupResponse": "The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
", "UpdateRuleGroupResponse$RuleGroupResponse": "The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
" } }, "RuleGroupType": { "base": null, "refs": { "CreateRuleGroupRequest$Type": "Indicates the type of the rule group. Valid values are:
STATELESS - Stateless rules, for use in a Classic Network Firewall policy.
STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.
FIREWALL - Firewall engine rules, for use in a Next Generation policy.
IPS - IPS engine rules, for use in a Next Generation policy.
Indicates the type of the rule group. Valid values are:
STATELESS - Stateless rules, for use in a Classic Network Firewall policy.
STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.
FIREWALL - Firewall engine rules, for use in a Next Generation policy.
IPS - IPS engine rules, for use in a Next Generation policy.
This setting is required for requests that do not include the RuleGroupARN.
Indicates the type of the rule group. Valid values are:
STATELESS - Stateless rules, for use in a Classic Network Firewall policy.
STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.
FIREWALL - Firewall engine rules, for use in a Next Generation policy.
IPS - IPS engine rules, for use in a Next Generation policy.
This setting is required for requests that do not include the RuleGroupARN.
Indicates the type of the rule group. Valid values are:
STATELESS - Stateless rules, for use in a Classic Network Firewall policy.
STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.
FIREWALL - Firewall engine rules, for use in a Next Generation policy.
IPS - IPS engine rules, for use in a Next Generation policy.
This setting is required for requests that do not include the RuleGroupARN.
Indicates the type of the rule group. Valid values are:
STATELESS - Stateless rules, for use in a Classic Network Firewall policy.
STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.
FIREWALL - Firewall engine rules, for use in a Next Generation policy.
IPS - IPS engine rules, for use in a Next Generation policy.
This setting is required for requests that do not include the RuleGroupARN.
The type of rule group you want a summary for. This is a required field.
Valid value: STATEFUL
Note that STATELESS exists but is not currently supported. If you provide STATELESS, an exception is returned.
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
", "RuleGroupResponse$Type": "Indicates the type of the rule group. Valid values are:
STATELESS - Stateless rules, for use in a Classic Network Firewall policy.
STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.
FIREWALL - Firewall engine rules, for use in a Next Generation policy.
IPS - IPS engine rules, for use in a Next Generation policy.
Indicates the type of the rule group. Valid values are:
STATELESS - Stateless rules, for use in a Classic Network Firewall policy.
STATEFUL - Stateful rules, for use in a Classic Network Firewall policy.
FIREWALL - Firewall engine rules, for use in a Next Generation policy.
IPS - IPS engine rules, for use in a Next Generation policy.
This setting is required for requests that do not include the RuleGroupARN.
The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.
" } }, "RuleIdList": { "base": null, "refs": { "AnalysisResult$IdentifiedRuleIds": "The priority number of the stateless rules identified in the analysis.
" } }, "RuleMetadata": { "base": "Metadata for a single firewall engine rule. Use it to disable a rule without removing it and to attach a description. When you describe a rule group in RULES_STRING format, Network Firewall renders a disabled rule and its description as # comment lines above the rule.
Optional metadata for the rule: whether the rule is enabled and a description. Metadata doesn't change how the rule matches or acts on traffic.
" } }, "RuleOption": { "base": "Additional settings for a stateful rule. This is part of the StatefulRule configuration.
", "refs": { "RuleOptions$member": null } }, "RuleOptions": { "base": null, "refs": { "FirewallRule$RuleOptions": "Additional options for the rule. These are the Suricata RuleOptions settings, such as the signature ID (sid) and match keywords.
Additional options for the rule. These are the Suricata RuleOptions settings.
Indicates how to manage the order of stateful rule evaluation for the policy. STRICT_ORDER is the recommended option, but DEFAULT_ACTION_ORDER is the default option. With STRICT_ORDER, provide your rules in the order that you want them to be evaluated. You can then choose one or more default actions for packets that don't match any rules. Choose STRICT_ORDER to have the stateful rules engine determine the evaluation order of your rules. The default action for this rule order is PASS, followed by DROP, REJECT, and ALERT actions. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
The format in which to return the rules of any firewall engine rule groups that are embedded in the policy. Specify FIREWALL_RULES for structured FirewallRule objects or RULES_STRING for a Suricata-compatible firewall-mode rule string. If you don't specify a format, Network Firewall returns each embedded rule group in the format you provided it in. Referenced rule groups aren't affected.
For a firewall engine rule group, the format in which to return the rules. Specify one of the following values:
FIREWALL_RULES - Returns the rules as structured FirewallRule objects.
RULES_STRING - Returns the rules as a Suricata-compatible firewall-mode rule string.
If you don't specify a format, Network Firewall returns the rules in the format you provided them in. This setting applies only to FIREWALL and IPS rule groups; IPS engine rule groups support only RULES_STRING.
An array of RuleSummary objects containing individual rule details that had been configured by the rulegroup's SummaryConfiguration.
" } }, "RuleSummary": { "base": "A complex type containing details about a Suricata rule. Contains:
SID
Msg
Metadata
Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.
", "refs": { "RuleSummaries$member": null } }, "RuleTargets": { "base": null, "refs": { "RulesSourceList$Targets": "The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:
Explicit names. For example, abc.example.com matches only the domain abc.example.com.
Names that use a domain wildcard, which you indicate with an initial '.'. For example,.example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.
Settings that are available for use in the rules in the RuleGroup where this is defined. See CreateRuleGroup or UpdateRuleGroup for usage.
", "refs": { "FirewallRuleGroup$RuleVariables": "Settings that are available for use in the rules in the firewall engine rule group, such as IP set and port variables that the rules reference.
", "IpsRuleGroup$RuleVariables": "Settings that are available for use in the rules in the IPS engine rule group.
", "RuleGroup$RuleVariables": "Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
" } }, "RulesSource": { "base": "The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single RulesSource. You can use an instance of this for either stateless rules or stateful rules.
The stateful rules or stateless rules for the rule group.
" } }, "RulesSourceList": { "base": "Stateful inspection criteria for a domain list rule group.
For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.
Stateful inspection criteria for a domain list, specified as the list of domain names that Network Firewall generates firewall engine rules from.
", "RulesSource$RulesSourceList": "Stateful inspection criteria for a domain list rule group.
" } }, "RulesString": { "base": null, "refs": { "CreateRuleGroupRequest$Rules": "A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.
", "FirewallRulesSource$RulesString": "Firewall engine rules, provided as a single Suricata-compatible rule string in firewall mode. Use this to provide rules that you've already written in the Suricata firewall-mode format. For the rule format, see Rule groups for a firewall using a Next Generation policy in the Network Firewall Developer Guide.
", "IpsRulesSource$RulesString": "IPS engine rules, provided as a single Suricata-compatible rule string. For the rule format, see Rules Format on the Suricata website.
", "RulesSource$RulesString": "Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.
These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.
You can't use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to STRICT_ORDER.
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.
" } }, "ServerCertificate": { "base": "Any Certificate Manager (ACM) Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a ServerCertificateConfiguration. Used in a TLSInspectionConfiguration for inspection of inbound traffic to your firewall. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in Certificate Manager, see Request a public certificate or Importing certificates in the Certificate Manager User Guide.
", "refs": { "ServerCertificates$member": null } }, "ServerCertificateConfiguration": { "base": "Configures the Certificate Manager certificates and scope that Network Firewall uses to decrypt and re-encrypt traffic using a TLSInspectionConfiguration. You can configure ServerCertificates for inbound SSL/TLS inspection, a CertificateAuthorityArn for outbound SSL/TLS inspection, or both. For information about working with certificates for TLS inspection, see Using SSL/TLS server certficiates with TLS inspection configurations in the Network Firewall Developer Guide.
If a server certificate that's associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.
Lists the server certificate configurations that are associated with the TLS configuration.
" } }, "ServerCertificateScope": { "base": "Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.
", "refs": { "ServerCertificateScopes$member": null } }, "ServerCertificateScopes": { "base": null, "refs": { "ServerCertificateConfiguration$Scopes": "A list of scopes.
" } }, "ServerCertificates": { "base": null, "refs": { "ServerCertificateConfiguration$ServerCertificates": "The list of server certificates to use for inbound SSL/TLS inspection.
" } }, "Setting": { "base": null, "refs": { "Settings$member": null } }, "Settings": { "base": null, "refs": { "RuleOption$Settings": "The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.
The source IP addresses and address ranges to inspect for, in CIDR notation. A firewall rule always compiles to a forward-direction rule, so you express inbound compared to outbound traffic through the source and destination addresses.
", "Header$Source": "The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
" } }, "SourceMetadata": { "base": "High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the originating rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
", "refs": { "CreateRuleGroupRequest$SourceMetadata": "A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
", "RuleGroupResponse$SourceMetadata": "A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.
", "UpdateRuleGroupRequest$SourceMetadata": "A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
" } }, "StartAnalysisReportRequest": { "base": null, "refs": {} }, "StartAnalysisReportResponse": { "base": null, "refs": {} }, "StartFlowCaptureRequest": { "base": null, "refs": {} }, "StartFlowCaptureResponse": { "base": null, "refs": {} }, "StartFlowFlushRequest": { "base": null, "refs": {} }, "StartFlowFlushResponse": { "base": null, "refs": {} }, "StartTime": { "base": null, "refs": { "GetAnalysisReportResultsResponse$StartTime": " The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ.
Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
The actions for a stateful rule are defined as follows:
PASS - Permits the packets to go to the intended destination.
DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
ALERT - Sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with ALERT action, verify in the logs that the rule is filtering as you want, then change the action to DROP.
REJECT - Drops traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and an RST bit contained in the TCP header flags. REJECT is available only for TCP traffic. This option doesn't support FTP or IMAP protocols.
The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.
Valid values of the stateful default action:
aws:drop_strict
aws:drop_established
aws:alert_strict
aws:alert_established
aws:drop_established_app_layer
aws:alert_established_app_layer
aws:drop_established_app_layer_to_server
aws:alert_established_app_layer_to_server
For more information, see Strict evaluation order in the Network Firewall Developer Guide.
" } }, "StatefulEngineOptions": { "base": "Configuration settings for the handling of the stateful rule groups in a firewall policy.
Updating any setting in StatefulEngineOptions may require a restart of the stateful engine in order to apply the changes. When this occurs, existing connections will be treated according to your stream exception policy configuration.
Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.
" } }, "StatefulEngineOptionsV2": { "base": "Configuration settings for the handling of stateful traffic in a Next Generation policy.
", "refs": { "FirewallPolicyV2$StatefulEngineOptions": "Additional options governing how the engines handle stateful traffic, such as the stream exception policy and flow timeouts.
" } }, "StatefulRule": { "base": "A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format on the Suricata website.
The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination.
The setting that allows the policy owner to change the behavior of the rule group within a policy.
", "refs": { "StatefulRuleGroupReference$Override": "The action that allows the policy owner to override the behavior of the rule group within a policy.
" } }, "StatefulRuleGroupReference": { "base": "Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.
", "refs": { "StatefulRuleGroupReferences$member": null } }, "StatefulRuleGroupReferences": { "base": null, "refs": { "FirewallPolicy$StatefulRuleGroupReferences": "References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
" } }, "StatefulRuleOptions": { "base": "Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.
", "refs": { "DescribeRuleGroupMetadataResponse$StatefulRuleOptions": null, "RuleGroup$StatefulRuleOptions": "Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings. Some limitations apply; for more information, see Strict evaluation order in the Network Firewall Developer Guide.
" } }, "StatefulRuleProtocol": { "base": null, "refs": { "Header$Protocol": "The protocol to inspect for. To specify all, you can use IP, because all traffic on Amazon Web Services and on the internet is IP.
An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format on the Suricata website.
The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.
For example, you could specify [\"aws:pass\"] or you could specify [\"aws:pass\", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.
The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.
For example, you could specify [\"aws:pass\"] or you could specify [\"aws:pass\", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.
The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.
Network Firewall only forwards a packet for stateful rule inspection if you specify aws:forward_to_sfe for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify aws:forward_to_sfe for the StatelessDefaultActions setting for the FirewallPolicy.
For every rule, you must specify exactly one of the following standard actions.
aws:pass - Discontinues all inspection of the packet and permits it to go to its intended destination.
aws:drop - Discontinues all inspection of the packet and blocks it from going to its intended destination.
aws:forward_to_sfe - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.
Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this Actions setting. For information about the options, see CustomAction.
To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom PublishMetrics action that you've named MyMetricsAction, then you could specify the standard action aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”].
A single stateless rule. This is used in StatelessRulesAndCustomActions.
", "refs": { "StatelessRules$member": null } }, "StatelessRuleGroupReference": { "base": "Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.
", "refs": { "StatelessRuleGroupReferences$member": null } }, "StatelessRuleGroupReferences": { "base": null, "refs": { "FirewallPolicy$StatelessRuleGroupReferences": "References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
" } }, "StatelessRules": { "base": null, "refs": { "StatelessRulesAndCustomActions$StatelessRules": "Defines the set of stateless rules for use in a stateless rule group.
" } }, "StatelessRulesAndCustomActions": { "base": "Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules.
", "refs": { "RulesSource$StatelessRulesAndCustomActions": "Stateless inspection criteria to be used in a stateless rule group.
" } }, "Status": { "base": null, "refs": { "AnalysisReport$Status": "The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.
The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.
If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.
A description of the error and how to resolve it.
", "ListFlowOperationResultsResponse$StatusMessage": "If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.
The reason that Network Firewall couldn't create or attach the NAT gateway, if it couldn't.
", "TlsCertificateData$StatusMessage": "Contains details about the certificate status, including information about certificate errors.
" } }, "StreamExceptionPolicy": { "base": null, "refs": { "StatefulEngineOptions$StreamExceptionPolicy": "Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.
CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.
REJECT - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
How Network Firewall handles traffic on a network connection that breaks midstream. A Next Generation policy supports DROP and REJECT. For more information, see Stream exception policy options in your firewall policy in the Network Firewall Developer Guide.
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
The IDs of the subnets that you want to associate with the firewall.
", "AssociateSubnetsResponse$SubnetMappings": "The IDs of the subnets that are associated with the firewall.
", "CreateFirewallRequest$SubnetMappings": "The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.
", "DisassociateSubnetsResponse$SubnetMappings": "The IDs of the subnets that are associated with the firewall.
", "Firewall$SubnetMappings": "The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.
These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.
In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.
The subnets where Network Firewall creates the firewall endpoints of a proxy mode firewall. Specify one subnet for each Availability Zone, and a NAT gateway mapping in each of those Availability Zones.
" } }, "SubscriptionStatus": { "base": null, "refs": { "ListRuleGroupsRequest$SubscriptionStatus": "Filters the results to show only rule groups with the specified subscription status. Use this to find subscribed or unsubscribed rule groups.
" } }, "Summary": { "base": "A complex type containing summaries of security protections provided by a rule group.
Network Firewall extracts this information from selected fields in the rule group's Suricata rules, based on your SummaryConfiguration settings.
", "refs": { "DescribeRuleGroupSummaryResponse$Summary": "A complex type that contains rule information based on the rule group's configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven't configured any summary settings, this returns an empty array. The response might include:
Rule identifiers
Rule descriptions
Any metadata fields that you specified in your SummaryConfiguration
A complex type that specifies which Suricata rule metadata fields to use when displaying threat information. Contains:
RuleOptions - The Suricata rule options fields to extract and display
These settings affect how threat information appears in both the console and API responses. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.
", "refs": { "CreateRuleGroupRequest$SummaryConfiguration": "An object that contains a RuleOptions array of strings. You use RuleOptions to determine which of the following RuleSummary values are returned in response to DescribeRuleGroupSummary.
Metadata - returns
Msg
SID
A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary.
The RuleOptions specified in SummaryConfiguration
Rule metadata organization preferences
Updates the selected summary configuration for a rule group.
Changes affect subsequent responses from DescribeRuleGroupSummary.
" } }, "SummaryRuleOption": { "base": null, "refs": { "SummaryRuleOptions$member": null } }, "SummaryRuleOptions": { "base": null, "refs": { "SummaryConfiguration$RuleOptions": "Specifies the selected rule options returned by DescribeRuleGroupSummary.
" } }, "SupportedAvailabilityZones": { "base": null, "refs": { "DescribeFirewallMetadataResponse$SupportedAvailabilityZones": "The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.
" } }, "SyncState": { "base": "The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. This is part of the FirewallStatus.
For each VPC subnet that you associate with a firewall, Network Firewall does the following:
Instantiates a firewall endpoint in the subnet, ready to take traffic.
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
", "refs": { "SyncStates$value": null } }, "SyncStateConfig": { "base": null, "refs": { "SyncState$Config": "The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic.
" } }, "SyncStates": { "base": null, "refs": { "FirewallStatus$SyncStates": "Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.
These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.
TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.
", "refs": { "TCPFlags$member": null } }, "TCPFlags": { "base": null, "refs": { "MatchAttributes$TCPFlags": "The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).
" } }, "TLSInspectionConfiguration": { "base": "The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
", "refs": { "CreateTLSInspectionConfigurationRequest$TLSInspectionConfiguration": "The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
", "DescribeTLSInspectionConfigurationResponse$TLSInspectionConfiguration": "The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
", "UpdateTLSInspectionConfigurationRequest$TLSInspectionConfiguration": "The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
" } }, "TLSInspectionConfigurationMetadata": { "base": "High-level information about a TLS inspection configuration, returned by ListTLSInspectionConfigurations. You can use the information provided in the metadata to retrieve and manage a TLS configuration.
The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
", "DeleteTLSInspectionConfigurationResponse$TLSInspectionConfigurationResponse": "The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
", "DescribeTLSInspectionConfigurationResponse$TLSInspectionConfigurationResponse": "The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
", "UpdateTLSInspectionConfigurationResponse$TLSInspectionConfigurationResponse": "The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
" } }, "TLSInspectionConfigurations": { "base": null, "refs": { "ListTLSInspectionConfigurationsResponse$TLSInspectionConfigurations": "The TLS inspection configuration metadata objects that you've defined. Depending on your setting for max results and the number of TLS inspection configurations, this might not be the full list.
" } }, "TLSInspectionDomain": { "base": null, "refs": { "TLSInspectionDomains$member": null } }, "TLSInspectionDomains": { "base": null, "refs": { "DomainMatch$Domains": "The domains to match. You can specify an exact domain, such as example.com, or a domain with a single leading wildcard label, such as *.example.com. You can specify from 1 to 50 domains, and each domain can be up to 255 characters long.
The type of firewall that this scope applies to. If you don't specify a value, the scope applies to both types, the same as ALL. You can choose from the following values:
ALL - The scope applies to both transparent firewalls and proxy mode firewalls.
TRANSPARENT_FIREWALL_ONLY - The scope applies only to transparent firewalls.
EXPLICIT_PROXY_ONLY - The scope applies only to proxy mode firewalls. A scope that specifies DomainMatch must use this value.
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each Amazon Web Services resource.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "" } }, "TagList": { "base": null, "refs": { "CreateContainerAssociationRequest$Tags": "The key:value pairs to associate with the resource.
", "CreateContainerAssociationResponse$Tags": "The key:value pairs to associate with the resource.
", "CreateFirewallPolicyRequest$Tags": "The key:value pairs to associate with the resource.
", "CreateFirewallPolicyV2Request$Tags": "The key:value pairs to associate with the resource.
", "CreateFirewallRequest$Tags": "The key:value pairs to associate with the resource.
", "CreateRuleGroupRequest$Tags": "The key:value pairs to associate with the resource.
", "CreateTLSInspectionConfigurationRequest$Tags": "The key:value pairs to associate with the resource.
", "CreateVpcEndpointAssociationRequest$Tags": "The key:value pairs to associate with the resource.
", "DescribeContainerAssociationResponse$Tags": "The key:value pairs to associate with the resource.
", "DescribeProxyResource$Tags": "The key:value pairs to associate with the resource.
", "Firewall$Tags": "", "FirewallPolicyResponse$Tags": "The key:value pairs to associate with the resource.
", "FirewallPolicyV2Response$Tags": "The key-value tag pairs that are associated with the Next Generation policy.
", "ListTagsForResourceResponse$Tags": "The tags that are associated with the resource.
", "RuleGroupResponse$Tags": "The key:value pairs to associate with the resource.
", "TLSInspectionConfigurationResponse$Tags": "The key:value pairs to associate with the resource.
", "TagResourceRequest$Tags": "", "UpdateContainerAssociationRequest$Tags": "The key:value pairs to associate with the resource.
", "UpdateContainerAssociationResponse$Tags": "The key:value pairs to associate with the resource.
", "VpcEndpointAssociation$Tags": "The key:value pairs to associate with the resource.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "Tag$Value": "The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.
" } }, "TagsPaginationMaxResults": { "base": null, "refs": { "ListTagsForResourceRequest$MaxResults": "The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
The types of matching to perform against the domains in Targets. You can specify any combination of the following:
AWS_ROUTE_53_RESOLVED_DOMAIN – Match the domain against the domain that the Amazon Route 53 Resolver resolved the connection's destination IP address for.
HTTP_HOST – Match the domain against the Host header of HTTP traffic.
TLS_SNI – Match the domain against the Server Name Indication (SNI) of HTTPS traffic.
AWS_ROUTE_53_RESOLVED_DOMAIN matches on how the destination IP address was resolved, rather than on the domain that the client asserts in its TLS SNI or HTTP Host header. This target type takes effect when you configure resolved IP validation on the firewall policy. For more information, see the Route53ResolvedIPValidation firewall policy setting.
Whether you include AWS_ROUTE_53_RESOLVED_DOMAIN changes what the generated rules match, together with GeneratedRulesType:
In an ALLOWLIST, combining AWS_ROUTE_53_RESOLVED_DOMAIN with TLS_SNI or HTTP_HOST requires both conditions to match: the SNI or Host header matches the domain, and the Route 53 Resolver resolved the destination IP address for that domain. Network Firewall allows the traffic only when both conditions match, so it blocks traffic that matches just one—for example, a spoofed Host header sent to an unresolved IP address.
In a DENYLIST, or when AWS_ROUTE_53_RESOLVED_DOMAIN is the only target type, Network Firewall evaluates each condition independently: a match on either the domain (SNI or Host) or the resolved destination IP address triggers the rule.
When you don't include AWS_ROUTE_53_RESOLVED_DOMAIN, the generated rules match only on the SNI or Host header, without checking how the destination IP address was resolved.
An ALLOWLIST whose only target type is AWS_ROUTE_53_RESOLVED_DOMAIN is additive: it allows matching traffic but doesn't generate a default rule that drops non-matching traffic. Only the TLS_SNI and HTTP_HOST target types generate that default drop. To allow only the resolved domains and drop all other traffic, include a protocol target type as well.
The number of seconds that can pass without any TCP traffic sent through the firewall before the firewall determines that the connection is idle. After the idle timeout passes, data packets are dropped, however, the next TCP SYN packet is considered a new flow and is processed by the firewall. Clients or targets can use TCP keepalive packets to reset the idle timeout.
You can define the TcpIdleTimeoutSeconds value to be between 60 and 6000 seconds. If no value is provided, it defaults to 350 seconds.
Unable to process the request due to throttling limitations.
", "refs": {} }, "TlsCertificateData": { "base": "Contains metadata about an Certificate Manager certificate.
", "refs": { "Certificates$member": null, "TLSInspectionConfigurationResponse$CertificateAuthority": null } }, "TlsInterceptMode": { "base": null, "refs": { "TlsInterceptProperties$TlsInterceptMode": "Specifies whether to enable or disable TLS Intercept Mode.
" } }, "TlsInterceptProperties": { "base": "TLS decryption on traffic to filter on attributes in the HTTP header.
", "refs": { "DescribeProxyResource$TlsInterceptProperties": "TLS decryption on traffic to filter on attributes in the HTTP header.
" } }, "TransitGatewayAttachmentId": { "base": null, "refs": { "AcceptNetworkFirewallTransitGatewayAttachmentRequest$TransitGatewayAttachmentId": "Required. The unique identifier of the transit gateway attachment to accept. This ID is returned in the response when creating a transit gateway-attached firewall.
", "AcceptNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentId": "The unique identifier of the transit gateway attachment that was accepted.
", "DeleteNetworkFirewallTransitGatewayAttachmentRequest$TransitGatewayAttachmentId": "Required. The unique identifier of the transit gateway attachment to delete.
", "DeleteNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentId": "The ID of the transit gateway attachment that was deleted.
", "DescribeFirewallMetadataResponse$TransitGatewayAttachmentId": "The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.
", "FirewallMetadata$TransitGatewayAttachmentId": "The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.
", "RejectNetworkFirewallTransitGatewayAttachmentRequest$TransitGatewayAttachmentId": "Required. The unique identifier of the transit gateway attachment to reject. This ID is returned in the response when creating a transit gateway-attached firewall.
", "RejectNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentId": "The unique identifier of the transit gateway attachment that was rejected.
" } }, "TransitGatewayAttachmentStatus": { "base": null, "refs": { "AcceptNetworkFirewallTransitGatewayAttachmentResponse$TransitGatewayAttachmentStatus": "The current status of the transit gateway attachment. Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
The current status of the transit gateway attachment deletion process.
Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
The current status of the transit gateway attachment. Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
For information about troubleshooting endpoint failures, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
", "TransitGatewayAttachmentSyncState$TransitGatewayAttachmentStatus": "The current status of the transit gateway attachment.
Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
Contains information about the synchronization state of a transit gateway attachment, including its current status and any error messages. Network Firewall uses this to track the state of your transit gateway configuration changes.
", "refs": { "FirewallStatus$TransitGatewayAttachmentSyncState": "The synchronization state of the transit gateway attachment. This indicates whether the firewall's transit gateway configuration is properly synchronized and operational. Use this to verify that your transit gateway configuration changes have been applied.
" } }, "TransitGatewayAttachmentSyncStateMessage": { "base": null, "refs": { "TransitGatewayAttachmentSyncState$StatusMessage": "A message providing additional information about the current status, particularly useful when the transit gateway attachment is in a non-READY state.
Valid values are:
CREATING - The attachment is being created
DELETING - The attachment is being deleted
DELETED - The attachment has been deleted
FAILED - The attachment creation has failed and cannot be recovered
ERROR - The attachment is in an error state that might be recoverable
READY - The attachment is active and processing traffic
PENDING_ACCEPTANCE - The attachment is waiting to be accepted
REJECTING - The attachment is in the process of being rejected
REJECTED - The attachment has been rejected
For information about troubleshooting endpoint failures, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
" } }, "TransitGatewayId": { "base": null, "refs": { "CreateFirewallRequest$TransitGatewayId": "Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through Resource Access Manager.
After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.
For information about creating firewalls, see CreateFirewall. For specific guidance about transit gateway-attached firewalls, see Considerations for transit gateway-attached firewalls in the Network Firewall Developer Guide.
", "Firewall$TransitGatewayId": "The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.
" } }, "TransparentFilteringNatScope": { "base": null, "refs": { "CreateFirewallRequest$TransparentFilteringNatScope": "How a proxy mode firewall handles traffic that isn't sent to its proxy listener. If you don't specify a value, the firewall uses NAT_ALL. You can choose from the following values:
NAT_ALL - After inspection, the firewall sends this traffic out through its NAT gateway, which translates the source address.
NAT_NONE - After inspection, the firewall returns this traffic to the firewall endpoint without address translation.
You can specify this only for a proxy mode firewall, and you can't change it after you create the firewall.
", "Firewall$TransparentFilteringNatScope": "How a proxy mode firewall handles traffic that isn't sent to its proxy listener. NAT_ALL sends this traffic out through the firewall's NAT gateway after inspection. NAT_NONE returns it to the firewall endpoint without address translation.
A unique source IP address that connected to a domain.
", "refs": { "AnalysisTypeReportResult$UniqueSources": "The number of unique source IP addresses that connected to a domain.
" } }, "UnsupportedOperationException": { "base": "The operation you requested isn't supported by Network Firewall.
", "refs": {} }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateAvailabilityZoneChangeProtectionRequest": { "base": null, "refs": {} }, "UpdateAvailabilityZoneChangeProtectionResponse": { "base": null, "refs": {} }, "UpdateContainerAssociationRequest": { "base": null, "refs": {} }, "UpdateContainerAssociationResponse": { "base": null, "refs": {} }, "UpdateFirewallAnalysisSettingsRequest": { "base": null, "refs": {} }, "UpdateFirewallAnalysisSettingsResponse": { "base": null, "refs": {} }, "UpdateFirewallDeleteProtectionRequest": { "base": null, "refs": {} }, "UpdateFirewallDeleteProtectionResponse": { "base": null, "refs": {} }, "UpdateFirewallDescriptionRequest": { "base": null, "refs": {} }, "UpdateFirewallDescriptionResponse": { "base": null, "refs": {} }, "UpdateFirewallEncryptionConfigurationRequest": { "base": null, "refs": {} }, "UpdateFirewallEncryptionConfigurationResponse": { "base": null, "refs": {} }, "UpdateFirewallPolicyChangeProtectionRequest": { "base": null, "refs": {} }, "UpdateFirewallPolicyChangeProtectionResponse": { "base": null, "refs": {} }, "UpdateFirewallPolicyRequest": { "base": null, "refs": {} }, "UpdateFirewallPolicyResponse": { "base": null, "refs": {} }, "UpdateFirewallPolicyV2Request": { "base": null, "refs": {} }, "UpdateFirewallPolicyV2Response": { "base": null, "refs": {} }, "UpdateLoggingConfigurationRequest": { "base": null, "refs": {} }, "UpdateLoggingConfigurationResponse": { "base": null, "refs": {} }, "UpdateProxySettingsRequest": { "base": null, "refs": {} }, "UpdateProxySettingsResponse": { "base": null, "refs": {} }, "UpdateRuleGroupRequest": { "base": null, "refs": {} }, "UpdateRuleGroupResponse": { "base": null, "refs": {} }, "UpdateSubnetChangeProtectionRequest": { "base": null, "refs": {} }, "UpdateSubnetChangeProtectionResponse": { "base": null, "refs": {} }, "UpdateTLSInspectionConfigurationRequest": { "base": null, "refs": {} }, "UpdateTLSInspectionConfigurationResponse": { "base": null, "refs": {} }, "UpdateTime": { "base": null, "refs": { "DescribeProxyResource$UpdateTime": "Time the Proxy was updated.
" } }, "UpdateToken": { "base": null, "refs": { "AssociateAvailabilityZonesRequest$UpdateToken": "An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.
To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.
To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.
To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
The current version of the object that is either in sync or pending synchronization.
", "SourceMetadata$SourceUpdateToken": "The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.
", "UpdateAvailabilityZoneChangeProtectionRequest$UpdateToken": "An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.
To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the container association. The token marks the state of the container association resource at the time of the request.
To make changes to the container association, you provide the token in your request. Network Firewall uses the token to ensure that the container association hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the container association again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
The list of IP addresses and address ranges, in CIDR notation.
", "PortSet$Definition": "The set of port ranges.
" } }, "VendorName": { "base": null, "refs": { "DescribeRuleGroupMetadataResponse$VendorName": "The name of the Amazon Web Services Marketplace vendor that provides this rule group.
", "RuleGroupMetadata$VendorName": "The name of the Amazon Web Services Marketplace seller that provides this rule group.
" } }, "VpcEndpoint": { "base": "The VPC and subnets for the endpoints of a proxy mode firewall. You use this in CreateFirewall. Network Firewall creates the firewall endpoints and the firewall's NAT gateways in this VPC.
This differs from VpcEndpointAssociation, which defines additional endpoints for a firewall in other VPCs.
The VPC and subnets for the endpoints of a proxy mode firewall. Network Firewall creates a firewall endpoint in each subnet that you specify. It also creates the firewall's NAT gateways in this VPC, in the subnets that you specify in NatGatewayCreateMappings.
To create a proxy mode firewall, you must specify VpcEndpoint and NatGatewayCreateMappings, and you must not specify the top-level VpcId and SubnetMappings. Specify one subnet for each Availability Zone where you want to use the firewall.
The VPC and subnets for the endpoints of a proxy mode firewall.
" } }, "VpcEndpointAssociation": { "base": "A VPC endpoint association defines a single subnet to use for a firewall endpoint for a Firewall. You can define VPC endpoint associations only in the Availability Zones that already have a subnet mapping defined in the Firewall resource.
You can retrieve the list of Availability Zones that are available for use by calling DescribeFirewallMetadata.
To manage firewall endpoints, first, in the Firewall specification, you specify a single VPC and one subnet for each of the Availability Zones where you want to use the firewall. Then you can define additional endpoints as VPC endpoint associations.
You can use VPC endpoint associations to expand the protections of the firewall as follows:
Protect multiple VPCs with a single firewall - You can use the firewall to protect other VPCs, either in your account or in accounts where the firewall is shared. You can only specify Availability Zones that already have a firewall endpoint defined in the Firewall subnet mappings.
Define multiple firewall endpoints for a VPC in an Availability Zone - You can create additional firewall endpoints for the VPC that you have defined in the firewall, in any Availability Zone that already has an endpoint defined in the Firewall subnet mappings. You can create multiple VPC endpoint associations for any other VPC where you use the firewall.
You can use Resource Access Manager to share a Firewall that you own with other accounts, which gives them the ability to use the firewall to create VPC endpoint associations. For information about sharing a firewall, see PutResourcePolicy in this guide and see Sharing Network Firewall resources in the Network Firewall Developer Guide.
The status of the VPC endpoint association, which indicates whether it's ready to filter network traffic, is provided in the corresponding VpcEndpointAssociationStatus. You can retrieve both the association and its status by calling DescribeVpcEndpointAssociation.
", "refs": { "CreateVpcEndpointAssociationResponse$VpcEndpointAssociation": "The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
", "DeleteVpcEndpointAssociationResponse$VpcEndpointAssociation": "The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
", "DescribeVpcEndpointAssociationResponse$VpcEndpointAssociation": "The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
" } }, "VpcEndpointAssociationMetadata": { "base": "High-level information about a VPC endpoint association, returned by ListVpcEndpointAssociations. You can use the information provided in the metadata to retrieve and manage a VPC endpoint association.
Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
", "refs": { "CreateVpcEndpointAssociationResponse$VpcEndpointAssociationStatus": "Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
", "DeleteVpcEndpointAssociationResponse$VpcEndpointAssociationStatus": "Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
", "DescribeVpcEndpointAssociationResponse$VpcEndpointAssociationStatus": "Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
" } }, "VpcEndpointAssociations": { "base": null, "refs": { "ListVpcEndpointAssociationsResponse$VpcEndpointAssociations": "The VPC endpoint assocation metadata objects for the firewall that you specified. If you didn't specify a firewall, this is all VPC endpoint associations that you have defined.
Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.
" } }, "VpcEndpointId": { "base": null, "refs": { "DescribeFlowOperationRequest$VpcEndpointId": "A unique identifier for the primary endpoint associated with a firewall.
", "DescribeFlowOperationResponse$VpcEndpointId": "A unique identifier for the primary endpoint associated with a firewall.
", "ListFlowOperationResultsRequest$VpcEndpointId": "A unique identifier for the primary endpoint associated with a firewall.
", "ListFlowOperationResultsResponse$VpcEndpointId": "", "ListFlowOperationsRequest$VpcEndpointId": "A unique identifier for the primary endpoint associated with a firewall.
", "StartFlowCaptureRequest$VpcEndpointId": "A unique identifier for the primary endpoint associated with a firewall.
", "StartFlowFlushRequest$VpcEndpointId": "A unique identifier for the primary endpoint associated with a firewall.
" } }, "VpcEndpointServiceName": { "base": null, "refs": { "DescribeProxyResource$VpcEndpointServiceName": "The service endpoint created in the VPC.
" } }, "VpcId": { "base": null, "refs": { "CreateFirewallRequest$VpcId": "The unique identifier of the VPC where Network Firewall should create the firewall.
You can't change this setting after you create the firewall.
", "CreateVpcEndpointAssociationRequest$VpcId": "The unique identifier of the VPC where you want to create a firewall endpoint.
", "Firewall$VpcId": "The unique identifier of the VPC where the firewall is in use.
", "VpcEndpoint$VpcId": "The ID of the VPC where Network Firewall creates the endpoints and NAT gateways of a proxy mode firewall.
", "VpcEndpointAssociation$VpcId": "The unique identifier of the VPC for the endpoint association.
", "VpcIds$member": null } }, "VpcIds": { "base": null, "refs": { "ListFirewallsRequest$VpcIds": "The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.
" } } } }