| --- |
| # ---------------------------------------------------------------------------- |
| # |
| # *** 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: "Discovery Engine" |
| description: |- |
| Data store is a collection of websites and documents used to find answers for |
| end-user's questions in Discovery Engine (a. |
| --- |
| |
| # google\_discovery\_engine\_data\_store |
| |
| Data store is a collection of websites and documents used to find answers for |
| end-user's questions in Discovery Engine (a.k.a. Vertex AI Search and |
| Conversation). |
| |
| |
| To get more information about DataStore, see: |
| |
| * [API documentation](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.dataStores) |
| * How-to Guides |
| * [Create a search data store](https://cloud.google.com/generative-ai-app-builder/docs/create-data-store-es) |
| |
| <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=discoveryengine_datastore_basic&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 - Discoveryengine Datastore Basic |
| |
| |
| ```hcl |
| resource "google_discovery_engine_data_store" "basic" { |
| location = "global" |
| data_store_id = "data-store-id" |
| display_name = "tf-test-structured-datastore" |
| industry_vertical = "GENERIC" |
| content_config = "NO_CONTENT" |
| solution_types = ["SOLUTION_TYPE_SEARCH"] |
| create_advanced_site_search = false |
| } |
| ``` |
| |
| ## Argument Reference |
| |
| The following arguments are supported: |
| |
| |
| * `display_name` - |
| (Required) |
| The display name of the data store. This field must be a UTF-8 encoded |
| string with a length limit of 128 characters. |
| |
| * `industry_vertical` - |
| (Required) |
| The industry vertical that the data store registers. |
| Possible values are: `GENERIC`, `MEDIA`. |
| |
| * `content_config` - |
| (Required) |
| The content config of the data store. |
| Possible values are: `NO_CONTENT`, `CONTENT_REQUIRED`, `PUBLIC_WEBSITE`. |
| |
| * `location` - |
| (Required) |
| The geographic location where the data store should reside. The value can |
| only be one of "global", "us" and "eu". |
| |
| * `data_store_id` - |
| (Required) |
| The unique id of the data store. |
| |
| |
| - - - |
| |
| |
| * `solution_types` - |
| (Optional) |
| The solutions that the data store enrolls. |
| Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`. |
| |
| * `create_advanced_site_search` - |
| (Optional) |
| If true, an advanced data store for site search will be created. If the |
| data store is not configured as site search (GENERIC vertical and |
| PUBLIC_WEBSITE contentConfig), this flag will be ignored. |
| |
| * `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}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}` |
| |
| * `name` - |
| The unique full resource name of the data store. Values are of the format |
| `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. |
| This field must be a UTF-8 encoded string with a length limit of 1024 |
| characters. |
| |
| * `default_schema_id` - |
| The id of the default Schema associated with this data store. |
| |
| * `create_time` - |
| Timestamp when the DataStore was created. |
| |
| |
| ## Timeouts |
| |
| This resource provides the following |
| [Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: |
| |
| - `create` - Default is 60 minutes. |
| - `update` - Default is 60 minutes. |
| - `delete` - Default is 60 minutes. |
| |
| ## Import |
| |
| |
| DataStore can be imported using any of these accepted formats: |
| |
| * `projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}` |
| * `{{project}}/{{location}}/{{data_store_id}}` |
| * `{{location}}/{{data_store_id}}` |
| |
| |
| In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DataStore using one of the formats above. For example: |
| |
| ```tf |
| import { |
| id = "projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}" |
| to = google_discovery_engine_data_store.default |
| } |
| ``` |
| |
| When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), DataStore can be imported using one of the formats above. For example: |
| |
| ``` |
| $ terraform import google_discovery_engine_data_store.default projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}} |
| $ terraform import google_discovery_engine_data_store.default {{project}}/{{location}}/{{data_store_id}} |
| $ terraform import google_discovery_engine_data_store.default {{location}}/{{data_store_id}} |
| ``` |
| |
| ## User Project Overrides |
| |
| This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override). |