| --- |
| # ---------------------------------------------------------------------------- |
| # |
| # *** 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: "Dataplex" |
| description: |- |
| An Entry Group represents a logical grouping of one or more Entries. |
| --- |
| |
| # google_dataplex_entry_group |
| |
| An Entry Group represents a logical grouping of one or more Entries. |
| |
| |
| |
| ## Example Usage - Dataplex Entry Group Basic |
| |
| |
| ```hcl |
| resource "google_dataplex_entry_group" "test_entry_group_basic" { |
| entry_group_id = "entry-group-basic" |
| project = "my-project-name" |
| location = "us-central1" |
| } |
| ``` |
| ## Example Usage - Dataplex Entry Group Full |
| |
| |
| ```hcl |
| resource "google_dataplex_entry_group" "test_entry_group_full" { |
| entry_group_id = "entry-group-full" |
| project = "my-project-name" |
| location = "us-central1" |
| |
| labels = { "tag": "test-tf" } |
| display_name = "terraform entry group" |
| description = "entry group created by Terraform" |
| } |
| ``` |
| |
| ## Argument Reference |
| |
| The following arguments are supported: |
| |
| |
| |
| - - - |
| |
| |
| * `description` - |
| (Optional) |
| Description of the EntryGroup. |
| |
| * `display_name` - |
| (Optional) |
| User friendly display name. |
| |
| * `labels` - |
| (Optional) |
| User-defined labels for the EntryGroup. |
| |
| **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. |
| Please refer to the field `effective_labels` for all of the labels present on the resource. |
| |
| * `location` - |
| (Optional) |
| The location where entry group will be created in. |
| |
| * `entry_group_id` - |
| (Optional) |
| The entry group id of the entry group. |
| |
| * `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}}/entryGroups/{{entry_group_id}}` |
| |
| * `name` - |
| The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id} |
| |
| * `uid` - |
| System generated globally unique ID for the EntryGroup. This ID will be different if the EntryGroup is deleted and re-created with the same name. |
| |
| * `create_time` - |
| The time when the EntryGroup was created. |
| |
| * `update_time` - |
| The time when the EntryGroup was last updated. |
| |
| * `transfer_status` - |
| Denotes the transfer status of the Entry Group. It is unspecified |
| for Entry Group created from Dataplex API. |
| |
| * `terraform_labels` - |
| The combination of labels configured directly on the resource |
| and default labels configured on the provider. |
| |
| * `effective_labels` - |
| All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services. |
| |
| |
| ## Timeouts |
| |
| This resource provides the following |
| [Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: |
| |
| - `create` - Default is 5 minutes. |
| - `update` - Default is 5 minutes. |
| - `delete` - Default is 5 minutes. |
| |
| ## Import |
| |
| |
| EntryGroup can be imported using any of these accepted formats: |
| |
| * `projects/{{project}}/locations/{{location}}/entryGroups/{{entry_group_id}}` |
| * `{{project}}/{{location}}/{{entry_group_id}}` |
| * `{{location}}/{{entry_group_id}}` |
| |
| |
| In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EntryGroup using one of the formats above. For example: |
| |
| ```tf |
| import { |
| id = "projects/{{project}}/locations/{{location}}/entryGroups/{{entry_group_id}}" |
| to = google_dataplex_entry_group.default |
| } |
| ``` |
| |
| When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), EntryGroup can be imported using one of the formats above. For example: |
| |
| ``` |
| $ terraform import google_dataplex_entry_group.default projects/{{project}}/locations/{{location}}/entryGroups/{{entry_group_id}} |
| $ terraform import google_dataplex_entry_group.default {{project}}/{{location}}/{{entry_group_id}} |
| $ terraform import google_dataplex_entry_group.default {{location}}/{{entry_group_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). |