| Column Name | Column Data Type |
|---|
firewall_policy_arn Input Column
The Amazon Resource Name (ARN) of the firewall policy. You must specify the ARN or the name, and you can specify both. | VARCHAR |
firewall_policy_name Input Column
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it. You must specify the ARN or the name, and you can specify both. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
firewall_policy
The policy for the specified firewall policy. | STRUCT(
"stateless_rule_group_references" STRUCT(
"resource_arn" VARCHAR,
"priority" BIGINT
)[],
"stateless_default_actions" VARCHAR[],
"stateless_fragment_default_actions" VARCHAR[],
"stateless_custom_actions" STRUCT(
"action_name" VARCHAR,
"action_definition" STRUCT(
"publish_metric_action" STRUCT(
"dimensions" STRUCT(
"value" VARCHAR
)[]
)
)
)[],
"stateful_rule_group_references" STRUCT(
"resource_arn" VARCHAR,
"priority" BIGINT,
"override" STRUCT(
"action" VARCHAR
)
)[],
"stateful_default_actions" VARCHAR[],
"stateful_engine_options" STRUCT(
"rule_order" VARCHAR,
"stream_exception_policy" VARCHAR
),
"tls_inspection_configuration_arn" VARCHAR,
"policy_variables" STRUCT(
"rule_variables" MAP(VARCHAR, STRUCT(
"definition" VARCHAR[]
))
)
) |
Show child fields- firewall_policy.policy_variables
Contains variables that you can use to override default Suricata settings in your firewall policy. Show child fields- firewall_policy.policy_variables.rule_variables
The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.
- firewall_policy.stateful_default_actions[]
- firewall_policy.stateful_engine_options
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. Show child fields- firewall_policy.stateful_engine_options.rule_order
Indicates how to manage the order of stateful rule evaluation for the policy. STRICT_ORDER is the default and recommended option. With STRICT_ORDER, provide your rules in the order that you want them to be evaluated. You can then choose one or more default actions for packets that don't match any rules. Choose STRICT_ORDER to have the stateful rules engine determine the evaluation order of your rules. The default action for this rule order is PASS, followed by DROP, REJECT, and ALERT actions. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide. - firewall_policy.stateful_engine_options.stream_exception_policy
Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself. -
DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior. -
CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action. -
REJECT - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
- firewall_policy.stateful_rule_group_references[]
Show child fields- firewall_policy.stateful_rule_group_references[].override
The action that allows the policy owner to override the behavior of the rule group within a policy. Show child fields- firewall_policy.stateful_rule_group_references[].override.action
The action that changes the rule group from DROP to ALERT. This only applies to managed rule groups.
- firewall_policy.stateful_rule_group_references[].priority
An integer setting that indicates the order in which to run the stateful rule groups in a single FirewallPolicy. This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings. 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. 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. - firewall_policy.stateful_rule_group_references[].resource_arn
The Amazon Resource Name (ARN) of the stateful rule group.
- firewall_policy.stateless_custom_actions[]
Show child fields- firewall_policy.stateless_custom_actions[].action_definition
The custom action associated with the action name. Show child fields- firewall_policy.stateless_custom_actions[].action_definition.publish_metric_action
Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published. You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it. Show child fields- firewall_policy.stateless_custom_actions[].action_definition.publish_metric_action.dimensions[]
Show child fields- firewall_policy.stateless_custom_actions[].action_definition.publish_metric_action.dimensions[].value
The value to use in the custom metric dimension.
- firewall_policy.stateless_custom_actions[].action_name
The descriptive name of the custom action. You can't change the name of a custom action after you create it.
- firewall_policy.stateless_default_actions[]
- firewall_policy.stateless_fragment_default_actions[]
- firewall_policy.stateless_rule_group_references[]
Show child fields- firewall_policy.stateless_rule_group_references[].priority
An integer setting that indicates the order in which to run the stateless rule groups in a single FirewallPolicy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy. - firewall_policy.stateless_rule_group_references[].resource_arn
The Amazon Resource Name (ARN) of the stateless rule group.
- firewall_policy.tls_inspection_configuration_arn
The Amazon Resource Name (ARN) of the TLS inspection configuration.
|
firewall_policy_response
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. | STRUCT(
"firewall_policy_name" VARCHAR,
"firewall_policy_arn" VARCHAR,
"firewall_policy_id" VARCHAR,
"description" VARCHAR,
"firewall_policy_status" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"consumed_stateless_rule_capacity" BIGINT,
"consumed_stateful_rule_capacity" BIGINT,
"number_of_associations" BIGINT,
"encryption_configuration" STRUCT(
"key_id" VARCHAR,
"type" VARCHAR
),
"last_modified_time" TIMESTAMP_S
) |
Show child fields- firewall_policy_response.consumed_stateful_rule_capacity
The number of capacity units currently consumed by the policy's stateful rules. - firewall_policy_response.consumed_stateless_rule_capacity
The number of capacity units currently consumed by the policy's stateless rules. - firewall_policy_response.description
A description of the firewall policy. - firewall_policy_response.encryption_configuration
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy. Show child fields- firewall_policy_response.encryption_configuration.key_id
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide. - firewall_policy_response.encryption_configuration.type
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
- firewall_policy_response.firewall_policy_arn
The Amazon Resource Name (ARN) of the firewall policy. 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. - firewall_policy_response.firewall_policy_id
The unique identifier for the firewall policy. - firewall_policy_response.firewall_policy_name
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it. - firewall_policy_response.firewall_policy_status
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. - firewall_policy_response.last_modified_time
The last time that the firewall policy was changed. - firewall_policy_response.number_of_associations
The number of firewalls that are associated with this firewall policy. - firewall_policy_response.tags[]
Show child fields- firewall_policy_response.tags[].key
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. - firewall_policy_response.tags[].value
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.
|
update_token
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. | VARCHAR |