`googleNotebooksEnvironment` Submodule

Constructs

GoogleNotebooksEnvironment

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment google_notebooks_environment}.

Initializers

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

new googleNotebooksEnvironment.GoogleNotebooksEnvironment(scope: Construct, id: string, config: GoogleNotebooksEnvironmentConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`GoogleNotebooksEnvironmentConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: GoogleNotebooksEnvironmentConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putContainerImage`	No description.
`putTimeouts`	No description.
`putVmImage`	No description.
`resetContainerImage`	No description.
`resetDescription`	No description.
`resetDisplayName`	No description.
`resetId`	No description.
`resetPostStartupScript`	No description.
`resetProject`	No description.
`resetTimeouts`	No description.
`resetVmImage`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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

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

`id`^Required

Type: string

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

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`putContainerImage`

public putContainerImage(value: GoogleNotebooksEnvironmentContainerImage): void

`value`^Required

Type: GoogleNotebooksEnvironmentContainerImage

`putTimeouts`

public putTimeouts(value: GoogleNotebooksEnvironmentTimeouts): void

`value`^Required

Type: GoogleNotebooksEnvironmentTimeouts

`putVmImage`

public putVmImage(value: GoogleNotebooksEnvironmentVmImage): void

`value`^Required

Type: GoogleNotebooksEnvironmentVmImage

`resetContainerImage`

public resetContainerImage(): void

`resetDescription`

public resetDescription(): void

`resetDisplayName`

public resetDisplayName(): void

`resetId`

public resetId(): void

`resetPostStartupScript`

public resetPostStartupScript(): void

`resetProject`

public resetProject(): void

`resetTimeouts`

public resetTimeouts(): void

`resetVmImage`

public resetVmImage(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a GoogleNotebooksEnvironment resource upon running "cdktf plan ".

`isConstruct`

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

googleNotebooksEnvironment.GoogleNotebooksEnvironment.isConstruct(x: any)

Checks if x is a construct.

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

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

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

googleNotebooksEnvironment.GoogleNotebooksEnvironment.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

googleNotebooksEnvironment.GoogleNotebooksEnvironment.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

googleNotebooksEnvironment.GoogleNotebooksEnvironment.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing GoogleNotebooksEnvironment that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`containerImage`	`GoogleNotebooksEnvironmentContainerImageOutputReference`	No description.
`createTime`	`string`	No description.
`timeouts`	`GoogleNotebooksEnvironmentTimeoutsOutputReference`	No description.
`vmImage`	`GoogleNotebooksEnvironmentVmImageOutputReference`	No description.
`containerImageInput`	`GoogleNotebooksEnvironmentContainerImage`	No description.
`descriptionInput`	`string`	No description.
`displayNameInput`	`string`	No description.
`idInput`	`string`	No description.
`locationInput`	`string`	No description.
`nameInput`	`string`	No description.
`postStartupScriptInput`	`string`	No description.
`projectInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GoogleNotebooksEnvironmentTimeouts`	No description.
`vmImageInput`	`GoogleNotebooksEnvironmentVmImage`	No description.
`description`	`string`	No description.
`displayName`	`string`	No description.
`id`	`string`	No description.
`location`	`string`	No description.
`name`	`string`	No description.
`postStartupScript`	`string`	No description.
`project`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`containerImage`^Required

public readonly containerImage: GoogleNotebooksEnvironmentContainerImageOutputReference;

Type: GoogleNotebooksEnvironmentContainerImageOutputReference

`createTime`^Required

public readonly createTime: string;

Type: string

`timeouts`^Required

public readonly timeouts: GoogleNotebooksEnvironmentTimeoutsOutputReference;

Type: GoogleNotebooksEnvironmentTimeoutsOutputReference

`vmImage`^Required

public readonly vmImage: GoogleNotebooksEnvironmentVmImageOutputReference;

Type: GoogleNotebooksEnvironmentVmImageOutputReference

`containerImageInput`^Optional

public readonly containerImageInput: GoogleNotebooksEnvironmentContainerImage;

Type: GoogleNotebooksEnvironmentContainerImage

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`displayNameInput`^Optional

public readonly displayNameInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`locationInput`^Optional

public readonly locationInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`postStartupScriptInput`^Optional

public readonly postStartupScriptInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleNotebooksEnvironmentTimeouts;

Type: cdktf.IResolvable | GoogleNotebooksEnvironmentTimeouts

`vmImageInput`^Optional

public readonly vmImageInput: GoogleNotebooksEnvironmentVmImage;

Type: GoogleNotebooksEnvironmentVmImage

`description`^Required

public readonly description: string;

Type: string

`displayName`^Required

public readonly displayName: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`location`^Required

public readonly location: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`postStartupScript`^Required

public readonly postStartupScript: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleNotebooksEnvironmentConfig

Initializer

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

const googleNotebooksEnvironmentConfig: googleNotebooksEnvironment.GoogleNotebooksEnvironmentConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`location`	`string`	A reference to the zone where the machine resides.
`name`	`string`	The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}.
`containerImage`	`GoogleNotebooksEnvironmentContainerImage`	container_image block.
`description`	`string`	A brief description of this environment.
`displayName`	`string`	Display name of this environment for the UI.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#id GoogleNotebooksEnvironment#id}.
`postStartupScript`	`string`	Path to a Bash script that automatically runs after a notebook instance fully boots up.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#project GoogleNotebooksEnvironment#project}.
`timeouts`	`GoogleNotebooksEnvironmentTimeouts`	timeouts block.
`vmImage`	`GoogleNotebooksEnvironmentVmImage`	vm_image block.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`location`^Required

public readonly location: string;

Type: string

A reference to the zone where the machine resides.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#location GoogleNotebooksEnvironment#location}

`name`^Required

public readonly name: string;

Type: string

The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#name GoogleNotebooksEnvironment#name}

`containerImage`^Optional

public readonly containerImage: GoogleNotebooksEnvironmentContainerImage;

Type: GoogleNotebooksEnvironmentContainerImage

container_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#container_image GoogleNotebooksEnvironment#container_image}

`description`^Optional

public readonly description: string;

Type: string

A brief description of this environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#description GoogleNotebooksEnvironment#description}

`displayName`^Optional

public readonly displayName: string;

Type: string

Display name of this environment for the UI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#display_name GoogleNotebooksEnvironment#display_name}

`id`^Optional

public readonly id: string;

Type: string

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

`postStartupScript`^Optional

public readonly postStartupScript: string;

Type: string

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#post_startup_script GoogleNotebooksEnvironment#post_startup_script}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#project GoogleNotebooksEnvironment#project}.

`timeouts`^Optional

public readonly timeouts: GoogleNotebooksEnvironmentTimeouts;

Type: GoogleNotebooksEnvironmentTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#timeouts GoogleNotebooksEnvironment#timeouts}

`vmImage`^Optional

public readonly vmImage: GoogleNotebooksEnvironmentVmImage;

Type: GoogleNotebooksEnvironmentVmImage

vm_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#vm_image GoogleNotebooksEnvironment#vm_image}

GoogleNotebooksEnvironmentContainerImage

Initializer

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

const googleNotebooksEnvironmentContainerImage: googleNotebooksEnvironment.GoogleNotebooksEnvironmentContainerImage = { ... }

Properties

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

`repository`^Required

public readonly repository: string;

Type: string

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-beta/6.13.0/docs/resources/google_notebooks_environment#repository GoogleNotebooksEnvironment#repository}

`tag`^Optional

public readonly tag: string;

Type: string

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-beta/6.13.0/docs/resources/google_notebooks_environment#tag GoogleNotebooksEnvironment#tag}

GoogleNotebooksEnvironmentTimeouts

Initializer

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

const googleNotebooksEnvironmentTimeouts: googleNotebooksEnvironment.GoogleNotebooksEnvironmentTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#create GoogleNotebooksEnvironment#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#delete GoogleNotebooksEnvironment#delete}.
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#update GoogleNotebooksEnvironment#update}.

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#create GoogleNotebooksEnvironment#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#delete GoogleNotebooksEnvironment#delete}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#update GoogleNotebooksEnvironment#update}.

GoogleNotebooksEnvironmentVmImage

Initializer

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

const googleNotebooksEnvironmentVmImage: googleNotebooksEnvironment.GoogleNotebooksEnvironmentVmImage = { ... }

Properties

Name	Type	Description
`project`	`string`	The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}.
`imageFamily`	`string`	Use this VM image family to find the image; the newest image in this family will be used.
`imageName`	`string`	Use VM image name to find the image.

`project`^Required

public readonly project: string;

Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#project GoogleNotebooksEnvironment#project}

`imageFamily`^Optional

public readonly imageFamily: string;

Type: string

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-beta/6.13.0/docs/resources/google_notebooks_environment#image_family GoogleNotebooksEnvironment#image_family}

`imageName`^Optional

public readonly imageName: string;

Type: string

Use VM image name to find the image.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_notebooks_environment#image_name GoogleNotebooksEnvironment#image_name}

Classes

GoogleNotebooksEnvironmentContainerImageOutputReference

Initializers

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

new googleNotebooksEnvironment.GoogleNotebooksEnvironmentContainerImageOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetTag`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetTag`

public resetTag(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`repositoryInput`	`string`	No description.
`tagInput`	`string`	No description.
`repository`	`string`	No description.
`tag`	`string`	No description.
`internalValue`	`GoogleNotebooksEnvironmentContainerImage`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`repositoryInput`^Optional

public readonly repositoryInput: string;

Type: string

`tagInput`^Optional

public readonly tagInput: string;

Type: string

`repository`^Required

public readonly repository: string;

Type: string

`tag`^Required

public readonly tag: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GoogleNotebooksEnvironmentContainerImage;

Type: GoogleNotebooksEnvironmentContainerImage

GoogleNotebooksEnvironmentTimeoutsOutputReference

Initializers

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

new googleNotebooksEnvironment.GoogleNotebooksEnvironmentTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetCreate`	No description.
`resetDelete`	No description.
`resetUpdate`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetCreate`

public resetCreate(): void

`resetDelete`

public resetDelete(): void

`resetUpdate`

public resetUpdate(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`createInput`	`string`	No description.
`deleteInput`	`string`	No description.
`updateInput`	`string`	No description.
`create`	`string`	No description.
`delete`	`string`	No description.
`update`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleNotebooksEnvironmentTimeouts`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`createInput`^Optional

public readonly createInput: string;

Type: string

`deleteInput`^Optional

public readonly deleteInput: string;

Type: string

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleNotebooksEnvironmentTimeouts;

Type: cdktf.IResolvable | GoogleNotebooksEnvironmentTimeouts

GoogleNotebooksEnvironmentVmImageOutputReference

Initializers

import { googleNotebooksEnvironment } from '@cdktf/provider-google-beta'

new googleNotebooksEnvironment.GoogleNotebooksEnvironmentVmImageOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetImageFamily`	No description.
`resetImageName`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetImageFamily`

public resetImageFamily(): void

`resetImageName`

public resetImageName(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`imageFamilyInput`	`string`	No description.
`imageNameInput`	`string`	No description.
`projectInput`	`string`	No description.
`imageFamily`	`string`	No description.
`imageName`	`string`	No description.
`project`	`string`	No description.
`internalValue`	`GoogleNotebooksEnvironmentVmImage`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

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

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

`fqn`^Required

public readonly fqn: string;

Type: string

`imageFamilyInput`^Optional

public readonly imageFamilyInput: string;

Type: string

`imageNameInput`^Optional

public readonly imageNameInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`imageFamily`^Required

public readonly imageFamily: string;

Type: string

`imageName`^Required

public readonly imageName: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GoogleNotebooksEnvironmentVmImage;

Type: GoogleNotebooksEnvironmentVmImage

Files

googleNotebooksEnvironment.typescript.md

Latest commit

History

googleNotebooksEnvironment.typescript.md

File metadata and controls

googleNotebooksEnvironment Submodule

Constructs