@pulumi/consul
Version:
A Pulumi package for creating and managing consul resources.
142 lines (141 loc) • 4.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides access to Node data in Consul. This can be used to define a
* node. Currently, defining health checks is not supported.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as consul from "@pulumi/consul";
*
* const foobar = new consul.Node("foobar", {
* address: "192.168.10.10",
* name: "foobar",
* });
* ```
*
* ## Import
*
* The `consul_node` resource can be imported:
*
* ```sh
* $ pulumi import consul:index/node:Node example node-name
* ```
*/
export declare class Node extends pulumi.CustomResource {
/**
* Get an existing Node resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NodeState, opts?: pulumi.CustomResourceOptions): Node;
/**
* Returns true if the given object is an instance of Node. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Node;
/**
* The address of the node being added to, or referenced in the catalog.
*/
readonly address: pulumi.Output<string>;
/**
* The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
*/
readonly datacenter: pulumi.Output<string>;
/**
* Key/value pairs that are associated with the node.
*/
readonly meta: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The name of the node being added to, or referenced in the catalog.
*/
readonly name: pulumi.Output<string>;
/**
* The partition the node is associated with.
*/
readonly partition: pulumi.Output<string | undefined>;
/**
* @deprecated The token argument has been deprecated and will be removed in a future release.
Please use the token argument in the provider configuration
*/
readonly token: pulumi.Output<string | undefined>;
/**
* Create a Node resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: NodeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Node resources.
*/
export interface NodeState {
/**
* The address of the node being added to, or referenced in the catalog.
*/
address?: pulumi.Input<string>;
/**
* The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
*/
datacenter?: pulumi.Input<string>;
/**
* Key/value pairs that are associated with the node.
*/
meta?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the node being added to, or referenced in the catalog.
*/
name?: pulumi.Input<string>;
/**
* The partition the node is associated with.
*/
partition?: pulumi.Input<string>;
/**
* @deprecated The token argument has been deprecated and will be removed in a future release.
Please use the token argument in the provider configuration
*/
token?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Node resource.
*/
export interface NodeArgs {
/**
* The address of the node being added to, or referenced in the catalog.
*/
address: pulumi.Input<string>;
/**
* The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
*/
datacenter?: pulumi.Input<string>;
/**
* Key/value pairs that are associated with the node.
*/
meta?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the node being added to, or referenced in the catalog.
*/
name?: pulumi.Input<string>;
/**
* The partition the node is associated with.
*/
partition?: pulumi.Input<string>;
/**
* @deprecated The token argument has been deprecated and will be removed in a future release.
Please use the token argument in the provider configuration
*/
token?: pulumi.Input<string>;
}