Google Vertex AI Dataset

This page shows how to write Terraform for Vertex AI Dataset and write them securely.

google_vertex_ai_dataset (Terraform)

The Dataset in Vertex AI can be configured in Terraform with the resource name google_vertex_ai_dataset. The following sections describe 1 example of how to use the resource and its parameters.

Example Usage from GitHub

createapi.tf#L1
resource "google_vertex_ai_dataset" "dataset" {
  display_name          = "income"
  metadata_schema_uri   = "*.yaml"
  region                = "asia-southeast1"

Review your Terraform file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • display_name - (Required) The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

  • metadata_schema_uri - (Required) Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.


  • labels - (Optional) A set of key/value label pairs to assign to this Workflow.

  • encryption_spec - (Optional) Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

  • region - (Optional) The region of the dataset. eg us-central1

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The encryption_spec block supports:

  • kms_key_name - (Optional) Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format [[name]]

  • name - The resource name of the Dataset. This value is set by Google.

  • create_time - The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

  • update_time - The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

Explanation in Terraform Registry

A collection of DataItems and Annotations on them. To get more information about Dataset, see:

Frequently asked questions

What is Google Vertex AI Dataset?

Google Vertex AI Dataset is a resource for Vertex AI of Google Cloud Platform. Settings can be wrote in Terraform.

Where can I find the example code for the Google Vertex AI Dataset?

For Terraform, the Aniki-lee/GCP source code example is useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.