Skip to content

Files

Latest commit

 

History

History
5634 lines (3585 loc) · 253 KB
·

notebooksInstance.python.md

File metadata and controls

5634 lines (3585 loc) · 253 KB
·

notebooksInstance Submodule

Constructs

NotebooksInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance google_notebooks_instance}.

Initializers 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstance(
  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,
  location: str,
  machine_type: str,
  name: str,
  accelerator_config: NotebooksInstanceAcceleratorConfig = None,
  boot_disk_size_gb: typing.Union[int, float] = None,
  boot_disk_type: str = None,
  container_image: NotebooksInstanceContainerImage = None,
  create_time: str = None,
  custom_gpu_driver_path: str = None,
  data_disk_size_gb: typing.Union[int, float] = None,
  data_disk_type: str = None,
  desired_state: str = None,
  disk_encryption: str = None,
  id: str = None,
  install_gpu_driver: typing.Union[bool, IResolvable] = None,
  instance_owners: typing.List[str] = None,
  kms_key: str = None,
  labels: typing.Mapping[str] = None,
  metadata: typing.Mapping[str] = None,
  network: str = None,
  nic_type: str = None,
  no_proxy_access: typing.Union[bool, IResolvable] = None,
  no_public_ip: typing.Union[bool, IResolvable] = None,
  no_remove_data_disk: typing.Union[bool, IResolvable] = None,
  post_startup_script: str = None,
  project: str = None,
  reservation_affinity: NotebooksInstanceReservationAffinity = None,
  service_account: str = None,
  service_account_scopes: typing.List[str] = None,
  shielded_instance_config: NotebooksInstanceShieldedInstanceConfig = None,
  subnet: str = None,
  tags: typing.List[str] = None,
  timeouts: NotebooksInstanceTimeouts = None,
  update_time: str = None,
  vm_image: NotebooksInstanceVmImage = 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.
location str A reference to the zone where the machine resides.
machine_type str A reference to a machine type which defines VM kind.
name str The name specified for the Notebook instance.
accelerator_config NotebooksInstanceAcceleratorConfig accelerator_config block.
boot_disk_size_gb typing.Union[int, float] The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).
boot_disk_type str Possible disk types for notebook instances. Possible values: ["DISK_TYPE_UNSPECIFIED", "PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].
container_image NotebooksInstanceContainerImage container_image block.
create_time str Instance creation time.
custom_gpu_driver_path str Specify a custom Cloud Storage path where the GPU driver is stored.
data_disk_size_gb typing.Union[int, float] The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).
data_disk_type str Possible disk types for notebook instances. Possible values: ["DISK_TYPE_UNSPECIFIED", "PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].
desired_state str Desired state of the Notebook Instance.
disk_encryption str Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values: ["DISK_ENCRYPTION_UNSPECIFIED", "GMEK", "CMEK"].
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#id NotebooksInstance#id}.
install_gpu_driver typing.Union[bool, cdktf.IResolvable] Whether the end user authorizes Google Cloud to install GPU driver on this instance.
instance_owners typing.List[str] The list of owners of this instance after creation.
kms_key str The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}.
labels typing.Mapping[str] Labels to apply to this instance.
metadata typing.Mapping[str] Custom metadata to apply to this instance.
network str The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}.
nic_type str The type of vNIC driver. Possible values: ["UNSPECIFIED_NIC_TYPE", "VIRTIO_NET", "GVNIC"].
no_proxy_access typing.Union[bool, cdktf.IResolvable] The notebook instance will not register with the proxy..
no_public_ip typing.Union[bool, cdktf.IResolvable] No public IP will be assigned to this instance.
no_remove_data_disk typing.Union[bool, cdktf.IResolvable] If true, the data disk will not be auto deleted when deleting the instance.
post_startup_script str Path to a Bash script that automatically runs after a notebook instance fully boots up.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#project NotebooksInstance#project}.
reservation_affinity NotebooksInstanceReservationAffinity reservation_affinity block.
service_account str The service account on this instance, giving access to other Google Cloud services.
service_account_scopes typing.List[str] Optional.
shielded_instance_config NotebooksInstanceShieldedInstanceConfig shielded_instance_config block.
subnet str The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}.
tags typing.List[str] The Compute Engine tags to add to instance.
timeouts NotebooksInstanceTimeouts timeouts block.
update_time str Instance update time.
vm_image NotebooksInstanceVmImage vm_image block.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
locationRequired
  • Type: str

A reference to the zone where the machine resides.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#location NotebooksInstance#location}

machine_typeRequired
  • Type: str

A reference to a machine type which defines VM kind.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#machine_type NotebooksInstance#machine_type}

nameRequired
  • Type: str

The name specified for the Notebook instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#name NotebooksInstance#name}

accelerator_configOptional

accelerator_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#accelerator_config NotebooksInstance#accelerator_config}

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

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).

The minimum recommended value is 100 GB. If not specified, this defaults to 100.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#boot_disk_size_gb NotebooksInstance#boot_disk_size_gb}

boot_disk_typeOptional
  • Type: str

Possible disk types for notebook instances. Possible values: ["DISK_TYPE_UNSPECIFIED", "PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#boot_disk_type NotebooksInstance#boot_disk_type}

container_imageOptional

container_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#container_image NotebooksInstance#container_image}

create_timeOptional
  • Type: str

Instance creation time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#create_time NotebooksInstance#create_time}

custom_gpu_driver_pathOptional
  • Type: str

Specify a custom Cloud Storage path where the GPU driver is stored.

If not specified, we'll automatically choose from official GPU drivers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#custom_gpu_driver_path NotebooksInstance#custom_gpu_driver_path}

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

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).

You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#data_disk_size_gb NotebooksInstance#data_disk_size_gb}

data_disk_typeOptional
  • Type: str

Possible disk types for notebook instances. Possible values: ["DISK_TYPE_UNSPECIFIED", "PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#data_disk_type NotebooksInstance#data_disk_type}

desired_stateOptional
  • Type: str

Desired state of the Notebook Instance.

Set this field to 'ACTIVE' to start the Instance, and 'STOPPED' to stop the Instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#desired_state NotebooksInstance#desired_state}

disk_encryptionOptional
  • Type: str

Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values: ["DISK_ENCRYPTION_UNSPECIFIED", "GMEK", "CMEK"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#disk_encryption NotebooksInstance#disk_encryption}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#id NotebooksInstance#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.

install_gpu_driverOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the end user authorizes Google Cloud to install GPU driver on this instance.

If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#install_gpu_driver NotebooksInstance#install_gpu_driver}

instance_ownersOptional
  • Type: typing.List[str]

The list of owners of this instance after creation.

Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#instance_owners NotebooksInstance#instance_owners}

kms_keyOptional
  • Type: str

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#kms_key NotebooksInstance#kms_key}

labelsOptional
  • Type: typing.Mapping[str]

Labels to apply to this instance.

These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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.34.0/docs/resources/notebooks_instance#labels NotebooksInstance#labels}

metadataOptional
  • Type: typing.Mapping[str]

Custom metadata to apply to this instance.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#metadata NotebooksInstance#metadata}

networkOptional
  • Type: str

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#network NotebooksInstance#network}

nic_typeOptional
  • Type: str

The type of vNIC driver. Possible values: ["UNSPECIFIED_NIC_TYPE", "VIRTIO_NET", "GVNIC"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#nic_type NotebooksInstance#nic_type}

no_proxy_accessOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

The notebook instance will not register with the proxy..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#no_proxy_access NotebooksInstance#no_proxy_access}

no_public_ipOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

No public IP will be assigned to this instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#no_public_ip NotebooksInstance#no_public_ip}

no_remove_data_diskOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

If true, the data disk will not be auto deleted when deleting the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#no_remove_data_disk NotebooksInstance#no_remove_data_disk}

post_startup_scriptOptional
  • Type: str

Path to a Bash script that automatically runs after a notebook instance fully boots up.

The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#post_startup_script NotebooksInstance#post_startup_script}

projectOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#project NotebooksInstance#project}.

reservation_affinityOptional

reservation_affinity block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#reservation_affinity NotebooksInstance#reservation_affinity}

service_accountOptional
  • Type: str

The service account on this instance, giving access to other Google Cloud services.

You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#service_account NotebooksInstance#service_account}

service_account_scopesOptional
  • Type: typing.List[str]

Optional.

The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#service_account_scopes NotebooksInstance#service_account_scopes}

shielded_instance_configOptional

shielded_instance_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#shielded_instance_config NotebooksInstance#shielded_instance_config}

subnetOptional
  • Type: str

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#subnet NotebooksInstance#subnet}

tagsOptional
  • Type: typing.List[str]

The Compute Engine tags to add to instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#tags NotebooksInstance#tags}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#timeouts NotebooksInstance#timeouts}

update_timeOptional
  • Type: str

Instance update time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#update_time NotebooksInstance#update_time}

vm_imageOptional

vm_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#vm_image NotebooksInstance#vm_image}

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_accelerator_config No description.
put_container_image No description.
put_reservation_affinity No description.
put_shielded_instance_config No description.
put_timeouts No description.
put_vm_image No description.
reset_accelerator_config No description.
reset_boot_disk_size_gb No description.
reset_boot_disk_type No description.
reset_container_image No description.
reset_create_time No description.
reset_custom_gpu_driver_path No description.
reset_data_disk_size_gb No description.
reset_data_disk_type No description.
reset_desired_state No description.
reset_disk_encryption No description.
reset_id No description.
reset_install_gpu_driver No description.
reset_instance_owners No description.
reset_kms_key No description.
reset_labels No description.
reset_metadata No description.
reset_network No description.
reset_nic_type No description.
reset_no_proxy_access No description.
reset_no_public_ip No description.
reset_no_remove_data_disk No description.
reset_post_startup_script No description.
reset_project No description.
reset_reservation_affinity No description.
reset_service_account No description.
reset_service_account_scopes No description.
reset_shielded_instance_config No description.
reset_subnet No description.
reset_tags No description.
reset_timeouts No description.
reset_update_time No description.
reset_vm_image 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
pathRequired
  • Type: str
valueRequired
  • 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_idRequired
  • 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_targetRequired
  • 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_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • 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.

idRequired
  • 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_targetRequired
  • Type: str

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

indexOptional
  • 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".

idRequired
  • Type: str

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

put_accelerator_config 
def put_accelerator_config(
  core_count: typing.Union[int, float],
  type: str
) -> None
core_countRequired
  • Type: typing.Union[int, float]

Count of cores of this accelerator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#core_count NotebooksInstance#core_count}

typeRequired
  • Type: str

Type of this accelerator. Possible values: ["ACCELERATOR_TYPE_UNSPECIFIED", "NVIDIA_TESLA_K80", "NVIDIA_TESLA_P100", "NVIDIA_TESLA_V100", "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS", "NVIDIA_TESLA_A100", "TPU_V2", "TPU_V3"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#type NotebooksInstance#type}

put_container_image 
def put_container_image(
  repository: str,
  tag: str = None
) -> None
repositoryRequired
  • Type: str

The path to the container image repository. For example: gcr.io/{project_id}/{imageName}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#repository NotebooksInstance#repository}

tagOptional
  • Type: str

The tag of the container image. If not specified, this defaults to the latest tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#tag NotebooksInstance#tag}

put_reservation_affinity 
def put_reservation_affinity(
  consume_reservation_type: str,
  key: str = None,
  values: typing.List[str] = None
) -> None
consume_reservation_typeRequired
  • Type: str

The type of Compute Reservation. Possible values: ["NO_RESERVATION", "ANY_RESERVATION", "SPECIFIC_RESERVATION"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#consume_reservation_type NotebooksInstance#consume_reservation_type}

keyOptional
  • Type: str

Corresponds to the label key of reservation resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#key NotebooksInstance#key}

valuesOptional
  • Type: typing.List[str]

Corresponds to the label values of reservation resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#values NotebooksInstance#values}

put_shielded_instance_config 
def put_shielded_instance_config(
  enable_integrity_monitoring: typing.Union[bool, IResolvable] = None,
  enable_secure_boot: typing.Union[bool, IResolvable] = None,
  enable_vtpm: typing.Union[bool, IResolvable] = None
) -> None
enable_integrity_monitoringOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Defines whether the instance has integrity monitoring enabled.

Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#enable_integrity_monitoring NotebooksInstance#enable_integrity_monitoring}

enable_secure_bootOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Defines whether the instance has Secure Boot enabled.

Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#enable_secure_boot NotebooksInstance#enable_secure_boot}

enable_vtpmOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Defines whether the instance has the vTPM enabled. Enabled by default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#enable_vtpm NotebooksInstance#enable_vtpm}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#create NotebooksInstance#create}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#delete NotebooksInstance#delete}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#update NotebooksInstance#update}.

put_vm_image 
def put_vm_image(
  project: str,
  image_family: str = None,
  image_name: str = None
) -> None
projectRequired
  • Type: str

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#project NotebooksInstance#project}

image_familyOptional
  • Type: str

Use this VM image family to find the image; the newest image in this family will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#image_family NotebooksInstance#image_family}

image_nameOptional
  • Type: str

Use VM image name to find the image.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#image_name NotebooksInstance#image_name}

reset_accelerator_config 
def reset_accelerator_config() -> None
reset_boot_disk_size_gb 
def reset_boot_disk_size_gb() -> None
reset_boot_disk_type 
def reset_boot_disk_type() -> None
reset_container_image 
def reset_container_image() -> None
reset_create_time 
def reset_create_time() -> None
reset_custom_gpu_driver_path 
def reset_custom_gpu_driver_path() -> None
reset_data_disk_size_gb 
def reset_data_disk_size_gb() -> None
reset_data_disk_type 
def reset_data_disk_type() -> None
reset_desired_state 
def reset_desired_state() -> None
reset_disk_encryption 
def reset_disk_encryption() -> None
reset_id 
def reset_id() -> None
reset_install_gpu_driver 
def reset_install_gpu_driver() -> None
reset_instance_owners 
def reset_instance_owners() -> None
reset_kms_key 
def reset_kms_key() -> None
reset_labels 
def reset_labels() -> None
reset_metadata 
def reset_metadata() -> None
reset_network 
def reset_network() -> None
reset_nic_type 
def reset_nic_type() -> None
reset_no_proxy_access 
def reset_no_proxy_access() -> None
reset_no_public_ip 
def reset_no_public_ip() -> None
reset_no_remove_data_disk 
def reset_no_remove_data_disk() -> None
reset_post_startup_script 
def reset_post_startup_script() -> None
reset_project 
def reset_project() -> None
reset_reservation_affinity 
def reset_reservation_affinity() -> None
reset_service_account 
def reset_service_account() -> None
reset_service_account_scopes 
def reset_service_account_scopes() -> None
reset_shielded_instance_config 
def reset_shielded_instance_config() -> None
reset_subnet 
def reset_subnet() -> None
reset_tags 
def reset_tags() -> None
reset_timeouts 
def reset_timeouts() -> None
reset_update_time 
def reset_update_time() -> None
reset_vm_image 
def reset_vm_image() -> 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 NotebooksInstance resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstance.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.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstance.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstance.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstance.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing NotebooksInstance that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the NotebooksInstance 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.
accelerator_config NotebooksInstanceAcceleratorConfigOutputReference No description.
container_image NotebooksInstanceContainerImageOutputReference No description.
effective_labels cdktf.StringMap No description.
proxy_uri str No description.
reservation_affinity NotebooksInstanceReservationAffinityOutputReference No description.
shielded_instance_config NotebooksInstanceShieldedInstanceConfigOutputReference No description.
state str No description.
terraform_labels cdktf.StringMap No description.
timeouts NotebooksInstanceTimeoutsOutputReference No description.
vm_image NotebooksInstanceVmImageOutputReference No description.
accelerator_config_input NotebooksInstanceAcceleratorConfig No description.
boot_disk_size_gb_input typing.Union[int, float] No description.
boot_disk_type_input str No description.
container_image_input NotebooksInstanceContainerImage No description.
create_time_input str No description.
custom_gpu_driver_path_input str No description.
data_disk_size_gb_input typing.Union[int, float] No description.
data_disk_type_input str No description.
desired_state_input str No description.
disk_encryption_input str No description.
id_input str No description.
install_gpu_driver_input typing.Union[bool, cdktf.IResolvable] No description.
instance_owners_input typing.List[str] No description.
kms_key_input str No description.
labels_input typing.Mapping[str] No description.
location_input str No description.
machine_type_input str No description.
metadata_input typing.Mapping[str] No description.
name_input str No description.
network_input str No description.
nic_type_input str No description.
no_proxy_access_input typing.Union[bool, cdktf.IResolvable] No description.
no_public_ip_input typing.Union[bool, cdktf.IResolvable] No description.
no_remove_data_disk_input typing.Union[bool, cdktf.IResolvable] No description.
post_startup_script_input str No description.
project_input str No description.
reservation_affinity_input NotebooksInstanceReservationAffinity No description.
service_account_input str No description.
service_account_scopes_input typing.List[str] No description.
shielded_instance_config_input NotebooksInstanceShieldedInstanceConfig No description.
subnet_input str No description.
tags_input typing.List[str] No description.
timeouts_input typing.Union[cdktf.IResolvable, NotebooksInstanceTimeouts] No description.
update_time_input str No description.
vm_image_input NotebooksInstanceVmImage No description.
boot_disk_size_gb typing.Union[int, float] No description.
boot_disk_type str No description.
create_time str No description.
custom_gpu_driver_path str No description.
data_disk_size_gb typing.Union[int, float] No description.
data_disk_type str No description.
desired_state str No description.
disk_encryption str No description.
id str No description.
install_gpu_driver typing.Union[bool, cdktf.IResolvable] No description.
instance_owners typing.List[str] No description.
kms_key str No description.
labels typing.Mapping[str] No description.
location str No description.
machine_type str No description.
metadata typing.Mapping[str] No description.
name str No description.
network str No description.
nic_type str No description.
no_proxy_access typing.Union[bool, cdktf.IResolvable] No description.
no_public_ip typing.Union[bool, cdktf.IResolvable] No description.
no_remove_data_disk typing.Union[bool, cdktf.IResolvable] No description.
post_startup_script str No description.
project str No description.
service_account str No description.
service_account_scopes typing.List[str] No description.
subnet str No description.
tags typing.List[str] No description.
update_time str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
accelerator_configRequired 
accelerator_config: NotebooksInstanceAcceleratorConfigOutputReference
container_imageRequired 
container_image: NotebooksInstanceContainerImageOutputReference
effective_labelsRequired 
effective_labels: StringMap
  • Type: cdktf.StringMap
proxy_uriRequired 
proxy_uri: str
  • Type: str
reservation_affinityRequired 
reservation_affinity: NotebooksInstanceReservationAffinityOutputReference
shielded_instance_configRequired 
shielded_instance_config: NotebooksInstanceShieldedInstanceConfigOutputReference
stateRequired 
state: str
  • Type: str
terraform_labelsRequired 
terraform_labels: StringMap
  • Type: cdktf.StringMap
timeoutsRequired 
timeouts: NotebooksInstanceTimeoutsOutputReference
vm_imageRequired 
vm_image: NotebooksInstanceVmImageOutputReference
accelerator_config_inputOptional 
accelerator_config_input: NotebooksInstanceAcceleratorConfig
boot_disk_size_gb_inputOptional 
boot_disk_size_gb_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
boot_disk_type_inputOptional 
boot_disk_type_input: str
  • Type: str
container_image_inputOptional 
container_image_input: NotebooksInstanceContainerImage
create_time_inputOptional 
create_time_input: str
  • Type: str
custom_gpu_driver_path_inputOptional 
custom_gpu_driver_path_input: str
  • Type: str
data_disk_size_gb_inputOptional 
data_disk_size_gb_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
data_disk_type_inputOptional 
data_disk_type_input: str
  • Type: str
desired_state_inputOptional 
desired_state_input: str
  • Type: str
disk_encryption_inputOptional 
disk_encryption_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
install_gpu_driver_inputOptional 
install_gpu_driver_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
instance_owners_inputOptional 
instance_owners_input: typing.List[str]
  • Type: typing.List[str]
kms_key_inputOptional 
kms_key_input: str
  • Type: str
labels_inputOptional 
labels_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
location_inputOptional 
location_input: str
  • Type: str
machine_type_inputOptional 
machine_type_input: str
  • Type: str
metadata_inputOptional 
metadata_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
name_inputOptional 
name_input: str
  • Type: str
network_inputOptional 
network_input: str
  • Type: str
nic_type_inputOptional 
nic_type_input: str
  • Type: str
no_proxy_access_inputOptional 
no_proxy_access_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
no_public_ip_inputOptional 
no_public_ip_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
no_remove_data_disk_inputOptional 
no_remove_data_disk_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
post_startup_script_inputOptional 
post_startup_script_input: str
  • Type: str
project_inputOptional 
project_input: str
  • Type: str
reservation_affinity_inputOptional 
reservation_affinity_input: NotebooksInstanceReservationAffinity
service_account_inputOptional 
service_account_input: str
  • Type: str
service_account_scopes_inputOptional 
service_account_scopes_input: typing.List[str]
  • Type: typing.List[str]
shielded_instance_config_inputOptional 
shielded_instance_config_input: NotebooksInstanceShieldedInstanceConfig
subnet_inputOptional 
subnet_input: str
  • Type: str
tags_inputOptional 
tags_input: typing.List[str]
  • Type: typing.List[str]
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, NotebooksInstanceTimeouts]
update_time_inputOptional 
update_time_input: str
  • Type: str
vm_image_inputOptional 
vm_image_input: NotebooksInstanceVmImage
boot_disk_size_gbRequired 
boot_disk_size_gb: typing.Union[int, float]
  • Type: typing.Union[int, float]
boot_disk_typeRequired 
boot_disk_type: str
  • Type: str
create_timeRequired 
create_time: str
  • Type: str
custom_gpu_driver_pathRequired 
custom_gpu_driver_path: str
  • Type: str
data_disk_size_gbRequired 
data_disk_size_gb: typing.Union[int, float]
  • Type: typing.Union[int, float]
data_disk_typeRequired 
data_disk_type: str
  • Type: str
desired_stateRequired 
desired_state: str
  • Type: str
disk_encryptionRequired 
disk_encryption: str
  • Type: str
idRequired 
id: str
  • Type: str
install_gpu_driverRequired 
install_gpu_driver: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
instance_ownersRequired 
instance_owners: typing.List[str]
  • Type: typing.List[str]
kms_keyRequired 
kms_key: str
  • Type: str
labelsRequired 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]
locationRequired 
location: str
  • Type: str
machine_typeRequired 
machine_type: str
  • Type: str
metadataRequired 
metadata: typing.Mapping[str]
  • Type: typing.Mapping[str]
nameRequired 
name: str
  • Type: str
networkRequired 
network: str
  • Type: str
nic_typeRequired 
nic_type: str
  • Type: str
no_proxy_accessRequired 
no_proxy_access: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
no_public_ipRequired 
no_public_ip: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
no_remove_data_diskRequired 
no_remove_data_disk: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
post_startup_scriptRequired 
post_startup_script: str
  • Type: str
projectRequired 
project: str
  • Type: str
service_accountRequired 
service_account: str
  • Type: str
service_account_scopesRequired 
service_account_scopes: typing.List[str]
  • Type: typing.List[str]
subnetRequired 
subnet: str
  • Type: str
tagsRequired 
tags: typing.List[str]
  • Type: typing.List[str]
update_timeRequired 
update_time: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

NotebooksInstanceAcceleratorConfig

Initializer 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceAcceleratorConfig(
  core_count: typing.Union[int, float],
  type: str
)

Properties

Name Type Description
core_count typing.Union[int, float] Count of cores of this accelerator.
type str Type of this accelerator. Possible values: ["ACCELERATOR_TYPE_UNSPECIFIED", "NVIDIA_TESLA_K80", "NVIDIA_TESLA_P100", "NVIDIA_TESLA_V100", "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS", "NVIDIA_TESLA_A100", "TPU_V2", "TPU_V3"].
core_countRequired 
core_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

Count of cores of this accelerator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#core_count NotebooksInstance#core_count}

typeRequired 
type: str
  • Type: str

Type of this accelerator. Possible values: ["ACCELERATOR_TYPE_UNSPECIFIED", "NVIDIA_TESLA_K80", "NVIDIA_TESLA_P100", "NVIDIA_TESLA_V100", "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS", "NVIDIA_TESLA_A100", "TPU_V2", "TPU_V3"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#type NotebooksInstance#type}

NotebooksInstanceConfig

Initializer 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceConfig(
  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,
  location: str,
  machine_type: str,
  name: str,
  accelerator_config: NotebooksInstanceAcceleratorConfig = None,
  boot_disk_size_gb: typing.Union[int, float] = None,
  boot_disk_type: str = None,
  container_image: NotebooksInstanceContainerImage = None,
  create_time: str = None,
  custom_gpu_driver_path: str = None,
  data_disk_size_gb: typing.Union[int, float] = None,
  data_disk_type: str = None,
  desired_state: str = None,
  disk_encryption: str = None,
  id: str = None,
  install_gpu_driver: typing.Union[bool, IResolvable] = None,
  instance_owners: typing.List[str] = None,
  kms_key: str = None,
  labels: typing.Mapping[str] = None,
  metadata: typing.Mapping[str] = None,
  network: str = None,
  nic_type: str = None,
  no_proxy_access: typing.Union[bool, IResolvable] = None,
  no_public_ip: typing.Union[bool, IResolvable] = None,
  no_remove_data_disk: typing.Union[bool, IResolvable] = None,
  post_startup_script: str = None,
  project: str = None,
  reservation_affinity: NotebooksInstanceReservationAffinity = None,
  service_account: str = None,
  service_account_scopes: typing.List[str] = None,
  shielded_instance_config: NotebooksInstanceShieldedInstanceConfig = None,
  subnet: str = None,
  tags: typing.List[str] = None,
  timeouts: NotebooksInstanceTimeouts = None,
  update_time: str = None,
  vm_image: NotebooksInstanceVmImage = 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.
location str A reference to the zone where the machine resides.
machine_type str A reference to a machine type which defines VM kind.
name str The name specified for the Notebook instance.
accelerator_config NotebooksInstanceAcceleratorConfig accelerator_config block.
boot_disk_size_gb typing.Union[int, float] The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).
boot_disk_type str Possible disk types for notebook instances. Possible values: ["DISK_TYPE_UNSPECIFIED", "PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].
container_image NotebooksInstanceContainerImage container_image block.
create_time str Instance creation time.
custom_gpu_driver_path str Specify a custom Cloud Storage path where the GPU driver is stored.
data_disk_size_gb typing.Union[int, float] The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).
data_disk_type str Possible disk types for notebook instances. Possible values: ["DISK_TYPE_UNSPECIFIED", "PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].
desired_state str Desired state of the Notebook Instance.
disk_encryption str Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values: ["DISK_ENCRYPTION_UNSPECIFIED", "GMEK", "CMEK"].
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#id NotebooksInstance#id}.
install_gpu_driver typing.Union[bool, cdktf.IResolvable] Whether the end user authorizes Google Cloud to install GPU driver on this instance.
instance_owners typing.List[str] The list of owners of this instance after creation.
kms_key str The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}.
labels typing.Mapping[str] Labels to apply to this instance.
metadata typing.Mapping[str] Custom metadata to apply to this instance.
network str The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}.
nic_type str The type of vNIC driver. Possible values: ["UNSPECIFIED_NIC_TYPE", "VIRTIO_NET", "GVNIC"].
no_proxy_access typing.Union[bool, cdktf.IResolvable] The notebook instance will not register with the proxy..
no_public_ip typing.Union[bool, cdktf.IResolvable] No public IP will be assigned to this instance.
no_remove_data_disk typing.Union[bool, cdktf.IResolvable] If true, the data disk will not be auto deleted when deleting the instance.
post_startup_script str Path to a Bash script that automatically runs after a notebook instance fully boots up.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#project NotebooksInstance#project}.
reservation_affinity NotebooksInstanceReservationAffinity reservation_affinity block.
service_account str The service account on this instance, giving access to other Google Cloud services.
service_account_scopes typing.List[str] Optional.
shielded_instance_config NotebooksInstanceShieldedInstanceConfig shielded_instance_config block.
subnet str The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}.
tags typing.List[str] The Compute Engine tags to add to instance.
timeouts NotebooksInstanceTimeouts timeouts block.
update_time str Instance update time.
vm_image NotebooksInstanceVmImage vm_image block.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
locationRequired 
location: str
  • Type: str

A reference to the zone where the machine resides.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#location NotebooksInstance#location}

machine_typeRequired 
machine_type: str
  • Type: str

A reference to a machine type which defines VM kind.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#machine_type NotebooksInstance#machine_type}

nameRequired 
name: str
  • Type: str

The name specified for the Notebook instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#name NotebooksInstance#name}

accelerator_configOptional 
accelerator_config: NotebooksInstanceAcceleratorConfig

accelerator_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#accelerator_config NotebooksInstance#accelerator_config}

boot_disk_size_gbOptional 
boot_disk_size_gb: typing.Union[int, float]
  • Type: typing.Union[int, float]

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).

The minimum recommended value is 100 GB. If not specified, this defaults to 100.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#boot_disk_size_gb NotebooksInstance#boot_disk_size_gb}

boot_disk_typeOptional 
boot_disk_type: str
  • Type: str

Possible disk types for notebook instances. Possible values: ["DISK_TYPE_UNSPECIFIED", "PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#boot_disk_type NotebooksInstance#boot_disk_type}

container_imageOptional 
container_image: NotebooksInstanceContainerImage

container_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#container_image NotebooksInstance#container_image}

create_timeOptional 
create_time: str
  • Type: str

Instance creation time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#create_time NotebooksInstance#create_time}

custom_gpu_driver_pathOptional 
custom_gpu_driver_path: str
  • Type: str

Specify a custom Cloud Storage path where the GPU driver is stored.

If not specified, we'll automatically choose from official GPU drivers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#custom_gpu_driver_path NotebooksInstance#custom_gpu_driver_path}

data_disk_size_gbOptional 
data_disk_size_gb: typing.Union[int, float]
  • Type: typing.Union[int, float]

The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB).

You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#data_disk_size_gb NotebooksInstance#data_disk_size_gb}

data_disk_typeOptional 
data_disk_type: str
  • Type: str

Possible disk types for notebook instances. Possible values: ["DISK_TYPE_UNSPECIFIED", "PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#data_disk_type NotebooksInstance#data_disk_type}

desired_stateOptional 
desired_state: str
  • Type: str

Desired state of the Notebook Instance.

Set this field to 'ACTIVE' to start the Instance, and 'STOPPED' to stop the Instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#desired_state NotebooksInstance#desired_state}

disk_encryptionOptional 
disk_encryption: str
  • Type: str

Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values: ["DISK_ENCRYPTION_UNSPECIFIED", "GMEK", "CMEK"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#disk_encryption NotebooksInstance#disk_encryption}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#id NotebooksInstance#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.

install_gpu_driverOptional 
install_gpu_driver: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the end user authorizes Google Cloud to install GPU driver on this instance.

If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#install_gpu_driver NotebooksInstance#install_gpu_driver}

instance_ownersOptional 
instance_owners: typing.List[str]
  • Type: typing.List[str]

The list of owners of this instance after creation.

Format: alias@example.com. Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#instance_owners NotebooksInstance#instance_owners}

kms_keyOptional 
kms_key: str
  • Type: str

The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#kms_key NotebooksInstance#kms_key}

labelsOptional 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

Labels to apply to this instance.

These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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.34.0/docs/resources/notebooks_instance#labels NotebooksInstance#labels}

metadataOptional 
metadata: typing.Mapping[str]
  • Type: typing.Mapping[str]

Custom metadata to apply to this instance.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#metadata NotebooksInstance#metadata}

networkOptional 
network: str
  • Type: str

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#network NotebooksInstance#network}

nic_typeOptional 
nic_type: str
  • Type: str

The type of vNIC driver. Possible values: ["UNSPECIFIED_NIC_TYPE", "VIRTIO_NET", "GVNIC"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#nic_type NotebooksInstance#nic_type}

no_proxy_accessOptional 
no_proxy_access: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

The notebook instance will not register with the proxy..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#no_proxy_access NotebooksInstance#no_proxy_access}

no_public_ipOptional 
no_public_ip: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

No public IP will be assigned to this instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#no_public_ip NotebooksInstance#no_public_ip}

no_remove_data_diskOptional 
no_remove_data_disk: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

If true, the data disk will not be auto deleted when deleting the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#no_remove_data_disk NotebooksInstance#no_remove_data_disk}

post_startup_scriptOptional 
post_startup_script: str
  • Type: str

Path to a Bash script that automatically runs after a notebook instance fully boots up.

The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#post_startup_script NotebooksInstance#post_startup_script}

projectOptional 
project: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#project NotebooksInstance#project}.

reservation_affinityOptional 
reservation_affinity: NotebooksInstanceReservationAffinity

reservation_affinity block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#reservation_affinity NotebooksInstance#reservation_affinity}

service_accountOptional 
service_account: str
  • Type: str

The service account on this instance, giving access to other Google Cloud services.

You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#service_account NotebooksInstance#service_account}

service_account_scopesOptional 
service_account_scopes: typing.List[str]
  • Type: typing.List[str]

Optional.

The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined:

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#service_account_scopes NotebooksInstance#service_account_scopes}

shielded_instance_configOptional 
shielded_instance_config: NotebooksInstanceShieldedInstanceConfig

shielded_instance_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#shielded_instance_config NotebooksInstance#shielded_instance_config}

subnetOptional 
subnet: str
  • Type: str

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#subnet NotebooksInstance#subnet}

tagsOptional 
tags: typing.List[str]
  • Type: typing.List[str]

The Compute Engine tags to add to instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#tags NotebooksInstance#tags}

timeoutsOptional 
timeouts: NotebooksInstanceTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#timeouts NotebooksInstance#timeouts}

update_timeOptional 
update_time: str
  • Type: str

Instance update time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#update_time NotebooksInstance#update_time}

vm_imageOptional 
vm_image: NotebooksInstanceVmImage

vm_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#vm_image NotebooksInstance#vm_image}

NotebooksInstanceContainerImage

Initializer 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceContainerImage(
  repository: str,
  tag: str = None
)

Properties

Name Type Description
repository str The path to the container image repository. For example: gcr.io/{project_id}/{imageName}.
tag str The tag of the container image. If not specified, this defaults to the latest tag.
repositoryRequired 
repository: str
  • Type: str

The path to the container image repository. For example: gcr.io/{project_id}/{imageName}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#repository NotebooksInstance#repository}

tagOptional 
tag: str
  • Type: str

The tag of the container image. If not specified, this defaults to the latest tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#tag NotebooksInstance#tag}

NotebooksInstanceReservationAffinity

Initializer 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceReservationAffinity(
  consume_reservation_type: str,
  key: str = None,
  values: typing.List[str] = None
)

Properties

Name Type Description
consume_reservation_type str The type of Compute Reservation. Possible values: ["NO_RESERVATION", "ANY_RESERVATION", "SPECIFIC_RESERVATION"].
key str Corresponds to the label key of reservation resource.
values typing.List[str] Corresponds to the label values of reservation resource.
consume_reservation_typeRequired 
consume_reservation_type: str
  • Type: str

The type of Compute Reservation. Possible values: ["NO_RESERVATION", "ANY_RESERVATION", "SPECIFIC_RESERVATION"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#consume_reservation_type NotebooksInstance#consume_reservation_type}

keyOptional 
key: str
  • Type: str

Corresponds to the label key of reservation resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#key NotebooksInstance#key}

valuesOptional 
values: typing.List[str]
  • Type: typing.List[str]

Corresponds to the label values of reservation resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#values NotebooksInstance#values}

NotebooksInstanceShieldedInstanceConfig

Initializer 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceShieldedInstanceConfig(
  enable_integrity_monitoring: typing.Union[bool, IResolvable] = None,
  enable_secure_boot: typing.Union[bool, IResolvable] = None,
  enable_vtpm: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
enable_integrity_monitoring typing.Union[bool, cdktf.IResolvable] Defines whether the instance has integrity monitoring enabled.
enable_secure_boot typing.Union[bool, cdktf.IResolvable] Defines whether the instance has Secure Boot enabled.
enable_vtpm typing.Union[bool, cdktf.IResolvable] Defines whether the instance has the vTPM enabled. Enabled by default.
enable_integrity_monitoringOptional 
enable_integrity_monitoring: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Defines whether the instance has integrity monitoring enabled.

Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#enable_integrity_monitoring NotebooksInstance#enable_integrity_monitoring}

enable_secure_bootOptional 
enable_secure_boot: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Defines whether the instance has Secure Boot enabled.

Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#enable_secure_boot NotebooksInstance#enable_secure_boot}

enable_vtpmOptional 
enable_vtpm: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Defines whether the instance has the vTPM enabled. Enabled by default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#enable_vtpm NotebooksInstance#enable_vtpm}

NotebooksInstanceTimeouts

Initializer 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceTimeouts(
  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.34.0/docs/resources/notebooks_instance#create NotebooksInstance#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#delete NotebooksInstance#delete}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#update NotebooksInstance#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#create NotebooksInstance#create}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#delete NotebooksInstance#delete}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#update NotebooksInstance#update}.

NotebooksInstanceVmImage

Initializer 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceVmImage(
  project: str,
  image_family: str = None,
  image_name: str = None
)

Properties

Name Type Description
project str The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}.
image_family str Use this VM image family to find the image; the newest image in this family will be used.
image_name str Use VM image name to find the image.
projectRequired 
project: str
  • Type: str

The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#project NotebooksInstance#project}

image_familyOptional 
image_family: str
  • Type: str

Use this VM image family to find the image; the newest image in this family will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#image_family NotebooksInstance#image_family}

image_nameOptional 
image_name: str
  • Type: str

Use VM image name to find the image.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/notebooks_instance#image_name NotebooksInstance#image_name}

Classes

NotebooksInstanceAcceleratorConfigOutputReference

Initializers 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceAcceleratorConfigOutputReference(
  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_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • 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.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
core_count_input typing.Union[int, float] No description.
type_input str No description.
core_count typing.Union[int, float] No description.
type str No description.
internal_value NotebooksInstanceAcceleratorConfig No description.
creation_stackRequired 
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.

fqnRequired 
fqn: str
  • Type: str
core_count_inputOptional 
core_count_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
type_inputOptional 
type_input: str
  • Type: str
core_countRequired 
core_count: typing.Union[int, float]
  • Type: typing.Union[int, float]
typeRequired 
type: str
  • Type: str
internal_valueOptional 
internal_value: NotebooksInstanceAcceleratorConfig

NotebooksInstanceContainerImageOutputReference

Initializers 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceContainerImageOutputReference(
  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_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • 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_tag 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_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_tag 
def reset_tag() -> 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.
repository_input str No description.
tag_input str No description.
repository str No description.
tag str No description.
internal_value NotebooksInstanceContainerImage No description.
creation_stackRequired 
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.

fqnRequired 
fqn: str
  • Type: str
repository_inputOptional 
repository_input: str
  • Type: str
tag_inputOptional 
tag_input: str
  • Type: str
repositoryRequired 
repository: str
  • Type: str
tagRequired 
tag: str
  • Type: str
internal_valueOptional 
internal_value: NotebooksInstanceContainerImage

NotebooksInstanceReservationAffinityOutputReference

Initializers 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceReservationAffinityOutputReference(
  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_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • 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_key No description.
reset_values 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_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_key 
def reset_key() -> None
reset_values 
def reset_values() -> 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.
consume_reservation_type_input str No description.
key_input str No description.
values_input typing.List[str] No description.
consume_reservation_type str No description.
key str No description.
values typing.List[str] No description.
internal_value NotebooksInstanceReservationAffinity No description.
creation_stackRequired 
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.

fqnRequired 
fqn: str
  • Type: str
consume_reservation_type_inputOptional 
consume_reservation_type_input: str
  • Type: str
key_inputOptional 
key_input: str
  • Type: str
values_inputOptional 
values_input: typing.List[str]
  • Type: typing.List[str]
consume_reservation_typeRequired 
consume_reservation_type: str
  • Type: str
keyRequired 
key: str
  • Type: str
valuesRequired 
values: typing.List[str]
  • Type: typing.List[str]
internal_valueOptional 
internal_value: NotebooksInstanceReservationAffinity

NotebooksInstanceShieldedInstanceConfigOutputReference

Initializers 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceShieldedInstanceConfigOutputReference(
  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_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • 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_enable_integrity_monitoring No description.
reset_enable_secure_boot No description.
reset_enable_vtpm 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_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_enable_integrity_monitoring 
def reset_enable_integrity_monitoring() -> None
reset_enable_secure_boot 
def reset_enable_secure_boot() -> None
reset_enable_vtpm 
def reset_enable_vtpm() -> 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.
enable_integrity_monitoring_input typing.Union[bool, cdktf.IResolvable] No description.
enable_secure_boot_input typing.Union[bool, cdktf.IResolvable] No description.
enable_vtpm_input typing.Union[bool, cdktf.IResolvable] No description.
enable_integrity_monitoring typing.Union[bool, cdktf.IResolvable] No description.
enable_secure_boot typing.Union[bool, cdktf.IResolvable] No description.
enable_vtpm typing.Union[bool, cdktf.IResolvable] No description.
internal_value NotebooksInstanceShieldedInstanceConfig No description.
creation_stackRequired 
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.

fqnRequired 
fqn: str
  • Type: str
enable_integrity_monitoring_inputOptional 
enable_integrity_monitoring_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
enable_secure_boot_inputOptional 
enable_secure_boot_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
enable_vtpm_inputOptional 
enable_vtpm_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
enable_integrity_monitoringRequired 
enable_integrity_monitoring: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
enable_secure_bootRequired 
enable_secure_boot: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
enable_vtpmRequired 
enable_vtpm: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
internal_valueOptional 
internal_value: NotebooksInstanceShieldedInstanceConfig

NotebooksInstanceTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceTimeoutsOutputReference(
  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_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • 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_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • 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, NotebooksInstanceTimeouts] No description.
creation_stackRequired 
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.

fqnRequired 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, NotebooksInstanceTimeouts]

NotebooksInstanceVmImageOutputReference

Initializers 

from cdktf_cdktf_provider_google import notebooks_instance

notebooksInstance.NotebooksInstanceVmImageOutputReference(
  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_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • 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_image_family No description.
reset_image_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_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_image_family 
def reset_image_family() -> None
reset_image_name 
def reset_image_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.
image_family_input str No description.
image_name_input str No description.
project_input str No description.
image_family str No description.
image_name str No description.
project str No description.
internal_value NotebooksInstanceVmImage No description.
creation_stackRequired 
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.

fqnRequired 
fqn: str
  • Type: str
image_family_inputOptional 
image_family_input: str
  • Type: str
image_name_inputOptional 
image_name_input: str
  • Type: str
project_inputOptional 
project_input: str
  • Type: str
image_familyRequired 
image_family: str
  • Type: str
image_nameRequired 
image_name: str
  • Type: str
projectRequired 
project: str
  • Type: str
internal_valueOptional 
internal_value: NotebooksInstanceVmImage