Package com.hashicorp.cdktf.providers.google.workbench_instance

Class WorkbenchInstance.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static WorkbenchInstance.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 WorkbenchInstance.Builder.

      • connection

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

      • connection

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • location

        @Stability(Stable)
public WorkbenchInstance.Builder location​(String location)
        Part of 'parent'. See documentation of 'projectsId'.

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

        Parameters:
        location - Part of 'parent'. See documentation of 'projectsId'. This parameter is required.
        Returns:
        this

      • name

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

        Parameters:
        name - The name of this workbench instance. Format: 'projects/{project_id}/locations/{location}/instances/{instance_id}'. This parameter is required.
        Returns:
        this

      • desiredState

        @Stability(Stable)
public WorkbenchInstance.Builder desiredState​(String desiredState)
        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/5.43.1/docs/resources/workbench_instance#desired_state WorkbenchInstance#desired_state}

        Parameters:
        desiredState - Desired state of the Workbench Instance. This parameter is required.
        Returns:
        this

      • disableProxyAccess

        @Stability(Stable)
public WorkbenchInstance.Builder disableProxyAccess​(Boolean disableProxyAccess)
        Optional. If true, the workbench instance will not register with the proxy.

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

        Parameters:
        disableProxyAccess - Optional. If true, the workbench instance will not register with the proxy. This parameter is required.
        Returns:
        this

      • disableProxyAccess

        @Stability(Stable)
public WorkbenchInstance.Builder disableProxyAccess​(com.hashicorp.cdktf.IResolvable disableProxyAccess)
        Optional. If true, the workbench instance will not register with the proxy.

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

        Parameters:
        disableProxyAccess - Optional. If true, the workbench instance will not register with the proxy. This parameter is required.
        Returns:
        this

      • gceSetup

        @Stability(Stable)
public WorkbenchInstance.Builder gceSetup​(WorkbenchInstanceGceSetup gceSetup)
        gce_setup block.

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

        Parameters:
        gceSetup - gce_setup block. This parameter is required.
        Returns:
        this

      • id

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

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

      • instanceId

        @Stability(Stable)
public WorkbenchInstance.Builder instanceId​(String instanceId)
        Required. User-defined unique ID of this instance.

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

        Parameters:
        instanceId - Required. User-defined unique ID of this instance. This parameter is required.
        Returns:
        this

      • instanceOwners

        @Stability(Stable)
public WorkbenchInstance.Builder instanceOwners​(List<String> instanceOwners)
        '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.' Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/workbench_instance#instance_owners WorkbenchInstance#instance_owners}

        Parameters:
        instanceOwners - 'Optional. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public WorkbenchInstance.Builder labels​(Map<String,​String> labels)
        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/5.43.1/docs/resources/workbench_instance#labels WorkbenchInstance#labels}

        Parameters:
        labels - Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method. This parameter is required.
        Returns:
        this

      • project

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

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

      • timeouts

        @Stability(Stable)
public WorkbenchInstance.Builder timeouts​(WorkbenchInstanceTimeouts timeouts)
        timeouts block.

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

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