Skip to content

Files

Latest commit

e9c717d · May 13, 2025

History

History
9396 lines (5972 loc) · 431 KB
·

workbenchInstance.python.md

File metadata and controls

9396 lines (5972 loc) · 431 KB
·

workbenchInstance Submodule

Constructs

WorkbenchInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance google_workbench_instance}.

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstance(
  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,
  name: str,
  desired_state: str = None,
  disable_proxy_access: typing.Union[bool, IResolvable] = None,
  enable_third_party_identity: typing.Union[bool, IResolvable] = None,
  gce_setup: WorkbenchInstanceGceSetup = None,
  id: str = None,
  instance_id: str = None,
  instance_owners: typing.List[str] = None,
  labels: typing.Mapping[str] = None,
  project: str = None,
  timeouts: WorkbenchInstanceTimeouts = 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 Part of 'parent'. See documentation of 'projectsId'.
name str The name of this workbench instance. Format: 'projects/{project_id}/locations/{location}/instances/{instance_id}'.
desired_state str Desired state of the Workbench Instance.
disable_proxy_access typing.Union[bool, cdktf.IResolvable] Optional. If true, the workbench instance will not register with the proxy.
enable_third_party_identity typing.Union[bool, cdktf.IResolvable] Flag that specifies that a notebook can be accessed with third party identity provider.
gce_setup WorkbenchInstanceGceSetup gce_setup block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#id WorkbenchInstance#id}.
instance_id str Required. User-defined unique ID of this instance.
instance_owners typing.List[str] 'Optional.
labels typing.Mapping[str] Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#project WorkbenchInstance#project}.
timeouts WorkbenchInstanceTimeouts timeouts 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

Part of 'parent'. See documentation of 'projectsId'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#location WorkbenchInstance#location}


nameRequired
  • Type: str

The name of this workbench instance. Format: 'projects/{project_id}/locations/{location}/instances/{instance_id}'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#name WorkbenchInstance#name}


desired_stateOptional
  • Type: str

Desired state of the Workbench 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.1/docs/resources/workbench_instance#desired_state WorkbenchInstance#desired_state}


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

Optional. If true, the workbench instance will not register with the proxy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disable_proxy_access WorkbenchInstance#disable_proxy_access}


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

Flag that specifies that a notebook can be accessed with third party identity provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#enable_third_party_identity WorkbenchInstance#enable_third_party_identity}


gce_setupOptional

gce_setup block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#gce_setup WorkbenchInstance#gce_setup}


idOptional
  • Type: str

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


instance_idOptional
  • Type: str

Required. User-defined unique ID of this instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#instance_id WorkbenchInstance#instance_id}


instance_ownersOptional
  • Type: typing.List[str]

'Optional.

Input only. The owner 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. If specified, sets the access mode to 'Single user'. For more details, see https://cloud.google.com/vertex-ai/docs/workbench/instances/manage-access-jupyterlab'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#instance_owners WorkbenchInstance#instance_owners}


labelsOptional
  • Type: typing.Mapping[str]

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

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.1/docs/resources/workbench_instance#labels WorkbenchInstance#labels}


projectOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#project WorkbenchInstance#project}.


timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#timeouts WorkbenchInstance#timeouts}


Methods

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

to_string
def to_string() -> str

Returns a string representation of this construct.

add_override
def add_override(
  path: str,
  value: typing.Any
) -> None
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_gce_setup
def put_gce_setup(
  accelerator_configs: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupAcceleratorConfigs]] = None,
  boot_disk: WorkbenchInstanceGceSetupBootDisk = None,
  confidential_instance_config: WorkbenchInstanceGceSetupConfidentialInstanceConfig = None,
  container_image: WorkbenchInstanceGceSetupContainerImage = None,
  data_disks: WorkbenchInstanceGceSetupDataDisks = None,
  disable_public_ip: typing.Union[bool, IResolvable] = None,
  enable_ip_forwarding: typing.Union[bool, IResolvable] = None,
  machine_type: str = None,
  metadata: typing.Mapping[str] = None,
  network_interfaces: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfaces]] = None,
  service_accounts: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupServiceAccounts]] = None,
  shielded_instance_config: WorkbenchInstanceGceSetupShieldedInstanceConfig = None,
  tags: typing.List[str] = None,
  vm_image: WorkbenchInstanceGceSetupVmImage = None
) -> None
accelerator_configsOptional

accelerator_configs block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#accelerator_configs WorkbenchInstance#accelerator_configs}


boot_diskOptional

boot_disk block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#boot_disk WorkbenchInstance#boot_disk}


confidential_instance_configOptional

confidential_instance_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#confidential_instance_config WorkbenchInstance#confidential_instance_config}


container_imageOptional

container_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#container_image WorkbenchInstance#container_image}


data_disksOptional

data_disks block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#data_disks WorkbenchInstance#data_disks}


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

Optional. If true, no external IP will be assigned to this VM instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disable_public_ip WorkbenchInstance#disable_public_ip}


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

Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#enable_ip_forwarding WorkbenchInstance#enable_ip_forwarding}


machine_typeOptional
  • Type: str

Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#machine_type WorkbenchInstance#machine_type}


metadataOptional
  • Type: typing.Mapping[str]

Optional. Custom metadata to apply to this instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#metadata WorkbenchInstance#metadata}


network_interfacesOptional

network_interfaces block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#network_interfaces WorkbenchInstance#network_interfaces}


service_accountsOptional

service_accounts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#service_accounts WorkbenchInstance#service_accounts}


shielded_instance_configOptional

shielded_instance_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#shielded_instance_config WorkbenchInstance#shielded_instance_config}


tagsOptional
  • Type: typing.List[str]

Optional. The Compute Engine tags to add to instance (see Tagging instances).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#tags WorkbenchInstance#tags}


vm_imageOptional

vm_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#vm_image WorkbenchInstance#vm_image}


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.1/docs/resources/workbench_instance#create WorkbenchInstance#create}.


deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#delete WorkbenchInstance#delete}.


updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#update WorkbenchInstance#update}.


reset_desired_state
def reset_desired_state() -> None
reset_disable_proxy_access
def reset_disable_proxy_access() -> None
reset_enable_third_party_identity
def reset_enable_third_party_identity() -> None
reset_gce_setup
def reset_gce_setup() -> None
reset_id
def reset_id() -> None
reset_instance_id
def reset_instance_id() -> None
reset_instance_owners
def reset_instance_owners() -> None
reset_labels
def reset_labels() -> None
reset_project
def reset_project() -> None
reset_timeouts
def reset_timeouts() -> None

Static Functions

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

is_construct
from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstance.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 workbench_instance

workbenchInstance.WorkbenchInstance.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstance.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstance.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a WorkbenchInstance 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 WorkbenchInstance to import.


import_from_idRequired
  • Type: str

The id of the existing WorkbenchInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_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 WorkbenchInstance to import is found.


Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
create_time str No description.
creator str No description.
effective_labels cdktf.StringMap No description.
gce_setup WorkbenchInstanceGceSetupOutputReference No description.
health_info WorkbenchInstanceHealthInfoList No description.
health_state str No description.
proxy_uri str No description.
state str No description.
terraform_labels cdktf.StringMap No description.
timeouts WorkbenchInstanceTimeoutsOutputReference No description.
update_time str No description.
upgrade_history WorkbenchInstanceUpgradeHistoryList No description.
desired_state_input str No description.
disable_proxy_access_input typing.Union[bool, cdktf.IResolvable] No description.
enable_third_party_identity_input typing.Union[bool, cdktf.IResolvable] No description.
gce_setup_input WorkbenchInstanceGceSetup No description.
id_input str No description.
instance_id_input str No description.
instance_owners_input typing.List[str] No description.
labels_input typing.Mapping[str] No description.
location_input str No description.
name_input str No description.
project_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, WorkbenchInstanceTimeouts] No description.
desired_state str No description.
disable_proxy_access typing.Union[bool, cdktf.IResolvable] No description.
enable_third_party_identity typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
instance_id str No description.
instance_owners typing.List[str] No description.
labels typing.Mapping[str] No description.
location str No description.
name str No description.
project 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]]

create_timeRequired
create_time: str
  • Type: str

creatorRequired
creator: str
  • Type: str

effective_labelsRequired
effective_labels: StringMap
  • Type: cdktf.StringMap

gce_setupRequired
gce_setup: WorkbenchInstanceGceSetupOutputReference

health_infoRequired
health_info: WorkbenchInstanceHealthInfoList

health_stateRequired
health_state: str
  • Type: str

proxy_uriRequired
proxy_uri: str
  • Type: str

stateRequired
state: str
  • Type: str

terraform_labelsRequired
terraform_labels: StringMap
  • Type: cdktf.StringMap

timeoutsRequired
timeouts: WorkbenchInstanceTimeoutsOutputReference

update_timeRequired
update_time: str
  • Type: str

upgrade_historyRequired
upgrade_history: WorkbenchInstanceUpgradeHistoryList

desired_state_inputOptional
desired_state_input: str
  • Type: str

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

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

gce_setup_inputOptional
gce_setup_input: WorkbenchInstanceGceSetup

id_inputOptional
id_input: str
  • Type: str

instance_id_inputOptional
instance_id_input: str
  • Type: str

instance_owners_inputOptional
instance_owners_input: typing.List[str]
  • Type: typing.List[str]

labels_inputOptional
labels_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

location_inputOptional
location_input: str
  • Type: str

name_inputOptional
name_input: str
  • Type: str

project_inputOptional
project_input: str
  • Type: str

timeouts_inputOptional
timeouts_input: typing.Union[IResolvable, WorkbenchInstanceTimeouts]

desired_stateRequired
desired_state: str
  • Type: str

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

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

idRequired
id: str
  • Type: str

instance_idRequired
instance_id: str
  • Type: str

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

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

locationRequired
location: str
  • Type: str

nameRequired
name: str
  • Type: str

projectRequired
project: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

WorkbenchInstanceConfig

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceConfig(
  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,
  name: str,
  desired_state: str = None,
  disable_proxy_access: typing.Union[bool, IResolvable] = None,
  enable_third_party_identity: typing.Union[bool, IResolvable] = None,
  gce_setup: WorkbenchInstanceGceSetup = None,
  id: str = None,
  instance_id: str = None,
  instance_owners: typing.List[str] = None,
  labels: typing.Mapping[str] = None,
  project: str = None,
  timeouts: WorkbenchInstanceTimeouts = 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 Part of 'parent'. See documentation of 'projectsId'.
name str The name of this workbench instance. Format: 'projects/{project_id}/locations/{location}/instances/{instance_id}'.
desired_state str Desired state of the Workbench Instance.
disable_proxy_access typing.Union[bool, cdktf.IResolvable] Optional. If true, the workbench instance will not register with the proxy.
enable_third_party_identity typing.Union[bool, cdktf.IResolvable] Flag that specifies that a notebook can be accessed with third party identity provider.
gce_setup WorkbenchInstanceGceSetup gce_setup block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#id WorkbenchInstance#id}.
instance_id str Required. User-defined unique ID of this instance.
instance_owners typing.List[str] 'Optional.
labels typing.Mapping[str] Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#project WorkbenchInstance#project}.
timeouts WorkbenchInstanceTimeouts timeouts 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

Part of 'parent'. See documentation of 'projectsId'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#location WorkbenchInstance#location}


nameRequired
name: str
  • Type: str

The name of this workbench instance. Format: 'projects/{project_id}/locations/{location}/instances/{instance_id}'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#name WorkbenchInstance#name}


desired_stateOptional
desired_state: str
  • Type: str

Desired state of the Workbench 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.1/docs/resources/workbench_instance#desired_state WorkbenchInstance#desired_state}


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

Optional. If true, the workbench instance will not register with the proxy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disable_proxy_access WorkbenchInstance#disable_proxy_access}


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

Flag that specifies that a notebook can be accessed with third party identity provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#enable_third_party_identity WorkbenchInstance#enable_third_party_identity}


gce_setupOptional
gce_setup: WorkbenchInstanceGceSetup

gce_setup block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#gce_setup WorkbenchInstance#gce_setup}


idOptional
id: str
  • Type: str

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


instance_idOptional
instance_id: str
  • Type: str

Required. User-defined unique ID of this instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#instance_id WorkbenchInstance#instance_id}


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

'Optional.

Input only. The owner 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. If specified, sets the access mode to 'Single user'. For more details, see https://cloud.google.com/vertex-ai/docs/workbench/instances/manage-access-jupyterlab'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#instance_owners WorkbenchInstance#instance_owners}


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

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

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.1/docs/resources/workbench_instance#labels WorkbenchInstance#labels}


projectOptional
project: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#project WorkbenchInstance#project}.


timeoutsOptional
timeouts: WorkbenchInstanceTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#timeouts WorkbenchInstance#timeouts}


WorkbenchInstanceGceSetup

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetup(
  accelerator_configs: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupAcceleratorConfigs]] = None,
  boot_disk: WorkbenchInstanceGceSetupBootDisk = None,
  confidential_instance_config: WorkbenchInstanceGceSetupConfidentialInstanceConfig = None,
  container_image: WorkbenchInstanceGceSetupContainerImage = None,
  data_disks: WorkbenchInstanceGceSetupDataDisks = None,
  disable_public_ip: typing.Union[bool, IResolvable] = None,
  enable_ip_forwarding: typing.Union[bool, IResolvable] = None,
  machine_type: str = None,
  metadata: typing.Mapping[str] = None,
  network_interfaces: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfaces]] = None,
  service_accounts: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupServiceAccounts]] = None,
  shielded_instance_config: WorkbenchInstanceGceSetupShieldedInstanceConfig = None,
  tags: typing.List[str] = None,
  vm_image: WorkbenchInstanceGceSetupVmImage = None
)

Properties

Name Type Description
accelerator_configs typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupAcceleratorConfigs]] accelerator_configs block.
boot_disk WorkbenchInstanceGceSetupBootDisk boot_disk block.
confidential_instance_config WorkbenchInstanceGceSetupConfidentialInstanceConfig confidential_instance_config block.
container_image WorkbenchInstanceGceSetupContainerImage container_image block.
data_disks WorkbenchInstanceGceSetupDataDisks data_disks block.
disable_public_ip typing.Union[bool, cdktf.IResolvable] Optional. If true, no external IP will be assigned to this VM instance.
enable_ip_forwarding typing.Union[bool, cdktf.IResolvable] Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward.
machine_type str Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource.
metadata typing.Mapping[str] Optional. Custom metadata to apply to this instance.
network_interfaces typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfaces]] network_interfaces block.
service_accounts typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupServiceAccounts]] service_accounts block.
shielded_instance_config WorkbenchInstanceGceSetupShieldedInstanceConfig shielded_instance_config block.
tags typing.List[str] Optional. The Compute Engine tags to add to instance (see Tagging instances).
vm_image WorkbenchInstanceGceSetupVmImage vm_image block.

accelerator_configsOptional
accelerator_configs: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupAcceleratorConfigs]]

accelerator_configs block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#accelerator_configs WorkbenchInstance#accelerator_configs}


boot_diskOptional
boot_disk: WorkbenchInstanceGceSetupBootDisk

boot_disk block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#boot_disk WorkbenchInstance#boot_disk}


confidential_instance_configOptional
confidential_instance_config: WorkbenchInstanceGceSetupConfidentialInstanceConfig

confidential_instance_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#confidential_instance_config WorkbenchInstance#confidential_instance_config}


container_imageOptional
container_image: WorkbenchInstanceGceSetupContainerImage

container_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#container_image WorkbenchInstance#container_image}


data_disksOptional
data_disks: WorkbenchInstanceGceSetupDataDisks

data_disks block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#data_disks WorkbenchInstance#data_disks}


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

Optional. If true, no external IP will be assigned to this VM instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disable_public_ip WorkbenchInstance#disable_public_ip}


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

Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#enable_ip_forwarding WorkbenchInstance#enable_ip_forwarding}


machine_typeOptional
machine_type: str
  • Type: str

Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#machine_type WorkbenchInstance#machine_type}


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

Optional. Custom metadata to apply to this instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#metadata WorkbenchInstance#metadata}


network_interfacesOptional
network_interfaces: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfaces]]

network_interfaces block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#network_interfaces WorkbenchInstance#network_interfaces}


service_accountsOptional
service_accounts: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupServiceAccounts]]

service_accounts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#service_accounts WorkbenchInstance#service_accounts}


shielded_instance_configOptional
shielded_instance_config: WorkbenchInstanceGceSetupShieldedInstanceConfig

shielded_instance_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#shielded_instance_config WorkbenchInstance#shielded_instance_config}


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

Optional. The Compute Engine tags to add to instance (see Tagging instances).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#tags WorkbenchInstance#tags}


vm_imageOptional
vm_image: WorkbenchInstanceGceSetupVmImage

vm_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#vm_image WorkbenchInstance#vm_image}


WorkbenchInstanceGceSetupAcceleratorConfigs

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupAcceleratorConfigs(
  core_count: str = None,
  type: str = None
)

Properties

Name Type Description
core_count str Optional. Count of cores of this accelerator.
type str Optional. Type of this accelerator. Possible values: ["NVIDIA_TESLA_P100", "NVIDIA_TESLA_V100", "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_A100", "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS"].

core_countOptional
core_count: str
  • Type: str

Optional. Count of cores of this accelerator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#core_count WorkbenchInstance#core_count}


typeOptional
type: str
  • Type: str

Optional. Type of this accelerator. Possible values: ["NVIDIA_TESLA_P100", "NVIDIA_TESLA_V100", "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_A100", "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#type WorkbenchInstance#type}


WorkbenchInstanceGceSetupBootDisk

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupBootDisk(
  disk_encryption: str = None,
  disk_size_gb: str = None,
  disk_type: str = None,
  kms_key: str = None
)

Properties

Name Type Description
disk_encryption str Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values: ["GMEK", "CMEK"].
disk_size_gb str Optional.
disk_type str Optional. Indicates the type of the disk. Possible values: ["PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].
kms_key str 'Optional.

disk_encryptionOptional
disk_encryption: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_encryption WorkbenchInstance#disk_encryption}


disk_size_gbOptional
disk_size_gb: str
  • Type: str

Optional.

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to the recommended value of 150GB.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_size_gb WorkbenchInstance#disk_size_gb}


disk_typeOptional
disk_type: str
  • Type: str

Optional. Indicates the type of the disk. Possible values: ["PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_type WorkbenchInstance#disk_type}


kms_keyOptional
kms_key: str
  • Type: str

'Optional.

The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: 'projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}' Learn more about using your own encryption keys.'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#kms_key WorkbenchInstance#kms_key}


WorkbenchInstanceGceSetupConfidentialInstanceConfig

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupConfidentialInstanceConfig(
  confidential_instance_type: str = None
)

Properties

Name Type Description
confidential_instance_type str Defines the type of technology used by the confidential instance. Possible values: ["SEV"].

confidential_instance_typeOptional
confidential_instance_type: str
  • Type: str

Defines the type of technology used by the confidential instance. Possible values: ["SEV"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#confidential_instance_type WorkbenchInstance#confidential_instance_type}


WorkbenchInstanceGceSetupContainerImage

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupContainerImage(
  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.1/docs/resources/workbench_instance#repository WorkbenchInstance#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.1/docs/resources/workbench_instance#tag WorkbenchInstance#tag}


WorkbenchInstanceGceSetupDataDisks

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupDataDisks(
  disk_encryption: str = None,
  disk_size_gb: str = None,
  disk_type: str = None,
  kms_key: str = None
)

Properties

Name Type Description
disk_encryption str Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values: ["GMEK", "CMEK"].
disk_size_gb str Optional.
disk_type str Optional. Input only. Indicates the type of the disk. Possible values: ["PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].
kms_key str 'Optional.

disk_encryptionOptional
disk_encryption: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_encryption WorkbenchInstance#disk_encryption}


disk_size_gbOptional
disk_size_gb: str
  • Type: str

Optional.

The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_size_gb WorkbenchInstance#disk_size_gb}


disk_typeOptional
disk_type: str
  • Type: str

Optional. Input only. Indicates the type of the disk. Possible values: ["PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_type WorkbenchInstance#disk_type}


kms_keyOptional
kms_key: str
  • Type: str

'Optional.

The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: 'projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}' Learn more about using your own encryption keys.'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#kms_key WorkbenchInstance#kms_key}


WorkbenchInstanceGceSetupNetworkInterfaces

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupNetworkInterfaces(
  access_configs: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs]] = None,
  network: str = None,
  nic_type: str = None,
  subnet: str = None
)

Properties

Name Type Description
access_configs typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs]] access_configs block.
network str Optional. The name of the VPC that this VM instance is in.
nic_type str Optional.
subnet str Optional. The name of the subnet that this VM instance is in.

access_configsOptional
access_configs: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs]]

access_configs block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#access_configs WorkbenchInstance#access_configs}


networkOptional
network: str
  • Type: str

Optional. The name of the VPC that this VM instance is in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#network WorkbenchInstance#network}


nic_typeOptional
nic_type: str
  • Type: str

Optional.

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Possible values: ["VIRTIO_NET", "GVNIC"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#nic_type WorkbenchInstance#nic_type}


subnetOptional
subnet: str
  • Type: str

Optional. The name of the subnet that this VM instance is in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#subnet WorkbenchInstance#subnet}


WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs(
  external_ip: str
)

Properties

Name Type Description
external_ip str An external IP address associated with this instance.

external_ipRequired
external_ip: str
  • Type: str

An external IP address associated with this instance.

Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#external_ip WorkbenchInstance#external_ip}


WorkbenchInstanceGceSetupServiceAccounts

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupServiceAccounts(
  email: str = None
)

Properties

Name Type Description
email str Optional. Email address of the service account.

emailOptional
email: str
  • Type: str

Optional. Email address of the service account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#email WorkbenchInstance#email}


WorkbenchInstanceGceSetupShieldedInstanceConfig

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupShieldedInstanceConfig(
  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] Optional.
enable_secure_boot typing.Union[bool, cdktf.IResolvable] Optional.
enable_vtpm typing.Union[bool, cdktf.IResolvable] Optional. Defines whether the VM instance has the vTPM enabled. Enabled by default.

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

Optional.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#enable_integrity_monitoring WorkbenchInstance#enable_integrity_monitoring}


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

Optional.

Defines whether the VM 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.1/docs/resources/workbench_instance#enable_secure_boot WorkbenchInstance#enable_secure_boot}


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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#enable_vtpm WorkbenchInstance#enable_vtpm}


WorkbenchInstanceGceSetupVmImage

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupVmImage(
  family: str = None,
  name: str = None,
  project: str = None
)

Properties

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

familyOptional
family: str
  • Type: str

Optional. 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.1/docs/resources/workbench_instance#family WorkbenchInstance#family}


nameOptional
name: str
  • Type: str

Optional. Use VM image name to find the image.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#name WorkbenchInstance#name}


projectOptional
project: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#project WorkbenchInstance#project}


WorkbenchInstanceHealthInfo

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceHealthInfo()

WorkbenchInstanceTimeouts

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceTimeouts(
  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.1/docs/resources/workbench_instance#create WorkbenchInstance#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#delete WorkbenchInstance#delete}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#update WorkbenchInstance#update}.

createOptional
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#create WorkbenchInstance#create}.


deleteOptional
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#delete WorkbenchInstance#delete}.


updateOptional
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#update WorkbenchInstance#update}.


WorkbenchInstanceUpgradeHistory

Initializer

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceUpgradeHistory()

Classes

WorkbenchInstanceGceSetupAcceleratorConfigsList

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupAcceleratorConfigsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str

compute_fqn
def compute_fqn() -> 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.

get
def get(
  index: typing.Union[int, float]
) -> WorkbenchInstanceGceSetupAcceleratorConfigsOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.


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.
internal_value typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupAcceleratorConfigs]] 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

internal_valueOptional
internal_value: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupAcceleratorConfigs]]

WorkbenchInstanceGceSetupAcceleratorConfigsOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupAcceleratorConfigsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


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

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


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_core_count No description.
reset_type 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_core_count
def reset_core_count() -> None
reset_type
def reset_type() -> 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.
core_count_input str No description.
type_input str No description.
core_count str No description.
type str No description.
internal_value typing.Union[cdktf.IResolvable, WorkbenchInstanceGceSetupAcceleratorConfigs] 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: str
  • Type: str

type_inputOptional
type_input: str
  • Type: str

core_countRequired
core_count: str
  • Type: str

typeRequired
type: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, WorkbenchInstanceGceSetupAcceleratorConfigs]

WorkbenchInstanceGceSetupBootDiskOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupBootDiskOutputReference(
  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_disk_encryption No description.
reset_disk_size_gb No description.
reset_disk_type No description.
reset_kms_key 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_disk_encryption
def reset_disk_encryption() -> None
reset_disk_size_gb
def reset_disk_size_gb() -> None
reset_disk_type
def reset_disk_type() -> None
reset_kms_key
def reset_kms_key() -> 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.
disk_encryption_input str No description.
disk_size_gb_input str No description.
disk_type_input str No description.
kms_key_input str No description.
disk_encryption str No description.
disk_size_gb str No description.
disk_type str No description.
kms_key str No description.
internal_value WorkbenchInstanceGceSetupBootDisk 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

disk_encryption_inputOptional
disk_encryption_input: str
  • Type: str

disk_size_gb_inputOptional
disk_size_gb_input: str
  • Type: str

disk_type_inputOptional
disk_type_input: str
  • Type: str

kms_key_inputOptional
kms_key_input: str
  • Type: str

disk_encryptionRequired
disk_encryption: str
  • Type: str

disk_size_gbRequired
disk_size_gb: str
  • Type: str

disk_typeRequired
disk_type: str
  • Type: str

kms_keyRequired
kms_key: str
  • Type: str

internal_valueOptional
internal_value: WorkbenchInstanceGceSetupBootDisk

WorkbenchInstanceGceSetupConfidentialInstanceConfigOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupConfidentialInstanceConfigOutputReference(
  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_confidential_instance_type 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_confidential_instance_type
def reset_confidential_instance_type() -> 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.
confidential_instance_type_input str No description.
confidential_instance_type str No description.
internal_value WorkbenchInstanceGceSetupConfidentialInstanceConfig 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

confidential_instance_type_inputOptional
confidential_instance_type_input: str
  • Type: str

confidential_instance_typeRequired
confidential_instance_type: str
  • Type: str

internal_valueOptional
internal_value: WorkbenchInstanceGceSetupConfidentialInstanceConfig

WorkbenchInstanceGceSetupContainerImageOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupContainerImageOutputReference(
  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 WorkbenchInstanceGceSetupContainerImage 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: WorkbenchInstanceGceSetupContainerImage

WorkbenchInstanceGceSetupDataDisksOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupDataDisksOutputReference(
  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_disk_encryption No description.
reset_disk_size_gb No description.
reset_disk_type No description.
reset_kms_key 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_disk_encryption
def reset_disk_encryption() -> None
reset_disk_size_gb
def reset_disk_size_gb() -> None
reset_disk_type
def reset_disk_type() -> None
reset_kms_key
def reset_kms_key() -> 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.
disk_encryption_input str No description.
disk_size_gb_input str No description.
disk_type_input str No description.
kms_key_input str No description.
disk_encryption str No description.
disk_size_gb str No description.
disk_type str No description.
kms_key str No description.
internal_value WorkbenchInstanceGceSetupDataDisks 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

disk_encryption_inputOptional
disk_encryption_input: str
  • Type: str

disk_size_gb_inputOptional
disk_size_gb_input: str
  • Type: str

disk_type_inputOptional
disk_type_input: str
  • Type: str

kms_key_inputOptional
kms_key_input: str
  • Type: str

disk_encryptionRequired
disk_encryption: str
  • Type: str

disk_size_gbRequired
disk_size_gb: str
  • Type: str

disk_typeRequired
disk_type: str
  • Type: str

kms_keyRequired
kms_key: str
  • Type: str

internal_valueOptional
internal_value: WorkbenchInstanceGceSetupDataDisks

WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigsList

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str

compute_fqn
def compute_fqn() -> 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.

get
def get(
  index: typing.Union[int, float]
) -> WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigsOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.


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.
internal_value typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs]] 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

internal_valueOptional
internal_value: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs]]

WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigsOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


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

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


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.
external_ip_input str No description.
external_ip str No description.
internal_value typing.Union[cdktf.IResolvable, WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs] 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

external_ip_inputOptional
external_ip_input: str
  • Type: str

external_ipRequired
external_ip: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs]

WorkbenchInstanceGceSetupNetworkInterfacesList

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupNetworkInterfacesList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str

compute_fqn
def compute_fqn() -> 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.

get
def get(
  index: typing.Union[int, float]
) -> WorkbenchInstanceGceSetupNetworkInterfacesOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.


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.
internal_value typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfaces]] 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

internal_valueOptional
internal_value: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfaces]]

WorkbenchInstanceGceSetupNetworkInterfacesOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupNetworkInterfacesOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


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

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


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.
put_access_configs No description.
reset_access_configs No description.
reset_network No description.
reset_nic_type No description.
reset_subnet 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.

put_access_configs
def put_access_configs(
  value: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs]]
) -> None
valueRequired

reset_access_configs
def reset_access_configs() -> None
reset_network
def reset_network() -> None
reset_nic_type
def reset_nic_type() -> None
reset_subnet
def reset_subnet() -> 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.
access_configs WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigsList No description.
access_configs_input typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs]] No description.
network_input str No description.
nic_type_input str No description.
subnet_input str No description.
network str No description.
nic_type str No description.
subnet str No description.
internal_value typing.Union[cdktf.IResolvable, WorkbenchInstanceGceSetupNetworkInterfaces] 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

access_configsRequired
access_configs: WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigsList

access_configs_inputOptional
access_configs_input: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfacesAccessConfigs]]

network_inputOptional
network_input: str
  • Type: str

nic_type_inputOptional
nic_type_input: str
  • Type: str

subnet_inputOptional
subnet_input: str
  • Type: str

networkRequired
network: str
  • Type: str

nic_typeRequired
nic_type: str
  • Type: str

subnetRequired
subnet: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, WorkbenchInstanceGceSetupNetworkInterfaces]

WorkbenchInstanceGceSetupOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupOutputReference(
  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.
put_accelerator_configs No description.
put_boot_disk No description.
put_confidential_instance_config No description.
put_container_image No description.
put_data_disks No description.
put_network_interfaces No description.
put_service_accounts No description.
put_shielded_instance_config No description.
put_vm_image No description.
reset_accelerator_configs No description.
reset_boot_disk No description.
reset_confidential_instance_config No description.
reset_container_image No description.
reset_data_disks No description.
reset_disable_public_ip No description.
reset_enable_ip_forwarding No description.
reset_machine_type No description.
reset_metadata No description.
reset_network_interfaces No description.
reset_service_accounts No description.
reset_shielded_instance_config No description.
reset_tags No description.
reset_vm_image 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.

put_accelerator_configs
def put_accelerator_configs(
  value: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupAcceleratorConfigs]]
) -> None
valueRequired

put_boot_disk
def put_boot_disk(
  disk_encryption: str = None,
  disk_size_gb: str = None,
  disk_type: str = None,
  kms_key: str = None
) -> None
disk_encryptionOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_encryption WorkbenchInstance#disk_encryption}


disk_size_gbOptional
  • Type: str

Optional.

The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to the recommended value of 150GB.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_size_gb WorkbenchInstance#disk_size_gb}


disk_typeOptional
  • Type: str

Optional. Indicates the type of the disk. Possible values: ["PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_type WorkbenchInstance#disk_type}


kms_keyOptional
  • Type: str

'Optional.

The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: 'projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}' Learn more about using your own encryption keys.'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#kms_key WorkbenchInstance#kms_key}


put_confidential_instance_config
def put_confidential_instance_config(
  confidential_instance_type: str = None
) -> None
confidential_instance_typeOptional
  • Type: str

Defines the type of technology used by the confidential instance. Possible values: ["SEV"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#confidential_instance_type WorkbenchInstance#confidential_instance_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.1/docs/resources/workbench_instance#repository WorkbenchInstance#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.1/docs/resources/workbench_instance#tag WorkbenchInstance#tag}


put_data_disks
def put_data_disks(
  disk_encryption: str = None,
  disk_size_gb: str = None,
  disk_type: str = None,
  kms_key: str = None
) -> None
disk_encryptionOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_encryption WorkbenchInstance#disk_encryption}


disk_size_gbOptional
  • Type: str

Optional.

The size of the disk in GB attached to this VM instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to 100.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_size_gb WorkbenchInstance#disk_size_gb}


disk_typeOptional
  • Type: str

Optional. Input only. Indicates the type of the disk. Possible values: ["PD_STANDARD", "PD_SSD", "PD_BALANCED", "PD_EXTREME"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#disk_type WorkbenchInstance#disk_type}


kms_keyOptional
  • Type: str

'Optional.

The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: 'projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}' Learn more about using your own encryption keys.'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#kms_key WorkbenchInstance#kms_key}


put_network_interfaces
def put_network_interfaces(
  value: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfaces]]
) -> None
valueRequired

put_service_accounts
def put_service_accounts(
  value: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupServiceAccounts]]
) -> None
valueRequired

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]

Optional.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#enable_integrity_monitoring WorkbenchInstance#enable_integrity_monitoring}


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

Optional.

Defines whether the VM 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.1/docs/resources/workbench_instance#enable_secure_boot WorkbenchInstance#enable_secure_boot}


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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#enable_vtpm WorkbenchInstance#enable_vtpm}


put_vm_image
def put_vm_image(
  family: str = None,
  name: str = None,
  project: str = None
) -> None
familyOptional
  • Type: str

Optional. 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.1/docs/resources/workbench_instance#family WorkbenchInstance#family}


nameOptional
  • Type: str

Optional. Use VM image name to find the image.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#name WorkbenchInstance#name}


projectOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.1/docs/resources/workbench_instance#project WorkbenchInstance#project}


reset_accelerator_configs
def reset_accelerator_configs() -> None
reset_boot_disk
def reset_boot_disk() -> None
reset_confidential_instance_config
def reset_confidential_instance_config() -> None
reset_container_image
def reset_container_image() -> None
reset_data_disks
def reset_data_disks() -> None
reset_disable_public_ip
def reset_disable_public_ip() -> None
reset_enable_ip_forwarding
def reset_enable_ip_forwarding() -> None
reset_machine_type
def reset_machine_type() -> None
reset_metadata
def reset_metadata() -> None
reset_network_interfaces
def reset_network_interfaces() -> None
reset_service_accounts
def reset_service_accounts() -> None
reset_shielded_instance_config
def reset_shielded_instance_config() -> None
reset_tags
def reset_tags() -> None
reset_vm_image
def reset_vm_image() -> 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.
accelerator_configs WorkbenchInstanceGceSetupAcceleratorConfigsList No description.
boot_disk WorkbenchInstanceGceSetupBootDiskOutputReference No description.
confidential_instance_config WorkbenchInstanceGceSetupConfidentialInstanceConfigOutputReference No description.
container_image WorkbenchInstanceGceSetupContainerImageOutputReference No description.
data_disks WorkbenchInstanceGceSetupDataDisksOutputReference No description.
network_interfaces WorkbenchInstanceGceSetupNetworkInterfacesList No description.
service_accounts WorkbenchInstanceGceSetupServiceAccountsList No description.
shielded_instance_config WorkbenchInstanceGceSetupShieldedInstanceConfigOutputReference No description.
vm_image WorkbenchInstanceGceSetupVmImageOutputReference No description.
accelerator_configs_input typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupAcceleratorConfigs]] No description.
boot_disk_input WorkbenchInstanceGceSetupBootDisk No description.
confidential_instance_config_input WorkbenchInstanceGceSetupConfidentialInstanceConfig No description.
container_image_input WorkbenchInstanceGceSetupContainerImage No description.
data_disks_input WorkbenchInstanceGceSetupDataDisks No description.
disable_public_ip_input typing.Union[bool, cdktf.IResolvable] No description.
enable_ip_forwarding_input typing.Union[bool, cdktf.IResolvable] No description.
machine_type_input str No description.
metadata_input typing.Mapping[str] No description.
network_interfaces_input typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfaces]] No description.
service_accounts_input typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupServiceAccounts]] No description.
shielded_instance_config_input WorkbenchInstanceGceSetupShieldedInstanceConfig No description.
tags_input typing.List[str] No description.
vm_image_input WorkbenchInstanceGceSetupVmImage No description.
disable_public_ip typing.Union[bool, cdktf.IResolvable] No description.
enable_ip_forwarding typing.Union[bool, cdktf.IResolvable] No description.
machine_type str No description.
metadata typing.Mapping[str] No description.
tags typing.List[str] No description.
internal_value WorkbenchInstanceGceSetup 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

accelerator_configsRequired
accelerator_configs: WorkbenchInstanceGceSetupAcceleratorConfigsList

boot_diskRequired
boot_disk: WorkbenchInstanceGceSetupBootDiskOutputReference

confidential_instance_configRequired
confidential_instance_config: WorkbenchInstanceGceSetupConfidentialInstanceConfigOutputReference

container_imageRequired
container_image: WorkbenchInstanceGceSetupContainerImageOutputReference

data_disksRequired
data_disks: WorkbenchInstanceGceSetupDataDisksOutputReference

network_interfacesRequired
network_interfaces: WorkbenchInstanceGceSetupNetworkInterfacesList

service_accountsRequired
service_accounts: WorkbenchInstanceGceSetupServiceAccountsList

shielded_instance_configRequired
shielded_instance_config: WorkbenchInstanceGceSetupShieldedInstanceConfigOutputReference

vm_imageRequired
vm_image: WorkbenchInstanceGceSetupVmImageOutputReference

accelerator_configs_inputOptional
accelerator_configs_input: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupAcceleratorConfigs]]

boot_disk_inputOptional
boot_disk_input: WorkbenchInstanceGceSetupBootDisk

confidential_instance_config_inputOptional
confidential_instance_config_input: WorkbenchInstanceGceSetupConfidentialInstanceConfig

container_image_inputOptional
container_image_input: WorkbenchInstanceGceSetupContainerImage

data_disks_inputOptional
data_disks_input: WorkbenchInstanceGceSetupDataDisks

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

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

machine_type_inputOptional
machine_type_input: str
  • Type: str

metadata_inputOptional
metadata_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

network_interfaces_inputOptional
network_interfaces_input: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupNetworkInterfaces]]

service_accounts_inputOptional
service_accounts_input: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupServiceAccounts]]

shielded_instance_config_inputOptional
shielded_instance_config_input: WorkbenchInstanceGceSetupShieldedInstanceConfig

tags_inputOptional
tags_input: typing.List[str]
  • Type: typing.List[str]

vm_image_inputOptional
vm_image_input: WorkbenchInstanceGceSetupVmImage

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

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

machine_typeRequired
machine_type: str
  • Type: str

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

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

internal_valueOptional
internal_value: WorkbenchInstanceGceSetup

WorkbenchInstanceGceSetupServiceAccountsList

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupServiceAccountsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str

compute_fqn
def compute_fqn() -> 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.

get
def get(
  index: typing.Union[int, float]
) -> WorkbenchInstanceGceSetupServiceAccountsOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.


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.
internal_value typing.Union[cdktf.IResolvable, typing.List[WorkbenchInstanceGceSetupServiceAccounts]] 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

internal_valueOptional
internal_value: typing.Union[IResolvable, typing.List[WorkbenchInstanceGceSetupServiceAccounts]]

WorkbenchInstanceGceSetupServiceAccountsOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupServiceAccountsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


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

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


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_email 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_email
def reset_email() -> 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.
scopes typing.List[str] No description.
email_input str No description.
email str No description.
internal_value typing.Union[cdktf.IResolvable, WorkbenchInstanceGceSetupServiceAccounts] 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

scopesRequired
scopes: typing.List[str]
  • Type: typing.List[str]

email_inputOptional
email_input: str
  • Type: str

emailRequired
email: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, WorkbenchInstanceGceSetupServiceAccounts]

WorkbenchInstanceGceSetupShieldedInstanceConfigOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupShieldedInstanceConfigOutputReference(
  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 WorkbenchInstanceGceSetupShieldedInstanceConfig 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: WorkbenchInstanceGceSetupShieldedInstanceConfig

WorkbenchInstanceGceSetupVmImageOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceGceSetupVmImageOutputReference(
  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_family No description.
reset_name No description.
reset_project 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_family
def reset_family() -> None
reset_name
def reset_name() -> None
reset_project
def reset_project() -> 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.
family_input str No description.
name_input str No description.
project_input str No description.
family str No description.
name str No description.
project str No description.
internal_value WorkbenchInstanceGceSetupVmImage 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

family_inputOptional
family_input: str
  • Type: str

name_inputOptional
name_input: str
  • Type: str

project_inputOptional
project_input: str
  • Type: str

familyRequired
family: str
  • Type: str

nameRequired
name: str
  • Type: str

projectRequired
project: str
  • Type: str

internal_valueOptional
internal_value: WorkbenchInstanceGceSetupVmImage

WorkbenchInstanceHealthInfoList

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceHealthInfoList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str

compute_fqn
def compute_fqn() -> 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.

get
def get(
  index: typing.Union[int, float]
) -> WorkbenchInstanceHealthInfoOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.


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.

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

WorkbenchInstanceHealthInfoOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceHealthInfoOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


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

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


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.
internal_value WorkbenchInstanceHealthInfo 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

internal_valueOptional
internal_value: WorkbenchInstanceHealthInfo

WorkbenchInstanceTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceTimeoutsOutputReference(
  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, WorkbenchInstanceTimeouts] 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, WorkbenchInstanceTimeouts]

WorkbenchInstanceUpgradeHistoryList

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceUpgradeHistoryList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str

compute_fqn
def compute_fqn() -> 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.

get
def get(
  index: typing.Union[int, float]
) -> WorkbenchInstanceUpgradeHistoryOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.


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.

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

WorkbenchInstanceUpgradeHistoryOutputReference

Initializers

from cdktf_cdktf_provider_google import workbench_instance

workbenchInstance.WorkbenchInstanceUpgradeHistoryOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


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

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


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.
action str No description.
container_image str No description.
create_time str No description.
framework str No description.
snapshot str No description.
state str No description.
target_version str No description.
version str No description.
vm_image str No description.
internal_value WorkbenchInstanceUpgradeHistory 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

actionRequired
action: str
  • Type: str

container_imageRequired
container_image: str
  • Type: str

create_timeRequired
create_time: str
  • Type: str

frameworkRequired
framework: str
  • Type: str

snapshotRequired
snapshot: str
  • Type: str

stateRequired
state: str
  • Type: str

target_versionRequired
target_version: str
  • Type: str

versionRequired
version: str
  • Type: str

vm_imageRequired
vm_image: str
  • Type: str

internal_valueOptional
internal_value: WorkbenchInstanceUpgradeHistory