NodeTemplate

Represents a NodeTemplate resource. Node templates specify properties for creating sole-tenant nodes, such as node type, vCPU and memory requirements, node affinity labels, and region.

To get more information about NodeTemplate, see:

API documentation
How-to Guides
- Sole-Tenant Nodes

Create a NodeTemplate Resource

new NodeTemplate(name: string, args?: NodeTemplateArgs, opts?: CustomResourceOptions);

def NodeTemplate(resource_name, opts=None, cpu_overcommit_type=None, description=None, name=None, node_affinity_labels=None, node_type=None, node_type_flexibility=None, project=None, region=None, server_binding=None, __props__=None);

func NewNodeTemplate(ctx *Context, name string, args *NodeTemplateArgs, opts ...ResourceOption) (*NodeTemplate, error)

public NodeTemplate(string name, NodeTemplateArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NodeTemplateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NodeTemplateArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NodeTemplateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NodeTemplate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NodeTemplate resource accepts the following input properties:

CpuOvercommitType string: CPU overcommit. Default value: “NONE” Possible values: [“ENABLED”, “NONE”]
Description string: An optional textual description of the resource.
Name string: Name of the resource.
NodeAffinityLabels Dictionary<string, string>: Labels to use for node affinity, which will be used in instance scheduling.
NodeType string: Node type to use for nodes group that are created from this template. Only one of nodeTypeFlexibility and nodeType can be specified.
NodeTypeFlexibility NodeTemplateNodeTypeFlexibilityArgs: Flexible properties for the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility and nodeType can be specified. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Region where nodes using the node template will be created. If it is not provided, the provider region is used.
ServerBinding NodeTemplateServerBindingArgs: The server binding policy for nodes using this template. Determines where the nodes should restart following a maintenance event. Structure is documented below.

CpuOvercommitType string: CPU overcommit. Default value: “NONE” Possible values: [“ENABLED”, “NONE”]
Description string: An optional textual description of the resource.
Name string: Name of the resource.
NodeAffinityLabels map[string]string: Labels to use for node affinity, which will be used in instance scheduling.
NodeType string: Node type to use for nodes group that are created from this template. Only one of nodeTypeFlexibility and nodeType can be specified.
NodeTypeFlexibility NodeTemplateNodeTypeFlexibility: Flexible properties for the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility and nodeType can be specified. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Region where nodes using the node template will be created. If it is not provided, the provider region is used.
ServerBinding NodeTemplateServerBinding: The server binding policy for nodes using this template. Determines where the nodes should restart following a maintenance event. Structure is documented below.

cpuOvercommitType string: CPU overcommit. Default value: “NONE” Possible values: [“ENABLED”, “NONE”]
description string: An optional textual description of the resource.
name string: Name of the resource.
nodeAffinityLabels {[key: string]: string}: Labels to use for node affinity, which will be used in instance scheduling.
nodeType string: Node type to use for nodes group that are created from this template. Only one of nodeTypeFlexibility and nodeType can be specified.
nodeTypeFlexibility NodeTemplateNodeTypeFlexibility: Flexible properties for the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility and nodeType can be specified. Structure is documented below.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: Region where nodes using the node template will be created. If it is not provided, the provider region is used.
serverBinding NodeTemplateServerBinding: The server binding policy for nodes using this template. Determines where the nodes should restart following a maintenance event. Structure is documented below.

cpu_overcommit_type str: CPU overcommit. Default value: “NONE” Possible values: [“ENABLED”, “NONE”]
description str: An optional textual description of the resource.
name str: Name of the resource.
node_affinity_labels Dict[str, str]: Labels to use for node affinity, which will be used in instance scheduling.
node_type str: Node type to use for nodes group that are created from this template. Only one of nodeTypeFlexibility and nodeType can be specified.
node_type_flexibility Dict[NodeTemplateNodeTypeFlexibility]: Flexible properties for the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility and nodeType can be specified. Structure is documented below.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: Region where nodes using the node template will be created. If it is not provided, the provider region is used.
server_binding Dict[NodeTemplateServerBinding]: The server binding policy for nodes using this template. Determines where the nodes should restart following a maintenance event. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the NodeTemplate resource produces the following output properties:

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

creationTimestamp string: Creation timestamp in RFC3339 text format.
id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.

creation_timestamp str: Creation timestamp in RFC3339 text format.
id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.

Look up an Existing NodeTemplate Resource

Get an existing NodeTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NodeTemplateState, opts?: CustomResourceOptions): NodeTemplate

static get(resource_name, id, opts=None, cpu_overcommit_type=None, creation_timestamp=None, description=None, name=None, node_affinity_labels=None, node_type=None, node_type_flexibility=None, project=None, region=None, self_link=None, server_binding=None, __props__=None);

func GetNodeTemplate(ctx *Context, name string, id IDInput, state *NodeTemplateState, opts ...ResourceOption) (*NodeTemplate, error)

public static NodeTemplate Get(string name, Input<string> id, NodeTemplateState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CpuOvercommitType string: CPU overcommit. Default value: “NONE” Possible values: [“ENABLED”, “NONE”]
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional textual description of the resource.
Name string: Name of the resource.
NodeAffinityLabels Dictionary<string, string>: Labels to use for node affinity, which will be used in instance scheduling.
NodeType string: Node type to use for nodes group that are created from this template. Only one of nodeTypeFlexibility and nodeType can be specified.
NodeTypeFlexibility NodeTemplateNodeTypeFlexibilityArgs: Flexible properties for the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility and nodeType can be specified. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Region where nodes using the node template will be created. If it is not provided, the provider region is used.
SelfLink string: The URI of the created resource.
ServerBinding NodeTemplateServerBindingArgs: The server binding policy for nodes using this template. Determines where the nodes should restart following a maintenance event. Structure is documented below.

CpuOvercommitType string: CPU overcommit. Default value: “NONE” Possible values: [“ENABLED”, “NONE”]
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional textual description of the resource.
Name string: Name of the resource.
NodeAffinityLabels map[string]string: Labels to use for node affinity, which will be used in instance scheduling.
NodeType string: Node type to use for nodes group that are created from this template. Only one of nodeTypeFlexibility and nodeType can be specified.
NodeTypeFlexibility NodeTemplateNodeTypeFlexibility: Flexible properties for the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility and nodeType can be specified. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Region where nodes using the node template will be created. If it is not provided, the provider region is used.
SelfLink string: The URI of the created resource.
ServerBinding NodeTemplateServerBinding: The server binding policy for nodes using this template. Determines where the nodes should restart following a maintenance event. Structure is documented below.

cpuOvercommitType string: CPU overcommit. Default value: “NONE” Possible values: [“ENABLED”, “NONE”]
creationTimestamp string: Creation timestamp in RFC3339 text format.
description string: An optional textual description of the resource.
name string: Name of the resource.
nodeAffinityLabels {[key: string]: string}: Labels to use for node affinity, which will be used in instance scheduling.
nodeType string: Node type to use for nodes group that are created from this template. Only one of nodeTypeFlexibility and nodeType can be specified.
nodeTypeFlexibility NodeTemplateNodeTypeFlexibility: Flexible properties for the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility and nodeType can be specified. Structure is documented below.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: Region where nodes using the node template will be created. If it is not provided, the provider region is used.
selfLink string: The URI of the created resource.
serverBinding NodeTemplateServerBinding: The server binding policy for nodes using this template. Determines where the nodes should restart following a maintenance event. Structure is documented below.

cpu_overcommit_type str: CPU overcommit. Default value: “NONE” Possible values: [“ENABLED”, “NONE”]
creation_timestamp str: Creation timestamp in RFC3339 text format.
description str: An optional textual description of the resource.
name str: Name of the resource.
node_affinity_labels Dict[str, str]: Labels to use for node affinity, which will be used in instance scheduling.
node_type str: Node type to use for nodes group that are created from this template. Only one of nodeTypeFlexibility and nodeType can be specified.
node_type_flexibility Dict[NodeTemplateNodeTypeFlexibility]: Flexible properties for the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility and nodeType can be specified. Structure is documented below.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: Region where nodes using the node template will be created. If it is not provided, the provider region is used.
self_link str: The URI of the created resource.
server_binding Dict[NodeTemplateServerBinding]: The server binding policy for nodes using this template. Determines where the nodes should restart following a maintenance event. Structure is documented below.

Supporting Types

NodeTemplateNodeTypeFlexibility

See the input and output API doc for this type.

Cpus string: Number of virtual CPUs to use.
LocalSsd string: - Use local SSD
Memory string: Physical memory available to the node, defined in MB.

Cpus string: Number of virtual CPUs to use.
LocalSsd string: - Use local SSD
Memory string: Physical memory available to the node, defined in MB.

cpus string: Number of virtual CPUs to use.
localSsd string: - Use local SSD
memory string: Physical memory available to the node, defined in MB.

cpus str: Number of virtual CPUs to use.
localSsd str: - Use local SSD
memory str: Physical memory available to the node, defined in MB.

NodeTemplateServerBinding

See the input and output API doc for this type.

Type string: Type of server binding policy. If RESTART_NODE_ON_ANY_SERVER, nodes using this template will restart on any physical server following a maintenance event. If RESTART_NODE_ON_MINIMAL_SERVER, nodes using this template will restart on the same physical server following a maintenance event, instead of being live migrated to or restarted on a new physical server. This option may be useful if you are using software licenses tied to the underlying server characteristics such as physical sockets or cores, to avoid the need for additional licenses when maintenance occurs. However, VMs on such nodes will experience outages while maintenance is applied.

Type string: Type of server binding policy. If RESTART_NODE_ON_ANY_SERVER, nodes using this template will restart on any physical server following a maintenance event. If RESTART_NODE_ON_MINIMAL_SERVER, nodes using this template will restart on the same physical server following a maintenance event, instead of being live migrated to or restarted on a new physical server. This option may be useful if you are using software licenses tied to the underlying server characteristics such as physical sockets or cores, to avoid the need for additional licenses when maintenance occurs. However, VMs on such nodes will experience outages while maintenance is applied.

type string: Type of server binding policy. If RESTART_NODE_ON_ANY_SERVER, nodes using this template will restart on any physical server following a maintenance event. If RESTART_NODE_ON_MINIMAL_SERVER, nodes using this template will restart on the same physical server following a maintenance event, instead of being live migrated to or restarted on a new physical server. This option may be useful if you are using software licenses tied to the underlying server characteristics such as physical sockets or cores, to avoid the need for additional licenses when maintenance occurs. However, VMs on such nodes will experience outages while maintenance is applied.

type str: Type of server binding policy. If RESTART_NODE_ON_ANY_SERVER, nodes using this template will restart on any physical server following a maintenance event. If RESTART_NODE_ON_MINIMAL_SERVER, nodes using this template will restart on the same physical server following a maintenance event, instead of being live migrated to or restarted on a new physical server. This option may be useful if you are using software licenses tied to the underlying server characteristics such as physical sockets or cores, to avoid the need for additional licenses when maintenance occurs. However, VMs on such nodes will experience outages while maintenance is applied.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud