Package com.hashicorp.cdktf.providers.google.notebooks_environment

Class NotebooksEnvironment.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static NotebooksEnvironment.Builder create​(software.constructs.Construct scope,
                                                  String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of NotebooksEnvironment.Builder.

      • connection

        @Stability(Experimental)
public NotebooksEnvironment.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public NotebooksEnvironment.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public NotebooksEnvironment.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public NotebooksEnvironment.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public NotebooksEnvironment.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public NotebooksEnvironment.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public NotebooksEnvironment.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public NotebooksEnvironment.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • location

        @Stability(Stable)
public NotebooksEnvironment.Builder location​(String location)
        A reference to the zone where the machine resides.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#location NotebooksEnvironment#location}

        Parameters:
        location - A reference to the zone where the machine resides. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public NotebooksEnvironment.Builder name​(String name)
        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/5.43.1/docs/resources/notebooks_environment#name NotebooksEnvironment#name}

        Parameters:
        name - The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}. This parameter is required.
        Returns:
        this

      • containerImage

        @Stability(Stable)
public NotebooksEnvironment.Builder containerImage​(NotebooksEnvironmentContainerImage containerImage)
        container_image block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#container_image NotebooksEnvironment#container_image}

        Parameters:
        containerImage - container_image block. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public NotebooksEnvironment.Builder description​(String description)
        A brief description of this environment.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#description NotebooksEnvironment#description}

        Parameters:
        description - A brief description of this environment. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public NotebooksEnvironment.Builder displayName​(String displayName)
        Display name of this environment for the UI.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#display_name NotebooksEnvironment#display_name}

        Parameters:
        displayName - Display name of this environment for the UI. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public NotebooksEnvironment.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#id NotebooksEnvironment#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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#id NotebooksEnvironment#id}. This parameter is required.
        Returns:
        this

      • postStartupScript

        @Stability(Stable)
public NotebooksEnvironment.Builder postStartupScript​(String postStartupScript)
        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/5.43.1/docs/resources/notebooks_environment#post_startup_script NotebooksEnvironment#post_startup_script}

        Parameters:
        postStartupScript - Path to a Bash script that automatically runs after a notebook instance fully boots up. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public NotebooksEnvironment.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#project NotebooksEnvironment#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#project NotebooksEnvironment#project}. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public NotebooksEnvironment.Builder timeouts​(NotebooksEnvironmentTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#timeouts NotebooksEnvironment#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • vmImage

        @Stability(Stable)
public NotebooksEnvironment.Builder vmImage​(NotebooksEnvironmentVmImage vmImage)
        vm_image block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_environment#vm_image NotebooksEnvironment#vm_image}

        Parameters:
        vmImage - vm_image block. This parameter is required.
        Returns:
        this