FirewallPolicyResponse - Amazon Network Firewall
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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 DryRun set to TRUE, 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

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 Amazon KMS encryption configuration settings for your firewall policy.

Type: EncryptionConfiguration object

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

Required: 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

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 Amazon SDKs, see the following: