Docs
Packagesconsul.Node
Explore with Pulumi AI
Provides access to Node data in Consul. This can be used to define a node. Currently, defining health checks is not supported.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Consul = Pulumi.Consul;
return await Deployment.RunAsync(() =>
{
var foobar = new Consul.Node("foobar", new()
{
Address = "192.168.10.10",
});
});
package main
import (
"github.com/pulumi/pulumi-consul/sdk/v3/go/consul"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := consul.NewNode(ctx, "foobar", &consul.NodeArgs{
Address: pulumi.String("192.168.10.10"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.consul.Node;
import com.pulumi.consul.NodeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var foobar = new Node("foobar", NodeArgs.builder()
.address("192.168.10.10")
.build());
}
}
import pulumi
import pulumi_consul as consul
foobar = consul.Node("foobar", address="192.168.10.10")
import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";
const foobar = new consul.Node("foobar", {address: "192.168.10.10"});
resources:
foobar:
type: consul:Node
properties:
address: 192.168.10.10
Create Node Resource
new Node(name: string, args: NodeArgs, opts?: CustomResourceOptions);@overload
def Node(resource_name: str,
opts: Optional[ResourceOptions] = None,
address: Optional[str] = None,
datacenter: Optional[str] = None,
meta: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
partition: Optional[str] = None,
token: Optional[str] = None)
@overload
def Node(resource_name: str,
args: NodeArgs,
opts: Optional[ResourceOptions] = None)func NewNode(ctx *Context, name string, args NodeArgs, opts ...ResourceOption) (*Node, error)public Node(string name, NodeArgs args, CustomResourceOptions? opts = null)type: consul:Node
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NodeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NodeArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NodeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NodeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NodeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Node Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Node resource accepts the following input properties:
- Address string
The address of the node being added to, or referenced in the catalog.
- Datacenter string
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- Meta Dictionary<string, string>
Key/value pairs that are associated with the node.
- Name string
The name of the node being added to, or referenced in the catalog.
- Partition string
The partition the node is associated with.
- Token string
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- Address string
The address of the node being added to, or referenced in the catalog.
- Datacenter string
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- Meta map[string]string
Key/value pairs that are associated with the node.
- Name string
The name of the node being added to, or referenced in the catalog.
- Partition string
The partition the node is associated with.
- Token string
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- address String
The address of the node being added to, or referenced in the catalog.
- datacenter String
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- meta Map<String,String>
Key/value pairs that are associated with the node.
- name String
The name of the node being added to, or referenced in the catalog.
- partition String
The partition the node is associated with.
- token String
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- address string
The address of the node being added to, or referenced in the catalog.
- datacenter string
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- meta {[key: string]: string}
Key/value pairs that are associated with the node.
- name string
The name of the node being added to, or referenced in the catalog.
- partition string
The partition the node is associated with.
- token string
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- address str
The address of the node being added to, or referenced in the catalog.
- datacenter str
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- meta Mapping[str, str]
Key/value pairs that are associated with the node.
- name str
The name of the node being added to, or referenced in the catalog.
- partition str
The partition the node is associated with.
- token str
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- address String
The address of the node being added to, or referenced in the catalog.
- datacenter String
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- meta Map<String>
Key/value pairs that are associated with the node.
- name String
The name of the node being added to, or referenced in the catalog.
- partition String
The partition the node is associated with.
- token String
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
Outputs
All input properties are implicitly available as output properties. Additionally, the Node resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing Node Resource
Get an existing Node 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?: NodeState, opts?: CustomResourceOptions): Node@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
address: Optional[str] = None,
datacenter: Optional[str] = None,
meta: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
partition: Optional[str] = None,
token: Optional[str] = None) -> Nodefunc GetNode(ctx *Context, name string, id IDInput, state *NodeState, opts ...ResourceOption) (*Node, error)public static Node Get(string name, Input<string> id, NodeState? state, CustomResourceOptions? opts = null)public static Node get(String name, Output<String> id, NodeState state, CustomResourceOptions options)Resource lookup is not supported in YAML- 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.
- 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.
- Address string
The address of the node being added to, or referenced in the catalog.
- Datacenter string
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- Meta Dictionary<string, string>
Key/value pairs that are associated with the node.
- Name string
The name of the node being added to, or referenced in the catalog.
- Partition string
The partition the node is associated with.
- Token string
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- Address string
The address of the node being added to, or referenced in the catalog.
- Datacenter string
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- Meta map[string]string
Key/value pairs that are associated with the node.
- Name string
The name of the node being added to, or referenced in the catalog.
- Partition string
The partition the node is associated with.
- Token string
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- address String
The address of the node being added to, or referenced in the catalog.
- datacenter String
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- meta Map<String,String>
Key/value pairs that are associated with the node.
- name String
The name of the node being added to, or referenced in the catalog.
- partition String
The partition the node is associated with.
- token String
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- address string
The address of the node being added to, or referenced in the catalog.
- datacenter string
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- meta {[key: string]: string}
Key/value pairs that are associated with the node.
- name string
The name of the node being added to, or referenced in the catalog.
- partition string
The partition the node is associated with.
- token string
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- address str
The address of the node being added to, or referenced in the catalog.
- datacenter str
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- meta Mapping[str, str]
Key/value pairs that are associated with the node.
- name str
The name of the node being added to, or referenced in the catalog.
- partition str
The partition the node is associated with.
- token str
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
- address String
The address of the node being added to, or referenced in the catalog.
- datacenter String
The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
- meta Map<String>
Key/value pairs that are associated with the node.
- name String
The name of the node being added to, or referenced in the catalog.
- partition String
The partition the node is associated with.
- token String
The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration
Import
The consul_node resource can be imported:
$ pulumi import consul:index/node:Node example node-name
Package Details
- Repository
- HashiCorp Consul pulumi/pulumi-consul
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
consulTerraform Provider.