Skip to content

googleVertexAiDataset

A collection of DataItems and Annotations on them.

To get more information about Dataset, see:

Open in Cloud Shell

Example Usage - Vertex Ai Dataset

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.vertexAiDataset.VertexAiDataset(this, "dataset", {
  display_name: "terraform",
  metadata_schema_uri:
    "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml",
  region: "us-central1",
});

Argument Reference

The following arguments are supported:

  • displayName - (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.

  • metadataSchemaUri - (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.

  • encryptionSpec - (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 encryptionSpec block supports:

  • kmsKeyName - (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.

Attributes Reference

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.

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

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

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • update - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

This resource does not support import.

User Project Overrides

This resource supports User Project Overrides.