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.
Contents
- FirewallPolicyArn
-
The Amazon Resource Name (ARN) of the firewall policy.
Note
If this response is for a create request that had
DryRunset toTRUE, then this ARN is a placeholder that isn't attached to a valid resource.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^arn:aws.*Required: Yes
- FirewallPolicyId
-
The unique identifier for the firewall policy.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$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
- ConsumedStatefulDomainCapacity
-
The total number of domain name specifications across all domain list rule groups in the firewall policy that use the
stateful-domain-rulegroupresource type.Type: Integer
Required: No
- ConsumedStatefulRuleCapacity
-
The number of capacity units currently consumed by the policy's stateful rules.
Type: Integer
Required: No
- ConsumedStatelessRuleCapacity
-
The number of capacity units currently consumed by the policy's stateless rules.
Type: Integer
Required: No
- Description
-
A description of the firewall policy.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
^.*$Required: No
- EncryptionConfiguration
-
A complex type that contains the AWS KMS encryption configuration settings for your firewall policy.
Type: EncryptionConfiguration object
Required: No
- Errors
-
Any configuration errors that apply to the firewall policy. Network Firewall detects these errors asynchronously, after you create or update the policy, so an error can appear after the request that caused it has already succeeded. Each entry describes the problem and how to resolve it, and Network Firewall clears it automatically after you resolve the problem.
Type: Array of FirewallPolicyError objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- FirewallPolicyStatus
-
The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.
Type: String
Valid Values:
ACTIVE | DELETING | ERROR | UPDATINGRequired: No
- LastModifiedTime
-
The last time that the firewall policy was changed.
Type: Timestamp
Required: No
- NumberOfAssociations
-
The number of firewalls that are associated with this firewall policy.
Type: Integer
Required: No
- StatusMessage
-
Additional detail about the firewall policy's current status, when applicable. For example, while an Amazon Route 53 Resolver DNS Firewall rule group change is in progress, the status is
UPDATINGand this message is "A DNS Firewall rule group change is in progress."Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Required: No
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: