dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/network-firewall/2020-11-12/service-2.json
Noah Meyerhans db48a53926 New upstream version 1.21.53+repack
2021-10-04 09:33:37 -07:00

2831 lines
162 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"version":"2.0",
"metadata":{
"apiVersion":"2020-11-12",
"endpointPrefix":"network-firewall",
"jsonVersion":"1.0",
"protocol":"json",
"serviceAbbreviation":"Network Firewall",
"serviceFullName":"AWS Network Firewall",
"serviceId":"Network Firewall",
"signatureVersion":"v4",
"signingName":"network-firewall",
"targetPrefix":"NetworkFirewall_20201112",
"uid":"network-firewall-2020-11-12"
},
"operations":{
"AssociateFirewallPolicy":{
"name":"AssociateFirewallPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateFirewallPolicyRequest"},
"output":{"shape":"AssociateFirewallPolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidTokenException"},
{"shape":"InvalidOperationException"}
],
"documentation":"<p>Associates a <a>FirewallPolicy</a> to a <a>Firewall</a>. </p> <p>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. </p>"
},
"AssociateSubnets":{
"name":"AssociateSubnets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateSubnetsRequest"},
"output":{"shape":"AssociateSubnetsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidTokenException"},
{"shape":"InvalidOperationException"},
{"shape":"InsufficientCapacityException"}
],
"documentation":"<p>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. </p> <p>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. </p>"
},
"CreateFirewall":{
"name":"CreateFirewall",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateFirewallRequest"},
"output":{"shape":"CreateFirewallResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerError"},
{"shape":"ThrottlingException"},
{"shape":"InsufficientCapacityException"},
{"shape":"InvalidOperationException"}
],
"documentation":"<p>Creates an AWS Network Firewall <a>Firewall</a> and accompanying <a>FirewallStatus</a> for a VPC. </p> <p>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. </p> <p>After you create a firewall, you can provide additional settings, like the logging configuration. </p> <p>To update the settings for a firewall, you use the operations that apply to the settings themselves, for example <a>UpdateLoggingConfiguration</a>, <a>AssociateSubnets</a>, and <a>UpdateFirewallDeleteProtection</a>. </p> <p>To manage a firewall's tags, use the standard AWS resource tagging operations, <a>ListTagsForResource</a>, <a>TagResource</a>, and <a>UntagResource</a>.</p> <p>To retrieve information about firewalls, use <a>ListFirewalls</a> and <a>DescribeFirewall</a>.</p>"
},
"CreateFirewallPolicy":{
"name":"CreateFirewallPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateFirewallPolicyRequest"},
"output":{"shape":"CreateFirewallPolicyResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"InsufficientCapacityException"}
],
"documentation":"<p>Creates the firewall policy for the firewall according to the specifications. </p> <p>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. </p>"
},
"CreateRuleGroup":{
"name":"CreateRuleGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateRuleGroupRequest"},
"output":{"shape":"CreateRuleGroupResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"InsufficientCapacityException"}
],
"documentation":"<p>Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags. </p> <p>You provide your rule group specification in your request using either <code>RuleGroup</code> or <code>Rules</code>.</p>"
},
"DeleteFirewall":{
"name":"DeleteFirewall",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteFirewallRequest"},
"output":{"shape":"DeleteFirewallResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedOperationException"},
{"shape":"InvalidOperationException"}
],
"documentation":"<p>Deletes the specified <a>Firewall</a> and its <a>FirewallStatus</a>. This operation requires the firewall's <code>DeleteProtection</code> flag to be <code>FALSE</code>. You can't revert this operation. </p> <p>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 <a>DescribeFirewall</a>. 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.</p> <p>To delete a firewall, remove the delete protection if you need to using <a>UpdateFirewallDeleteProtection</a>, then delete the firewall by calling <a>DeleteFirewall</a>. </p>"
},
"DeleteFirewallPolicy":{
"name":"DeleteFirewallPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteFirewallPolicyRequest"},
"output":{"shape":"DeleteFirewallPolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"UnsupportedOperationException"},
{"shape":"InvalidOperationException"}
],
"documentation":"<p>Deletes the specified <a>FirewallPolicy</a>. </p>"
},
"DeleteResourcePolicy":{
"name":"DeleteResourcePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteResourcePolicyRequest"},
"output":{"shape":"DeleteResourcePolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidResourcePolicyException"}
],
"documentation":"<p>Deletes a resource policy that you created in a <a>PutResourcePolicy</a> request. </p>"
},
"DeleteRuleGroup":{
"name":"DeleteRuleGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteRuleGroupRequest"},
"output":{"shape":"DeleteRuleGroupResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"UnsupportedOperationException"},
{"shape":"InvalidOperationException"}
],
"documentation":"<p>Deletes the specified <a>RuleGroup</a>. </p>"
},
"DescribeFirewall":{
"name":"DescribeFirewall",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeFirewallRequest"},
"output":{"shape":"DescribeFirewallResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Returns the data objects for the specified firewall. </p>"
},
"DescribeFirewallPolicy":{
"name":"DescribeFirewallPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeFirewallPolicyRequest"},
"output":{"shape":"DescribeFirewallPolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns the data objects for the specified firewall policy. </p>"
},
"DescribeLoggingConfiguration":{
"name":"DescribeLoggingConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeLoggingConfigurationRequest"},
"output":{"shape":"DescribeLoggingConfigurationResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Returns the logging configuration for the specified firewall. </p>"
},
"DescribeResourcePolicy":{
"name":"DescribeResourcePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeResourcePolicyRequest"},
"output":{"shape":"DescribeResourcePolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves a resource policy that you created in a <a>PutResourcePolicy</a> request. </p>"
},
"DescribeRuleGroup":{
"name":"DescribeRuleGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeRuleGroupRequest"},
"output":{"shape":"DescribeRuleGroupResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns the data objects for the specified rule group. </p>"
},
"DisassociateSubnets":{
"name":"DisassociateSubnets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateSubnetsRequest"},
"output":{"shape":"DisassociateSubnetsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidTokenException"},
{"shape":"InvalidOperationException"}
],
"documentation":"<p>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. </p>"
},
"ListFirewallPolicies":{
"name":"ListFirewallPolicies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListFirewallPoliciesRequest"},
"output":{"shape":"ListFirewallPoliciesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>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. </p>"
},
"ListFirewalls":{
"name":"ListFirewalls",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListFirewallsRequest"},
"output":{"shape":"ListFirewallsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>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.</p> <p>Depending on your setting for max results and the number of firewalls, a single call might not return the full list. </p>"
},
"ListRuleGroups":{
"name":"ListRuleGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListRuleGroupsRequest"},
"output":{"shape":"ListRuleGroupsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>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. </p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>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.</p> <p>You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups. </p>"
},
"PutResourcePolicy":{
"name":"PutResourcePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutResourcePolicyRequest"},
"output":{"shape":"PutResourcePolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidResourcePolicyException"}
],
"documentation":"<p>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. </p> <p>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. </p> <p>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. </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_GetResourceShareInvitations.html\">GetResourceShareInvitations</a> - Returns the Amazon Resource Names (ARNs) of the resource share invitations. </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_AcceptResourceShareInvitation.html\">AcceptResourceShareInvitation</a> - Accepts the share invitation for a specified resource share. </p> </li> </ul> <p>For additional information about resource sharing using RAM, see <a href=\"https://docs.aws.amazon.com/ram/latest/userguide/what-is.html\">AWS Resource Access Manager User Guide</a>.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>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.</p> <p>You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups. </p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>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.</p> <p>You can manage tags for the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups. </p>"
},
"UpdateFirewallDeleteProtection":{
"name":"UpdateFirewallDeleteProtection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateFirewallDeleteProtectionRequest"},
"output":{"shape":"UpdateFirewallDeleteProtectionResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidTokenException"},
{"shape":"ResourceOwnerCheckException"}
],
"documentation":"<p>Modifies the flag, <code>DeleteProtection</code>, which indicates whether it is possible to delete the firewall. If the flag is set to <code>TRUE</code>, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use. </p>"
},
"UpdateFirewallDescription":{
"name":"UpdateFirewallDescription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateFirewallDescriptionRequest"},
"output":{"shape":"UpdateFirewallDescriptionResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidTokenException"}
],
"documentation":"<p>Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it. </p>"
},
"UpdateFirewallPolicy":{
"name":"UpdateFirewallPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateFirewallPolicyRequest"},
"output":{"shape":"UpdateFirewallPolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"InvalidTokenException"}
],
"documentation":"<p>Updates the properties of the specified firewall policy.</p>"
},
"UpdateFirewallPolicyChangeProtection":{
"name":"UpdateFirewallPolicyChangeProtection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateFirewallPolicyChangeProtectionRequest"},
"output":{"shape":"UpdateFirewallPolicyChangeProtectionResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidTokenException"},
{"shape":"ResourceOwnerCheckException"}
],
"documentation":"<p/>"
},
"UpdateLoggingConfiguration":{
"name":"UpdateLoggingConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateLoggingConfigurationRequest"},
"output":{"shape":"UpdateLoggingConfigurationResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidTokenException"},
{"shape":"LogDestinationPermissionException"}
],
"documentation":"<p>Sets the logging configuration for the specified firewall. </p> <p>To change the logging configuration, retrieve the <a>LoggingConfiguration</a> by calling <a>DescribeLoggingConfiguration</a>, then change it and provide the modified object to this update call. You must change the logging configuration one <a>LogDestinationConfig</a> at a time inside the retrieved <a>LoggingConfiguration</a> object. </p> <p>You can perform only one of the following actions in any call to <code>UpdateLoggingConfiguration</code>: </p> <ul> <li> <p>Create a new log destination object by adding a single <code>LogDestinationConfig</code> array element to <code>LogDestinationConfigs</code>.</p> </li> <li> <p>Delete a log destination object by removing a single <code>LogDestinationConfig</code> array element from <code>LogDestinationConfigs</code>.</p> </li> <li> <p>Change the <code>LogDestination</code> setting in a single <code>LogDestinationConfig</code> array element.</p> </li> </ul> <p>You can't change the <code>LogDestinationType</code> or <code>LogType</code> in a <code>LogDestinationConfig</code>. To change these settings, delete the existing <code>LogDestinationConfig</code> object and create a new one, using two separate calls to this update operation.</p>"
},
"UpdateRuleGroup":{
"name":"UpdateRuleGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateRuleGroupRequest"},
"output":{"shape":"UpdateRuleGroupResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"InvalidTokenException"}
],
"documentation":"<p>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. </p> <p>To update a rule group, first call <a>DescribeRuleGroup</a> to retrieve the current <a>RuleGroup</a> object, update the object as needed, and then provide the updated object to this call. </p>"
},
"UpdateSubnetChangeProtection":{
"name":"UpdateSubnetChangeProtection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateSubnetChangeProtectionRequest"},
"output":{"shape":"UpdateSubnetChangeProtectionResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidTokenException"},
{"shape":"ResourceOwnerCheckException"}
],
"documentation":"<p/>"
}
},
"shapes":{
"ActionDefinition":{
"type":"structure",
"members":{
"PublishMetricAction":{
"shape":"PublishMetricAction",
"documentation":"<p>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.</p> <p>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. </p>"
}
},
"documentation":"<p>A custom action to use in stateless rule actions settings. This is used in <a>CustomAction</a>.</p>"
},
"ActionName":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[a-zA-Z0-9]+$"
},
"Address":{
"type":"structure",
"required":["AddressDefinition"],
"members":{
"AddressDefinition":{
"shape":"AddressDefinition",
"documentation":"<p>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. </p> <p>Examples: </p> <ul> <li> <p>To configure Network Firewall to inspect for the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p>"
}
},
"documentation":"<p>A single IP address specification. This is used in the <a>MatchAttributes</a> source and destination specifications.</p>"
},
"AddressDefinition":{
"type":"string",
"max":255,
"min":1,
"pattern":"^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$"
},
"Addresses":{
"type":"list",
"member":{"shape":"Address"}
},
"AssociateFirewallPolicyRequest":{
"type":"structure",
"required":["FirewallPolicyArn"],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallPolicyArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall policy.</p>"
}
}
},
"AssociateFirewallPolicyResponse":{
"type":"structure",
"members":{
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"FirewallPolicyArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall policy.</p>"
},
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
}
}
},
"AssociateSubnetsRequest":{
"type":"structure",
"required":["SubnetMappings"],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"SubnetMappings":{
"shape":"SubnetMappings",
"documentation":"<p>The IDs of the subnets that you want to associate with the firewall. </p>"
}
}
},
"AssociateSubnetsResponse":{
"type":"structure",
"members":{
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"SubnetMappings":{
"shape":"SubnetMappings",
"documentation":"<p>The IDs of the subnets that are associated with the firewall. </p>"
},
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
}
}
},
"Attachment":{
"type":"structure",
"members":{
"SubnetId":{
"shape":"AzSubnet",
"documentation":"<p>The unique identifier of the subnet that you've specified to be used for a firewall endpoint. </p>"
},
"EndpointId":{
"shape":"EndpointId",
"documentation":"<p>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. </p>"
},
"Status":{
"shape":"AttachmentStatus",
"documentation":"<p>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 <code>Config</code> settings. When this value is <code>READY</code>, the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example <code>CREATING</code>, <code>DELETING</code>, or <code>FAILED</code>.</p>"
}
},
"documentation":"<p>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 <a>FirewallStatus</a>.</p>"
},
"AttachmentStatus":{
"type":"string",
"enum":[
"CREATING",
"DELETING",
"SCALING",
"READY"
]
},
"AvailabilityZone":{"type":"string"},
"AzSubnet":{
"type":"string",
"max":128,
"min":1,
"pattern":"^subnet-[0-9a-f]+$"
},
"AzSubnets":{
"type":"list",
"member":{"shape":"AzSubnet"}
},
"Boolean":{"type":"boolean"},
"CollectionMember_String":{"type":"string"},
"ConfigurationSyncState":{
"type":"string",
"enum":[
"PENDING",
"IN_SYNC"
]
},
"CreateFirewallPolicyRequest":{
"type":"structure",
"required":[
"FirewallPolicyName",
"FirewallPolicy"
],
"members":{
"FirewallPolicyName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>"
},
"FirewallPolicy":{
"shape":"FirewallPolicy",
"documentation":"<p>The rule groups and policy actions to use in the firewall policy.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the firewall policy.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The key:value pairs to associate with the resource.</p>"
},
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p> <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to <code>FALSE</code>, 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. </p> <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
}
}
},
"CreateFirewallPolicyResponse":{
"type":"structure",
"required":[
"UpdateToken",
"FirewallPolicyResponse"
],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallPolicyResponse":{
"shape":"FirewallPolicyResponse",
"documentation":"<p>The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. </p>"
}
}
},
"CreateFirewallRequest":{
"type":"structure",
"required":[
"FirewallName",
"FirewallPolicyArn",
"VpcId",
"SubnetMappings"
],
"members":{
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"FirewallPolicyArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the <a>FirewallPolicy</a> that you want to use for the firewall.</p>"
},
"VpcId":{
"shape":"VpcId",
"documentation":"<p>The unique identifier of the VPC where Network Firewall should create the firewall. </p> <p>You can't change this setting after you create the firewall. </p>"
},
"SubnetMappings":{
"shape":"SubnetMappings",
"documentation":"<p>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. </p>"
},
"DeleteProtection":{
"shape":"Boolean",
"documentation":"<p>A flag indicating whether it is possible to delete the firewall. A setting of <code>TRUE</code> indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to <code>TRUE</code>.</p>"
},
"SubnetChangeProtection":{
"shape":"Boolean",
"documentation":"<p>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 <code>TRUE</code>.</p>"
},
"FirewallPolicyChangeProtection":{
"shape":"Boolean",
"documentation":"<p>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 <code>TRUE</code>.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the firewall.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The key:value pairs to associate with the resource.</p>"
}
}
},
"CreateFirewallResponse":{
"type":"structure",
"members":{
"Firewall":{
"shape":"Firewall",
"documentation":"<p>The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints. </p>"
},
"FirewallStatus":{
"shape":"FirewallStatus",
"documentation":"<p>Detailed information about the current status of a <a>Firewall</a>. You can retrieve this for a firewall by calling <a>DescribeFirewall</a> and providing the firewall name and ARN.</p>"
}
}
},
"CreateRuleGroupRequest":{
"type":"structure",
"required":[
"RuleGroupName",
"Type",
"Capacity"
],
"members":{
"RuleGroupName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>"
},
"RuleGroup":{
"shape":"RuleGroup",
"documentation":"<p>An object that defines the rule group rules. </p> <note> <p>You must provide either this rule group setting or a <code>Rules</code> setting, but not both. </p> </note>"
},
"Rules":{
"shape":"RulesString",
"documentation":"<p>A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. </p> <note> <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p> </note> <p>You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a <a>RuleGroup</a> object that Network Firewall has populated from your string. </p>"
},
"Type":{
"shape":"RuleGroupType",
"documentation":"<p>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. </p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the rule group. </p>"
},
"Capacity":{
"shape":"RuleCapacity",
"documentation":"<p>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. </p> <p>You can retrieve the capacity that would be required for a rule group before you create the rule group by calling <a>CreateRuleGroup</a> with <code>DryRun</code> set to <code>TRUE</code>. </p> <note> <p>You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow. </p> </note> <p> <b>Capacity for a stateless rule group</b> </p> <p>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. </p> <p>To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:</p> <ul> <li> <p>A match setting with no criteria specified has a value of 1. </p> </li> <li> <p>A match setting with <code>Any</code> specified has a value of 1. </p> </li> <li> <p>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. </p> </li> </ul> <p>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. </p> <p> <b>Capacity for a stateful rule group</b> </p> <p>For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The key:value pairs to associate with the resource.</p>"
},
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p> <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to <code>FALSE</code>, 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. </p> <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
}
}
},
"CreateRuleGroupResponse":{
"type":"structure",
"required":[
"UpdateToken",
"RuleGroupResponse"
],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"RuleGroupResponse":{
"shape":"RuleGroupResponse",
"documentation":"<p>The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>"
}
}
},
"CustomAction":{
"type":"structure",
"required":[
"ActionName",
"ActionDefinition"
],
"members":{
"ActionName":{
"shape":"ActionName",
"documentation":"<p>The descriptive name of the custom action. You can't change the name of a custom action after you create it.</p>"
},
"ActionDefinition":{
"shape":"ActionDefinition",
"documentation":"<p>The custom action associated with the action name.</p>"
}
},
"documentation":"<p>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. </p> <p>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. </p> <p>You can use custom actions in the following places: </p> <ul> <li> <p>In a rule group's <a>StatelessRulesAndCustomActions</a> specification. The custom actions are available for use by name inside the <code>StatelessRulesAndCustomActions</code> 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. </p> </li> <li> <p>In a <a>FirewallPolicy</a> specification, in <code>StatelessCustomActions</code>. 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. </p> </li> </ul>"
},
"CustomActions":{
"type":"list",
"member":{"shape":"CustomAction"}
},
"DeleteFirewallPolicyRequest":{
"type":"structure",
"members":{
"FirewallPolicyName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallPolicyArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall policy.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
}
}
},
"DeleteFirewallPolicyResponse":{
"type":"structure",
"required":["FirewallPolicyResponse"],
"members":{
"FirewallPolicyResponse":{
"shape":"FirewallPolicyResponse",
"documentation":"<p>The object containing the definition of the <a>FirewallPolicyResponse</a> that you asked to delete. </p>"
}
}
},
"DeleteFirewallRequest":{
"type":"structure",
"members":{
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
}
}
},
"DeleteFirewallResponse":{
"type":"structure",
"members":{
"Firewall":{"shape":"Firewall"},
"FirewallStatus":{"shape":"FirewallStatus"}
}
},
"DeleteResourcePolicyRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete. </p>"
}
}
},
"DeleteResourcePolicyResponse":{
"type":"structure",
"members":{
}
},
"DeleteRuleGroupRequest":{
"type":"structure",
"members":{
"RuleGroupName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"RuleGroupArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the rule group.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"Type":{
"shape":"RuleGroupType",
"documentation":"<p>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. </p> <note> <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p> </note>"
}
}
},
"DeleteRuleGroupResponse":{
"type":"structure",
"required":["RuleGroupResponse"],
"members":{
"RuleGroupResponse":{
"shape":"RuleGroupResponse",
"documentation":"<p>The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>"
}
}
},
"DescribeFirewallPolicyRequest":{
"type":"structure",
"members":{
"FirewallPolicyName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallPolicyArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall policy.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
}
}
},
"DescribeFirewallPolicyResponse":{
"type":"structure",
"required":[
"UpdateToken",
"FirewallPolicyResponse"
],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallPolicyResponse":{
"shape":"FirewallPolicyResponse",
"documentation":"<p>The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. </p>"
},
"FirewallPolicy":{
"shape":"FirewallPolicy",
"documentation":"<p>The policy for the specified firewall policy. </p>"
}
}
},
"DescribeFirewallRequest":{
"type":"structure",
"members":{
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
}
}
},
"DescribeFirewallResponse":{
"type":"structure",
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"Firewall":{
"shape":"Firewall",
"documentation":"<p>The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints. </p>"
},
"FirewallStatus":{
"shape":"FirewallStatus",
"documentation":"<p>Detailed information about the current status of a <a>Firewall</a>. You can retrieve this for a firewall by calling <a>DescribeFirewall</a> and providing the firewall name and ARN.</p>"
}
}
},
"DescribeLoggingConfigurationRequest":{
"type":"structure",
"members":{
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
}
}
},
"DescribeLoggingConfigurationResponse":{
"type":"structure",
"members":{
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"LoggingConfiguration":{"shape":"LoggingConfiguration"}
}
},
"DescribeResourcePolicyRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve. </p>"
}
}
},
"DescribeResourcePolicyResponse":{
"type":"structure",
"members":{
"Policy":{
"shape":"PolicyString",
"documentation":"<p>The AWS Identity and Access Management policy for the resource. </p>"
}
}
},
"DescribeRuleGroupRequest":{
"type":"structure",
"members":{
"RuleGroupName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"RuleGroupArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the rule group.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"Type":{
"shape":"RuleGroupType",
"documentation":"<p>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. </p> <note> <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p> </note>"
}
}
},
"DescribeRuleGroupResponse":{
"type":"structure",
"required":[
"UpdateToken",
"RuleGroupResponse"
],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"RuleGroup":{
"shape":"RuleGroup",
"documentation":"<p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p> <p>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. </p> <p>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. </p>"
},
"RuleGroupResponse":{
"shape":"RuleGroupResponse",
"documentation":"<p>The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>"
}
}
},
"Description":{
"type":"string",
"max":512,
"pattern":"^.*$"
},
"Destination":{
"type":"string",
"max":1024,
"min":1,
"pattern":"^.*$"
},
"Dimension":{
"type":"structure",
"required":["Value"],
"members":{
"Value":{
"shape":"DimensionValue",
"documentation":"<p>The value to use in the custom metric dimension.</p>"
}
},
"documentation":"<p>The value to use in an Amazon CloudWatch custom metric dimension. This is used in the <code>PublishMetrics</code> <a>CustomAction</a>. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric. </p> <p>AWS Network Firewall sets the dimension name to <code>CustomAction</code> and you provide the dimension value. </p> <p>For more information about CloudWatch custom metric dimensions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions\">Publishing Custom Metrics</a> in the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html\">Amazon CloudWatch User Guide</a>.</p>"
},
"DimensionValue":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[a-zA-Z0-9-_ ]+$"
},
"Dimensions":{
"type":"list",
"member":{"shape":"Dimension"},
"max":1,
"min":1
},
"DisassociateSubnetsRequest":{
"type":"structure",
"required":["SubnetIds"],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"SubnetIds":{
"shape":"AzSubnets",
"documentation":"<p>The unique identifiers for the subnets that you want to disassociate. </p>"
}
}
},
"DisassociateSubnetsResponse":{
"type":"structure",
"members":{
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"SubnetMappings":{
"shape":"SubnetMappings",
"documentation":"<p>The IDs of the subnets that are associated with the firewall. </p>"
},
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
}
}
},
"EndpointId":{"type":"string"},
"ErrorMessage":{"type":"string"},
"Firewall":{
"type":"structure",
"required":[
"FirewallPolicyArn",
"VpcId",
"SubnetMappings",
"FirewallId"
],
"members":{
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"FirewallPolicyArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall policy.</p> <p>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. </p>"
},
"VpcId":{
"shape":"VpcId",
"documentation":"<p>The unique identifier of the VPC where the firewall is in use. </p>"
},
"SubnetMappings":{
"shape":"SubnetMappings",
"documentation":"<p>The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone. </p>"
},
"DeleteProtection":{
"shape":"Boolean",
"documentation":"<p>A flag indicating whether it is possible to delete the firewall. A setting of <code>TRUE</code> indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to <code>TRUE</code>.</p>"
},
"SubnetChangeProtection":{
"shape":"Boolean",
"documentation":"<p>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 <code>TRUE</code>.</p>"
},
"FirewallPolicyChangeProtection":{
"shape":"Boolean",
"documentation":"<p>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 <code>TRUE</code>.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the firewall.</p>"
},
"FirewallId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier for the firewall. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p/>"
}
},
"documentation":"<p>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. </p> <p>The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding <a>FirewallStatus</a>. You can retrieve both objects by calling <a>DescribeFirewall</a>.</p>"
},
"FirewallMetadata":{
"type":"structure",
"members":{
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
}
},
"documentation":"<p>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.</p>"
},
"FirewallPolicies":{
"type":"list",
"member":{"shape":"FirewallPolicyMetadata"}
},
"FirewallPolicy":{
"type":"structure",
"required":[
"StatelessDefaultActions",
"StatelessFragmentDefaultActions"
],
"members":{
"StatelessRuleGroupReferences":{
"shape":"StatelessRuleGroupReferences",
"documentation":"<p>References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules. </p>"
},
"StatelessDefaultActions":{
"shape":"StatelessActions",
"documentation":"<p>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 <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>[\"aws:pass\"]</code> or you could specify <code>[\"aws:pass\", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>"
},
"StatelessFragmentDefaultActions":{
"shape":"StatelessActions",
"documentation":"<p>The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>[\"aws:pass\"]</code> or you could specify <code>[\"aws:pass\", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>"
},
"StatelessCustomActions":{
"shape":"CustomActions",
"documentation":"<p>The custom action definitions that are available for use in the firewall policy's <code>StatelessDefaultActions</code> setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.</p>"
},
"StatefulRuleGroupReferences":{
"shape":"StatefulRuleGroupReferences",
"documentation":"<p>References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules. </p>"
},
"StatefulDefaultActions":{
"shape":"StatefulActions",
"documentation":"<p>The default actions to take on a packet that doesn't match any stateful rules.</p>"
},
"StatefulEngineOptions":{
"shape":"StatefulEngineOptions",
"documentation":"<p>Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.</p>"
}
},
"documentation":"<p>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. </p> <p>This, along with <a>FirewallPolicyResponse</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>.</p>"
},
"FirewallPolicyMetadata":{
"type":"structure",
"members":{
"Name":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>"
},
"Arn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall policy.</p>"
}
},
"documentation":"<p>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 <a>DescribeFirewallPolicy</a>. </p>"
},
"FirewallPolicyResponse":{
"type":"structure",
"required":[
"FirewallPolicyName",
"FirewallPolicyArn",
"FirewallPolicyId"
],
"members":{
"FirewallPolicyName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>"
},
"FirewallPolicyArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall policy.</p> <note> <p>If this response is for a create request that had <code>DryRun</code> set to <code>TRUE</code>, then this ARN is a placeholder that isn't attached to a valid resource.</p> </note>"
},
"FirewallPolicyId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier for the firewall policy. </p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the firewall policy.</p>"
},
"FirewallPolicyStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The current status of the firewall policy. You can retrieve this for a firewall policy by calling <a>DescribeFirewallPolicy</a> and providing the firewall policy's name or ARN.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The key:value pairs to associate with the resource.</p>"
},
"ConsumedStatelessRuleCapacity":{
"shape":"RuleCapacity",
"documentation":"<p>The number of capacity units currently consumed by the policy's stateless rules.</p>"
},
"ConsumedStatefulRuleCapacity":{
"shape":"RuleCapacity",
"documentation":"<p>The number of capacity units currently consumed by the policy's stateful rules.</p>"
},
"NumberOfAssociations":{
"shape":"NumberOfAssociations",
"documentation":"<p>The number of firewalls that are associated with this firewall policy.</p>"
}
},
"documentation":"<p>The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. </p>"
},
"FirewallStatus":{
"type":"structure",
"required":[
"Status",
"ConfigurationSyncStateSummary"
],
"members":{
"Status":{
"shape":"FirewallStatusValue",
"documentation":"<p>The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it. This setting is <code>READY</code> only when the <code>ConfigurationSyncStateSummary</code> value is <code>IN_SYNC</code> and the <code>Attachment</code> <code>Status</code> values for all of the configured subnets are <code>READY</code>. </p>"
},
"ConfigurationSyncStateSummary":{
"shape":"ConfigurationSyncState",
"documentation":"<p>The configuration sync state for the firewall. This summarizes the sync states reported in the <code>Config</code> settings for all of the Availability Zones where you have configured the firewall. </p> <p>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. </p> <p>This status must be <code>IN_SYNC</code> for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The <code>Status</code> setting indicates firewall readiness.</p>"
},
"SyncStates":{
"shape":"SyncStates",
"documentation":"<p>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 <code>ConfigurationSyncStateSummary</code> and <code>Status</code>, broken down by zone and configuration object. </p>"
}
},
"documentation":"<p>Detailed information about the current status of a <a>Firewall</a>. You can retrieve this for a firewall by calling <a>DescribeFirewall</a> and providing the firewall name and ARN.</p>"
},
"FirewallStatusValue":{
"type":"string",
"enum":[
"PROVISIONING",
"DELETING",
"READY"
]
},
"Firewalls":{
"type":"list",
"member":{"shape":"FirewallMetadata"}
},
"Flags":{
"type":"list",
"member":{"shape":"TCPFlag"}
},
"GeneratedRulesType":{
"type":"string",
"enum":[
"ALLOWLIST",
"DENYLIST"
]
},
"HashMapKey":{
"type":"string",
"max":50,
"min":3,
"pattern":"^[0-9A-Za-z.\\-_@\\/]+$"
},
"HashMapValue":{
"type":"string",
"max":1024,
"min":1,
"pattern":"[\\s\\S]*$"
},
"Header":{
"type":"structure",
"required":[
"Protocol",
"Source",
"SourcePort",
"Direction",
"Destination",
"DestinationPort"
],
"members":{
"Protocol":{
"shape":"StatefulRuleProtocol",
"documentation":"<p>The protocol to inspect for. To specify all, you can use <code>IP</code>, because all traffic on AWS and on the internet is IP.</p>"
},
"Source":{
"shape":"Source",
"documentation":"<p>The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify <code>ANY</code>. </p> <p>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. </p> <p>Examples: </p> <ul> <li> <p>To configure Network Firewall to inspect for the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p>"
},
"SourcePort":{
"shape":"Port",
"documentation":"<p>The source port to inspect for. You can specify an individual port, for example <code>1994</code> and you can specify a port range, for example <code>1990:1994</code>. To match with any port, specify <code>ANY</code>. </p>"
},
"Direction":{
"shape":"StatefulRuleDirection",
"documentation":"<p>The direction of traffic flow to inspect. If set to <code>ANY</code>, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to <code>FORWARD</code>, the inspection only matches traffic going from the source to the destination. </p>"
},
"Destination":{
"shape":"Destination",
"documentation":"<p>The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify <code>ANY</code>. </p> <p>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. </p> <p>Examples: </p> <ul> <li> <p>To configure Network Firewall to inspect for the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p>"
},
"DestinationPort":{
"shape":"Port",
"documentation":"<p>The destination port to inspect for. You can specify an individual port, for example <code>1994</code> and you can specify a port range, for example <code>1990:1994</code>. To match with any port, specify <code>ANY</code>. </p>"
}
},
"documentation":"<p>The basic rule 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 <a>StatefulRule</a>. </p>"
},
"IPSet":{
"type":"structure",
"required":["Definition"],
"members":{
"Definition":{
"shape":"VariableDefinitionList",
"documentation":"<p>The list of IP addresses and address ranges, in CIDR notation. </p>"
}
},
"documentation":"<p>A list of IP addresses and address ranges, in CIDR notation. This is part of a <a>RuleVariables</a>. </p>"
},
"IPSets":{
"type":"map",
"key":{"shape":"RuleVariableName"},
"value":{"shape":"IPSet"}
},
"InsufficientCapacityException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>AWS doesn't currently have enough available capacity to fulfill your request. Try your request later. </p>",
"exception":true,
"fault":true
},
"InternalServerError":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request. </p>",
"exception":true,
"fault":true
},
"InvalidOperationException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>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.</p>",
"exception":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The operation failed because of a problem with your request. Examples include: </p> <ul> <li> <p>You specified an unsupported parameter name or value.</p> </li> <li> <p>You tried to update a property with a value that isn't among the available types.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.</p> </li> </ul>",
"exception":true
},
"InvalidResourcePolicyException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The policy statement failed validation.</p>",
"exception":true
},
"InvalidTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The token you provided is stale or isn't valid for the operation. </p>",
"exception":true
},
"Keyword":{
"type":"string",
"max":128,
"min":1,
"pattern":".*"
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Unable to perform the operation because doing so would violate a limit setting. </p>",
"exception":true
},
"ListFirewallPoliciesRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
},
"MaxResults":{
"shape":"PaginationMaxResults",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
}
}
},
"ListFirewallPoliciesResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
},
"FirewallPolicies":{
"shape":"FirewallPolicies",
"documentation":"<p>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. </p>"
}
}
},
"ListFirewallsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
},
"VpcIds":{
"shape":"VpcIds",
"documentation":"<p>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.</p>"
},
"MaxResults":{
"shape":"PaginationMaxResults",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
}
}
},
"ListFirewallsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
},
"Firewalls":{
"shape":"Firewalls",
"documentation":"<p>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. </p>"
}
}
},
"ListRuleGroupsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
},
"MaxResults":{
"shape":"PaginationMaxResults",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
}
}
},
"ListRuleGroupsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
},
"RuleGroups":{
"shape":"RuleGroups",
"documentation":"<p>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. </p>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
},
"MaxResults":{
"shape":"TagsPaginationMaxResults",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
},
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags that are associated with the resource. </p>"
}
}
},
"LogDestinationConfig":{
"type":"structure",
"required":[
"LogType",
"LogDestinationType",
"LogDestination"
],
"members":{
"LogType":{
"shape":"LogType",
"documentation":"<p>The type of log to send. Alert logs report traffic that matches a <a>StatefulRule</a> with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs. </p>"
},
"LogDestinationType":{
"shape":"LogDestinationType",
"documentation":"<p>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.</p>"
},
"LogDestination":{
"shape":"LogDestinationMap",
"documentation":"<p>The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type. </p> <ul> <li> <p>For an Amazon S3 bucket, provide the name of the bucket, with key <code>bucketName</code>, and optionally provide a prefix, with key <code>prefix</code>. The following example specifies an Amazon S3 bucket named <code>DOC-EXAMPLE-BUCKET</code> and the prefix <code>alerts</code>: </p> <p> <code>\"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\" }</code> </p> </li> <li> <p>For a CloudWatch log group, provide the name of the CloudWatch log group, with key <code>logGroup</code>. The following example specifies a log group named <code>alert-log-group</code>: </p> <p> <code>\"LogDestination\": { \"logGroup\": \"alert-log-group\" }</code> </p> </li> <li> <p>For a Kinesis Data Firehose delivery stream, provide the name of the delivery stream, with key <code>deliveryStream</code>. The following example specifies a delivery stream named <code>alert-delivery-stream</code>: </p> <p> <code>\"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\" }</code> </p> </li> </ul>"
}
},
"documentation":"<p>Defines where AWS Network Firewall sends logs for the firewall for one log type. This is used in <a>LoggingConfiguration</a>. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.</p> <p>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 <code>DROP</code> or <code>ALERT</code>. </p>"
},
"LogDestinationConfigs":{
"type":"list",
"member":{"shape":"LogDestinationConfig"}
},
"LogDestinationMap":{
"type":"map",
"key":{"shape":"HashMapKey"},
"value":{"shape":"HashMapValue"}
},
"LogDestinationPermissionException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Unable to send logs to a configured logging destination. </p>",
"exception":true
},
"LogDestinationType":{
"type":"string",
"enum":[
"S3",
"CloudWatchLogs",
"KinesisDataFirehose"
],
"max":30,
"min":2,
"pattern":"[0-9A-Za-z]+"
},
"LogType":{
"type":"string",
"enum":[
"ALERT",
"FLOW"
]
},
"LoggingConfiguration":{
"type":"structure",
"required":["LogDestinationConfigs"],
"members":{
"LogDestinationConfigs":{
"shape":"LogDestinationConfigs",
"documentation":"<p>Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups. </p>"
}
},
"documentation":"<p>Defines how AWS Network Firewall performs logging for a <a>Firewall</a>. </p>"
},
"MatchAttributes":{
"type":"structure",
"members":{
"Sources":{
"shape":"Addresses",
"documentation":"<p>The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address. </p>"
},
"Destinations":{
"shape":"Addresses",
"documentation":"<p>The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address. </p>"
},
"SourcePorts":{
"shape":"PortRanges",
"documentation":"<p>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). </p> <p>You can specify individual ports, for example <code>1994</code> and you can specify port ranges, for example <code>1990:1994</code>. </p>"
},
"DestinationPorts":{
"shape":"PortRanges",
"documentation":"<p>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). </p> <p>You can specify individual ports, for example <code>1994</code> and you can specify port ranges, for example <code>1990:1994</code>. </p>"
},
"Protocols":{
"shape":"ProtocolNumbers",
"documentation":"<p>The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). If not specified, this matches with any protocol. </p>"
},
"TCPFlags":{
"shape":"TCPFlags",
"documentation":"<p>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).</p>"
}
},
"documentation":"<p>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. </p>"
},
"NumberOfAssociations":{"type":"integer"},
"PaginationMaxResults":{
"type":"integer",
"max":100,
"min":1
},
"PaginationToken":{
"type":"string",
"max":2048,
"min":1,
"pattern":"[0-9A-Za-z:\\/+=]+$"
},
"PerObjectStatus":{
"type":"structure",
"members":{
"SyncStatus":{
"shape":"PerObjectSyncStatus",
"documentation":"<p>Indicates whether this object is in sync with the version indicated in the update token.</p>"
},
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>The current version of the object that is either in sync or pending synchronization. </p>"
}
},
"documentation":"<p>Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a <a>SyncState</a> for a firewall.</p>"
},
"PerObjectSyncStatus":{
"type":"string",
"enum":[
"PENDING",
"IN_SYNC"
]
},
"PolicyString":{
"type":"string",
"max":395000,
"min":1,
"pattern":".*\\S.*"
},
"Port":{
"type":"string",
"max":1024,
"min":1,
"pattern":"^.*$"
},
"PortRange":{
"type":"structure",
"required":[
"FromPort",
"ToPort"
],
"members":{
"FromPort":{
"shape":"PortRangeBound",
"documentation":"<p>The lower limit of the port range. This must be less than or equal to the <code>ToPort</code> specification. </p>"
},
"ToPort":{
"shape":"PortRangeBound",
"documentation":"<p>The upper limit of the port range. This must be greater than or equal to the <code>FromPort</code> specification. </p>"
}
},
"documentation":"<p>A single port range specification. This is used for source and destination port ranges in the stateless rule <a>MatchAttributes</a>, <code>SourcePorts</code>, and <code>DestinationPorts</code> settings. </p>"
},
"PortRangeBound":{
"type":"integer",
"max":65535,
"min":0
},
"PortRanges":{
"type":"list",
"member":{"shape":"PortRange"}
},
"PortSet":{
"type":"structure",
"members":{
"Definition":{
"shape":"VariableDefinitionList",
"documentation":"<p>The set of port ranges. </p>"
}
},
"documentation":"<p>A set of port ranges for use in the rules in a rule group. </p>"
},
"PortSets":{
"type":"map",
"key":{"shape":"RuleVariableName"},
"value":{"shape":"PortSet"}
},
"Priority":{
"type":"integer",
"max":65535,
"min":1
},
"ProtocolNumber":{
"type":"integer",
"max":255,
"min":0
},
"ProtocolNumbers":{
"type":"list",
"member":{"shape":"ProtocolNumber"}
},
"PublishMetricAction":{
"type":"structure",
"required":["Dimensions"],
"members":{
"Dimensions":{
"shape":"Dimensions",
"documentation":"<p/>"
}
},
"documentation":"<p>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.</p>"
},
"PutResourcePolicyRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Policy"
],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the account that you want to share rule groups and firewall policies with.</p>"
},
"Policy":{
"shape":"PolicyString",
"documentation":"<p>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. </p> <p>For a rule group resource, you can specify the following operations in the Actions section of the statement:</p> <ul> <li> <p>network-firewall:CreateFirewallPolicy</p> </li> <li> <p>network-firewall:UpdateFirewallPolicy</p> </li> <li> <p>network-firewall:ListRuleGroups</p> </li> </ul> <p>For a firewall policy resource, you can specify the following operations in the Actions section of the statement:</p> <ul> <li> <p>network-firewall:CreateFirewall</p> </li> <li> <p>network-firewall:UpdateFirewall</p> </li> <li> <p>network-firewall:AssociateFirewallPolicy</p> </li> <li> <p>network-firewall:ListFirewallPolicies</p> </li> </ul> <p>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 <code>Arn</code>.</p>"
}
}
},
"PutResourcePolicyResponse":{
"type":"structure",
"members":{
}
},
"ResourceArn":{
"type":"string",
"max":256,
"min":1,
"pattern":"^arn:aws.*"
},
"ResourceId":{
"type":"string",
"max":36,
"min":36,
"pattern":"^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$"
},
"ResourceName":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[a-zA-Z0-9-]+$"
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Unable to locate a resource using the parameters that you provided.</p>",
"exception":true
},
"ResourceOwnerCheckException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Unable to change the resource because your account doesn't own it. </p>",
"exception":true
},
"ResourceStatus":{
"type":"string",
"enum":[
"ACTIVE",
"DELETING"
]
},
"RuleCapacity":{"type":"integer"},
"RuleDefinition":{
"type":"structure",
"required":[
"MatchAttributes",
"Actions"
],
"members":{
"MatchAttributes":{
"shape":"MatchAttributes",
"documentation":"<p>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. </p>"
},
"Actions":{
"shape":"StatelessActions",
"documentation":"<p>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. </p> <note> <p>Network Firewall only forwards a packet for stateful rule inspection if you specify <code>aws:forward_to_sfe</code> for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify <code>aws:forward_to_sfe</code> for the <code>StatelessDefaultActions</code> setting for the <a>FirewallPolicy</a>.</p> </note> <p>For every rule, you must specify exactly one of the following standard actions. </p> <ul> <li> <p> <b>aws:pass</b> - Discontinues all inspection of the packet and permits it to go to its intended destination.</p> </li> <li> <p> <b>aws:drop</b> - Discontinues all inspection of the packet and blocks it from going to its intended destination.</p> </li> <li> <p> <b>aws:forward_to_sfe</b> - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection. </p> </li> </ul> <p>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 <code>Actions</code> setting. For information about the options, see <a>CustomAction</a>. </p> <p>To provide more than one action in this setting, separate the settings with a comma. For example, if you have a custom <code>PublishMetrics</code> action that you've named <code>MyMetricsAction</code>, then you could specify the standard action <code>aws:pass</code> and the custom action with <code>[“aws:pass”, “MyMetricsAction”]</code>. </p>"
}
},
"documentation":"<p>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.</p>"
},
"RuleGroup":{
"type":"structure",
"required":["RulesSource"],
"members":{
"RuleVariables":{
"shape":"RuleVariables",
"documentation":"<p>Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups. </p>"
},
"RulesSource":{
"shape":"RulesSource",
"documentation":"<p>The stateful rules or stateless rules for the rule group. </p>"
},
"StatefulRuleOptions":{
"shape":"StatefulRuleOptions",
"documentation":"<p>Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.</p>"
}
},
"documentation":"<p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p> <p>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. </p> <p>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. </p>"
},
"RuleGroupMetadata":{
"type":"structure",
"members":{
"Name":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>"
},
"Arn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the rule group.</p>"
}
},
"documentation":"<p>High-level information about a rule group, returned by <a>ListRuleGroups</a>. You can use the information provided in the metadata to retrieve and manage a rule group.</p>"
},
"RuleGroupResponse":{
"type":"structure",
"required":[
"RuleGroupArn",
"RuleGroupName",
"RuleGroupId"
],
"members":{
"RuleGroupArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the rule group.</p> <note> <p>If this response is for a create request that had <code>DryRun</code> set to <code>TRUE</code>, then this ARN is a placeholder that isn't attached to a valid resource.</p> </note>"
},
"RuleGroupName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>"
},
"RuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier for the rule group. </p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the rule group. </p>"
},
"Type":{
"shape":"RuleGroupType",
"documentation":"<p>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. </p>"
},
"Capacity":{
"shape":"RuleCapacity",
"documentation":"<p>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. </p> <p>You can retrieve the capacity that would be required for a rule group before you create the rule group by calling <a>CreateRuleGroup</a> with <code>DryRun</code> set to <code>TRUE</code>. </p>"
},
"RuleGroupStatus":{
"shape":"ResourceStatus",
"documentation":"<p>Detailed information about the current status of a rule group. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The key:value pairs to associate with the resource.</p>"
},
"ConsumedCapacity":{
"shape":"RuleCapacity",
"documentation":"<p>The number of capacity units currently consumed by the rule group rules. </p>"
},
"NumberOfAssociations":{
"shape":"NumberOfAssociations",
"documentation":"<p>The number of firewall policies that use this rule group.</p>"
}
},
"documentation":"<p>The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>"
},
"RuleGroupType":{
"type":"string",
"enum":[
"STATELESS",
"STATEFUL"
]
},
"RuleGroups":{
"type":"list",
"member":{"shape":"RuleGroupMetadata"}
},
"RuleOption":{
"type":"structure",
"required":["Keyword"],
"members":{
"Keyword":{
"shape":"Keyword",
"documentation":"<p/>"
},
"Settings":{
"shape":"Settings",
"documentation":"<p/>"
}
},
"documentation":"<p>Additional settings for a stateful rule. This is part of the <a>StatefulRule</a> configuration.</p>"
},
"RuleOptions":{
"type":"list",
"member":{"shape":"RuleOption"}
},
"RuleOrder":{
"type":"string",
"enum":[
"DEFAULT_ACTION_ORDER",
"STRICT_ORDER"
]
},
"RuleTargets":{
"type":"list",
"member":{"shape":"CollectionMember_String"}
},
"RuleVariableName":{
"type":"string",
"max":32,
"min":1,
"pattern":"^[A-Za-z][A-Za-z0-9_]*$"
},
"RuleVariables":{
"type":"structure",
"members":{
"IPSets":{
"shape":"IPSets",
"documentation":"<p>A list of IP addresses and address ranges, in CIDR notation. </p>"
},
"PortSets":{
"shape":"PortSets",
"documentation":"<p>A list of port ranges. </p>"
}
},
"documentation":"<p>Settings that are available for use in the rules in the <a>RuleGroup</a> where this is defined. </p>"
},
"RulesSource":{
"type":"structure",
"members":{
"RulesString":{
"shape":"RulesString",
"documentation":"<p>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.</p> <p>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.</p>"
},
"RulesSourceList":{
"shape":"RulesSourceList",
"documentation":"<p>Stateful inspection criteria for a domain list rule group. </p>"
},
"StatefulRules":{
"shape":"StatefulRules",
"documentation":"<p>An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata <code>Rules</code> format, see <a href=\"https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#\">Rules Format</a>. </p>"
},
"StatelessRulesAndCustomActions":{
"shape":"StatelessRulesAndCustomActions",
"documentation":"<p>Stateless inspection criteria to be used in a stateless rule group. </p>"
}
},
"documentation":"<p>The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single <code>RulesSource</code>. You can use an instance of this for either stateless rules or stateful rules. </p>"
},
"RulesSourceList":{
"type":"structure",
"required":[
"Targets",
"TargetTypes",
"GeneratedRulesType"
],
"members":{
"Targets":{
"shape":"RuleTargets",
"documentation":"<p>The domains that you want to inspect for in your traffic flows. To provide multiple domains, separate them with commas. Valid domain specifications are the following:</p> <ul> <li> <p>Explicit names. For example, <code>abc.example.com</code> matches only the domain <code>abc.example.com</code>.</p> </li> <li> <p>Names that use a domain wildcard, which you indicate with an initial '<code>.</code>'. For example,<code>.example.com</code> matches <code>example.com</code> and matches all subdomains of <code>example.com</code>, such as <code>abc.example.com</code> and <code>www.example.com</code>. </p> </li> </ul>"
},
"TargetTypes":{
"shape":"TargetTypes",
"documentation":"<p>The protocols you want to inspect. Specify <code>TLS_SNI</code> for <code>HTTPS</code>. Specify <code>HTTP_HOST</code> for <code>HTTP</code>. You can specify either or both. </p>"
},
"GeneratedRulesType":{
"shape":"GeneratedRulesType",
"documentation":"<p>Whether you want to allow or deny access to the domains in your target list.</p>"
}
},
"documentation":"<p>Stateful inspection criteria for a domain list rule group. </p> <p>For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.</p> <p>By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the <code>HOME_NET</code> rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see <a>RuleVariables</a> in this guide and <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html\">Stateful domain list rule groups in AWS Network Firewall</a> in the <i>Network Firewall Developer Guide</i>.</p>"
},
"RulesString":{
"type":"string",
"max":2000000,
"min":0
},
"Setting":{
"type":"string",
"max":8192,
"min":1,
"pattern":".*"
},
"Settings":{
"type":"list",
"member":{"shape":"Setting"}
},
"Source":{
"type":"string",
"max":1024,
"min":1,
"pattern":"^.*$"
},
"StatefulAction":{
"type":"string",
"enum":[
"PASS",
"DROP",
"ALERT"
]
},
"StatefulActions":{
"type":"list",
"member":{"shape":"CollectionMember_String"}
},
"StatefulEngineOptions":{
"type":"structure",
"members":{
"RuleOrder":{
"shape":"RuleOrder",
"documentation":"<p>Indicates how to manage the order of stateful rule evaluation for the policy. By default, Network Firewall leaves the rule evaluation order up to the Suricata rule processing engine. If you set this to <code>STRICT_ORDER</code>, your rules are evaluated in the exact order that you provide them in the policy. With strict ordering, the rule groups are evaluated by order of priority, starting from the lowest number, and the rules in each rule group are processed in the order that they're defined. </p>"
}
},
"documentation":"<p>Configuration settings for the handling of the stateful rule groups in a firewall policy. </p>"
},
"StatefulRule":{
"type":"structure",
"required":[
"Action",
"Header",
"RuleOptions"
],
"members":{
"Action":{
"shape":"StatefulAction",
"documentation":"<p>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. </p> <p>The actions for a stateful rule are defined as follows: </p> <ul> <li> <p> <b>PASS</b> - Permits the packets to go to the intended destination.</p> </li> <li> <p> <b>DROP</b> - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the <a>Firewall</a> <a>LoggingConfiguration</a>. </p> </li> <li> <p> <b>ALERT</b> - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the <a>Firewall</a> <a>LoggingConfiguration</a>. </p> <p>You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with <code>ALERT</code> action, verify in the logs that the rule is filtering as you want, then change the action to <code>DROP</code>.</p> </li> </ul>"
},
"Header":{
"shape":"Header",
"documentation":"<p>The stateful inspection criteria for this rule, used to inspect traffic flows. </p>"
},
"RuleOptions":{
"shape":"RuleOptions",
"documentation":"<p>Additional options for the rule. These are the Suricata <code>RuleOptions</code> settings.</p>"
}
},
"documentation":"<p>A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata <code>Rules</code> format, see <a href=\"https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#\">Rules Format</a>. </p>"
},
"StatefulRuleDirection":{
"type":"string",
"enum":[
"FORWARD",
"ANY"
]
},
"StatefulRuleGroupReference":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the stateful rule group.</p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>An integer setting that indicates the order in which to run the stateful rule groups in a single <a>FirewallPolicy</a>. This setting only applies to firewall policies that specify the <code>STRICT_ORDER</code> rule order in the stateful engine options settings.</p> <p>Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.</p> <p>You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on. </p>",
"box":true
}
},
"documentation":"<p>Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group. </p>"
},
"StatefulRuleGroupReferences":{
"type":"list",
"member":{"shape":"StatefulRuleGroupReference"}
},
"StatefulRuleOptions":{
"type":"structure",
"members":{
"RuleOrder":{
"shape":"RuleOrder",
"documentation":"<p>Indicates how to manage the order of the rule evaluation for the rule group. By default, Network Firewall leaves the rule evaluation order up to the Suricata rule processing engine. If you set this to <code>STRICT_ORDER</code>, your rules are evaluated in the exact order that they're listed in your Suricata rules string. </p>"
}
},
"documentation":"<p>Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.</p>"
},
"StatefulRuleProtocol":{
"type":"string",
"enum":[
"IP",
"TCP",
"UDP",
"ICMP",
"HTTP",
"FTP",
"TLS",
"SMB",
"DNS",
"DCERPC",
"SSH",
"SMTP",
"IMAP",
"MSN",
"KRB5",
"IKEV2",
"TFTP",
"NTP",
"DHCP"
]
},
"StatefulRules":{
"type":"list",
"member":{"shape":"StatefulRule"}
},
"StatelessActions":{
"type":"list",
"member":{"shape":"CollectionMember_String"}
},
"StatelessRule":{
"type":"structure",
"required":[
"RuleDefinition",
"Priority"
],
"members":{
"RuleDefinition":{
"shape":"RuleDefinition",
"documentation":"<p>Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria. </p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>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. </p> <p>Each stateless rule group uses exactly one <code>StatelessRulesAndCustomActions</code> object, and each <code>StatelessRulesAndCustomActions</code> contains exactly one <code>StatelessRules</code> object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single <code>StatelessRules</code> object.</p> <p>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. </p>"
}
},
"documentation":"<p>A single stateless rule. This is used in <a>StatelessRulesAndCustomActions</a>.</p>"
},
"StatelessRuleGroupReference":{
"type":"structure",
"required":[
"ResourceArn",
"Priority"
],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the stateless rule group.</p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>An integer setting that indicates the order in which to run the stateless rule groups in a single <a>FirewallPolicy</a>. 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.</p>"
}
},
"documentation":"<p>Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group. </p>"
},
"StatelessRuleGroupReferences":{
"type":"list",
"member":{"shape":"StatelessRuleGroupReference"}
},
"StatelessRules":{
"type":"list",
"member":{"shape":"StatelessRule"}
},
"StatelessRulesAndCustomActions":{
"type":"structure",
"required":["StatelessRules"],
"members":{
"StatelessRules":{
"shape":"StatelessRules",
"documentation":"<p>Defines the set of stateless rules for use in a stateless rule group. </p>"
},
"CustomActions":{
"shape":"CustomActions",
"documentation":"<p>Defines an array of individual custom action definitions that are available for use by the stateless rules in this <code>StatelessRulesAndCustomActions</code> specification. You name each custom action that you define, and then you can use it by name in your <a>StatelessRule</a> <a>RuleDefinition</a> <code>Actions</code> specification.</p>"
}
},
"documentation":"<p>Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules. </p>"
},
"SubnetMapping":{
"type":"structure",
"required":["SubnetId"],
"members":{
"SubnetId":{
"shape":"CollectionMember_String",
"documentation":"<p>The unique identifier for the subnet. </p>"
}
},
"documentation":"<p>The ID for a subnet that you want to associate with the firewall. This is used with <a>CreateFirewall</a> and <a>AssociateSubnets</a>. 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.</p>"
},
"SubnetMappings":{
"type":"list",
"member":{"shape":"SubnetMapping"}
},
"SyncState":{
"type":"structure",
"members":{
"Attachment":{
"shape":"Attachment",
"documentation":"<p>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 <a>FirewallStatus</a>.</p>"
},
"Config":{
"shape":"SyncStateConfig",
"documentation":"<p>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 <a>FirewallStatus</a>.</p>"
}
},
"documentation":"<p>The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. </p> <p>For each VPC subnet that you associate with a firewall, AWS Network Firewall does the following: </p> <ul> <li> <p>Instantiates a firewall endpoint in the subnet, ready to take traffic.</p> </li> <li> <p>Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.</p> </li> </ul> <p>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. </p>"
},
"SyncStateConfig":{
"type":"map",
"key":{"shape":"ResourceName"},
"value":{"shape":"PerObjectStatus"}
},
"SyncStates":{
"type":"map",
"key":{"shape":"AvailabilityZone"},
"value":{"shape":"SyncState"}
},
"TCPFlag":{
"type":"string",
"enum":[
"FIN",
"SYN",
"RST",
"PSH",
"ACK",
"URG",
"ECE",
"CWR"
]
},
"TCPFlagField":{
"type":"structure",
"required":["Flags"],
"members":{
"Flags":{
"shape":"Flags",
"documentation":"<p>Used in conjunction with the <code>Masks</code> setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the <code>Masks</code> setting.</p> <p>For the flags that are specified in the masks setting, the following must be true for the packet to match: </p> <ul> <li> <p>The ones that are set in this flags setting must be set in the packet. </p> </li> <li> <p>The ones that are not set in this flags setting must also not be set in the packet. </p> </li> </ul>"
},
"Masks":{
"shape":"Flags",
"documentation":"<p>The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.</p>"
}
},
"documentation":"<p>TCP flags and masks to inspect packets for, used in stateless rules <a>MatchAttributes</a> settings.</p>"
},
"TCPFlags":{
"type":"list",
"member":{"shape":"TCPFlagField"}
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>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.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>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. </p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^.*$"
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200,
"min":1
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":200,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p/>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"^.*$"
},
"TagsPaginationMaxResults":{
"type":"integer",
"max":100,
"min":0
},
"TargetType":{
"type":"string",
"enum":[
"TLS_SNI",
"HTTP_HOST"
]
},
"TargetTypes":{
"type":"list",
"member":{"shape":"TargetType"}
},
"ThrottlingException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Unable to process the request due to throttling limitations.</p>",
"exception":true
},
"UnsupportedOperationException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The operation you requested isn't supported by Network Firewall. </p>",
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p/>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateFirewallDeleteProtectionRequest":{
"type":"structure",
"required":["DeleteProtection"],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"DeleteProtection":{
"shape":"Boolean",
"documentation":"<p>A flag indicating whether it is possible to delete the firewall. A setting of <code>TRUE</code> indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to <code>TRUE</code>.</p>"
}
}
},
"UpdateFirewallDeleteProtectionResponse":{
"type":"structure",
"members":{
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"DeleteProtection":{
"shape":"Boolean",
"documentation":"<p/>"
},
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
}
}
},
"UpdateFirewallDescriptionRequest":{
"type":"structure",
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.</p>"
}
}
},
"UpdateFirewallDescriptionResponse":{
"type":"structure",
"members":{
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the firewall.</p>"
},
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
}
}
},
"UpdateFirewallPolicyChangeProtectionRequest":{
"type":"structure",
"required":["FirewallPolicyChangeProtection"],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallPolicyChangeProtection":{
"shape":"Boolean",
"documentation":"<p>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 <code>TRUE</code>.</p>"
}
}
},
"UpdateFirewallPolicyChangeProtectionResponse":{
"type":"structure",
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"FirewallPolicyChangeProtection":{
"shape":"Boolean",
"documentation":"<p>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 <code>TRUE</code>.</p>"
}
}
},
"UpdateFirewallPolicyRequest":{
"type":"structure",
"required":[
"UpdateToken",
"FirewallPolicy"
],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallPolicyArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall policy.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallPolicyName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallPolicy":{
"shape":"FirewallPolicy",
"documentation":"<p>The updated firewall policy to use for the firewall. </p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the firewall policy.</p>"
},
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p> <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to <code>FALSE</code>, 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. </p> <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
}
}
},
"UpdateFirewallPolicyResponse":{
"type":"structure",
"required":[
"UpdateToken",
"FirewallPolicyResponse"
],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallPolicyResponse":{
"shape":"FirewallPolicyResponse",
"documentation":"<p>The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. </p>"
}
}
},
"UpdateLoggingConfigurationRequest":{
"type":"structure",
"members":{
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"LoggingConfiguration":{
"shape":"LoggingConfiguration",
"documentation":"<p>Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.</p>"
}
}
},
"UpdateLoggingConfigurationResponse":{
"type":"structure",
"members":{
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"LoggingConfiguration":{"shape":"LoggingConfiguration"}
}
},
"UpdateRuleGroupRequest":{
"type":"structure",
"required":["UpdateToken"],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"RuleGroupArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the rule group.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"RuleGroupName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"RuleGroup":{
"shape":"RuleGroup",
"documentation":"<p>An object that defines the rule group rules. </p> <note> <p>You must provide either this rule group setting or a <code>Rules</code> setting, but not both. </p> </note>"
},
"Rules":{
"shape":"RulesString",
"documentation":"<p>A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. </p> <note> <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p> </note> <p>You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a <a>RuleGroup</a> object that Network Firewall has populated from your string. </p>"
},
"Type":{
"shape":"RuleGroupType",
"documentation":"<p>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. </p> <note> <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p> </note>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the rule group. </p>"
},
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p> <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to <code>FALSE</code>, 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. </p> <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
}
}
},
"UpdateRuleGroupResponse":{
"type":"structure",
"required":[
"UpdateToken",
"RuleGroupResponse"
],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"RuleGroupResponse":{
"shape":"RuleGroupResponse",
"documentation":"<p>The high-level properties of a rule group. This, along with the <a>RuleGroup</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>"
}
}
},
"UpdateSubnetChangeProtectionRequest":{
"type":"structure",
"required":["SubnetChangeProtection"],
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"
},
"SubnetChangeProtection":{
"shape":"Boolean",
"documentation":"<p>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 <code>TRUE</code>.</p>"
}
}
},
"UpdateSubnetChangeProtectionResponse":{
"type":"structure",
"members":{
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>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. </p> <p>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.</p> <p>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 <code>InvalidTokenException</code>. 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. </p>"
},
"FirewallArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p>"
},
"FirewallName":{
"shape":"ResourceName",
"documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
},
"SubnetChangeProtection":{
"shape":"Boolean",
"documentation":"<p>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 <code>TRUE</code>.</p>"
}
}
},
"UpdateToken":{
"type":"string",
"max":1024,
"min":1,
"pattern":"^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$"
},
"VariableDefinition":{
"type":"string",
"min":1,
"pattern":"^.*$"
},
"VariableDefinitionList":{
"type":"list",
"member":{"shape":"VariableDefinition"}
},
"VpcId":{
"type":"string",
"max":128,
"min":1,
"pattern":"^vpc-[0-9a-f]+$"
},
"VpcIds":{
"type":"list",
"member":{"shape":"VpcId"}
}
},
"documentation":"<p>This is the API Reference for AWS Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors. </p> <ul> <li> <p>The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the AWS REST APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">AWS APIs</a>. </p> <p>To access Network Firewall using the REST API endpoint: <code>https://network-firewall.&lt;region&gt;.amazonaws.com </code> </p> </li> <li> <p>Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> </li> <li> <p>For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/\">Network Firewall Developer Guide</a>.</p> </li> </ul> <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source intrusion detection system (IDS) engine. AWS Network Firewall supports Suricata version 5.0.2. For information about Suricata, see the <a href=\"https://suricata-ids.org/\">Suricata website</a>.</p> <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples: </p> <ul> <li> <p>Allow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and block all other forms of traffic.</p> </li> <li> <p>Use custom lists of known bad domains to limit the types of domain names that your applications can access.</p> </li> <li> <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p> </li> <li> <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.</p> </li> </ul> <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/\">Amazon VPC User Guide</a>.</p> <p>To start using Network Firewall, do the following: </p> <ol> <li> <p>(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC. </p> </li> <li> <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall. </p> </li> <li> <p>In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have. </p> </li> <li> <p>In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior. </p> </li> <li> <p>In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.</p> </li> <li> <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.</p> </li> </ol>"
}
Reference in a new issue View git blame Copy permalink