Package com.hashicorp.cdktf.providers.google.tpu_node

Class TpuNode.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<TpuNode>
    Enclosing class:
    TpuNode
    @Stability(Stable)
public static final class TpuNode.Builder
extends Object
implements software.amazon.jsii.Builder<TpuNode>
    A fluent builder for TpuNode.

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

        @Stability(Experimental)
public TpuNode.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • acceleratorType

        @Stability(Stable)
public TpuNode.Builder acceleratorType​(String acceleratorType)
        The type of hardware accelerators associated with this node.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#accelerator_type TpuNode#accelerator_type}

        Parameters:
        acceleratorType - The type of hardware accelerators associated with this node. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public TpuNode.Builder name​(String name)
        The immutable name of the TPU.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#name TpuNode#name}

        Parameters:
        name - The immutable name of the TPU. This parameter is required.
        Returns:
        this

      • tensorflowVersion

        @Stability(Stable)
public TpuNode.Builder tensorflowVersion​(String tensorflowVersion)
        The version of Tensorflow running in the Node.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#tensorflow_version TpuNode#tensorflow_version}

        Parameters:
        tensorflowVersion - The version of Tensorflow running in the Node. This parameter is required.
        Returns:
        this

      • cidrBlock

        @Stability(Stable)
public TpuNode.Builder cidrBlock​(String cidrBlock)
        The CIDR block that the TPU node will use when selecting an IP address.

        This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#cidr_block TpuNode#cidr_block}

        Parameters:
        cidrBlock - The CIDR block that the TPU node will use when selecting an IP address. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public TpuNode.Builder description​(String description)
        The user-supplied description of the TPU. Maximum of 512 characters.

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

        Parameters:
        description - The user-supplied description of the TPU. Maximum of 512 characters. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public TpuNode.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#id TpuNode#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/tpu_node#id TpuNode#id}. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public TpuNode.Builder labels​(Map<String,​String> labels)
        Resource labels to represent user provided metadata.

        **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/tpu_node#labels TpuNode#labels}

        Parameters:
        labels - Resource labels to represent user provided metadata. This parameter is required.
        Returns:
        this

      • network

        @Stability(Stable)
public TpuNode.Builder network​(String network)
        The name of a network to peer the TPU node to.

        It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#network TpuNode#network}

        Parameters:
        network - The name of a network to peer the TPU node to. This parameter is required.
        Returns:
        this

      • project

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

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

      • schedulingConfig

        @Stability(Stable)
public TpuNode.Builder schedulingConfig​(TpuNodeSchedulingConfig schedulingConfig)
        scheduling_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#scheduling_config TpuNode#scheduling_config}

        Parameters:
        schedulingConfig - scheduling_config block. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public TpuNode.Builder timeouts​(TpuNodeTimeouts timeouts)
        timeouts block.

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

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

      • useServiceNetworking

        @Stability(Stable)
public TpuNode.Builder useServiceNetworking​(Boolean useServiceNetworking)
        Whether the VPC peering for the node is set up through Service Networking API.

        The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network that you want to peer the TPU Node to is a Shared VPC network, the node must be created with this this field enabled. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#use_service_networking TpuNode#use_service_networking}

        Parameters:
        useServiceNetworking - Whether the VPC peering for the node is set up through Service Networking API. This parameter is required.
        Returns:
        this

      • useServiceNetworking

        @Stability(Stable)
public TpuNode.Builder useServiceNetworking​(com.hashicorp.cdktf.IResolvable useServiceNetworking)
        Whether the VPC peering for the node is set up through Service Networking API.

        The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network that you want to peer the TPU Node to is a Shared VPC network, the node must be created with this this field enabled. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#use_service_networking TpuNode#use_service_networking}

        Parameters:
        useServiceNetworking - Whether the VPC peering for the node is set up through Service Networking API. This parameter is required.
        Returns:
        this

      • zone

        @Stability(Stable)
public TpuNode.Builder zone​(String zone)
        The GCP location for the TPU. If it is not provided, the provider zone is used.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tpu_node#zone TpuNode#zone}

        Parameters:
        zone - The GCP location for the TPU. If it is not provided, the provider zone is used. This parameter is required.
        Returns:
        this

      • build

        @Stability(Stable)
public TpuNode build()
        Specified by:
        build in interface software.amazon.jsii.Builder<TpuNode>
        Returns:
        a newly built instance of TpuNode.