PublishMetricAction 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.
String 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.
List<E> identifiedRuleIds
The priority number of the stateless rules identified in the analysis.
String 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.
String analysisDetail
Provides analysis details for the identified rule.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
String firewallPolicyArn
The Amazon Resource Name (ARN) of the firewall policy.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
String firewallPolicyArn
The Amazon Resource Name (ARN) of the firewall policy.
String 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.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
List<E> subnetMappings
The IDs of the subnets that you want to associate with the firewall.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
List<E> subnetMappings
The IDs of the subnets that are associated with the firewall.
String 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.
String subnetId
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
String endpointId
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.
String status
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 or
DELETING.
String statusMessage
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.
CIDRSummary cIDRs
Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
String 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.
String unknownStatusAction
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.
Integer availableCIDRCount
The number of CIDR blocks available for use by the IP set references in a firewall.
Integer utilizedCIDRCount
The number of CIDR blocks used by the IP set references in a firewall.
Map<K,V> iPSetReferences
The list of the IP set references used by a firewall.
String firewallPolicyName
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
FirewallPolicy firewallPolicy
The rule groups and policy actions to use in the firewall policy.
String description
A description of the firewall policy.
List<E> tags
The key:value pairs to associate with the resource.
Boolean 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.
EncryptionConfiguration encryptionConfiguration
A complex type that contains settings for encryption of your firewall policy resources.
String updateToken
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.
FirewallPolicyResponse 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.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
String firewallPolicyArn
The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
String 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.
List<E> 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.
Boolean deleteProtection
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.
Boolean subnetChangeProtection
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.
Boolean firewallPolicyChangeProtection
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.
String description
A description of the firewall.
List<E> tags
The key:value pairs to associate with the resource.
EncryptionConfiguration encryptionConfiguration
A complex type that contains settings for encryption of your firewall resources.
Firewall 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.
FirewallStatus 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.
String ruleGroupName
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
RuleGroup ruleGroup
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
String 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.
String type
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.
String description
A description of the rule group.
Integer 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.
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.
List<E> tags
The key:value pairs to associate with the resource.
Boolean 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.
EncryptionConfiguration encryptionConfiguration
A complex type that contains settings for encryption of your rule group resources.
SourceMetadata 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.
Boolean analyzeRuleGroup
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.
String updateToken
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.
RuleGroupResponse 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.
String tLSInspectionConfigurationName
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
TLSInspectionConfiguration 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.
String description
A description of the TLS inspection configuration.
List<E> tags
The key:value pairs to associate with the resource.
EncryptionConfiguration encryptionConfiguration
String updateToken
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.
TLSInspectionConfigurationResponse 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.
String actionName
The descriptive name of the custom action. You can't change the name of a custom action after you create it.
ActionDefinition actionDefinition
The custom action associated with the action name.
String 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.
String firewallPolicyArn
The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
FirewallPolicyResponse firewallPolicyResponse
The object containing the definition of the FirewallPolicyResponse that you asked to delete.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
Firewall firewall
FirewallStatus firewallStatus
String resourceArn
The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete.
String 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.
String ruleGroupArn
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
String type
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.
RuleGroupResponse 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.
String tLSInspectionConfigurationArn
The Amazon Resource Name (ARN) of the TLS inspection configuration.
You must specify the ARN or the name, and you can specify both.
String 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.
TLSInspectionConfigurationResponse 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.
String 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.
String firewallPolicyArn
The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
String updateToken
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.
FirewallPolicyResponse 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.
FirewallPolicy firewallPolicy
The policy for the specified firewall policy.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
Firewall 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.
FirewallStatus 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
LoggingConfiguration loggingConfiguration
String resourceArn
The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve.
String policy
The IAM policy for the resource.
String 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.
String 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.
String type
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.
String 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.
String 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.
String description
Returns the metadata objects for the specified rule group.
String type
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.
Integer 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.
StatefulRuleOptions statefulRuleOptions
Date lastModifiedTime
The last time that the rule group was changed.
String 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.
String ruleGroupArn
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
String type
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.
Boolean analyzeRuleGroup
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.
String updateToken
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.
RuleGroup ruleGroup
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.
RuleGroupResponse 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.
String tLSInspectionConfigurationArn
The Amazon Resource Name (ARN) of the TLS inspection configuration.
You must specify the ARN or the name, and you can specify both.
String 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.
String updateToken
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.
TLSInspectionConfiguration 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.
TLSInspectionConfigurationResponse 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.
String value
The value to use in the custom metric dimension.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
List<E> subnetIds
The unique identifiers for the subnets that you want to disassociate.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
List<E> subnetMappings
The IDs of the subnets that are associated with the firewall.
String 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.
String 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.
String type
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String 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.
String vpcId
The unique identifier of the VPC where the firewall is in use.
List<E> subnetMappings
The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
Boolean deleteProtection
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.
Boolean subnetChangeProtection
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.
Boolean firewallPolicyChangeProtection
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.
String description
A description of the firewall.
String firewallId
The unique identifier for the firewall.
List<E> tags
EncryptionConfiguration encryptionConfiguration
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
List<E> statelessRuleGroupReferences
References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
List<E> statelessDefaultActions
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.
List<E> statelessFragmentDefaultActions
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.
List<E> statelessCustomActions
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.
List<E> statefulRuleGroupReferences
References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
List<E> statefulDefaultActions
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
For more information, see Strict evaluation order in the Network Firewall Developer Guide.
StatefulEngineOptions statefulEngineOptions
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.
String tLSInspectionConfigurationArn
The Amazon Resource Name (ARN) of the TLS inspection configuration.
PolicyVariables policyVariables
Contains variables that you can use to override default Suricata settings in your firewall policy.
String firewallPolicyName
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
String 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.
String firewallPolicyId
The unique identifier for the firewall policy.
String description
A description of the firewall policy.
String 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.
List<E> tags
The key:value pairs to associate with the resource.
Integer consumedStatelessRuleCapacity
The number of capacity units currently consumed by the policy's stateless rules.
Integer consumedStatefulRuleCapacity
The number of capacity units currently consumed by the policy's stateful rules.
Integer numberOfAssociations
The number of firewalls that are associated with this firewall policy.
EncryptionConfiguration encryptionConfiguration
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
Date lastModifiedTime
The last time that the firewall policy was changed.
String status
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.
String configurationSyncStateSummary
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.
Map<K,V> syncStates
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.
CapacityUsageSummary capacityUsageSummary
Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
String 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.
String 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.
String 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.
String direction
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.
String 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.
String destinationPort
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.
Integer 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.
String referenceArn
The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
String 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.
Integer 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.
String 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.
List<E> 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.
String 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.
List<E> 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.
Integer 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.
String 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.
List<E> 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.
String 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.
Integer 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.
String 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.
String managedType
Indicates the general category of the Amazon Web Services managed rule group.
String type
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.
String 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.
List<E> ruleGroups
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.
String 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.
Integer 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.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
String 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.
List<E> tags
The tags that are associated with the resource.
String 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.
Integer 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.
String 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.
List<E> 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.
String 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.
String 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.
Map<K,V> 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" }
List<E> sources
The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
List<E> destinations
The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
List<E> sourcePorts
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.
List<E> destinationPorts
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.
List<E> protocols
The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). If not specified, this matches with any protocol.
List<E> 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).
Map<K,V> 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.
String resourceArn
The Amazon Resource Name (ARN) of the account that you want to share rule groups and firewall policies with.
String policy
The IAM 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: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.
MatchAttributes 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.
List<E> actions
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”]
.
RuleVariables ruleVariables
Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
ReferenceSets referenceSets
The list of a rule group's reference sets.
RulesSource rulesSource
The stateful rules or stateless rules for the rule group.
StatefulRuleOptions 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.
String 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.
String ruleGroupName
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
String ruleGroupId
The unique identifier for the rule group.
String description
A description of the rule group.
String type
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.
Integer 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.
String ruleGroupStatus
Detailed information about the current status of a rule group.
List<E> tags
The key:value pairs to associate with the resource.
Integer consumedCapacity
The number of capacity units currently consumed by the rule group rules.
Integer numberOfAssociations
The number of firewall policies that use this rule group.
EncryptionConfiguration encryptionConfiguration
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
SourceMetadata 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.
String snsTopic
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..
Date lastModifiedTime
The last time that the rule group was changed.
List<E> analysisResults
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.
String 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.
List<E> 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.
String 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.
RulesSourceList rulesSourceList
Stateful inspection criteria for a domain list rule group.
List<E> statefulRules
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.
StatelessRulesAndCustomActions statelessRulesAndCustomActions
Stateless inspection criteria to be used in a stateless rule group.
List<E> 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.
List<E> targetTypes
The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify
HTTP_HOST for HTTP. You can specify either or both.
String generatedRulesType
Whether you want to allow or deny access to the domains in your target list.
String resourceArn
The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection.
List<E> serverCertificates
The list of server certificates to use for inbound SSL/TLS inspection.
List<E> scopes
A list of scopes.
String 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 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.
CheckCertificateRevocationStatusActions 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.
List<E> sources
The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.
List<E> destinations
The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.
List<E> 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.
List<E> destinationPorts
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.
List<E> protocols
The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number (IANA). Network Firewall currently supports only TCP.
String sourceArn
The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
String 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.
String ruleOrder
Indicates how to manage the order of stateful rule evaluation for the policy. STRICT_ORDER is the
default and recommended 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.
String 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.
String action
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.
Header header
The stateful inspection criteria for this rule, used to inspect traffic flows.
List<E> ruleOptions
Additional options for the rule. These are the Suricata RuleOptions settings.
String action
The action that changes the rule group from DROP to ALERT. This only applies to managed
rule groups.
String resourceArn
The Amazon Resource Name (ARN) of the stateful rule group.
Integer 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.
StatefulRuleGroupOverride override
The action that allows the policy owner to override the behavior of the rule group within a policy.
String ruleOrder
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.
RuleDefinition ruleDefinition
Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
Integer 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.
String resourceArn
The Amazon Resource Name (ARN) of the stateless rule group.
Integer 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.
List<E> statelessRules
Defines the set of stateless rules for use in a stateless rule group.
List<E> customActions
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.
Attachment attachment
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.
Map<K,V> 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. This is part of the FirewallStatus.
String 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.
String 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.
List<E> 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.
List<E> masks
The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
String certificateArn
The Amazon Resource Name (ARN) of the certificate.
String certificateSerial
The serial number of the certificate.
String status
The status of the certificate.
String statusMessage
Contains details about the certificate status, including information about certificate errors.
String tLSInspectionConfigurationArn
The Amazon Resource Name (ARN) of the TLS inspection configuration.
String tLSInspectionConfigurationName
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
String 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.
String 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.
String description
A description of the TLS inspection configuration.
List<E> tags
The key:value pairs to associate with the resource.
Date lastModifiedTime
The last time that the TLS inspection configuration was changed.
Integer numberOfAssociations
The number of firewall policies that use this TLS inspection configuration.
EncryptionConfiguration encryptionConfiguration
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
List<E> certificates
A list of the certificates associated with the TLS inspection configuration.
TlsCertificateData certificateAuthority
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
Boolean deleteProtection
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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
Boolean deleteProtection
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.
String 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.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
String description
The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
String description
A description of the firewall.
String 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.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
EncryptionConfiguration encryptionConfiguration
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
String 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.
EncryptionConfiguration encryptionConfiguration
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
Boolean firewallPolicyChangeProtection
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.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
Boolean firewallPolicyChangeProtection
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.
String updateToken
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.
String firewallPolicyArn
The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
String 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.
FirewallPolicy 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.
String description
A description of the firewall policy.
Boolean 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.
EncryptionConfiguration encryptionConfiguration
A complex type that contains settings for encryption of your firewall policy resources.
String updateToken
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.
FirewallPolicyResponse 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
LoggingConfiguration loggingConfiguration
Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
LoggingConfiguration loggingConfiguration
String updateToken
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.
String ruleGroupArn
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
String 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.
RuleGroup ruleGroup
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
String 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.
String type
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.
String description
A description of the rule group.
Boolean 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.
EncryptionConfiguration encryptionConfiguration
A complex type that contains settings for encryption of your rule group resources.
SourceMetadata 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.
Boolean analyzeRuleGroup
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.
String updateToken
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.
RuleGroupResponse 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.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
String 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.
Boolean subnetChangeProtection
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.
String 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.
String firewallArn
The Amazon Resource Name (ARN) of the firewall.
String firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
Boolean subnetChangeProtection
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.
String tLSInspectionConfigurationArn
The Amazon Resource Name (ARN) of the TLS inspection configuration.
String tLSInspectionConfigurationName
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
TLSInspectionConfiguration 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.
String description
A description of the TLS inspection configuration.
EncryptionConfiguration encryptionConfiguration
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
String updateToken
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.
String updateToken
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.
TLSInspectionConfigurationResponse 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.
Copyright © 2025. All rights reserved.