@pulumi/consul
Version:
A Pulumi package for creating and managing consul resources.
128 lines (127 loc) • 4.85 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* !> The `consul.CatalogEntry` resource has been deprecated in version 2.0.0 of the provider
* and will be removed in a future release. Please read the [upgrade guide](https://www.terraform.io/docs/providers/consul/guides/upgrading.html#deprecation-of-consul_catalog_entry)
* for more information.
*
* Registers a node or service with the [Consul Catalog](https://www.consul.io/docs/agent/http/catalog.html#catalog_register).
* Currently, defining health checks is not supported.
*/
export declare class CatalogEntry extends pulumi.CustomResource {
/**
* Get an existing CatalogEntry 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?: CatalogEntryState, opts?: pulumi.CustomResourceOptions): CatalogEntry;
/**
* Returns true if the given object is an instance of CatalogEntry. 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 CatalogEntry;
/**
* 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>;
/**
* The name of the node being added to, or
* referenced in the catalog.
*/
readonly node: pulumi.Output<string>;
/**
* A service to optionally associated with
* the node. Supported values are documented below.
*/
readonly services: pulumi.Output<outputs.CatalogEntryService[] | undefined>;
/**
* ACL token.
*
* @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 CatalogEntry 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: CatalogEntryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CatalogEntry resources.
*/
export interface CatalogEntryState {
/**
* 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>;
/**
* The name of the node being added to, or
* referenced in the catalog.
*/
node?: pulumi.Input<string>;
/**
* A service to optionally associated with
* the node. Supported values are documented below.
*/
services?: pulumi.Input<pulumi.Input<inputs.CatalogEntryService>[]>;
/**
* ACL token.
*
* @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 CatalogEntry resource.
*/
export interface CatalogEntryArgs {
/**
* 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>;
/**
* The name of the node being added to, or
* referenced in the catalog.
*/
node: pulumi.Input<string>;
/**
* A service to optionally associated with
* the node. Supported values are documented below.
*/
services?: pulumi.Input<pulumi.Input<inputs.CatalogEntryService>[]>;
/**
* ACL token.
*
* @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>;
}