|
| 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: "Artifact Registry" |
| 16 | +description: |- |
| 17 | + The Artifact Registry VPC SC config that applies to a Project. |
| 18 | +--- |
| 19 | + |
| 20 | +# google\_artifact\_registry\_vpcsc\_config |
| 21 | + |
| 22 | +The Artifact Registry VPC SC config that applies to a Project. |
| 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 VPCSCConfig, see: |
| 28 | + |
| 29 | +* [API documentation](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/VPCSCConfig) |
| 30 | + |
| 31 | +~> **Note:** VPC SC configs are automatically created for a given location. Creating a |
| 32 | +resource of this type will acquire and update the resource that already |
| 33 | +exists at the location. Deleting this resource will remove the config from |
| 34 | +your Terraform state but leave the resource as is. |
| 35 | +## Example Usage - Artifact Registry Vpcsc Config |
| 36 | + |
| 37 | + |
| 38 | +```hcl |
| 39 | +resource "google_artifact_registry_vpcsc_config" "my-config" { |
| 40 | + provider = google-beta |
| 41 | + location = "us-central1" |
| 42 | + vpcsc_policy = "ALLOW" |
| 43 | +} |
| 44 | +``` |
| 45 | + |
| 46 | +## Argument Reference |
| 47 | + |
| 48 | +The following arguments are supported: |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | +- - - |
| 53 | + |
| 54 | + |
| 55 | +* `vpcsc_policy` - |
| 56 | + (Optional) |
| 57 | + The VPC SC policy for project and location. |
| 58 | + Possible values are: `DENY`, `ALLOW`. |
| 59 | + |
| 60 | +* `location` - |
| 61 | + (Optional) |
| 62 | + The name of the location this config is located in. |
| 63 | + |
| 64 | +* `project` - (Optional) The ID of the project in which the resource belongs. |
| 65 | + If it is not provided, the provider project is used. |
| 66 | + |
| 67 | + |
| 68 | +## Attributes Reference |
| 69 | + |
| 70 | +In addition to the arguments listed above, the following computed attributes are exported: |
| 71 | + |
| 72 | +* `id` - an identifier for the resource with format `projects/{{project}}/locations/{{location}}/vpcscConfig` |
| 73 | + |
| 74 | +* `name` - |
| 75 | + The name of the project's VPC SC Config. |
| 76 | + Always of the form: projects/{project}/location/{location}/vpcscConfig |
| 77 | + |
| 78 | + |
| 79 | +## Timeouts |
| 80 | + |
| 81 | +This resource provides the following |
| 82 | +[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: |
| 83 | + |
| 84 | +- `create` - Default is 20 minutes. |
| 85 | +- `update` - Default is 20 minutes. |
| 86 | +- `delete` - Default is 20 minutes. |
| 87 | + |
| 88 | +## Import |
| 89 | + |
| 90 | + |
| 91 | +VPCSCConfig can be imported using any of these accepted formats: |
| 92 | + |
| 93 | +``` |
| 94 | +$ terraform import google_artifact_registry_vpcsc_config.default projects/{{project}}/locations/{{location}}/vpcscConfig/{{name}} |
| 95 | +$ terraform import google_artifact_registry_vpcsc_config.default {{project}}/{{location}}/{{name}} |
| 96 | +$ terraform import google_artifact_registry_vpcsc_config.default {{location}}/{{name}} |
| 97 | +``` |
| 98 | + |
| 99 | +## User Project Overrides |
| 100 | + |
| 101 | +This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override). |
0 commit comments