-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
private-googleapis data source support
Signed-off-by: Modular Magician <[email protected]>
- Loading branch information
1 parent
1dc8e3b
commit 4ce3c46
Showing
10 changed files
with
400 additions
and
205 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,255 @@ | ||
| --- | ||
| # ---------------------------------------------------------------------------- | ||
| # | ||
| # *** AUTO GENERATED CODE *** AUTO GENERATED CODE *** | ||
| # | ||
| # ---------------------------------------------------------------------------- | ||
| # | ||
| # 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. | ||
| # | ||
| # ---------------------------------------------------------------------------- | ||
| layout: "google" | ||
| page_title: "Google: google_bigquery_dataset" | ||
| sidebar_current: "docs-google-bigquery-dataset" | ||
| description: |- | ||
| Datasets allow you to organize and control access to your tables. | ||
| --- | ||
|
|
||
| # google\_bigquery\_dataset | ||
|
|
||
| Datasets allow you to organize and control access to your tables. | ||
|
|
||
|
|
||
|
|
||
| <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=bigquery_dataset_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"> | ||
| <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 - Bigquery Dataset Basic | ||
|
|
||
|
|
||
| ```hcl | ||
| resource "google_bigquery_dataset" "dataset" { | ||
| dataset_id = "example_dataset" | ||
| friendly_name = "test" | ||
| description = "This is a test description" | ||
| location = "EU" | ||
| default_table_expiration_ms = 3600000 | ||
| labels = { | ||
| env = "default" | ||
| } | ||
| access { | ||
| role = "OWNER" | ||
| user_by_email = "[email protected]" | ||
| } | ||
| access { | ||
| role = "READER" | ||
| domain = "example.com" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Argument Reference | ||
|
|
||
| The following arguments are supported: | ||
|
|
||
|
|
||
| * `dataset_id` - | ||
| (Required) | ||
| A unique ID for this dataset, without the project name. The ID | ||
| must contain only letters (a-z, A-Z), numbers (0-9), or | ||
| underscores (_). The maximum length is 1,024 characters. | ||
|
|
||
|
|
||
| - - - | ||
|
|
||
|
|
||
| * `access` - | ||
| (Optional) | ||
| An array of objects that define dataset access for one or more entities. Structure is documented below. | ||
|
|
||
| * `default_table_expiration_ms` - | ||
| (Optional) | ||
| The default lifetime of all tables in the dataset, in milliseconds. | ||
| The minimum value is 3600000 milliseconds (one hour). | ||
|
|
||
| Once this property is set, all newly-created tables in the dataset | ||
| will have an `expirationTime` property set to the creation time plus | ||
| the value in this property, and changing the value will only affect | ||
| new tables, not existing ones. When the `expirationTime` for a given | ||
| table is reached, that table will be deleted automatically. | ||
| If a table's `expirationTime` is modified or removed before the | ||
| table expires, or if you provide an explicit `expirationTime` when | ||
| creating a table, that value takes precedence over the default | ||
| expiration time indicated by this property. | ||
|
|
||
| * `default_partition_expiration_ms` - | ||
| (Optional) | ||
| The default partition expiration for all partitioned tables in | ||
| the dataset, in milliseconds. | ||
|
|
||
| Once this property is set, all newly-created partitioned tables in | ||
| the dataset will have an `expirationMs` property in the `timePartitioning` | ||
| settings set to this value, and changing the value will only | ||
| affect new tables, not existing ones. The storage in a partition will | ||
| have an expiration time of its partition time plus this value. | ||
| Setting this property overrides the use of `defaultTableExpirationMs` | ||
| for partitioned tables: only one of `defaultTableExpirationMs` and | ||
| `defaultPartitionExpirationMs` will be used for any new partitioned | ||
| table. If you provide an explicit `timePartitioning.expirationMs` when | ||
| creating or updating a partitioned table, that value takes precedence | ||
| over the default partition expiration time indicated by this property. | ||
|
|
||
| * `description` - | ||
| (Optional) | ||
| A user-friendly description of the dataset | ||
|
|
||
| * `friendly_name` - | ||
| (Optional) | ||
| A descriptive name for the dataset | ||
|
|
||
| * `labels` - | ||
| (Optional) | ||
| The labels associated with this dataset. You can use these to | ||
| organize and group your datasets | ||
|
|
||
| * `location` - | ||
| (Optional) | ||
| The geographic location where the dataset should reside. | ||
| See [official docs](https://cloud.google.com/bigquery/docs/dataset-locations). | ||
|
|
||
| There are two types of locations, regional or multi-regional. A regional | ||
| location is a specific geographic place, such as Tokyo, and a multi-regional | ||
| location is a large geographic area, such as the United States, that | ||
| contains at least two geographic places. | ||
|
|
||
| Possible regional values include: `asia-east1`, `asia-northeast1`, | ||
| `asia-southeast1`, `australia-southeast1`, `europe-north1`, | ||
| `europe-west2` and `us-east4`. | ||
|
|
||
| Possible multi-regional values: `EU` and `US`. | ||
|
|
||
| The default value is multi-regional location `US`. | ||
| Changing this forces a new resource to be created. | ||
|
|
||
| * `project` - (Optional) The ID of the project in which the resource belongs. | ||
| If it is not provided, the provider project is used. | ||
|
|
||
| * `delete_contents_on_destroy` - (Optional) If set to `true`, delete all the tables in the | ||
| dataset when destroying the resource; otherwise, | ||
| destroying the resource will fail if tables are present. | ||
|
|
||
| The `access` block supports: | ||
|
|
||
| * `domain` - | ||
| (Optional) | ||
| A domain to grant access to. Any users signed in with the | ||
| domain specified will be granted the specified access | ||
|
|
||
| * `group_by_email` - | ||
| (Optional) | ||
| An email address of a Google Group to grant access to. | ||
|
|
||
| * `role` - | ||
| (Optional) | ||
| Describes the rights granted to the user specified by the other | ||
| member of the access object. Primitive, Predefined and custom | ||
| roles are supported. Predefined roles that have equivalent | ||
| primitive roles are swapped by the API to their Primitive | ||
| counterparts, and will show a diff post-create. See | ||
| [official docs](https://cloud.google.com/bigquery/docs/access-control). | ||
|
|
||
| * `special_group` - | ||
| (Optional) | ||
| A special group to grant access to. | ||
|
|
||
| Possible values include: | ||
|
|
||
| * `projectOwners`: Owners of the enclosing project. | ||
|
|
||
| * `projectReaders`: Readers of the enclosing project. | ||
|
|
||
| * `projectWriters`: Writers of the enclosing project. | ||
|
|
||
| * `allAuthenticatedUsers`: All authenticated BigQuery users. | ||
|
|
||
| * `user_by_email` - | ||
| (Optional) | ||
| An email address of a user to grant access to. For example: | ||
| [email protected] | ||
|
|
||
| * `view` - | ||
| (Optional) | ||
| A view from a different dataset to grant access to. Queries | ||
| executed against that view will have read access to tables in | ||
| this dataset. The role field is not required when this field is | ||
| set. If that view is updated by any user, access to the view | ||
| needs to be granted again via an update operation. Structure is documented below. | ||
|
|
||
|
|
||
| The `view` block supports: | ||
|
|
||
| * `dataset_id` - | ||
| (Required) | ||
| The ID of the dataset containing this table. | ||
|
|
||
| * `project_id` - | ||
| (Required) | ||
| The ID of the project containing this table. | ||
|
|
||
| * `table_id` - | ||
| (Required) | ||
| The ID of the table. The ID must contain only letters (a-z, | ||
| A-Z), numbers (0-9), or underscores (_). The maximum length | ||
| is 1,024 characters. | ||
|
|
||
| ## Attributes Reference | ||
|
|
||
| In addition to the arguments listed above, the following computed attributes are exported: | ||
|
|
||
|
|
||
| * `creation_time` - | ||
| The time when this dataset was created, in milliseconds since the | ||
| epoch. | ||
|
|
||
| * `etag` - | ||
| A hash of the resource. | ||
|
|
||
| * `last_modified_time` - | ||
| The date when this dataset or any of its tables was last modified, in | ||
| milliseconds since the epoch. | ||
| * `self_link` - The URI of the created resource. | ||
|
|
||
|
|
||
| ## Timeouts | ||
|
|
||
| This resource provides the following | ||
| [Timeouts](/docs/configuration/resources.html#timeouts) configuration options: | ||
|
|
||
| - `create` - Default is 4 minutes. | ||
| - `update` - Default is 4 minutes. | ||
| - `delete` - Default is 4 minutes. | ||
|
|
||
| ## Import | ||
|
|
||
| Dataset can be imported using any of these accepted formats: | ||
|
|
||
| ``` | ||
| $ terraform import google_bigquery_dataset.default {{project}}/{{dataset_id}} | ||
| $ terraform import google_bigquery_dataset.default {{project}}:{{dataset_id}} | ||
| $ terraform import google_bigquery_dataset.default {{dataset_id}} | ||
| ``` | ||
|
|
||
| -> If you're importing a resource with beta features, make sure to include `-provider=google-beta` | ||
| as an argument so that Terraform uses the correct provider to import your resource. | ||
|
|
||
| ## User Project Overrides | ||
|
|
||
| This resource supports [User Project Overrides](https://www.terraform.io/docs/providers/google/provider_reference.html#user_project_override). |
Oops, something went wrong.