| --- |
| # ---------------------------------------------------------------------------- |
| # |
| # *** 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: "Document AI Warehouse" |
| description: |- |
| A location is used to initialize a project. |
| --- |
| |
| # google\_document\_ai\_warehouse\_location |
| |
| A location is used to initialize a project. |
| |
| |
| To get more information about Location, see: |
| |
| * [API documentation](https://cloud.google.com/document-warehouse/docs/reference/rest/v1/projects.locations) |
| * How-to Guides |
| * [Official Documentation](https://cloud.google.com/document-warehouse/docs/overview) |
| |
| <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=document_ai_warehouse_location&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 - Document Ai Warehouse Location |
| |
| |
| ```hcl |
| resource "google_document_ai_warehouse_location" "example" { |
| location = "us" |
| project_number = data.google_project.project.number |
| access_control_mode = "ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI" |
| database_type = "DB_INFRA_SPANNER" |
| kms_key = "dummy_key" |
| document_creator_default_role = "DOCUMENT_ADMIN" |
| } |
| |
| data "google_project" "project" { |
| } |
| ``` |
| |
| ## Argument Reference |
| |
| The following arguments are supported: |
| |
| |
| * `database_type` - |
| (Required) |
| The type of database used to store customer data. |
| Possible values are: `DB_INFRA_SPANNER`, `DB_CLOUD_SQL_POSTGRES`. |
| |
| * `access_control_mode` - |
| (Required) |
| The access control mode for accessing the customer data. |
| Possible values are: `ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI`, `ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID`, `ACL_MODE_UNIVERSAL_ACCESS`. |
| |
| * `project_number` - |
| (Required) |
| The unique identifier of the project. |
| |
| * `location` - |
| (Required) |
| The location in which the instance is to be provisioned. It takes the form projects/{projectNumber}/locations/{location}. |
| |
| |
| - - - |
| |
| |
| * `kms_key` - |
| (Optional) |
| The KMS key used for CMEK encryption. It is required that |
| the kms key is in the same region as the endpoint. The |
| same key will be used for all provisioned resources, if |
| encryption is available. If the kmsKey is left empty, no |
| encryption will be enforced. |
| |
| * `document_creator_default_role` - |
| (Optional) |
| The default role for the person who create a document. |
| Possible values are: `DOCUMENT_ADMIN`, `DOCUMENT_EDITOR`, `DOCUMENT_VIEWER`. |
| |
| |
| ## 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_number}}/locations/{{location}}` |
| |
| |
| ## Timeouts |
| |
| This resource provides the following |
| [Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: |
| |
| - `create` - Default is 30 minutes. |
| - `delete` - Default is 30 minutes. |
| |
| ## Import |
| |
| This resource does not support import. |