CreateFirewallPolicy
Creates the firewall policy for the firewall according to the specifications.
An AWS Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
Request Syntax
{
"Description": "string",
"DryRun": boolean,
"EncryptionConfiguration": {
"KeyId": "string",
"Type": "string"
},
"FirewallPolicy": {
"PolicyVariables": {
"RuleVariables": {
"string" : {
"Definition": [ "string" ]
}
}
},
"StatefulDefaultActions": [ "string" ],
"StatefulEngineOptions": {
"RuleOrder": "string",
"StreamExceptionPolicy": "string"
},
"StatefulRuleGroupReferences": [
{
"Override": {
"Action": "string"
},
"Priority": number,
"ResourceArn": "string"
}
],
"StatelessCustomActions": [
{
"ActionDefinition": {
"PublishMetricAction": {
"Dimensions": [
{
"Value": "string"
}
]
}
},
"ActionName": "string"
}
],
"StatelessDefaultActions": [ "string" ],
"StatelessFragmentDefaultActions": [ "string" ],
"StatelessRuleGroupReferences": [
{
"Priority": number,
"ResourceArn": "string"
}
],
"TLSInspectionConfigurationArn": "string"
},
"FirewallPolicyName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Description
-
A description of the firewall policy.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
^.*$Required: No
- DryRun
-
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to
TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set toFALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.If set to
FALSE, Network Firewall makes the requested changes to your resources.Type: Boolean
Required: No
- EncryptionConfiguration
-
A complex type that contains settings for encryption of your firewall policy resources.
Type: EncryptionConfiguration object
Required: No
- FirewallPolicy
-
The rule groups and policy actions to use in the firewall policy.
Type: FirewallPolicy object
Required: Yes
- FirewallPolicyName
-
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9-]+$Required: Yes
- Tags
-
The key:value pairs to associate with the resource.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Required: No
Response Syntax
{
"FirewallPolicyResponse": {
"ConsumedStatefulRuleCapacity": number,
"ConsumedStatelessRuleCapacity": number,
"Description": "string",
"EncryptionConfiguration": {
"KeyId": "string",
"Type": "string"
},
"FirewallPolicyArn": "string",
"FirewallPolicyId": "string",
"FirewallPolicyName": "string",
"FirewallPolicyStatus": "string",
"LastModifiedTime": number,
"NumberOfAssociations": number,
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
},
"UpdateToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- FirewallPolicyResponse
-
The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
Type: FirewallPolicyResponse object
- UpdateToken
-
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an
InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InsufficientCapacityException
-
AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.
HTTP Status Code: 500
- InternalServerError
-
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.
HTTP Status Code: 500
- InvalidRequestException
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400
-
- LimitExceededException
-
Unable to perform the operation because doing so would violate a limit setting.
HTTP Status Code: 400
- ThrottlingException
-
Unable to process the request due to throttling limitations.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
