|
| 1 | +--- |
| 2 | +# ---------------------------------------------------------------------------- |
| 3 | +# |
| 4 | +# *** AUTO GENERATED CODE *** Type: MMv1 *** |
| 5 | +# |
| 6 | +# ---------------------------------------------------------------------------- |
| 7 | +# |
| 8 | +# This file is automatically generated by Magic Modules and manual |
| 9 | +# changes will be clobbered when the file is regenerated. |
| 10 | +# |
| 11 | +# Please read more about how to change this file in |
| 12 | +# .github/CONTRIBUTING.md. |
| 13 | +# |
| 14 | +# ---------------------------------------------------------------------------- |
| 15 | +subcategory: "Network security" |
| 16 | +description: |- |
| 17 | + UrlList proto helps users to set reusable, independently manageable lists of hosts, host patterns, URLs, URL patterns. |
| 18 | +--- |
| 19 | + |
| 20 | +# google\_network\_security\_url\_lists |
| 21 | + |
| 22 | +UrlList proto helps users to set reusable, independently manageable lists of hosts, host patterns, URLs, URL patterns. |
| 23 | + |
| 24 | +~> **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. |
| 25 | +See [Provider Versions](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources. |
| 26 | + |
| 27 | +To get more information about UrlLists, see: |
| 28 | + |
| 29 | +* [API documentation](https://cloud.google.com/secure-web-proxy/docs/reference/network-security/rest/v1alpha1/projects.locations.urlLists) |
| 30 | +* How-to Guides |
| 31 | + * [Use UrlLists]( https://cloud.google.com/secure-web-proxy/docs/use-url-list) |
| 32 | + |
| 33 | +<div class = "oics-button" style="float: right; margin: 0 0 -15px"> |
| 34 | + <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.jpy.wang%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=network_security_url_lists_basic&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank"> |
| 35 | + <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;"> |
| 36 | + </a> |
| 37 | +</div> |
| 38 | +## Example Usage - Network Security Url Lists Basic |
| 39 | + |
| 40 | + |
| 41 | +```hcl |
| 42 | +resource "google_network_security_url_lists" "default" { |
| 43 | + provider = google-beta |
| 44 | + name = "my-url-lists" |
| 45 | + location = "us-central1" |
| 46 | + values = ["www.example.com"] |
| 47 | +} |
| 48 | +``` |
| 49 | +<div class = "oics-button" style="float: right; margin: 0 0 -15px"> |
| 50 | + <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.jpy.wang%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=network_security_url_lists_advanced&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank"> |
| 51 | + <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;"> |
| 52 | + </a> |
| 53 | +</div> |
| 54 | +## Example Usage - Network Security Url Lists Advanced |
| 55 | + |
| 56 | + |
| 57 | +```hcl |
| 58 | +resource "google_network_security_url_lists" "default" { |
| 59 | + provider = google-beta |
| 60 | + name = "my-url-lists" |
| 61 | + location = "us-central1" |
| 62 | + description = "my description" |
| 63 | + values = ["www.example.com", "about.example.com", "github.com/example-org/*"] |
| 64 | +} |
| 65 | +``` |
| 66 | + |
| 67 | +## Argument Reference |
| 68 | + |
| 69 | +The following arguments are supported: |
| 70 | + |
| 71 | + |
| 72 | +* `values` - |
| 73 | + (Required) |
| 74 | + FQDNs and URLs. |
| 75 | + |
| 76 | +* `name` - |
| 77 | + (Required) |
| 78 | + Short name of the UrlList resource to be created. |
| 79 | + This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. 'urlList'. |
| 80 | + |
| 81 | +* `location` - |
| 82 | + (Required) |
| 83 | + The location of the url lists. |
| 84 | + |
| 85 | + |
| 86 | +- - - |
| 87 | + |
| 88 | + |
| 89 | +* `description` - |
| 90 | + (Optional) |
| 91 | + Free-text description of the resource. |
| 92 | + |
| 93 | +* `project` - (Optional) The ID of the project in which the resource belongs. |
| 94 | + If it is not provided, the provider project is used. |
| 95 | + |
| 96 | + |
| 97 | +## Attributes Reference |
| 98 | + |
| 99 | +In addition to the arguments listed above, the following computed attributes are exported: |
| 100 | + |
| 101 | +* `id` - an identifier for the resource with format `projects/{{project}}/locations/{{location}}/urlLists/{{name}}` |
| 102 | + |
| 103 | +* `create_time` - |
| 104 | + Output only. Time when the security policy was created. |
| 105 | + A timestamp in RFC3339 UTC 'Zulu' format, with nanosecond resolution and up to nine fractional digits. |
| 106 | + Examples: '2014-10-02T15:01:23Z' and '2014-10-02T15:01:23.045123456Z' |
| 107 | + |
| 108 | +* `update_time` - |
| 109 | + Output only. Time when the security policy was updated. |
| 110 | + A timestamp in RFC3339 UTC 'Zulu' format, with nanosecond resolution and up to nine fractional digits. |
| 111 | + Examples: '2014-10-02T15:01:23Z' and '2014-10-02T15:01:23.045123456Z'. |
| 112 | + |
| 113 | + |
| 114 | +## Timeouts |
| 115 | + |
| 116 | +This resource provides the following |
| 117 | +[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: |
| 118 | + |
| 119 | +- `create` - Default is 30 minutes. |
| 120 | +- `update` - Default is 30 minutes. |
| 121 | +- `delete` - Default is 30 minutes. |
| 122 | + |
| 123 | +## Import |
| 124 | + |
| 125 | + |
| 126 | +UrlLists can be imported using any of these accepted formats: |
| 127 | + |
| 128 | +``` |
| 129 | +$ terraform import google_network_security_url_lists.default projects/{{project}}/locations/{{location}}/urlLists/{{name}} |
| 130 | +$ terraform import google_network_security_url_lists.default {{project}}/{{location}}/{{name}} |
| 131 | +$ terraform import google_network_security_url_lists.default {{location}}/{{name}} |
| 132 | +``` |
| 133 | + |
| 134 | +## User Project Overrides |
| 135 | + |
| 136 | +This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override). |
0 commit comments