AWS Network Firewall 2020-11-12
- Client: Aws\NetworkFirewall\NetworkFirewallClient
- Service ID: network-firewall
- Version: 2020-11-12
This page describes the parameters and results for the operations of the AWS Network Firewall (2020-11-12), and shows how to use the Aws\NetworkFirewall\NetworkFirewallClient object to call the described operations. This documentation is specific to the 2020-11-12 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociateFirewallPolicy ( array $params = [] )
Associates a FirewallPolicy to a Firewall.
- AssociateSubnets ( array $params = [] )
Associates the specified subnets in the Amazon VPC to the firewall.
- CreateFirewall ( array $params = [] )
Creates an AWS Network Firewall Firewall and accompanying FirewallStatus for a VPC.
- CreateFirewallPolicy ( array $params = [] )
Creates the firewall policy for the firewall according to the specifications.
- CreateRuleGroup ( array $params = [] )
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
- DeleteFirewall ( array $params = [] )
Deletes the specified Firewall and its FirewallStatus.
- DeleteFirewallPolicy ( array $params = [] )
Deletes the specified FirewallPolicy.
- DeleteResourcePolicy ( array $params = [] )
Deletes a resource policy that you created in a PutResourcePolicy request.
- DeleteRuleGroup ( array $params = [] )
Deletes the specified RuleGroup.
- DescribeFirewall ( array $params = [] )
Returns the data objects for the specified firewall.
- DescribeFirewallPolicy ( array $params = [] )
Returns the data objects for the specified firewall policy.
- DescribeLoggingConfiguration ( array $params = [] )
Returns the logging configuration for the specified firewall.
- DescribeResourcePolicy ( array $params = [] )
Retrieves a resource policy that you created in a PutResourcePolicy request.
- DescribeRuleGroup ( array $params = [] )
Returns the data objects for the specified rule group.
- DisassociateSubnets ( array $params = [] )
Removes the specified subnet associations from the firewall.
- ListFirewallPolicies ( array $params = [] )
Retrieves the metadata for the firewall policies that you have defined.
- ListFirewalls ( array $params = [] )
Retrieves the metadata for the firewalls that you have defined.
- ListRuleGroups ( array $params = [] )
Retrieves the metadata for the rule groups that you have defined.
- ListTagsForResource ( array $params = [] )
Retrieves the tags associated with the specified resource.
- PutResourcePolicy ( array $params = [] )
Creates or updates an AWS Identity and Access Management policy for your rule group or firewall policy.
- TagResource ( array $params = [] )
Adds the specified tags to the specified resource.
- UntagResource ( array $params = [] )
Removes the tags with the specified keys from the specified resource.
- UpdateFirewallDeleteProtection ( array $params = [] )
Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall.
- UpdateFirewallDescription ( array $params = [] )
Modifies the description for the specified firewall.
- UpdateFirewallPolicy ( array $params = [] )
Updates the properties of the specified firewall policy.
- UpdateFirewallPolicyChangeProtection ( array $params = [] )
- UpdateLoggingConfiguration ( array $params = [] )
Sets the logging configuration for the specified firewall.
- UpdateRuleGroup ( array $params = [] )
Updates the rule settings for the specified rule group.
- UpdateSubnetChangeProtection ( array $params = [] )
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateFirewallPolicy
$result = $client->associateFirewallPolicy
([/* ... */]); $promise = $client->associateFirewallPolicyAsync
([/* ... */]);
Associates a FirewallPolicy to a Firewall.
A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
Parameter Syntax
$result = $client->associateFirewallPolicy([ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'FirewallPolicyArn' => '<string>', // REQUIRED 'UpdateToken' => '<string>', ]);
Parameter Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
- FirewallPolicyArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the firewall policy.
- UpdateToken
-
- Type: string
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.
Result Syntax
[ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'FirewallPolicyArn' => '<string>', 'UpdateToken' => '<string>', ]
Result Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- FirewallName
-
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- FirewallPolicyArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall policy.
- UpdateToken
-
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
The token you provided is stale or isn't valid for the operation.
-
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
AssociateSubnets
$result = $client->associateSubnets
([/* ... */]); $promise = $client->associateSubnetsAsync
([/* ... */]);
Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.
This request creates an AWS Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.
Parameter Syntax
$result = $client->associateSubnets([ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'SubnetMappings' => [ // REQUIRED [ 'SubnetId' => '<string>', // REQUIRED ], // ... ], 'UpdateToken' => '<string>', ]);
Parameter Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
- SubnetMappings
-
- Required: Yes
- Type: Array of SubnetMapping structures
The IDs of the subnets that you want to associate with the firewall.
- UpdateToken
-
- Type: string
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.
Result Syntax
[ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'SubnetMappings' => [ [ 'SubnetId' => '<string>', ], // ... ], 'UpdateToken' => '<string>', ]
Result Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- FirewallName
-
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- SubnetMappings
-
- Type: Array of SubnetMapping structures
The IDs of the subnets that are associated with the firewall.
- UpdateToken
-
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
The token you provided is stale or isn't valid for the operation.
-
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
CreateFirewall
$result = $client->createFirewall
([/* ... */]); $promise = $client->createFirewallAsync
([/* ... */]);
Creates an AWS Network Firewall Firewall and accompanying FirewallStatus for a VPC.
The firewall defines the configuration settings for an AWS Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.
After you create a firewall, you can provide additional settings, like the logging configuration.
To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.
To manage a firewall's tags, use the standard AWS resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
Parameter Syntax
$result = $client->createFirewall([ 'DeleteProtection' => true || false, 'Description' => '<string>', 'FirewallName' => '<string>', // REQUIRED 'FirewallPolicyArn' => '<string>', // REQUIRED 'FirewallPolicyChangeProtection' => true || false, 'SubnetChangeProtection' => true || false, 'SubnetMappings' => [ // REQUIRED [ 'SubnetId' => '<string>', // REQUIRED ], // ... ], 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'VpcId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DeleteProtection
-
- Type: boolean
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 toTRUE
. - Description
-
- Type: string
A description of the firewall.
- FirewallName
-
- Required: Yes
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- FirewallPolicyArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
- FirewallPolicyChangeProtection
-
- Type: boolean
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
. - SubnetChangeProtection
-
- Type: boolean
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
. - SubnetMappings
-
- Required: Yes
- Type: Array of SubnetMapping structures
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.
- Tags
-
- Type: Array of Tag structures
The key:value pairs to associate with the resource.
- VpcId
-
- Required: Yes
- Type: string
The unique identifier of the VPC where Network Firewall should create the firewall.
You can't change this setting after you create the firewall.
Result Syntax
[ 'Firewall' => [ 'DeleteProtection' => true || false, 'Description' => '<string>', 'FirewallArn' => '<string>', 'FirewallId' => '<string>', 'FirewallName' => '<string>', 'FirewallPolicyArn' => '<string>', 'FirewallPolicyChangeProtection' => true || false, 'SubnetChangeProtection' => true || false, 'SubnetMappings' => [ [ 'SubnetId' => '<string>', ], // ... ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcId' => '<string>', ], 'FirewallStatus' => [ 'ConfigurationSyncStateSummary' => 'PENDING|IN_SYNC', 'Status' => 'PROVISIONING|DELETING|READY', 'SyncStates' => [ '<AvailabilityZone>' => [ 'Attachment' => [ 'EndpointId' => '<string>', 'Status' => 'CREATING|DELETING|SCALING|READY', 'SubnetId' => '<string>', ], 'Config' => [ '<ResourceName>' => [ 'SyncStatus' => 'PENDING|IN_SYNC', ], // ... ], ], // ... ], ], ]
Result Details
Members
- Firewall
-
- Type: Firewall structure
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
-
- Type: FirewallStatus structure
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to perform the operation because doing so would violate a limit setting.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to process the request due to throttling limitations.
-
InsufficientCapacityException:
AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.
-
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
CreateFirewallPolicy
$result = $client->createFirewallPolicy
([/* ... */]); $promise = $client->createFirewallPolicyAsync
([/* ... */]);
Creates the firewall policy for the firewall according to the specifications.
An AWS Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
Parameter Syntax
$result = $client->createFirewallPolicy([ 'Description' => '<string>', 'DryRun' => true || false, 'FirewallPolicy' => [ // REQUIRED 'StatefulRuleGroupReferences' => [ [ 'ResourceArn' => '<string>', // REQUIRED ], // ... ], 'StatelessCustomActions' => [ [ 'ActionDefinition' => [ // REQUIRED 'PublishMetricAction' => [ 'Dimensions' => [ // REQUIRED [ 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'ActionName' => '<string>', // REQUIRED ], // ... ], 'StatelessDefaultActions' => ['<string>', ...], // REQUIRED 'StatelessFragmentDefaultActions' => ['<string>', ...], // REQUIRED 'StatelessRuleGroupReferences' => [ [ 'Priority' => <integer>, // REQUIRED 'ResourceArn' => '<string>', // REQUIRED ], // ... ], ], 'FirewallPolicyName' => '<string>', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- Description
-
- Type: string
A description of the firewall policy.
- DryRun
-
- Type: boolean
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 toFALSE
, 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. - FirewallPolicy
-
- Required: Yes
- Type: FirewallPolicy structure
The rule groups and policy actions to use in the firewall policy.
- FirewallPolicyName
-
- Required: Yes
- Type: string
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
- Tags
-
- Type: Array of Tag structures
The key:value pairs to associate with the resource.
Result Syntax
[ 'FirewallPolicyResponse' => [ 'Description' => '<string>', 'FirewallPolicyArn' => '<string>', 'FirewallPolicyId' => '<string>', 'FirewallPolicyName' => '<string>', 'FirewallPolicyStatus' => 'ACTIVE|DELETING', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'UpdateToken' => '<string>', ]
Result Details
Members
- FirewallPolicyResponse
-
- Required: Yes
- Type: FirewallPolicyResponse structure
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.
- UpdateToken
-
- Required: Yes
- Type: string
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.
Errors
-
Unable to perform the operation because doing so would violate a limit setting.
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
InsufficientCapacityException:
AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.
CreateRuleGroup
$result = $client->createRuleGroup
([/* ... */]); $promise = $client->createRuleGroupAsync
([/* ... */]);
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
You provide your rule group specification in your request using either RuleGroup
or Rules
.
Parameter Syntax
$result = $client->createRuleGroup([ 'Capacity' => <integer>, // REQUIRED 'Description' => '<string>', 'DryRun' => true || false, 'RuleGroup' => [ 'RuleVariables' => [ 'IPSets' => [ '<RuleVariableName>' => [ 'Definition' => ['<string>', ...], // REQUIRED ], // ... ], 'PortSets' => [ '<RuleVariableName>' => [ 'Definition' => ['<string>', ...], ], // ... ], ], 'RulesSource' => [ // REQUIRED 'RulesSourceList' => [ 'GeneratedRulesType' => 'ALLOWLIST|DENYLIST', // REQUIRED 'TargetTypes' => ['<string>', ...], // REQUIRED 'Targets' => ['<string>', ...], // REQUIRED ], 'RulesString' => '<string>', 'StatefulRules' => [ [ 'Action' => 'PASS|DROP|ALERT', // REQUIRED 'Header' => [ // REQUIRED 'Destination' => '<string>', // REQUIRED 'DestinationPort' => '<string>', // REQUIRED 'Direction' => 'FORWARD|ANY', // REQUIRED 'Protocol' => 'IP|TCP|UDP|ICMP|HTTP|FTP|TLS|SMB|DNS|DCERPC|SSH|SMTP|IMAP|MSN|KRB5|IKEV2|TFTP|NTP|DHCP', // REQUIRED 'Source' => '<string>', // REQUIRED 'SourcePort' => '<string>', // REQUIRED ], 'RuleOptions' => [ // REQUIRED [ 'Keyword' => '<string>', // REQUIRED 'Settings' => ['<string>', ...], ], // ... ], ], // ... ], 'StatelessRulesAndCustomActions' => [ 'CustomActions' => [ [ 'ActionDefinition' => [ // REQUIRED 'PublishMetricAction' => [ 'Dimensions' => [ // REQUIRED [ 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'ActionName' => '<string>', // REQUIRED ], // ... ], 'StatelessRules' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'RuleDefinition' => [ // REQUIRED 'Actions' => ['<string>', ...], // REQUIRED 'MatchAttributes' => [ // REQUIRED 'DestinationPorts' => [ [ 'FromPort' => <integer>, // REQUIRED 'ToPort' => <integer>, // REQUIRED ], // ... ], 'Destinations' => [ [ 'AddressDefinition' => '<string>', // REQUIRED ], // ... ], 'Protocols' => [<integer>, ...], 'SourcePorts' => [ [ 'FromPort' => <integer>, // REQUIRED 'ToPort' => <integer>, // REQUIRED ], // ... ], 'Sources' => [ [ 'AddressDefinition' => '<string>', // REQUIRED ], // ... ], 'TCPFlags' => [ [ 'Flags' => ['<string>', ...], // REQUIRED 'Masks' => ['<string>', ...], ], // ... ], ], ], ], // ... ], ], ], ], 'RuleGroupName' => '<string>', // REQUIRED 'Rules' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'Type' => 'STATELESS|STATEFUL', // REQUIRED ]);
Parameter Details
Members
- Capacity
-
- Required: Yes
- Type: int
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 toTRUE
.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.
- Description
-
- Type: string
A description of the rule group.
- DryRun
-
- Type: boolean
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 toFALSE
, 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. - RuleGroup
-
- Type: RuleGroup structure
An object that defines the rule group rules.
You must provide either this rule group setting or a
Rules
setting, but not both. - RuleGroupName
-
- Required: Yes
- Type: string
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
- Rules
-
- Type: string
The name of a file 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 a file 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 file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call DescribeRuleGroup to retrieve the rule group, Network Firewall returns rules settings inside a RuleGroup object.
- Tags
-
- Type: Array of Tag structures
The key:value pairs to associate with the resource.
- Type
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'RuleGroupResponse' => [ 'Capacity' => <integer>, 'Description' => '<string>', 'RuleGroupArn' => '<string>', 'RuleGroupId' => '<string>', 'RuleGroupName' => '<string>', 'RuleGroupStatus' => 'ACTIVE|DELETING', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Type' => 'STATELESS|STATEFUL', ], 'UpdateToken' => '<string>', ]
Result Details
Members
- RuleGroupResponse
-
- Required: Yes
- Type: RuleGroupResponse structure
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.
- UpdateToken
-
- Required: Yes
- Type: string
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.
Errors
-
Unable to perform the operation because doing so would violate a limit setting.
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
InsufficientCapacityException:
AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.
DeleteFirewall
$result = $client->deleteFirewall
([/* ... */]); $promise = $client->deleteFirewallAsync
([/* ... */]);
Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection
flag to be FALSE
. You can't revert this operation.
You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.
To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.
Parameter Syntax
$result = $client->deleteFirewall([ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', ]);
Parameter Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
Result Syntax
[ 'Firewall' => [ 'DeleteProtection' => true || false, 'Description' => '<string>', 'FirewallArn' => '<string>', 'FirewallId' => '<string>', 'FirewallName' => '<string>', 'FirewallPolicyArn' => '<string>', 'FirewallPolicyChangeProtection' => true || false, 'SubnetChangeProtection' => true || false, 'SubnetMappings' => [ [ 'SubnetId' => '<string>', ], // ... ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcId' => '<string>', ], 'FirewallStatus' => [ 'ConfigurationSyncStateSummary' => 'PENDING|IN_SYNC', 'Status' => 'PROVISIONING|DELETING|READY', 'SyncStates' => [ '<AvailabilityZone>' => [ 'Attachment' => [ 'EndpointId' => '<string>', 'Status' => 'CREATING|DELETING|SCALING|READY', 'SubnetId' => '<string>', ], 'Config' => [ '<ResourceName>' => [ 'SyncStatus' => 'PENDING|IN_SYNC', ], // ... ], ], // ... ], ], ]
Result Details
Members
- Firewall
-
- Type: Firewall structure
The firewall defines the configuration settings for an AWS Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both objects by calling DescribeFirewall.
- FirewallStatus
-
- Type: FirewallStatus structure
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
UnsupportedOperationException:
The operation you requested isn't supported by Network Firewall.
-
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
DeleteFirewallPolicy
$result = $client->deleteFirewallPolicy
([/* ... */]); $promise = $client->deleteFirewallPolicyAsync
([/* ... */]);
Deletes the specified FirewallPolicy.
Parameter Syntax
$result = $client->deleteFirewallPolicy([ 'FirewallPolicyArn' => '<string>', 'FirewallPolicyName' => '<string>', ]);
Parameter Details
Members
- FirewallPolicyArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
- FirewallPolicyName
-
- Type: string
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.
Result Syntax
[ 'FirewallPolicyResponse' => [ 'Description' => '<string>', 'FirewallPolicyArn' => '<string>', 'FirewallPolicyId' => '<string>', 'FirewallPolicyName' => '<string>', 'FirewallPolicyStatus' => 'ACTIVE|DELETING', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ]
Result Details
Members
- FirewallPolicyResponse
-
- Required: Yes
- Type: FirewallPolicyResponse structure
The object containing the definition of the FirewallPolicyResponse that you asked to delete.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
UnsupportedOperationException:
The operation you requested isn't supported by Network Firewall.
-
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
DeleteResourcePolicy
$result = $client->deleteResourcePolicy
([/* ... */]); $promise = $client->deleteResourcePolicyAsync
([/* ... */]);
Deletes a resource policy that you created in a PutResourcePolicy request.
Parameter Syntax
$result = $client->deleteResourcePolicy([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
DeleteRuleGroup
$result = $client->deleteRuleGroup
([/* ... */]); $promise = $client->deleteRuleGroupAsync
([/* ... */]);
Deletes the specified RuleGroup.
Parameter Syntax
$result = $client->deleteRuleGroup([ 'RuleGroupArn' => '<string>', 'RuleGroupName' => '<string>', 'Type' => 'STATELESS|STATEFUL', ]);
Parameter Details
Members
- RuleGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
- RuleGroupName
-
- Type: string
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.
- Type
-
- Type: string
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
.
Result Syntax
[ 'RuleGroupResponse' => [ 'Capacity' => <integer>, 'Description' => '<string>', 'RuleGroupArn' => '<string>', 'RuleGroupId' => '<string>', 'RuleGroupName' => '<string>', 'RuleGroupStatus' => 'ACTIVE|DELETING', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Type' => 'STATELESS|STATEFUL', ], ]
Result Details
Members
- RuleGroupResponse
-
- Required: Yes
- Type: RuleGroupResponse structure
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
UnsupportedOperationException:
The operation you requested isn't supported by Network Firewall.
-
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
DescribeFirewall
$result = $client->describeFirewall
([/* ... */]); $promise = $client->describeFirewallAsync
([/* ... */]);
Returns the data objects for the specified firewall.
Parameter Syntax
$result = $client->describeFirewall([ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', ]);
Parameter Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
Result Syntax
[ 'Firewall' => [ 'DeleteProtection' => true || false, 'Description' => '<string>', 'FirewallArn' => '<string>', 'FirewallId' => '<string>', 'FirewallName' => '<string>', 'FirewallPolicyArn' => '<string>', 'FirewallPolicyChangeProtection' => true || false, 'SubnetChangeProtection' => true || false, 'SubnetMappings' => [ [ 'SubnetId' => '<string>', ], // ... ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VpcId' => '<string>', ], 'FirewallStatus' => [ 'ConfigurationSyncStateSummary' => 'PENDING|IN_SYNC', 'Status' => 'PROVISIONING|DELETING|READY', 'SyncStates' => [ '<AvailabilityZone>' => [ 'Attachment' => [ 'EndpointId' => '<string>', 'Status' => 'CREATING|DELETING|SCALING|READY', 'SubnetId' => '<string>', ], 'Config' => [ '<ResourceName>' => [ 'SyncStatus' => 'PENDING|IN_SYNC', ], // ... ], ], // ... ], ], 'UpdateToken' => '<string>', ]
Result Details
Members
- Firewall
-
- Type: Firewall structure
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
-
- Type: FirewallStatus structure
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.
- UpdateToken
-
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
DescribeFirewallPolicy
$result = $client->describeFirewallPolicy
([/* ... */]); $promise = $client->describeFirewallPolicyAsync
([/* ... */]);
Returns the data objects for the specified firewall policy.
Parameter Syntax
$result = $client->describeFirewallPolicy([ 'FirewallPolicyArn' => '<string>', 'FirewallPolicyName' => '<string>', ]);
Parameter Details
Members
- FirewallPolicyArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
- FirewallPolicyName
-
- Type: string
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.
Result Syntax
[ 'FirewallPolicy' => [ 'StatefulRuleGroupReferences' => [ [ 'ResourceArn' => '<string>', ], // ... ], 'StatelessCustomActions' => [ [ 'ActionDefinition' => [ 'PublishMetricAction' => [ 'Dimensions' => [ [ 'Value' => '<string>', ], // ... ], ], ], 'ActionName' => '<string>', ], // ... ], 'StatelessDefaultActions' => ['<string>', ...], 'StatelessFragmentDefaultActions' => ['<string>', ...], 'StatelessRuleGroupReferences' => [ [ 'Priority' => <integer>, 'ResourceArn' => '<string>', ], // ... ], ], 'FirewallPolicyResponse' => [ 'Description' => '<string>', 'FirewallPolicyArn' => '<string>', 'FirewallPolicyId' => '<string>', 'FirewallPolicyName' => '<string>', 'FirewallPolicyStatus' => 'ACTIVE|DELETING', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'UpdateToken' => '<string>', ]
Result Details
Members
- FirewallPolicy
-
- Type: FirewallPolicy structure
The policy for the specified firewall policy.
- FirewallPolicyResponse
-
- Required: Yes
- Type: FirewallPolicyResponse structure
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.
- UpdateToken
-
- Required: Yes
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
DescribeLoggingConfiguration
$result = $client->describeLoggingConfiguration
([/* ... */]); $promise = $client->describeLoggingConfigurationAsync
([/* ... */]);
Returns the logging configuration for the specified firewall.
Parameter Syntax
$result = $client->describeLoggingConfiguration([ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', ]);
Parameter Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
Result Syntax
[ 'FirewallArn' => '<string>', 'LoggingConfiguration' => [ 'LogDestinationConfigs' => [ [ 'LogDestination' => ['<string>', ...], 'LogDestinationType' => 'S3|CloudWatchLogs|KinesisDataFirehose', 'LogType' => 'ALERT|FLOW', ], // ... ], ], ]
Result Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- LoggingConfiguration
-
- Type: LoggingConfiguration structure
Defines how AWS Network Firewall performs logging for a Firewall.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
DescribeResourcePolicy
$result = $client->describeResourcePolicy
([/* ... */]); $promise = $client->describeResourcePolicyAsync
([/* ... */]);
Retrieves a resource policy that you created in a PutResourcePolicy request.
Parameter Syntax
$result = $client->describeResourcePolicy([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'Policy' => '<string>', ]
Result Details
Errors
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
DescribeRuleGroup
$result = $client->describeRuleGroup
([/* ... */]); $promise = $client->describeRuleGroupAsync
([/* ... */]);
Returns the data objects for the specified rule group.
Parameter Syntax
$result = $client->describeRuleGroup([ 'RuleGroupArn' => '<string>', 'RuleGroupName' => '<string>', 'Type' => 'STATELESS|STATEFUL', ]);
Parameter Details
Members
- RuleGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
- RuleGroupName
-
- Type: string
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.
- Type
-
- Type: string
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
.
Result Syntax
[ 'RuleGroup' => [ 'RuleVariables' => [ 'IPSets' => [ '<RuleVariableName>' => [ 'Definition' => ['<string>', ...], ], // ... ], 'PortSets' => [ '<RuleVariableName>' => [ 'Definition' => ['<string>', ...], ], // ... ], ], 'RulesSource' => [ 'RulesSourceList' => [ 'GeneratedRulesType' => 'ALLOWLIST|DENYLIST', 'TargetTypes' => ['<string>', ...], 'Targets' => ['<string>', ...], ], 'RulesString' => '<string>', 'StatefulRules' => [ [ 'Action' => 'PASS|DROP|ALERT', 'Header' => [ 'Destination' => '<string>', 'DestinationPort' => '<string>', 'Direction' => 'FORWARD|ANY', 'Protocol' => 'IP|TCP|UDP|ICMP|HTTP|FTP|TLS|SMB|DNS|DCERPC|SSH|SMTP|IMAP|MSN|KRB5|IKEV2|TFTP|NTP|DHCP', 'Source' => '<string>', 'SourcePort' => '<string>', ], 'RuleOptions' => [ [ 'Keyword' => '<string>', 'Settings' => ['<string>', ...], ], // ... ], ], // ... ], 'StatelessRulesAndCustomActions' => [ 'CustomActions' => [ [ 'ActionDefinition' => [ 'PublishMetricAction' => [ 'Dimensions' => [ [ 'Value' => '<string>', ], // ... ], ], ], 'ActionName' => '<string>', ], // ... ], 'StatelessRules' => [ [ 'Priority' => <integer>, 'RuleDefinition' => [ 'Actions' => ['<string>', ...], 'MatchAttributes' => [ 'DestinationPorts' => [ [ 'FromPort' => <integer>, 'ToPort' => <integer>, ], // ... ], 'Destinations' => [ [ 'AddressDefinition' => '<string>', ], // ... ], 'Protocols' => [<integer>, ...], 'SourcePorts' => [ [ 'FromPort' => <integer>, 'ToPort' => <integer>, ], // ... ], 'Sources' => [ [ 'AddressDefinition' => '<string>', ], // ... ], 'TCPFlags' => [ [ 'Flags' => ['<string>', ...], 'Masks' => ['<string>', ...], ], // ... ], ], ], ], // ... ], ], ], ], 'RuleGroupResponse' => [ 'Capacity' => <integer>, 'Description' => '<string>', 'RuleGroupArn' => '<string>', 'RuleGroupId' => '<string>', 'RuleGroupName' => '<string>', 'RuleGroupStatus' => 'ACTIVE|DELETING', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Type' => 'STATELESS|STATEFUL', ], 'UpdateToken' => '<string>', ]
Result Details
Members
- RuleGroup
-
- Type: RuleGroup structure
The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
AWS Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
- RuleGroupResponse
-
- Required: Yes
- Type: RuleGroupResponse structure
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.
- UpdateToken
-
- Required: Yes
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
DisassociateSubnets
$result = $client->disassociateSubnets
([/* ... */]); $promise = $client->disassociateSubnetsAsync
([/* ... */]);
Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.
Parameter Syntax
$result = $client->disassociateSubnets([ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'SubnetIds' => ['<string>', ...], // REQUIRED 'UpdateToken' => '<string>', ]);
Parameter Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
- SubnetIds
-
- Required: Yes
- Type: Array of strings
The unique identifiers for the subnets that you want to disassociate.
- UpdateToken
-
- Type: string
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.
Result Syntax
[ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'SubnetMappings' => [ [ 'SubnetId' => '<string>', ], // ... ], 'UpdateToken' => '<string>', ]
Result Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- FirewallName
-
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- SubnetMappings
-
- Type: Array of SubnetMapping structures
The IDs of the subnets that are associated with the firewall.
- UpdateToken
-
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
The token you provided is stale or isn't valid for the operation.
-
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
ListFirewallPolicies
$result = $client->listFirewallPolicies
([/* ... */]); $promise = $client->listFirewallPoliciesAsync
([/* ... */]);
Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.
Parameter Syntax
$result = $client->listFirewallPolicies([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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. - NextToken
-
- Type: string
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 aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Result Syntax
[ 'FirewallPolicies' => [ [ 'Arn' => '<string>', 'Name' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- FirewallPolicies
-
- Type: Array of FirewallPolicyMetadata structures
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.
- NextToken
-
- Type: string
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 aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
ListFirewalls
$result = $client->listFirewalls
([/* ... */]); $promise = $client->listFirewallsAsync
([/* ... */]);
Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.
Depending on your setting for max results and the number of firewalls, a single call might not return the full list.
Parameter Syntax
$result = $client->listFirewalls([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'VpcIds' => ['<string>', ...], ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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. - NextToken
-
- Type: string
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 aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request. - VpcIds
-
- Type: Array of strings
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.
Result Syntax
[ 'Firewalls' => [ [ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Firewalls
-
- Type: Array of FirewallMetadata structures
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.
- NextToken
-
- Type: string
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 aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to process the request due to throttling limitations.
ListRuleGroups
$result = $client->listRuleGroups
([/* ... */]); $promise = $client->listRuleGroupsAsync
([/* ... */]);
Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.
Parameter Syntax
$result = $client->listRuleGroups([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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. - NextToken
-
- Type: string
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 aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Result Syntax
[ 'NextToken' => '<string>', 'RuleGroups' => [ [ 'Arn' => '<string>', 'Name' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
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 aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request. - RuleGroups
-
- Type: Array of RuleGroupMetadata structures
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.
Parameter Syntax
$result = $client->listTagsForResource([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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. - NextToken
-
- Type: string
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 aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request. - ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
Result Syntax
[ 'NextToken' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
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 aNextToken
value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request. - Tags
-
- Type: Array of Tag structures
The tags that are associated with the resource.
Errors
-
Unable to locate a resource using the parameters that you provided.
PutResourcePolicy
$result = $client->putResourcePolicy
([/* ... */]); $promise = $client->putResourcePolicyAsync
([/* ... */]);
Creates or updates an AWS Identity and Access Management policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the AWS Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.
When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.
-
GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
-
AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see AWS Resource Access Manager User Guide.
Parameter Syntax
$result = $client->putResourcePolicy([ 'Policy' => '<string>', // REQUIRED 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Policy
-
- Required: Yes
- Type: string
The AWS Identity and Access Management policy statement that lists the accounts that you want to share your rule group or firewall policy with and the operations that you want the accounts to be able to perform.
For a rule group resource, you can specify the following operations in the Actions section of the statement:
-
network-firewall:CreateFirewallPolicy
-
network-firewall:UpdateFirewallPolicy
-
network-firewall:ListRuleGroups
For a firewall policy resource, you can specify the following operations in the Actions section of the statement:
-
network-firewall:CreateFirewall
-
network-firewall:UpdateFirewall
-
network-firewall:AssociateFirewallPolicy
-
network-firewall:ListFirewallPolicies
In the Resource section of the statement, you specify the ARNs for the rule groups and firewall policies that you want to share with the account that you specified in
Arn
. - ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the account that you want to share rule groups and firewall policies with.
Result Syntax
[]
Result Details
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.
Parameter Syntax
$result = $client->tagResource([ 'ResourceArn' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
Result Syntax
[]
Result Details
Errors
-
Unable to locate a resource using the parameters that you provided.
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can manage tags for the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.
Parameter Syntax
$result = $client->untagResource([ 'ResourceArn' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Unable to locate a resource using the parameters that you provided.
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
UpdateFirewallDeleteProtection
$result = $client->updateFirewallDeleteProtection
([/* ... */]); $promise = $client->updateFirewallDeleteProtectionAsync
([/* ... */]);
Modifies the flag, DeleteProtection
, which indicates whether it is possible to delete the firewall. If the flag is set to TRUE
, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use.
Parameter Syntax
$result = $client->updateFirewallDeleteProtection([ 'DeleteProtection' => true || false, // REQUIRED 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'UpdateToken' => '<string>', ]);
Parameter Details
Members
- DeleteProtection
-
- Required: Yes
- Type: boolean
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 toTRUE
. - FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
- UpdateToken
-
- Type: string
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.
Result Syntax
[ 'DeleteProtection' => true || false, 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'UpdateToken' => '<string>', ]
Result Details
Members
- DeleteProtection
-
- Type: boolean
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- FirewallName
-
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- UpdateToken
-
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
The token you provided is stale or isn't valid for the operation.
UpdateFirewallDescription
$result = $client->updateFirewallDescription
([/* ... */]); $promise = $client->updateFirewallDescriptionAsync
([/* ... */]);
Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
Parameter Syntax
$result = $client->updateFirewallDescription([ 'Description' => '<string>', 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'UpdateToken' => '<string>', ]);
Parameter Details
Members
- Description
-
- Type: string
The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
- UpdateToken
-
- Type: string
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.
Result Syntax
[ 'Description' => '<string>', 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'UpdateToken' => '<string>', ]
Result Details
Members
- Description
-
- Type: string
A description of the firewall.
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- FirewallName
-
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- UpdateToken
-
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
The token you provided is stale or isn't valid for the operation.
UpdateFirewallPolicy
$result = $client->updateFirewallPolicy
([/* ... */]); $promise = $client->updateFirewallPolicyAsync
([/* ... */]);
Updates the properties of the specified firewall policy.
Parameter Syntax
$result = $client->updateFirewallPolicy([ 'Description' => '<string>', 'DryRun' => true || false, 'FirewallPolicy' => [ // REQUIRED 'StatefulRuleGroupReferences' => [ [ 'ResourceArn' => '<string>', // REQUIRED ], // ... ], 'StatelessCustomActions' => [ [ 'ActionDefinition' => [ // REQUIRED 'PublishMetricAction' => [ 'Dimensions' => [ // REQUIRED [ 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'ActionName' => '<string>', // REQUIRED ], // ... ], 'StatelessDefaultActions' => ['<string>', ...], // REQUIRED 'StatelessFragmentDefaultActions' => ['<string>', ...], // REQUIRED 'StatelessRuleGroupReferences' => [ [ 'Priority' => <integer>, // REQUIRED 'ResourceArn' => '<string>', // REQUIRED ], // ... ], ], 'FirewallPolicyArn' => '<string>', 'FirewallPolicyName' => '<string>', 'UpdateToken' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Description
-
- Type: string
A description of the firewall policy.
- DryRun
-
- Type: boolean
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 toFALSE
, 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. - FirewallPolicy
-
- Required: Yes
- Type: FirewallPolicy structure
The updated firewall policy to use for the firewall.
- FirewallPolicyArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
- FirewallPolicyName
-
- Type: string
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.
- UpdateToken
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'FirewallPolicyResponse' => [ 'Description' => '<string>', 'FirewallPolicyArn' => '<string>', 'FirewallPolicyId' => '<string>', 'FirewallPolicyName' => '<string>', 'FirewallPolicyStatus' => 'ACTIVE|DELETING', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'UpdateToken' => '<string>', ]
Result Details
Members
- FirewallPolicyResponse
-
- Required: Yes
- Type: FirewallPolicyResponse structure
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.
- UpdateToken
-
- Required: Yes
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
The token you provided is stale or isn't valid for the operation.
UpdateFirewallPolicyChangeProtection
$result = $client->updateFirewallPolicyChangeProtection
([/* ... */]); $promise = $client->updateFirewallPolicyChangeProtectionAsync
([/* ... */]);
Parameter Syntax
$result = $client->updateFirewallPolicyChangeProtection([ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'FirewallPolicyChangeProtection' => true || false, // REQUIRED 'UpdateToken' => '<string>', ]);
Parameter Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
- FirewallPolicyChangeProtection
-
- Required: Yes
- Type: boolean
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
. - UpdateToken
-
- Type: string
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.
Result Syntax
[ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'FirewallPolicyChangeProtection' => true || false, 'UpdateToken' => '<string>', ]
Result Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- FirewallName
-
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- FirewallPolicyChangeProtection
-
- Type: boolean
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
. - UpdateToken
-
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
The token you provided is stale or isn't valid for the operation.
UpdateLoggingConfiguration
$result = $client->updateLoggingConfiguration
([/* ... */]); $promise = $client->updateLoggingConfigurationAsync
([/* ... */]);
Sets the logging configuration for the specified firewall.
To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.
You can perform only one of the following actions in any call to UpdateLoggingConfiguration
:
-
Create a new log destination object by adding a single
LogDestinationConfig
array element toLogDestinationConfigs
. -
Delete a log destination object by removing a single
LogDestinationConfig
array element fromLogDestinationConfigs
. -
Change the
LogDestination
setting in a singleLogDestinationConfig
array element.
You can't change the LogDestinationType
or LogType
in a LogDestinationConfig
. To change these settings, delete the existing LogDestinationConfig
object and create a new one, using two separate calls to this update operation.
Parameter Syntax
$result = $client->updateLoggingConfiguration([ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'LoggingConfiguration' => [ 'LogDestinationConfigs' => [ // REQUIRED [ 'LogDestination' => ['<string>', ...], // REQUIRED 'LogDestinationType' => 'S3|CloudWatchLogs|KinesisDataFirehose', // REQUIRED 'LogType' => 'ALERT|FLOW', // REQUIRED ], // ... ], ], ]);
Parameter Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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
-
- Type: LoggingConfiguration structure
Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.
Result Syntax
[ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'LoggingConfiguration' => [ 'LogDestinationConfigs' => [ [ 'LogDestination' => ['<string>', ...], 'LogDestinationType' => 'S3|CloudWatchLogs|KinesisDataFirehose', 'LogType' => 'ALERT|FLOW', ], // ... ], ], ]
Result Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- FirewallName
-
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- LoggingConfiguration
-
- Type: LoggingConfiguration structure
Defines how AWS Network Firewall performs logging for a Firewall.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
The token you provided is stale or isn't valid for the operation.
-
LogDestinationPermissionException:
Unable to send logs to a configured logging destination.
UpdateRuleGroup
$result = $client->updateRuleGroup
([/* ... */]); $promise = $client->updateRuleGroupAsync
([/* ... */]);
Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.
To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.
Parameter Syntax
$result = $client->updateRuleGroup([ 'Description' => '<string>', 'DryRun' => true || false, 'RuleGroup' => [ 'RuleVariables' => [ 'IPSets' => [ '<RuleVariableName>' => [ 'Definition' => ['<string>', ...], // REQUIRED ], // ... ], 'PortSets' => [ '<RuleVariableName>' => [ 'Definition' => ['<string>', ...], ], // ... ], ], 'RulesSource' => [ // REQUIRED 'RulesSourceList' => [ 'GeneratedRulesType' => 'ALLOWLIST|DENYLIST', // REQUIRED 'TargetTypes' => ['<string>', ...], // REQUIRED 'Targets' => ['<string>', ...], // REQUIRED ], 'RulesString' => '<string>', 'StatefulRules' => [ [ 'Action' => 'PASS|DROP|ALERT', // REQUIRED 'Header' => [ // REQUIRED 'Destination' => '<string>', // REQUIRED 'DestinationPort' => '<string>', // REQUIRED 'Direction' => 'FORWARD|ANY', // REQUIRED 'Protocol' => 'IP|TCP|UDP|ICMP|HTTP|FTP|TLS|SMB|DNS|DCERPC|SSH|SMTP|IMAP|MSN|KRB5|IKEV2|TFTP|NTP|DHCP', // REQUIRED 'Source' => '<string>', // REQUIRED 'SourcePort' => '<string>', // REQUIRED ], 'RuleOptions' => [ // REQUIRED [ 'Keyword' => '<string>', // REQUIRED 'Settings' => ['<string>', ...], ], // ... ], ], // ... ], 'StatelessRulesAndCustomActions' => [ 'CustomActions' => [ [ 'ActionDefinition' => [ // REQUIRED 'PublishMetricAction' => [ 'Dimensions' => [ // REQUIRED [ 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'ActionName' => '<string>', // REQUIRED ], // ... ], 'StatelessRules' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'RuleDefinition' => [ // REQUIRED 'Actions' => ['<string>', ...], // REQUIRED 'MatchAttributes' => [ // REQUIRED 'DestinationPorts' => [ [ 'FromPort' => <integer>, // REQUIRED 'ToPort' => <integer>, // REQUIRED ], // ... ], 'Destinations' => [ [ 'AddressDefinition' => '<string>', // REQUIRED ], // ... ], 'Protocols' => [<integer>, ...], 'SourcePorts' => [ [ 'FromPort' => <integer>, // REQUIRED 'ToPort' => <integer>, // REQUIRED ], // ... ], 'Sources' => [ [ 'AddressDefinition' => '<string>', // REQUIRED ], // ... ], 'TCPFlags' => [ [ 'Flags' => ['<string>', ...], // REQUIRED 'Masks' => ['<string>', ...], ], // ... ], ], ], ], // ... ], ], ], ], 'RuleGroupArn' => '<string>', 'RuleGroupName' => '<string>', 'Rules' => '<string>', 'Type' => 'STATELESS|STATEFUL', 'UpdateToken' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Description
-
- Type: string
A description of the rule group.
- DryRun
-
- Type: boolean
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 toFALSE
, 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. - RuleGroup
-
- Type: RuleGroup structure
An object that defines the rule group rules.
You must provide either this rule group setting or a
Rules
setting, but not both. - RuleGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
- RuleGroupName
-
- Type: string
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.
- Rules
-
- Type: string
The name of a file 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 a file 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 file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call DescribeRuleGroup to retrieve the rule group, Network Firewall returns rules settings inside a RuleGroup object.
- Type
-
- Type: string
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
. - UpdateToken
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'RuleGroupResponse' => [ 'Capacity' => <integer>, 'Description' => '<string>', 'RuleGroupArn' => '<string>', 'RuleGroupId' => '<string>', 'RuleGroupName' => '<string>', 'RuleGroupStatus' => 'ACTIVE|DELETING', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Type' => 'STATELESS|STATEFUL', ], 'UpdateToken' => '<string>', ]
Result Details
Members
- RuleGroupResponse
-
- Required: Yes
- Type: RuleGroupResponse structure
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.
- UpdateToken
-
- Required: Yes
- Type: string
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.
Errors
-
Unable to locate a resource using the parameters that you provided.
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Unable to process the request due to throttling limitations.
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
The token you provided is stale or isn't valid for the operation.
UpdateSubnetChangeProtection
$result = $client->updateSubnetChangeProtection
([/* ... */]); $promise = $client->updateSubnetChangeProtectionAsync
([/* ... */]);
Parameter Syntax
$result = $client->updateSubnetChangeProtection([ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'SubnetChangeProtection' => true || false, // REQUIRED 'UpdateToken' => '<string>', ]);
Parameter Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
- FirewallName
-
- Type: string
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.
- SubnetChangeProtection
-
- Required: Yes
- Type: boolean
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
. - UpdateToken
-
- Type: string
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.
Result Syntax
[ 'FirewallArn' => '<string>', 'FirewallName' => '<string>', 'SubnetChangeProtection' => true || false, 'UpdateToken' => '<string>', ]
Result Details
Members
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- FirewallName
-
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- SubnetChangeProtection
-
- Type: boolean
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
. - UpdateToken
-
- Type: string
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.
Errors
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
-
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
-
Unable to locate a resource using the parameters that you provided.
-
Unable to process the request due to throttling limitations.
-
The token you provided is stale or isn't valid for the operation.
Shapes
ActionDefinition
Description
A custom action to use in stateless rule actions settings. This is used in CustomAction.
Members
- PublishMetricAction
-
- Type: PublishMetricAction structure
Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.
You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.
Address
Description
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
Members
- AddressDefinition
-
- Required: Yes
- Type: string
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4.
Examples:
-
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
192.0.2.44/32
. -
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Attachment
Description
The configuration and status for a single subnet that you've specified for use by the AWS Network Firewall firewall. This is part of the FirewallStatus.
Members
- EndpointId
-
- Type: string
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.
- Status
-
- Type: string
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 isREADY
, 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 exampleCREATING
,DELETING
, orFAILED
. - SubnetId
-
- Type: string
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
CustomAction
Description
An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify.
You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.
You can use custom actions in the following places:
-
In a rule group's StatelessRulesAndCustomActions specification. The custom actions are available for use by name inside the
StatelessRulesAndCustomActions
where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes. -
In a FirewallPolicy specification, in
StatelessCustomActions
. The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.
Members
- ActionDefinition
-
- Required: Yes
- Type: ActionDefinition structure
The custom action associated with the action name.
- ActionName
-
- Required: Yes
- Type: string
The descriptive name of the custom action. You can't change the name of a custom action after you create it.
Dimension
Description
The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics
CustomAction. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.
AWS Network Firewall sets the dimension name to CustomAction
and you provide the dimension value.
For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.
Members
Firewall
Description
The firewall defines the configuration settings for an AWS Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both objects by calling DescribeFirewall.
Members
- DeleteProtection
-
- Type: boolean
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 toTRUE
. - Description
-
- Type: string
A description of the firewall.
- FirewallArn
-
- Type: string
The Amazon Resource Name (ARN) of the firewall.
- FirewallId
-
- Required: Yes
- Type: string
The unique identifier for the firewall.
- FirewallName
-
- Type: string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- FirewallPolicyArn
-
- Required: Yes
- Type: string
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.
- FirewallPolicyChangeProtection
-
- Type: boolean
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
. - SubnetChangeProtection
-
- Type: boolean
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
. - SubnetMappings
-
- Required: Yes
- Type: Array of SubnetMapping structures
The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- Tags
-
- Type: Array of Tag structures
- VpcId
-
- Required: Yes
- Type: string
The unique identifier of the VPC where the firewall is in use.
FirewallMetadata
Description
High-level information about a firewall, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall.
Members
FirewallPolicy
Description
The firewall policy defines the behavior of a firewall using a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
This, along with FirewallPolicyResponse, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
Members
- StatefulRuleGroupReferences
-
- Type: Array of StatefulRuleGroupReference structures
References to the stateless rule groups that are used in the policy. These define the inspection criteria in stateful rules.
- StatelessCustomActions
-
- Type: Array of CustomAction structures
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. - StatelessDefaultActions
-
- Required: Yes
- Type: Array of strings
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
, oraws: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. - StatelessFragmentDefaultActions
-
- Required: Yes
- Type: Array of strings
The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy. If you want non-matching fragmented packets to be forwarded for stateful inspection, specify
aws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws: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. - StatelessRuleGroupReferences
-
- Type: Array of StatelessRuleGroupReference structures
References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
FirewallPolicyMetadata
Description
High-level information about a firewall policy, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
Members
FirewallPolicyResponse
Description
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.
Members
- Description
-
- Type: string
A description of the firewall policy.
- FirewallPolicyArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the firewall policy.
If this response is for a create request that had
DryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource. - FirewallPolicyId
-
- Required: Yes
- Type: string
The unique identifier for the firewall policy.
- FirewallPolicyName
-
- Required: Yes
- Type: string
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
- FirewallPolicyStatus
-
- Type: string
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.
- Tags
-
- Type: Array of Tag structures
The key:value pairs to associate with the resource.
FirewallStatus
Description
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.
Members
- ConfigurationSyncStateSummary
-
- Required: Yes
- Type: string
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. TheStatus
setting indicates firewall readiness. - Status
-
- Required: Yes
- Type: string
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 theConfigurationSyncStateSummary
value isIN_SYNC
and theAttachment
Status
values for all of the configured subnets areREADY
. - SyncStates
-
- Type: Associative array of custom strings keys (AvailabilityZone) to SyncState structures
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
andStatus
, broken down by zone and configuration object.
Header
Description
The 5-tuple criteria for AWS Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a match for the corresponding StatefulRule.
Members
- Destination
-
- Required: Yes
- Type: string
The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY
.Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4.
Examples:
-
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
192.0.2.44/32
. -
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
- DestinationPort
-
- Required: Yes
- Type: string
The destination port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990-1994
. To match with any port, specifyANY
. - Direction
-
- Required: Yes
- Type: string
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 toFORWARD
, the inspection only matches traffic going from the source to the destination. - Protocol
-
- Required: Yes
- Type: string
The protocol to inspect for. To match with any protocol, specify
ANY
. - Source
-
- Required: Yes
- Type: string
The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY
.Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4.
Examples:
-
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify
192.0.2.44/32
. -
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
- SourcePort
-
- Required: Yes
- Type: string
The source port to inspect for. You can specify an individual port, for example
1994
and you can specify a port range, for example1990-1994
. To match with any port, specifyANY
.
IPSet
Description
A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.
Members
InsufficientCapacityException
Description
AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.
Members
InternalServerError
Description
Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.
Members
InvalidOperationException
Description
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.
Members
InvalidRequestException
Description
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
Members
InvalidResourcePolicyException
InvalidTokenException
Description
The token you provided is stale or isn't valid for the operation.
Members
LimitExceededException
Description
Unable to perform the operation because doing so would violate a limit setting.
Members
LogDestinationConfig
Description
Defines where AWS Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
Network Firewall generates logs for stateful rule groups. You can save alert and flow log types. The stateful rules engine records flow logs for all network traffic that it receives. It records alert logs for traffic that matches stateful rules that have the rule action set to DROP
or ALERT
.
Members
- LogDestination
-
- Required: Yes
- Type: Associative array of custom strings keys (HashMapKey) to strings
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 keyprefix
. The following example specifies an Amazon S3 bucket namedDOC-EXAMPLE-BUCKET
and the prefixalerts
:"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 namedalert-log-group
:"LogDestination": { "logGroup": "alert-log-group" }
-
For a Kinesis Data Firehose delivery stream, provide the name of the delivery stream, with key
deliveryStream
. The following example specifies a delivery stream namedalert-delivery-stream
:"LogDestination": { "deliveryStream": "alert-delivery-stream" }
- LogDestinationType
-
- Required: Yes
- Type: string
The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
- LogType
-
- Required: Yes
- Type: string
The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.
LogDestinationPermissionException
LoggingConfiguration
Description
Defines how AWS Network Firewall performs logging for a Firewall.
Members
- LogDestinationConfigs
-
- Required: Yes
- Type: Array of LogDestinationConfig structures
Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups.
MatchAttributes
Description
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.
Members
- DestinationPorts
-
- Type: Array of PortRange structures
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 example1990-1994
. - Destinations
-
- Type: Array of Address structures
The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.
- Protocols
-
- Type: Array of ints
The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). If not specified, this matches with any protocol.
- SourcePorts
-
- Type: Array of PortRange structures
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 example1990-1994
. - Sources
-
- Type: Array of Address structures
The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.
- TCPFlags
-
- Type: Array of TCPFlagField structures
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).
PerObjectStatus
PortRange
Description
A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts
, and DestinationPorts
settings.
Members
PortSet
Description
A set of port ranges for use in the rules in a rule group.
Members
PublishMetricAction
Description
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.
Members
- Dimensions
-
- Required: Yes
- Type: Array of Dimension structures
ResourceNotFoundException
Description
Unable to locate a resource using the parameters that you provided.
Members
ResourceOwnerCheckException
RuleDefinition
Description
The inspection criteria and action for a single stateless rule. AWS Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.
Members
- Actions
-
- Required: Yes
- Type: Array of strings
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 specifyaws:forward_to_sfe
for theStatelessDefaultActions
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 namedMyMetricsAction
, then you could specify the standard actionaws:pass
and the custom action with[“aws:pass”, “MyMetricsAction”]
. - MatchAttributes
-
- Required: Yes
- Type: MatchAttributes structure
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.
RuleGroup
Description
The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
AWS Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
Members
- RuleVariables
-
- Type: RuleVariables structure
Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
- RulesSource
-
- Required: Yes
- Type: RulesSource structure
The stateful rules or stateless rules for the rule group.
RuleGroupMetadata
Description
High-level information about a rule group, returned by ListRuleGroups. You can use the information provided in the metadata to retrieve and manage a rule group.
Members
RuleGroupResponse
Description
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.
Members
- Capacity
-
- Type: int
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 toTRUE
. - Description
-
- Type: string
A description of the rule group.
- RuleGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the rule group.
If this response is for a create request that had
DryRun
set toTRUE
, then this ARN is a placeholder that isn't attached to a valid resource. - RuleGroupId
-
- Required: Yes
- Type: string
The unique identifier for the rule group.
- RuleGroupName
-
- Required: Yes
- Type: string
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
- RuleGroupStatus
-
- Type: string
Detailed information about the current status of a rule group.
- Tags
-
- Type: Array of Tag structures
The key:value pairs to associate with the resource.
- Type
-
- Type: string
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.
RuleOption
Description
Additional settings for a stateful rule. This is part of the StatefulRule configuration.
Members
RuleVariables
Description
Settings that are available for use in the rules in the RuleGroup where this is defined.
Members
RulesSource
Description
The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single RulesSource
. You can use an instance of this for either stateless rules or stateful rules.
Members
- RulesSourceList
-
- Type: RulesSourceList structure
Stateful inspection criteria for a domain list rule group.
- RulesString
-
- Type: string
Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules. Suricata is an open-source network IPS that includes a standard rule-based language for network traffic inspection.
These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.
You can provide the rules from a file that you've stored in an Amazon S3 bucket, or by providing the rules in a Suricata rules string. To import from Amazon S3, provide the fully qualified name of the file that contains the rules definitions. To provide a Suricata rule string, provide the complete, Suricata compatible rule.
- StatefulRules
-
- Type: Array of StatefulRule structures
The 5-tuple stateful inspection criteria. This contains an array of individual 5-tuple stateful rules to be used together in a stateful rule group.
- StatelessRulesAndCustomActions
-
- Type: StatelessRulesAndCustomActions structure
Stateless inspection criteria to be used in a stateless rule group.
RulesSourceList
Description
Stateful inspection criteria for a domain list rule group.
Members
- GeneratedRulesType
-
- Required: Yes
- Type: string
Whether you want to allow or deny access to the domains in your target list.
- TargetTypes
-
- Required: Yes
- Type: Array of strings
- Targets
-
- Required: Yes
- Type: Array of strings
The domains that you want to inspect for in your traffic flows. To provide multiple domains, separate them with commas.
StatefulRule
Description
A single 5-tuple stateful rule, for use in a stateful rule group.
Members
- Action
-
- Required: Yes
- Type: string
Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.
The actions for a stateful rule are defined as follows:
-
PASS - Permits the packets to go to the intended destination.
-
DROP - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
-
ALERT - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the Firewall LoggingConfiguration.
You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with
ALERT
action, verify in the logs that the rule is filtering as you want, then change the action toDROP
.
- Header
-
- Required: Yes
- Type: Header structure
The stateful 5-tuple inspection criteria for this rule, used to inspect traffic flows.
- RuleOptions
-
- Required: Yes
- Type: Array of RuleOption structures
StatefulRuleGroupReference
Description
Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.
Members
StatelessRule
Description
A single stateless rule. This is used in StatelessRulesAndCustomActions.
Members
- Priority
-
- Required: Yes
- Type: int
A setting that 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 eachStatelessRulesAndCustomActions
contains exactly oneStatelessRules
object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any singleStatelessRules
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.
- RuleDefinition
-
- Required: Yes
- Type: RuleDefinition structure
Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
StatelessRuleGroupReference
Description
Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.
Members
- Priority
-
- Required: Yes
- Type: int
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.
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the stateless rule group.
StatelessRulesAndCustomActions
Description
Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules.
Members
- CustomActions
-
- Type: Array of CustomAction structures
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 RuleDefinitionActions
specification. - StatelessRules
-
- Required: Yes
- Type: Array of StatelessRule structures
Defines the set of stateless rules for use in a stateless rule group.
SubnetMapping
Description
The ID for a subnet that you want to associate with the firewall. This is used with CreateFirewall and AssociateSubnets. AWS Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
Members
SyncState
Description
The status of the firewall endpoint and firewall policy configuration for a single VPC subnet.
For each VPC subnet that you associate with a firewall, AWS Network Firewall does the following:
-
Instantiates a firewall endpoint in the subnet, ready to take traffic.
-
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
Members
- Attachment
-
- Type: Attachment structure
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.
- Config
-
- Type: Associative array of custom strings keys (ResourceName) to PerObjectStatus structures
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.
TCPFlagField
Description
TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.
Members
- Flags
-
- Required: Yes
- Type: Array of strings
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 theMasks
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.
- Masks
-
- Type: Array of strings
The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
Tag
Description
A key:value pair associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
Members
- Key
-
- Required: Yes
- Type: string
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.
- Value
-
- Required: Yes
- Type: string
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.
ThrottlingException
Description
Unable to process the request due to throttling limitations.