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

Interface NotebooksEnvironmentConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    NotebooksEnvironmentConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.174Z")
@Stability(Stable)
public interface NotebooksEnvironmentConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getLocation

        @Stability(Stable)
@NotNull
String getLocation()
        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}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        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}

      • getContainerImage

        @Stability(Stable)
@Nullable
default NotebooksEnvironmentContainerImage getContainerImage()
        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}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        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}

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        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}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        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.

      • getPostStartupScript

        @Stability(Stable)
@Nullable
default String getPostStartupScript()
        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}

      • getProject

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

      • getTimeouts

        @Stability(Stable)
@Nullable
default NotebooksEnvironmentTimeouts getTimeouts()
        timeouts block.

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

      • getVmImage

        @Stability(Stable)
@Nullable
default NotebooksEnvironmentVmImage getVmImage()
        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}