libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.NetworkFirewall.Lens

Description

 
Synopsis

Operations

AssociateSubnets

associateSubnets_updateToken :: Lens' AssociateSubnets (Maybe Text) Source #

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.

associateSubnets_firewallArn :: Lens' AssociateSubnets (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

associateSubnets_firewallName :: Lens' AssociateSubnets (Maybe Text) Source #

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.

associateSubnets_subnetMappings :: Lens' AssociateSubnets [SubnetMapping] Source #

The IDs of the subnets that you want to associate with the firewall.

associateSubnetsResponse_subnetMappings :: Lens' AssociateSubnetsResponse (Maybe [SubnetMapping]) Source #

The IDs of the subnets that are associated with the firewall.

associateSubnetsResponse_updateToken :: Lens' AssociateSubnetsResponse (Maybe Text) Source #

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.

associateSubnetsResponse_firewallArn :: Lens' AssociateSubnetsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

associateSubnetsResponse_firewallName :: Lens' AssociateSubnetsResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

UpdateSubnetChangeProtection

updateSubnetChangeProtection_updateToken :: Lens' UpdateSubnetChangeProtection (Maybe Text) Source #

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.

updateSubnetChangeProtection_firewallArn :: Lens' UpdateSubnetChangeProtection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

updateSubnetChangeProtection_firewallName :: Lens' UpdateSubnetChangeProtection (Maybe Text) Source #

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.

updateSubnetChangeProtection_subnetChangeProtection :: Lens' UpdateSubnetChangeProtection Bool Source #

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.

updateSubnetChangeProtectionResponse_updateToken :: Lens' UpdateSubnetChangeProtectionResponse (Maybe Text) Source #

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.

updateSubnetChangeProtectionResponse_subnetChangeProtection :: Lens' UpdateSubnetChangeProtectionResponse (Maybe Bool) Source #

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.

updateSubnetChangeProtectionResponse_firewallName :: Lens' UpdateSubnetChangeProtectionResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

UpdateFirewallPolicy

updateFirewallPolicy_firewallPolicyName :: Lens' UpdateFirewallPolicy (Maybe Text) Source #

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.

updateFirewallPolicy_firewallPolicyArn :: Lens' UpdateFirewallPolicy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

updateFirewallPolicy_dryRun :: Lens' UpdateFirewallPolicy (Maybe Bool) Source #

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.

updateFirewallPolicy_updateToken :: Lens' UpdateFirewallPolicy Text Source #

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.

updateFirewallPolicy_firewallPolicy :: Lens' UpdateFirewallPolicy FirewallPolicy Source #

The updated firewall policy to use for the firewall.

updateFirewallPolicyResponse_updateToken :: Lens' UpdateFirewallPolicyResponse Text Source #

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.

updateFirewallPolicyResponse_firewallPolicyResponse :: Lens' UpdateFirewallPolicyResponse FirewallPolicyResponse Source #

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.

DeleteFirewallPolicy

deleteFirewallPolicy_firewallPolicyName :: Lens' DeleteFirewallPolicy (Maybe Text) Source #

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.

deleteFirewallPolicy_firewallPolicyArn :: Lens' DeleteFirewallPolicy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

deleteFirewallPolicyResponse_firewallPolicyResponse :: Lens' DeleteFirewallPolicyResponse FirewallPolicyResponse Source #

The object containing the definition of the FirewallPolicyResponse that you asked to delete.

CreateFirewallPolicy

createFirewallPolicy_dryRun :: Lens' CreateFirewallPolicy (Maybe Bool) Source #

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.

createFirewallPolicy_tags :: Lens' CreateFirewallPolicy (Maybe (NonEmpty Tag)) Source #

The key:value pairs to associate with the resource.

createFirewallPolicy_firewallPolicyName :: Lens' CreateFirewallPolicy Text Source #

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

createFirewallPolicy_firewallPolicy :: Lens' CreateFirewallPolicy FirewallPolicy Source #

The rule groups and policy actions to use in the firewall policy.

createFirewallPolicyResponse_updateToken :: Lens' CreateFirewallPolicyResponse Text Source #

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.

createFirewallPolicyResponse_firewallPolicyResponse :: Lens' CreateFirewallPolicyResponse FirewallPolicyResponse Source #

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.

UpdateLoggingConfiguration

updateLoggingConfiguration_firewallArn :: Lens' UpdateLoggingConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

updateLoggingConfiguration_loggingConfiguration :: Lens' UpdateLoggingConfiguration (Maybe LoggingConfiguration) Source #

Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.

updateLoggingConfiguration_firewallName :: Lens' UpdateLoggingConfiguration (Maybe Text) Source #

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 :: Lens' UpdateLoggingConfigurationResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

DisassociateSubnets

disassociateSubnets_updateToken :: Lens' DisassociateSubnets (Maybe Text) Source #

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.

disassociateSubnets_firewallArn :: Lens' DisassociateSubnets (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

disassociateSubnets_firewallName :: Lens' DisassociateSubnets (Maybe Text) Source #

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.

disassociateSubnets_subnetIds :: Lens' DisassociateSubnets [Text] Source #

The unique identifiers for the subnets that you want to disassociate.

disassociateSubnetsResponse_subnetMappings :: Lens' DisassociateSubnetsResponse (Maybe [SubnetMapping]) Source #

The IDs of the subnets that are associated with the firewall.

disassociateSubnetsResponse_updateToken :: Lens' DisassociateSubnetsResponse (Maybe Text) Source #

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.

disassociateSubnetsResponse_firewallArn :: Lens' DisassociateSubnetsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

disassociateSubnetsResponse_firewallName :: Lens' DisassociateSubnetsResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

ListTagsForResource

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

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.

listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #

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.

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

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.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #

The tags that are associated with the resource.

ListFirewallPolicies

listFirewallPolicies_nextToken :: Lens' ListFirewallPolicies (Maybe Text) Source #

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.

listFirewallPolicies_maxResults :: Lens' ListFirewallPolicies (Maybe Natural) Source #

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.

listFirewallPoliciesResponse_firewallPolicies :: Lens' ListFirewallPoliciesResponse (Maybe [FirewallPolicyMetadata]) Source #

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.

listFirewallPoliciesResponse_nextToken :: Lens' ListFirewallPoliciesResponse (Maybe Text) Source #

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.

UpdateFirewallDeleteProtection

updateFirewallDeleteProtection_updateToken :: Lens' UpdateFirewallDeleteProtection (Maybe Text) Source #

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.

updateFirewallDeleteProtection_firewallArn :: Lens' UpdateFirewallDeleteProtection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

updateFirewallDeleteProtection_firewallName :: Lens' UpdateFirewallDeleteProtection (Maybe Text) Source #

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.

updateFirewallDeleteProtection_deleteProtection :: Lens' UpdateFirewallDeleteProtection Bool Source #

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.

updateFirewallDeleteProtectionResponse_updateToken :: Lens' UpdateFirewallDeleteProtectionResponse (Maybe Text) Source #

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.

updateFirewallDeleteProtectionResponse_firewallName :: Lens' UpdateFirewallDeleteProtectionResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

CreateRuleGroup

createRuleGroup_rules :: Lens' CreateRuleGroup (Maybe Text) Source #

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.

createRuleGroup_description :: Lens' CreateRuleGroup (Maybe Text) Source #

A description of the rule group.

createRuleGroup_dryRun :: Lens' CreateRuleGroup (Maybe Bool) Source #

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.

createRuleGroup_tags :: Lens' CreateRuleGroup (Maybe (NonEmpty Tag)) Source #

The key:value pairs to associate with the resource.

createRuleGroup_ruleGroup :: Lens' CreateRuleGroup (Maybe RuleGroup) Source #

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

createRuleGroup_ruleGroupName :: Lens' CreateRuleGroup Text Source #

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

createRuleGroup_type :: Lens' CreateRuleGroup RuleGroupType Source #

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.

createRuleGroup_capacity :: Lens' CreateRuleGroup Int Source #

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.

createRuleGroupResponse_updateToken :: Lens' CreateRuleGroupResponse Text Source #

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.

createRuleGroupResponse_ruleGroupResponse :: Lens' CreateRuleGroupResponse RuleGroupResponse Source #

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.

DescribeFirewallPolicy

describeFirewallPolicy_firewallPolicyName :: Lens' DescribeFirewallPolicy (Maybe Text) Source #

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.

describeFirewallPolicy_firewallPolicyArn :: Lens' DescribeFirewallPolicy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

describeFirewallPolicyResponse_updateToken :: Lens' DescribeFirewallPolicyResponse Text Source #

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.

describeFirewallPolicyResponse_firewallPolicyResponse :: Lens' DescribeFirewallPolicyResponse FirewallPolicyResponse Source #

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.

UpdateFirewallDescription

updateFirewallDescription_updateToken :: Lens' UpdateFirewallDescription (Maybe Text) Source #

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.

updateFirewallDescription_firewallArn :: Lens' UpdateFirewallDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

updateFirewallDescription_description :: Lens' UpdateFirewallDescription (Maybe Text) Source #

The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.

updateFirewallDescription_firewallName :: Lens' UpdateFirewallDescription (Maybe Text) Source #

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_updateToken :: Lens' UpdateFirewallDescriptionResponse (Maybe Text) Source #

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.

updateFirewallDescriptionResponse_firewallName :: Lens' UpdateFirewallDescriptionResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

DescribeRuleGroup

describeRuleGroup_ruleGroupArn :: Lens' DescribeRuleGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

describeRuleGroup_type :: Lens' DescribeRuleGroup (Maybe RuleGroupType) Source #

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.

This setting is required for requests that do not include the RuleGroupARN.

describeRuleGroup_ruleGroupName :: Lens' DescribeRuleGroup (Maybe Text) Source #

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.

describeRuleGroupResponse_ruleGroup :: Lens' DescribeRuleGroupResponse (Maybe RuleGroup) Source #

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.

AWS 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.

describeRuleGroupResponse_updateToken :: Lens' DescribeRuleGroupResponse Text Source #

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.

describeRuleGroupResponse_ruleGroupResponse :: Lens' DescribeRuleGroupResponse RuleGroupResponse Source #

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.

DeleteFirewall

deleteFirewall_firewallArn :: Lens' DeleteFirewall (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

deleteFirewall_firewallName :: Lens' DeleteFirewall (Maybe Text) Source #

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.

ListFirewalls

listFirewalls_nextToken :: Lens' ListFirewalls (Maybe Text) Source #

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.

listFirewalls_vpcIds :: Lens' ListFirewalls (Maybe [Text]) Source #

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.

listFirewalls_maxResults :: Lens' ListFirewalls (Maybe Natural) Source #

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.

listFirewallsResponse_nextToken :: Lens' ListFirewallsResponse (Maybe Text) Source #

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.

listFirewallsResponse_firewalls :: Lens' ListFirewallsResponse (Maybe [FirewallMetadata]) Source #

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.

DescribeResourcePolicy

describeResourcePolicy_resourceArn :: Lens' DescribeResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve.

describeResourcePolicyResponse_policy :: Lens' DescribeResourcePolicyResponse (Maybe Text) Source #

The AWS Identity and Access Management policy for the resource.

AssociateFirewallPolicy

associateFirewallPolicy_updateToken :: Lens' AssociateFirewallPolicy (Maybe Text) Source #

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.

associateFirewallPolicy_firewallArn :: Lens' AssociateFirewallPolicy (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

associateFirewallPolicy_firewallName :: Lens' AssociateFirewallPolicy (Maybe Text) Source #

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.

associateFirewallPolicy_firewallPolicyArn :: Lens' AssociateFirewallPolicy Text Source #

The Amazon Resource Name (ARN) of the firewall policy.

associateFirewallPolicyResponse_updateToken :: Lens' AssociateFirewallPolicyResponse (Maybe Text) Source #

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.

associateFirewallPolicyResponse_firewallName :: Lens' AssociateFirewallPolicyResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

UpdateFirewallPolicyChangeProtection

updateFirewallPolicyChangeProtection_updateToken :: Lens' UpdateFirewallPolicyChangeProtection (Maybe Text) Source #

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.

updateFirewallPolicyChangeProtection_firewallArn :: Lens' UpdateFirewallPolicyChangeProtection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

updateFirewallPolicyChangeProtection_firewallName :: Lens' UpdateFirewallPolicyChangeProtection (Maybe Text) Source #

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.

updateFirewallPolicyChangeProtection_firewallPolicyChangeProtection :: Lens' UpdateFirewallPolicyChangeProtection Bool Source #

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.

updateFirewallPolicyChangeProtectionResponse_updateToken :: Lens' UpdateFirewallPolicyChangeProtectionResponse (Maybe Text) Source #

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.

updateFirewallPolicyChangeProtectionResponse_firewallPolicyChangeProtection :: Lens' UpdateFirewallPolicyChangeProtectionResponse (Maybe Bool) Source #

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.

updateFirewallPolicyChangeProtectionResponse_firewallName :: Lens' UpdateFirewallPolicyChangeProtectionResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

CreateFirewall

createFirewall_firewallPolicyChangeProtection :: Lens' CreateFirewall (Maybe Bool) Source #

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.

createFirewall_subnetChangeProtection :: Lens' CreateFirewall (Maybe Bool) Source #

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.

createFirewall_deleteProtection :: Lens' CreateFirewall (Maybe Bool) Source #

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.

createFirewall_description :: Lens' CreateFirewall (Maybe Text) Source #

A description of the firewall.

createFirewall_tags :: Lens' CreateFirewall (Maybe (NonEmpty Tag)) Source #

The key:value pairs to associate with the resource.

createFirewall_firewallName :: Lens' CreateFirewall Text Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

createFirewall_firewallPolicyArn :: Lens' CreateFirewall Text Source #

The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.

createFirewall_vpcId :: Lens' CreateFirewall Text Source #

The unique identifier of the VPC where Network Firewall should create the firewall.

You can't change this setting after you create the firewall.

createFirewall_subnetMappings :: Lens' CreateFirewall [SubnetMapping] Source #

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.

createFirewallResponse_firewallStatus :: Lens' CreateFirewallResponse (Maybe FirewallStatus) Source #

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.

createFirewallResponse_firewall :: Lens' CreateFirewallResponse (Maybe Firewall) Source #

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

ListRuleGroups

listRuleGroups_nextToken :: Lens' ListRuleGroups (Maybe Text) Source #

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.

listRuleGroups_maxResults :: Lens' ListRuleGroups (Maybe Natural) Source #

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.

listRuleGroupsResponse_nextToken :: Lens' ListRuleGroupsResponse (Maybe Text) Source #

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.

listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupMetadata]) Source #

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.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

DeleteRuleGroup

deleteRuleGroup_ruleGroupArn :: Lens' DeleteRuleGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

deleteRuleGroup_type :: Lens' DeleteRuleGroup (Maybe RuleGroupType) Source #

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.

This setting is required for requests that do not include the RuleGroupARN.

deleteRuleGroup_ruleGroupName :: Lens' DeleteRuleGroup (Maybe Text) Source #

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.

deleteRuleGroupResponse_ruleGroupResponse :: Lens' DeleteRuleGroupResponse RuleGroupResponse Source #

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.

UpdateRuleGroup

updateRuleGroup_ruleGroupArn :: Lens' UpdateRuleGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

updateRuleGroup_rules :: Lens' UpdateRuleGroup (Maybe Text) Source #

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.

updateRuleGroup_type :: Lens' UpdateRuleGroup (Maybe RuleGroupType) Source #

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.

This setting is required for requests that do not include the RuleGroupARN.

updateRuleGroup_description :: Lens' UpdateRuleGroup (Maybe Text) Source #

A description of the rule group.

updateRuleGroup_ruleGroupName :: Lens' UpdateRuleGroup (Maybe Text) Source #

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.

updateRuleGroup_dryRun :: Lens' UpdateRuleGroup (Maybe Bool) Source #

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.

updateRuleGroup_ruleGroup :: Lens' UpdateRuleGroup (Maybe RuleGroup) Source #

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

updateRuleGroup_updateToken :: Lens' UpdateRuleGroup Text Source #

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.

updateRuleGroupResponse_updateToken :: Lens' UpdateRuleGroupResponse Text Source #

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.

updateRuleGroupResponse_ruleGroupResponse :: Lens' UpdateRuleGroupResponse RuleGroupResponse Source #

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.

PutResourcePolicy

putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the account that you want to share rule groups and firewall policies with.

putResourcePolicy_policy :: Lens' PutResourcePolicy Text Source #

The AWS Identity and Access Management policy statement that lists the accounts that you want to share your rule group or firewall policy 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:CreateFirewall
  • network-firewall:UpdateFirewall
  • network-firewall:AssociateFirewallPolicy
  • network-firewall:ListFirewallPolicies

In the Resource section of the statement, you specify the ARNs for the rule groups and firewall policies that you want to share with the account that you specified in Arn.

DescribeFirewall

describeFirewall_firewallArn :: Lens' DescribeFirewall (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

describeFirewall_firewallName :: Lens' DescribeFirewall (Maybe Text) Source #

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.

describeFirewallResponse_firewallStatus :: Lens' DescribeFirewallResponse (Maybe FirewallStatus) Source #

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.

describeFirewallResponse_updateToken :: Lens' DescribeFirewallResponse (Maybe Text) Source #

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.

describeFirewallResponse_firewall :: Lens' DescribeFirewallResponse (Maybe Firewall) Source #

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

DeleteResourcePolicy

deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

DescribeLoggingConfiguration

describeLoggingConfiguration_firewallArn :: Lens' DescribeLoggingConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

describeLoggingConfiguration_firewallName :: Lens' DescribeLoggingConfiguration (Maybe Text) Source #

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.

Types

ActionDefinition

actionDefinition_publishMetricAction :: Lens' ActionDefinition (Maybe PublishMetricAction) Source #

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.

Address

address_addressDefinition :: Lens' Address Text Source #

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.

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.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Attachment

attachment_status :: Lens' Attachment (Maybe AttachmentStatus) Source #

The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this value is READY, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example CREATING, DELETING, or FAILED.

attachment_subnetId :: Lens' Attachment (Maybe Text) Source #

The unique identifier of the subnet that you've specified to be used for a firewall endpoint.

attachment_endpointId :: Lens' Attachment (Maybe Text) Source #

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.

CustomAction

customAction_actionName :: Lens' CustomAction Text Source #

The descriptive name of the custom action. You can't change the name of a custom action after you create it.

customAction_actionDefinition :: Lens' CustomAction ActionDefinition Source #

The custom action associated with the action name.

Dimension

dimension_value :: Lens' Dimension Text Source #

The value to use in the custom metric dimension.

Firewall

firewall_firewallArn :: Lens' Firewall (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

firewall_firewallPolicyChangeProtection :: Lens' Firewall (Maybe Bool) Source #

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.

firewall_subnetChangeProtection :: Lens' Firewall (Maybe Bool) Source #

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.

firewall_deleteProtection :: Lens' Firewall (Maybe Bool) Source #

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.

firewall_description :: Lens' Firewall (Maybe Text) Source #

A description of the firewall.

firewall_firewallName :: Lens' Firewall (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

firewall_firewallPolicyArn :: Lens' Firewall Text Source #

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.

firewall_vpcId :: Lens' Firewall Text Source #

The unique identifier of the VPC where the firewall is in use.

firewall_subnetMappings :: Lens' Firewall [SubnetMapping] Source #

The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.

firewall_firewallId :: Lens' Firewall Text Source #

The unique identifier for the firewall.

FirewallMetadata

firewallMetadata_firewallArn :: Lens' FirewallMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

firewallMetadata_firewallName :: Lens' FirewallMetadata (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

FirewallPolicy

firewallPolicy_statefulEngineOptions :: Lens' FirewallPolicy (Maybe StatefulEngineOptions) Source #

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.

firewallPolicy_statefulRuleGroupReferences :: Lens' FirewallPolicy (Maybe [StatefulRuleGroupReference]) Source #

References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.

firewallPolicy_statelessRuleGroupReferences :: Lens' FirewallPolicy (Maybe [StatelessRuleGroupReference]) Source #

References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.

firewallPolicy_statelessCustomActions :: Lens' FirewallPolicy (Maybe [CustomAction]) Source #

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.

firewallPolicy_statefulDefaultActions :: Lens' FirewallPolicy (Maybe [Text]) Source #

The default actions to take on a packet that doesn't match any stateful rules.

firewallPolicy_statelessDefaultActions :: Lens' FirewallPolicy [Text] Source #

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.

firewallPolicy_statelessFragmentDefaultActions :: Lens' FirewallPolicy [Text] Source #

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.

FirewallPolicyMetadata

firewallPolicyMetadata_arn :: Lens' FirewallPolicyMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall policy.

firewallPolicyMetadata_name :: Lens' FirewallPolicyMetadata (Maybe Text) Source #

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

FirewallPolicyResponse

firewallPolicyResponse_consumedStatelessRuleCapacity :: Lens' FirewallPolicyResponse (Maybe Int) Source #

The number of capacity units currently consumed by the policy's stateless rules.

firewallPolicyResponse_numberOfAssociations :: Lens' FirewallPolicyResponse (Maybe Int) Source #

The number of firewalls that are associated with this firewall policy.

firewallPolicyResponse_firewallPolicyStatus :: Lens' FirewallPolicyResponse (Maybe ResourceStatus) Source #

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.

firewallPolicyResponse_consumedStatefulRuleCapacity :: Lens' FirewallPolicyResponse (Maybe Int) Source #

The number of capacity units currently consumed by the policy's stateful rules.

firewallPolicyResponse_tags :: Lens' FirewallPolicyResponse (Maybe (NonEmpty Tag)) Source #

The key:value pairs to associate with the resource.

firewallPolicyResponse_firewallPolicyName :: Lens' FirewallPolicyResponse Text Source #

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

firewallPolicyResponse_firewallPolicyArn :: Lens' FirewallPolicyResponse Text Source #

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.

firewallPolicyResponse_firewallPolicyId :: Lens' FirewallPolicyResponse Text Source #

The unique identifier for the firewall policy.

FirewallStatus

firewallStatus_syncStates :: Lens' FirewallStatus (Maybe (HashMap Text SyncState)) Source #

The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you've configured a subnet. These objects provide details of the information that is summarized in the ConfigurationSyncStateSummary and Status, broken down by zone and configuration object.

firewallStatus_status :: Lens' FirewallStatus FirewallStatusValue Source #

The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it. 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.

firewallStatus_configurationSyncStateSummary :: Lens' FirewallStatus ConfigurationSyncState Source #

The configuration sync state for the firewall. This summarizes the sync states reported in the Config settings for all of the Availability Zones where you have configured the firewall.

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 zones where the firewall is in use. 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.

Header

header_protocol :: Lens' Header StatefulRuleProtocol Source #

The protocol to inspect for. To specify all, you can use IP, because all traffic on AWS and on the internet is IP.

header_source :: Lens' Header Text 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.

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.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

header_sourcePort :: Lens' Header Text Source #

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.

header_direction :: Lens' Header StatefulRuleDirection Source #

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.

header_destination :: Lens' Header Text Source #

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.

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.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

header_destinationPort :: Lens' Header Text Source #

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.

IPSet

iPSet_definition :: Lens' IPSet [Text] Source #

The list of IP addresses and address ranges, in CIDR notation.

LogDestinationConfig

logDestinationConfig_logType :: Lens' LogDestinationConfig LogType Source #

The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.

logDestinationConfig_logDestinationType :: Lens' LogDestinationConfig LogDestinationType Source #

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 Kinesis Data Firehose delivery stream.

logDestinationConfig_logDestination :: Lens' LogDestinationConfig (HashMap Text Text) Source #

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 Kinesis Data 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" }

LoggingConfiguration

loggingConfiguration_logDestinationConfigs :: Lens' LoggingConfiguration [LogDestinationConfig] Source #

Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.

MatchAttributes

matchAttributes_protocols :: Lens' MatchAttributes (Maybe [Natural]) Source #

The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). If not specified, this matches with any protocol.

matchAttributes_tCPFlags :: Lens' MatchAttributes (Maybe [TCPFlagField]) Source #

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).

matchAttributes_destinationPorts :: Lens' MatchAttributes (Maybe [PortRange]) Source #

The destination ports to inspect for. If not specified, this matches with any destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP).

You can specify individual ports, for example 1994 and you can specify port ranges, for example 1990:1994.

matchAttributes_sources :: Lens' MatchAttributes (Maybe [Address]) Source #

The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.

matchAttributes_sourcePorts :: Lens' MatchAttributes (Maybe [PortRange]) Source #

The source ports to inspect for. If not specified, this matches with any source port. This setting is only used for protocols 6 (TCP) and 17 (UDP).

You can specify individual ports, for example 1994 and you can specify port ranges, for example 1990:1994.

matchAttributes_destinations :: Lens' MatchAttributes (Maybe [Address]) Source #

The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.

PerObjectStatus

perObjectStatus_updateToken :: Lens' PerObjectStatus (Maybe Text) Source #

The current version of the object that is either in sync or pending synchronization.

perObjectStatus_syncStatus :: Lens' PerObjectStatus (Maybe PerObjectSyncStatus) Source #

Indicates whether this object is in sync with the version indicated in the update token.

PortRange

portRange_fromPort :: Lens' PortRange Natural Source #

The lower limit of the port range. This must be less than or equal to the ToPort specification.

portRange_toPort :: Lens' PortRange Natural Source #

The upper limit of the port range. This must be greater than or equal to the FromPort specification.

PortSet

portSet_definition :: Lens' PortSet (Maybe [Text]) Source #

The set of port ranges.

PublishMetricAction

RuleDefinition

ruleDefinition_matchAttributes :: Lens' RuleDefinition MatchAttributes Source #

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.

ruleDefinition_actions :: Lens' RuleDefinition [Text] Source #

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”].

RuleGroup

ruleGroup_statefulRuleOptions :: Lens' RuleGroup (Maybe StatefulRuleOptions) Source #

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.

ruleGroup_ruleVariables :: Lens' RuleGroup (Maybe RuleVariables) Source #

Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.

ruleGroup_rulesSource :: Lens' RuleGroup RulesSource Source #

The stateful rules or stateless rules for the rule group.

RuleGroupMetadata

ruleGroupMetadata_arn :: Lens' RuleGroupMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule group.

ruleGroupMetadata_name :: Lens' RuleGroupMetadata (Maybe Text) Source #

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

RuleGroupResponse

ruleGroupResponse_numberOfAssociations :: Lens' RuleGroupResponse (Maybe Int) Source #

The number of firewall policies that use this rule group.

ruleGroupResponse_capacity :: Lens' RuleGroupResponse (Maybe Int) Source #

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.

ruleGroupResponse_consumedCapacity :: Lens' RuleGroupResponse (Maybe Int) Source #

The number of capacity units currently consumed by the rule group rules.

ruleGroupResponse_ruleGroupStatus :: Lens' RuleGroupResponse (Maybe ResourceStatus) Source #

Detailed information about the current status of a rule group.

ruleGroupResponse_type :: Lens' RuleGroupResponse (Maybe RuleGroupType) Source #

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_tags :: Lens' RuleGroupResponse (Maybe (NonEmpty Tag)) Source #

The key:value pairs to associate with the resource.

ruleGroupResponse_ruleGroupArn :: Lens' RuleGroupResponse Text Source #

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.

ruleGroupResponse_ruleGroupName :: Lens' RuleGroupResponse Text Source #

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

ruleGroupResponse_ruleGroupId :: Lens' RuleGroupResponse Text Source #

The unique identifier for the rule group.

RuleOption

RuleVariables

ruleVariables_iPSets :: Lens' RuleVariables (Maybe (HashMap Text IPSet)) Source #

A list of IP addresses and address ranges, in CIDR notation.

RulesSource

rulesSource_rulesString :: Lens' RulesSource (Maybe Text) Source #

Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules. Suricata is an open-source network IPS 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.

rulesSource_rulesSourceList :: Lens' RulesSource (Maybe RulesSourceList) Source #

Stateful inspection criteria for a domain list rule group.

rulesSource_statefulRules :: Lens' RulesSource (Maybe [StatefulRule]) Source #

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.

rulesSource_statelessRulesAndCustomActions :: Lens' RulesSource (Maybe StatelessRulesAndCustomActions) Source #

Stateless inspection criteria to be used in a stateless rule group.

RulesSourceList

rulesSourceList_targets :: Lens' RulesSourceList [Text] Source #

The domains that you want to inspect for in your traffic flows. To provide multiple domains, separate them with commas. 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.

rulesSourceList_targetTypes :: Lens' RulesSourceList [TargetType] Source #

The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

rulesSourceList_generatedRulesType :: Lens' RulesSourceList GeneratedRulesType Source #

Whether you want to allow or deny access to the domains in your target list.

StatefulEngineOptions

statefulEngineOptions_ruleOrder :: Lens' StatefulEngineOptions (Maybe RuleOrder) Source #

Indicates how to manage the order of stateful rule evaluation for the policy. By default, Network Firewall leaves the rule evaluation order up to the Suricata rule processing engine. If you set this to STRICT_ORDER, your rules are evaluated in the exact order that you provide them in the policy. With strict ordering, the rule groups are evaluated by order of priority, starting from the lowest number, and the rules in each rule group are processed in the order that they're defined.

StatefulRule

statefulRule_action :: Lens' StatefulRule StatefulAction Source #

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 - Permits the packets to go to the intended destination and 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.

statefulRule_header :: Lens' StatefulRule Header Source #

The stateful inspection criteria for this rule, used to inspect traffic flows.

statefulRule_ruleOptions :: Lens' StatefulRule [RuleOption] Source #

Additional options for the rule. These are the Suricata RuleOptions settings.

StatefulRuleGroupReference

statefulRuleGroupReference_priority :: Lens' StatefulRuleGroupReference (Maybe Natural) Source #

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.

statefulRuleGroupReference_resourceArn :: Lens' StatefulRuleGroupReference Text Source #

The Amazon Resource Name (ARN) of the stateful rule group.

StatefulRuleOptions

statefulRuleOptions_ruleOrder :: Lens' StatefulRuleOptions (Maybe RuleOrder) Source #

Indicates how to manage the order of the rule evaluation for the rule group. By default, Network Firewall leaves the rule evaluation order up to the Suricata rule processing engine. If you set this to STRICT_ORDER, your rules are evaluated in the exact order that they're listed in your Suricata rules string.

StatelessRule

statelessRule_ruleDefinition :: Lens' StatelessRule RuleDefinition Source #

Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.

statelessRule_priority :: Lens' StatelessRule Natural Source #

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

statelessRuleGroupReference_resourceArn :: Lens' StatelessRuleGroupReference Text Source #

The Amazon Resource Name (ARN) of the stateless rule group.

statelessRuleGroupReference_priority :: Lens' StatelessRuleGroupReference Natural Source #

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.

StatelessRulesAndCustomActions

statelessRulesAndCustomActions_customActions :: Lens' StatelessRulesAndCustomActions (Maybe [CustomAction]) Source #

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.

statelessRulesAndCustomActions_statelessRules :: Lens' StatelessRulesAndCustomActions [StatelessRule] Source #

Defines the set of stateless rules for use in a stateless rule group.

SubnetMapping

subnetMapping_subnetId :: Lens' SubnetMapping Text Source #

The unique identifier for the subnet.

SyncState

syncState_config :: Lens' SyncState (Maybe (HashMap Text PerObjectStatus)) Source #

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. This is part of the FirewallStatus.

syncState_attachment :: Lens' SyncState (Maybe Attachment) Source #

The attachment status of the firewall's association with a single VPC 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. This is part of the FirewallStatus.

TCPFlagField

tCPFlagField_masks :: Lens' TCPFlagField (Maybe [TCPFlag]) Source #

The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.

tCPFlagField_flags :: Lens' TCPFlagField [TCPFlag] Source #

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.

Tag

tag_key :: Lens' Tag Text Source #

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.

tag_value :: Lens' Tag Text Source #

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.