blob: 3cdcf317ef8cd8c8aabcf281f5b2756187b4448a [file] [log] [blame]
---
# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** Type: MMv1 ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in
# .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
subcategory: "Compute Engine"
description: |-
The Compute NetworkFirewallPolicy resource
---
# google\_compute\_network\_firewall\_policy
The Compute NetworkFirewallPolicy resource
<div class = "oics-button" style="float: right; margin: 0 0 -15px">
<a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=network_firewall_policy_full&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
<img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
</a>
</div>
## Example Usage - Network Firewall Policy Full
```hcl
resource "google_compute_network_firewall_policy" "policy" {
name = "tf-test-policy"
description = "Terraform test"
}
```
## Argument Reference
The following arguments are supported:
* `name` -
(Required)
User-provided name of the Network firewall policy. The name should be unique in the project in which the firewall policy is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
- - -
* `description` -
(Optional)
An optional description of this resource. Provide this property when you create the resource.
* `project` - (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
## Attributes Reference
In addition to the arguments listed above, the following computed attributes are exported:
* `id` - an identifier for the resource with format `projects/{{project}}/global/firewallPolicies/{{name}}`
* `creation_timestamp` -
Creation timestamp in RFC3339 text format.
* `network_firewall_policy_id` -
The unique identifier for the resource. This identifier is defined by the server.
* `fingerprint` -
Fingerprint of the resource. This field is used internally during updates of this resource.
* `self_link` -
Server-defined URL for the resource.
* `self_link_with_id` -
Server-defined URL for this resource with the resource id.
* `rule_tuple_count` -
Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
## Timeouts
This resource provides the following
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:
- `create` - Default is 20 minutes.
- `update` - Default is 20 minutes.
- `delete` - Default is 20 minutes.
## Import
NetworkFirewallPolicy can be imported using any of these accepted formats:
* `projects/{{project}}/global/firewallPolicies/{{name}}`
* `{{project}}/{{name}}`
* `{{name}}`
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import NetworkFirewallPolicy using one of the formats above. For example:
```tf
import {
id = "projects/{{project}}/global/firewallPolicies/{{name}}"
to = google_compute_network_firewall_policy.default
}
```
When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), NetworkFirewallPolicy can be imported using one of the formats above. For example:
```
$ terraform import google_compute_network_firewall_policy.default projects/{{project}}/global/firewallPolicies/{{name}}
$ terraform import google_compute_network_firewall_policy.default {{project}}/{{name}}
$ terraform import google_compute_network_firewall_policy.default {{name}}
```
## User Project Overrides
This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).