vertexAiDataset.python.md

vertexAiDataset Submodule

Constructs

VertexAiDataset

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset google_vertex_ai_dataset}.

Initializers

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDataset(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  display_name: str,
  metadata_schema_uri: str,
  encryption_spec: VertexAiDatasetEncryptionSpec = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  project: str = None,
  region: str = None,
  timeouts: VertexAiDatasetTimeouts = None
)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	str	The scoped construct ID.
connection	typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]	No description.
count	typing.Union[typing.Union[int, float], cdktf.TerraformCount]	No description.
depends_on	typing.List[cdktf.ITerraformDependable]	No description.
for_each	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]	No description.
display_name	str	The user-defined name of the Dataset.
metadata_schema_uri	str	Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset.
encryption_spec	VertexAiDatasetEncryptionSpec	encryption_spec block.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#id VertexAiDataset#id}.
labels	typing.Mapping[str]	A set of key/value label pairs to assign to this Workflow.
project	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#project VertexAiDataset#project}.
region	str	The region of the dataset. eg us-central1.
timeouts	VertexAiDatasetTimeouts	timeouts block.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

connection^Optional

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

• Type: typing.List[cdktf.ITerraformDependable]

---

for_each^Optional

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

• Type: cdktf.TerraformProvider

---

provisioners^Optional

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

display_name^Required

• Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#display_name VertexAiDataset#display_name}

---

metadata_schema_uri^Required

• Type: str

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/.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#metadata_schema_uri VertexAiDataset#metadata_schema_uri}

---

encryption_spec^Optional

• Type: VertexAiDatasetEncryptionSpec

encryption_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#encryption_spec VertexAiDataset#encryption_spec}

---

id^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#id VertexAiDataset#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

labels^Optional

• Type: typing.Mapping[str]

A set of key/value label pairs to assign to this Workflow.

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#labels VertexAiDataset#labels}

---

project^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#project VertexAiDataset#project}.

---

region^Optional

• Type: str

The region of the dataset. eg us-central1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#region VertexAiDataset#region}

---

timeouts^Optional

• Type: VertexAiDatasetTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#timeouts VertexAiDataset#timeouts}

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
add_override	No description.
override_logical_id	Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id	Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform	No description.
to_metadata	No description.
to_terraform	Adds this resource to the terraform JSON output.
add_move_target	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute	No description.
get_boolean_attribute	No description.
get_boolean_map_attribute	No description.
get_list_attribute	No description.
get_number_attribute	No description.
get_number_list_attribute	No description.
get_number_map_attribute	No description.
get_string_attribute	No description.
get_string_map_attribute	No description.
has_resource_move	No description.
import_from	No description.
interpolation_for_attribute	No description.
move_from_id	Move the resource corresponding to "id" to this resource.
move_to	Moves this resource to the target resource given by moveTarget.
move_to_id	Moves this resource to the resource corresponding to "id".
put_encryption_spec	No description.
put_timeouts	No description.
reset_encryption_spec	No description.
reset_id	No description.
reset_labels	No description.
reset_project	No description.
reset_region	No description.
reset_timeouts	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

path^Required

• Type: str

---

value^Required

• Type: typing.Any

---

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

---

reset_override_logical_id

def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform

def to_hcl_terraform() -> typing.Any

to_metadata

def to_metadata() -> typing.Any

to_terraform

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target

def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_target^Required

• Type: str

The string move target that will correspond to this resource.

---

get_any_map_attribute

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

terraform_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

has_resource_move

def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]

import_from

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

id^Required

• Type: str

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolation_for_attribute

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

move_from_id

def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

move_to

def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_target^Required

• Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

move_to_id

def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

id^Required

• Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

put_encryption_spec

def put_encryption_spec(
  kms_key_name: str = None
) -> None

kms_key_name^Optional

• Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#kms_key_name VertexAiDataset#kms_key_name}

---

put_timeouts

def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None

create^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#create VertexAiDataset#create}.

---

delete^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#delete VertexAiDataset#delete}.

---

update^Optional

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#update VertexAiDataset#update}.

---

reset_encryption_spec

def reset_encryption_spec() -> None

reset_id

def reset_id() -> None

reset_labels

def reset_labels() -> None

reset_project

def reset_project() -> None

reset_region

def reset_region() -> None

reset_timeouts

def reset_timeouts() -> None

Static Functions

Name	Description
is_construct	Checks if x is a construct.
is_terraform_element	No description.
is_terraform_resource	No description.
generate_config_for_import	Generates CDKTF code for importing a VertexAiDataset resource upon running "cdktf plan ".

---

is_construct

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDataset.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: typing.Any

Any object.

---

is_terraform_element

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDataset.is_terraform_element(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

is_terraform_resource

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDataset.is_terraform_resource(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

generate_config_for_import

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDataset.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a VertexAiDataset resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

import_to_id^Required

• Type: str

The construct id used in the generated config for the VertexAiDataset to import.

---

import_from_id^Required

• Type: str

The id of the existing VertexAiDataset that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the VertexAiDataset to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktf_stack	cdktf.TerraformStack	No description.
fqn	str	No description.
friendly_unique_id	str	No description.
terraform_meta_arguments	typing.Mapping[typing.Any]	No description.
terraform_resource_type	str	No description.
terraform_generator_metadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]	No description.
count	typing.Union[typing.Union[int, float], cdktf.TerraformCount]	No description.
depends_on	typing.List[str]	No description.
for_each	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]	No description.
create_time	str	No description.
effective_labels	cdktf.StringMap	No description.
encryption_spec	VertexAiDatasetEncryptionSpecOutputReference	No description.
name	str	No description.
terraform_labels	cdktf.StringMap	No description.
timeouts	VertexAiDatasetTimeoutsOutputReference	No description.
update_time	str	No description.
display_name_input	str	No description.
encryption_spec_input	VertexAiDatasetEncryptionSpec	No description.
id_input	str	No description.
labels_input	typing.Mapping[str]	No description.
metadata_schema_uri_input	str	No description.
project_input	str	No description.
region_input	str	No description.
timeouts_input	typing.Union[cdktf.IResolvable, VertexAiDatasetTimeouts]	No description.
display_name	str	No description.
id	str	No description.
labels	typing.Mapping[str]	No description.
metadata_schema_uri	str	No description.
project	str	No description.
region	str	No description.

---

node^Required

node: Node

• Type: constructs.Node

The tree node.

---

cdktf_stack^Required

cdktf_stack: TerraformStack

• Type: cdktf.TerraformStack

---

fqn^Required

fqn: str

• Type: str

---

friendly_unique_id^Required

friendly_unique_id: str

• Type: str

---

terraform_meta_arguments^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

• Type: typing.Mapping[typing.Any]

---

terraform_resource_type^Required

terraform_resource_type: str

• Type: str

---

terraform_generator_metadata^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

depends_on: typing.List[str]

• Type: typing.List[str]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktf.TerraformProvider

---

provisioners^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

create_time^Required

create_time: str

• Type: str

---

effective_labels^Required

effective_labels: StringMap

• Type: cdktf.StringMap

---

encryption_spec^Required

encryption_spec: VertexAiDatasetEncryptionSpecOutputReference

• Type: VertexAiDatasetEncryptionSpecOutputReference

---

name^Required

name: str

• Type: str

---

terraform_labels^Required

terraform_labels: StringMap

• Type: cdktf.StringMap

---

timeouts^Required

timeouts: VertexAiDatasetTimeoutsOutputReference

• Type: VertexAiDatasetTimeoutsOutputReference

---

update_time^Required

update_time: str

• Type: str

---

display_name_input^Optional

display_name_input: str

• Type: str

---

encryption_spec_input^Optional

encryption_spec_input: VertexAiDatasetEncryptionSpec

• Type: VertexAiDatasetEncryptionSpec

---

id_input^Optional

id_input: str

• Type: str

---

labels_input^Optional

labels_input: typing.Mapping[str]

• Type: typing.Mapping[str]

---

metadata_schema_uri_input^Optional

metadata_schema_uri_input: str

• Type: str

---

project_input^Optional

project_input: str

• Type: str

---

region_input^Optional

region_input: str

• Type: str

---

timeouts_input^Optional

timeouts_input: typing.Union[IResolvable, VertexAiDatasetTimeouts]

• Type: typing.Union[cdktf.IResolvable, VertexAiDatasetTimeouts]

---

display_name^Required

display_name: str

• Type: str

---

id^Required

id: str

• Type: str

---

labels^Required

labels: typing.Mapping[str]

• Type: typing.Mapping[str]

---

metadata_schema_uri^Required

metadata_schema_uri: str

• Type: str

---

project^Required

project: str

• Type: str

---

region^Required

region: str

• Type: str

---

Constants

Name	Type	Description
tfResourceType	str	No description.

---

tfResourceType^Required

tfResourceType: str

• Type: str

---

Structs

VertexAiDatasetConfig

Initializer

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDatasetConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  display_name: str,
  metadata_schema_uri: str,
  encryption_spec: VertexAiDatasetEncryptionSpec = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  project: str = None,
  region: str = None,
  timeouts: VertexAiDatasetTimeouts = None
)

Properties

Name	Type	Description
connection	typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]	No description.
count	typing.Union[typing.Union[int, float], cdktf.TerraformCount]	No description.
depends_on	typing.List[cdktf.ITerraformDependable]	No description.
for_each	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]	No description.
display_name	str	The user-defined name of the Dataset.
metadata_schema_uri	str	Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset.
encryption_spec	VertexAiDatasetEncryptionSpec	encryption_spec block.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#id VertexAiDataset#id}.
labels	typing.Mapping[str]	A set of key/value label pairs to assign to this Workflow.
project	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#project VertexAiDataset#project}.
region	str	The region of the dataset. eg us-central1.
timeouts	VertexAiDatasetTimeouts	timeouts block.

---

connection^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

depends_on: typing.List[ITerraformDependable]

• Type: typing.List[cdktf.ITerraformDependable]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktf.TerraformProvider

---

provisioners^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

display_name^Required

display_name: str

• Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#display_name VertexAiDataset#display_name}

---

metadata_schema_uri^Required

metadata_schema_uri: str

• Type: str

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/.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#metadata_schema_uri VertexAiDataset#metadata_schema_uri}

---

encryption_spec^Optional

encryption_spec: VertexAiDatasetEncryptionSpec

• Type: VertexAiDatasetEncryptionSpec

encryption_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#encryption_spec VertexAiDataset#encryption_spec}

---

id^Optional

id: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#id VertexAiDataset#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

labels^Optional

labels: typing.Mapping[str]

• Type: typing.Mapping[str]

A set of key/value label pairs to assign to this Workflow.

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#labels VertexAiDataset#labels}

---

project^Optional

project: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#project VertexAiDataset#project}.

---

region^Optional

region: str

• Type: str

The region of the dataset. eg us-central1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#region VertexAiDataset#region}

---

timeouts^Optional

timeouts: VertexAiDatasetTimeouts

• Type: VertexAiDatasetTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#timeouts VertexAiDataset#timeouts}

---

VertexAiDatasetEncryptionSpec

Initializer

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDatasetEncryptionSpec(
  kms_key_name: str = None
)

Properties

Name	Type	Description
kms_key_name	str	Required.

---

kms_key_name^Optional

kms_key_name: str

• Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#kms_key_name VertexAiDataset#kms_key_name}

---

VertexAiDatasetTimeouts

Initializer

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDatasetTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name	Type	Description
create	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#create VertexAiDataset#create}.
delete	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#delete VertexAiDataset#delete}.
update	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#update VertexAiDataset#update}.

---

create^Optional

create: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#create VertexAiDataset#create}.

---

delete^Optional

delete: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#delete VertexAiDataset#delete}.

---

update^Optional

update: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/vertex_ai_dataset#update VertexAiDataset#update}.

---

Classes

VertexAiDatasetEncryptionSpecOutputReference

Initializers

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDatasetEncryptionSpecOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
terraform_resource	cdktf.IInterpolatingParent	The parent resource.
terraform_attribute	str	The attribute on the parent resource this class is referencing.

---

terraform_resource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraform_attribute^Required

• Type: str

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
compute_fqn	No description.
get_any_map_attribute	No description.
get_boolean_attribute	No description.
get_boolean_map_attribute	No description.
get_list_attribute	No description.
get_number_attribute	No description.
get_number_list_attribute	No description.
get_number_map_attribute	No description.
get_string_attribute	No description.
get_string_map_attribute	No description.
interpolation_for_attribute	No description.
resolve	Produce the Token's value at resolution time.
to_string	Return a string representation of this resolvable object.
reset_kms_key_name	No description.

---

compute_fqn

def compute_fqn() -> str

get_any_map_attribute

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

terraform_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

interpolation_for_attribute

def interpolation_for_attribute(
  property: str
) -> IResolvable

property^Required

• Type: str

---

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_kms_key_name

def reset_kms_key_name() -> None

Properties

Name	Type	Description
creation_stack	typing.List[str]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	str	No description.
kms_key_name_input	str	No description.
kms_key_name	str	No description.
internal_value	VertexAiDatasetEncryptionSpec	No description.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

fqn: str

• Type: str

---

kms_key_name_input^Optional

kms_key_name_input: str

• Type: str

---

kms_key_name^Required

kms_key_name: str

• Type: str

---

internal_value^Optional

internal_value: VertexAiDatasetEncryptionSpec

• Type: VertexAiDatasetEncryptionSpec

---

VertexAiDatasetTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_google import vertex_ai_dataset

vertexAiDataset.VertexAiDatasetTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
terraform_resource	cdktf.IInterpolatingParent	The parent resource.
terraform_attribute	str	The attribute on the parent resource this class is referencing.

---

terraform_resource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraform_attribute^Required

• Type: str

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
compute_fqn	No description.
get_any_map_attribute	No description.
get_boolean_attribute	No description.
get_boolean_map_attribute	No description.
get_list_attribute	No description.
get_number_attribute	No description.
get_number_list_attribute	No description.
get_number_map_attribute	No description.
get_string_attribute	No description.
get_string_map_attribute	No description.
interpolation_for_attribute	No description.
resolve	Produce the Token's value at resolution time.
to_string	Return a string representation of this resolvable object.
reset_create	No description.
reset_delete	No description.
reset_update	No description.

---

compute_fqn

def compute_fqn() -> str

get_any_map_attribute

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

terraform_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

interpolation_for_attribute

def interpolation_for_attribute(
  property: str
) -> IResolvable

property^Required

• Type: str

---

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create

def reset_create() -> None

reset_delete

def reset_delete() -> None

reset_update

def reset_update() -> None

Properties

Name	Type	Description
creation_stack	typing.List[str]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	str	No description.
create_input	str	No description.
delete_input	str	No description.
update_input	str	No description.
create	str	No description.
delete	str	No description.
update	str	No description.
internal_value	typing.Union[cdktf.IResolvable, VertexAiDatasetTimeouts]	No description.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

fqn: str

• Type: str

---

create_input^Optional

create_input: str

• Type: str

---

delete_input^Optional

delete_input: str

• Type: str

---

update_input^Optional

update_input: str

• Type: str

---

create^Required

create: str

• Type: str

---

delete^Required

delete: str

• Type: str

---

update^Required

update: str

• Type: str

---

internal_value^Optional

internal_value: typing.Union[IResolvable, VertexAiDatasetTimeouts]

• Type: typing.Union[cdktf.IResolvable, VertexAiDatasetTimeouts]

---