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

Interface WorkbenchInstanceConfig

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

    • Method Detail

      • getLocation

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

      • getName

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

      • getDesiredState

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

      • getDisableProxyAccess

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

      • getGceSetup

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

      • getId

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

      • getInstanceId

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

      • getInstanceOwners

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

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        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}

      • getProject

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

      • getTimeouts

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

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