Package com.hashicorp.cdktf.providers.google.notebooks_instance

Class NotebooksInstance

  • All Implemented Interfaces:
    com.hashicorp.cdktf.IInterpolatingParent, com.hashicorp.cdktf.ITerraformAddressable, com.hashicorp.cdktf.ITerraformDependable, com.hashicorp.cdktf.ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.175Z")
@Stability(Stable)
public class NotebooksInstance
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_instance google_notebooks_instance}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • NotebooksInstance

        protected NotebooksInstance​(software.amazon.jsii.JsiiObjectRef objRef)

      • NotebooksInstance

        protected NotebooksInstance​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • NotebooksInstance

        @Stability(Stable)
public NotebooksInstance​(@NotNull
                         software.constructs.Construct scope,
                         @NotNull
                         String id,
                         @NotNull
                         NotebooksInstanceConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/notebooks_instance google_notebooks_instance} Resource.

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        config - This parameter is required.

    • Method Detail

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId,
                                                                             @Nullable
                                                                             com.hashicorp.cdktf.TerraformProvider provider)
        Generates CDKTF code for importing a NotebooksInstance resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the NotebooksInstance to import. This parameter is required.
        importFromId - The id of the existing NotebooksInstance that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the NotebooksInstance to import is found.

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId)
        Generates CDKTF code for importing a NotebooksInstance resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the NotebooksInstance to import. This parameter is required.
        importFromId - The id of the existing NotebooksInstance that should be imported. This parameter is required.

      • putAcceleratorConfig

        @Stability(Stable)
public void putAcceleratorConfig​(@NotNull
                                 NotebooksInstanceAcceleratorConfig value)
        Parameters:
        value - This parameter is required.

      • putContainerImage

        @Stability(Stable)
public void putContainerImage​(@NotNull
                              NotebooksInstanceContainerImage value)
        Parameters:
        value - This parameter is required.

      • putReservationAffinity

        @Stability(Stable)
public void putReservationAffinity​(@NotNull
                                   NotebooksInstanceReservationAffinity value)
        Parameters:
        value - This parameter is required.

      • putTimeouts

        @Stability(Stable)
public void putTimeouts​(@NotNull
                        NotebooksInstanceTimeouts value)
        Parameters:
        value - This parameter is required.

      • putVmImage

        @Stability(Stable)
public void putVmImage​(@NotNull
                       NotebooksInstanceVmImage value)
        Parameters:
        value - This parameter is required.

      • resetAcceleratorConfig

        @Stability(Stable)
public void resetAcceleratorConfig()

      • resetBootDiskSizeGb

        @Stability(Stable)
public void resetBootDiskSizeGb()

      • resetBootDiskType

        @Stability(Stable)
public void resetBootDiskType()

      • resetContainerImage

        @Stability(Stable)
public void resetContainerImage()

      • resetCreateTime

        @Stability(Stable)
public void resetCreateTime()

      • resetCustomGpuDriverPath

        @Stability(Stable)
public void resetCustomGpuDriverPath()

      • resetDataDiskSizeGb

        @Stability(Stable)
public void resetDataDiskSizeGb()

      • resetDataDiskType

        @Stability(Stable)
public void resetDataDiskType()

      • resetDesiredState

        @Stability(Stable)
public void resetDesiredState()

      • resetDiskEncryption

        @Stability(Stable)
public void resetDiskEncryption()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetInstallGpuDriver

        @Stability(Stable)
public void resetInstallGpuDriver()

      • resetInstanceOwners

        @Stability(Stable)
public void resetInstanceOwners()

      • resetKmsKey

        @Stability(Stable)
public void resetKmsKey()

      • resetLabels

        @Stability(Stable)
public void resetLabels()

      • resetMetadata

        @Stability(Stable)
public void resetMetadata()

      • resetNetwork

        @Stability(Stable)
public void resetNetwork()

      • resetNicType

        @Stability(Stable)
public void resetNicType()

      • resetNoProxyAccess

        @Stability(Stable)
public void resetNoProxyAccess()

      • resetNoPublicIp

        @Stability(Stable)
public void resetNoPublicIp()

      • resetNoRemoveDataDisk

        @Stability(Stable)
public void resetNoRemoveDataDisk()

      • resetPostStartupScript

        @Stability(Stable)
public void resetPostStartupScript()

      • resetProject

        @Stability(Stable)
public void resetProject()

      • resetReservationAffinity

        @Stability(Stable)
public void resetReservationAffinity()

      • resetServiceAccount

        @Stability(Stable)
public void resetServiceAccount()

      • resetServiceAccountScopes

        @Stability(Stable)
public void resetServiceAccountScopes()

      • resetShieldedInstanceConfig

        @Stability(Stable)
public void resetShieldedInstanceConfig()

      • resetSubnet

        @Stability(Stable)
public void resetSubnet()

      • resetTags

        @Stability(Stable)
public void resetTags()

      • resetTimeouts

        @Stability(Stable)
public void resetTimeouts()

      • resetUpdateTime

        @Stability(Stable)
public void resetUpdateTime()

      • resetVmImage

        @Stability(Stable)
public void resetVmImage()

      • synthesizeAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeAttributes()
        Overrides:
        synthesizeAttributes in class com.hashicorp.cdktf.TerraformResource

      • synthesizeHclAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeHclAttributes()
        Overrides:
        synthesizeHclAttributes in class com.hashicorp.cdktf.TerraformResource

      • getEffectiveLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getEffectiveLabels()

      • getProxyUri

        @Stability(Stable)
@NotNull
public String getProxyUri()

      • getState

        @Stability(Stable)
@NotNull
public String getState()

      • getTerraformLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getTerraformLabels()

      • getBootDiskSizeGbInput

        @Stability(Stable)
@Nullable
public Number getBootDiskSizeGbInput()

      • getBootDiskTypeInput

        @Stability(Stable)
@Nullable
public String getBootDiskTypeInput()

      • getCreateTimeInput

        @Stability(Stable)
@Nullable
public String getCreateTimeInput()

      • getCustomGpuDriverPathInput

        @Stability(Stable)
@Nullable
public String getCustomGpuDriverPathInput()

      • getDataDiskSizeGbInput

        @Stability(Stable)
@Nullable
public Number getDataDiskSizeGbInput()

      • getDataDiskTypeInput

        @Stability(Stable)
@Nullable
public String getDataDiskTypeInput()

      • getDesiredStateInput

        @Stability(Stable)
@Nullable
public String getDesiredStateInput()

      • getDiskEncryptionInput

        @Stability(Stable)
@Nullable
public String getDiskEncryptionInput()

      • getIdInput

        @Stability(Stable)
@Nullable
public String getIdInput()

      • getInstallGpuDriverInput

        @Stability(Stable)
@Nullable
public Object getInstallGpuDriverInput()

      • getInstanceOwnersInput

        @Stability(Stable)
@Nullable
public List<String> getInstanceOwnersInput()

      • getKmsKeyInput

        @Stability(Stable)
@Nullable
public String getKmsKeyInput()

      • getLabelsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getLabelsInput()

      • getLocationInput

        @Stability(Stable)
@Nullable
public String getLocationInput()

      • getMachineTypeInput

        @Stability(Stable)
@Nullable
public String getMachineTypeInput()

      • getMetadataInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getMetadataInput()

      • getNameInput

        @Stability(Stable)
@Nullable
public String getNameInput()

      • getNetworkInput

        @Stability(Stable)
@Nullable
public String getNetworkInput()

      • getNicTypeInput

        @Stability(Stable)
@Nullable
public String getNicTypeInput()

      • getNoProxyAccessInput

        @Stability(Stable)
@Nullable
public Object getNoProxyAccessInput()

      • getNoPublicIpInput

        @Stability(Stable)
@Nullable
public Object getNoPublicIpInput()

      • getNoRemoveDataDiskInput

        @Stability(Stable)
@Nullable
public Object getNoRemoveDataDiskInput()

      • getPostStartupScriptInput

        @Stability(Stable)
@Nullable
public String getPostStartupScriptInput()

      • getProjectInput

        @Stability(Stable)
@Nullable
public String getProjectInput()

      • getServiceAccountInput

        @Stability(Stable)
@Nullable
public String getServiceAccountInput()

      • getServiceAccountScopesInput

        @Stability(Stable)
@Nullable
public List<String> getServiceAccountScopesInput()

      • getSubnetInput

        @Stability(Stable)
@Nullable
public String getSubnetInput()

      • getTagsInput

        @Stability(Stable)
@Nullable
public List<String> getTagsInput()

      • getTimeoutsInput

        @Stability(Stable)
@Nullable
public Object getTimeoutsInput()

      • getUpdateTimeInput

        @Stability(Stable)
@Nullable
public String getUpdateTimeInput()

      • getBootDiskSizeGb

        @Stability(Stable)
@NotNull
public Number getBootDiskSizeGb()

      • setBootDiskSizeGb

        @Stability(Stable)
public void setBootDiskSizeGb​(@NotNull
                              Number value)

      • getBootDiskType

        @Stability(Stable)
@NotNull
public String getBootDiskType()

      • setBootDiskType

        @Stability(Stable)
public void setBootDiskType​(@NotNull
                            String value)

      • getCreateTime

        @Stability(Stable)
@NotNull
public String getCreateTime()

      • setCreateTime

        @Stability(Stable)
public void setCreateTime​(@NotNull
                          String value)

      • getCustomGpuDriverPath

        @Stability(Stable)
@NotNull
public String getCustomGpuDriverPath()

      • setCustomGpuDriverPath

        @Stability(Stable)
public void setCustomGpuDriverPath​(@NotNull
                                   String value)

      • getDataDiskSizeGb

        @Stability(Stable)
@NotNull
public Number getDataDiskSizeGb()

      • setDataDiskSizeGb

        @Stability(Stable)
public void setDataDiskSizeGb​(@NotNull
                              Number value)

      • getDataDiskType

        @Stability(Stable)
@NotNull
public String getDataDiskType()

      • setDataDiskType

        @Stability(Stable)
public void setDataDiskType​(@NotNull
                            String value)

      • getDesiredState

        @Stability(Stable)
@NotNull
public String getDesiredState()

      • setDesiredState

        @Stability(Stable)
public void setDesiredState​(@NotNull
                            String value)

      • getDiskEncryption

        @Stability(Stable)
@NotNull
public String getDiskEncryption()

      • setDiskEncryption

        @Stability(Stable)
public void setDiskEncryption​(@NotNull
                              String value)

      • getId

        @Stability(Stable)
@NotNull
public String getId()

      • setId

        @Stability(Stable)
public void setId​(@NotNull
                  String value)

      • getInstallGpuDriver

        @Stability(Stable)
@NotNull
public Object getInstallGpuDriver()

      • setInstallGpuDriver

        @Stability(Stable)
public void setInstallGpuDriver​(@NotNull
                                Boolean value)

      • setInstallGpuDriver

        @Stability(Stable)
public void setInstallGpuDriver​(@NotNull
                                com.hashicorp.cdktf.IResolvable value)

      • getInstanceOwners

        @Stability(Stable)
@NotNull
public List<String> getInstanceOwners()

      • setInstanceOwners

        @Stability(Stable)
public void setInstanceOwners​(@NotNull
                              List<String> value)

      • getKmsKey

        @Stability(Stable)
@NotNull
public String getKmsKey()

      • setKmsKey

        @Stability(Stable)
public void setKmsKey​(@NotNull
                      String value)

      • getLabels

        @Stability(Stable)
@NotNull
public Map<String,​String> getLabels()

      • setLabels

        @Stability(Stable)
public void setLabels​(@NotNull
                      Map<String,​String> value)

      • getLocation

        @Stability(Stable)
@NotNull
public String getLocation()

      • setLocation

        @Stability(Stable)
public void setLocation​(@NotNull
                        String value)

      • getMachineType

        @Stability(Stable)
@NotNull
public String getMachineType()

      • setMachineType

        @Stability(Stable)
public void setMachineType​(@NotNull
                           String value)

      • getMetadata

        @Stability(Stable)
@NotNull
public Map<String,​String> getMetadata()

      • setMetadata

        @Stability(Stable)
public void setMetadata​(@NotNull
                        Map<String,​String> value)

      • getName

        @Stability(Stable)
@NotNull
public String getName()

      • setName

        @Stability(Stable)
public void setName​(@NotNull
                    String value)

      • getNetwork

        @Stability(Stable)
@NotNull
public String getNetwork()

      • setNetwork

        @Stability(Stable)
public void setNetwork​(@NotNull
                       String value)

      • getNicType

        @Stability(Stable)
@NotNull
public String getNicType()

      • setNicType

        @Stability(Stable)
public void setNicType​(@NotNull
                       String value)

      • getNoProxyAccess

        @Stability(Stable)
@NotNull
public Object getNoProxyAccess()

      • setNoProxyAccess

        @Stability(Stable)
public void setNoProxyAccess​(@NotNull
                             Boolean value)

      • setNoProxyAccess

        @Stability(Stable)
public void setNoProxyAccess​(@NotNull
                             com.hashicorp.cdktf.IResolvable value)

      • getNoPublicIp

        @Stability(Stable)
@NotNull
public Object getNoPublicIp()

      • setNoPublicIp

        @Stability(Stable)
public void setNoPublicIp​(@NotNull
                          Boolean value)

      • setNoPublicIp

        @Stability(Stable)
public void setNoPublicIp​(@NotNull
                          com.hashicorp.cdktf.IResolvable value)

      • getNoRemoveDataDisk

        @Stability(Stable)
@NotNull
public Object getNoRemoveDataDisk()

      • setNoRemoveDataDisk

        @Stability(Stable)
public void setNoRemoveDataDisk​(@NotNull
                                Boolean value)

      • setNoRemoveDataDisk

        @Stability(Stable)
public void setNoRemoveDataDisk​(@NotNull
                                com.hashicorp.cdktf.IResolvable value)

      • getPostStartupScript

        @Stability(Stable)
@NotNull
public String getPostStartupScript()

      • setPostStartupScript

        @Stability(Stable)
public void setPostStartupScript​(@NotNull
                                 String value)

      • getProject

        @Stability(Stable)
@NotNull
public String getProject()

      • setProject

        @Stability(Stable)
public void setProject​(@NotNull
                       String value)

      • getServiceAccount

        @Stability(Stable)
@NotNull
public String getServiceAccount()

      • setServiceAccount

        @Stability(Stable)
public void setServiceAccount​(@NotNull
                              String value)

      • getServiceAccountScopes

        @Stability(Stable)
@NotNull
public List<String> getServiceAccountScopes()

      • setServiceAccountScopes

        @Stability(Stable)
public void setServiceAccountScopes​(@NotNull
                                    List<String> value)

      • getSubnet

        @Stability(Stable)
@NotNull
public String getSubnet()

      • setSubnet

        @Stability(Stable)
public void setSubnet​(@NotNull
                      String value)

      • getTags

        @Stability(Stable)
@NotNull
public List<String> getTags()

      • setTags

        @Stability(Stable)
public void setTags​(@NotNull
                    List<String> value)

      • getUpdateTime

        @Stability(Stable)
@NotNull
public String getUpdateTime()

      • setUpdateTime

        @Stability(Stable)
public void setUpdateTime​(@NotNull
                          String value)