1. Docs
  2. Reference
  3. API
  4. @pulumi/consul

Package @pulumi/consul

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-consul repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-consul repo.

var consul = require("@pulumi/consul");

import * as consul from "@pulumi/consul";

Modules

Resources

Functions

Others

Resources

Resource AclAuthMethod

class AclAuthMethod extends CustomResource

Starting with Consul 1.5.0, the consul..AclAuthMethod resource can be used to managed Consul ACL auth methods.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const minikube = new consul.AclAuthMethod("minikube", {
    config: {
        CACert: `-----BEGIN CERTIFICATE-----
...-----END CERTIFICATE-----
`,
        Host: "https://192.0.2.42:8443",
        ServiceAccountJWT: "eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9...",
    },
    description: "dev minikube cluster",
    type: "kubernetes",
});

constructor

new AclAuthMethod(name: string, args: AclAuthMethodArgs, opts?: pulumi.CustomResourceOptions)

Create a AclAuthMethod resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AclAuthMethodState, opts?: pulumi.CustomResourceOptions): AclAuthMethod

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AclAuthMethod

Returns true if the given object is an instance of AclAuthMethod. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property config

public config: pulumi.Output<{[key: string]: string}>;

The raw configuration for this ACL auth method.

property description

public description: pulumi.Output<string | undefined>;

A free form human readable description of the auth method.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the ACL auth method.

property namespace

public namespace: pulumi.Output<string | undefined>;

The namespace to create the policy within.

property type

public type: pulumi.Output<string>;

The type of the ACL auth method.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AclBindingRule

class AclBindingRule extends CustomResource

Starting with Consul 1.5.0, the consul..AclBindingRule resource can be used to managed Consul ACL binding rules.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const minikube = new consul.AclAuthMethod("minikube", {
    config: {
        CACert: `-----BEGIN CERTIFICATE-----
...-----END CERTIFICATE-----
`,
        Host: "https://192.0.2.42:8443",
        ServiceAccountJWT: "eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9...",
    },
    description: "dev minikube cluster",
    type: "kubernetes",
});
const test = new consul.AclBindingRule("test", {
    authMethod: minikube.name,
    bindName: "minikube",
    bindType: "service",
    description: "foobar",
    selector: "serviceaccount.namespace==default",
});

constructor

new AclBindingRule(name: string, args: AclBindingRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a AclBindingRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AclBindingRuleState, opts?: pulumi.CustomResourceOptions): AclBindingRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AclBindingRule

Returns true if the given object is an instance of AclBindingRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authMethod

public authMethod: pulumi.Output<string>;

The name of the ACL auth method this rule apply.

property bindName

public bindName: pulumi.Output<string>;

The name to bind to a token at login-time.

property bindType

public bindType: pulumi.Output<string>;

Specifies the way the binding rule affects a token created at login.

property description

public description: pulumi.Output<string | undefined>;

A free form human readable description of the binding rule.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property namespace

public namespace: pulumi.Output<string | undefined>;

The namespace to create the binding rule within.

property selector

public selector: pulumi.Output<string | undefined>;

The expression used to math this rule against valid identities returned from an auth method validation.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AclPolicy

class AclPolicy extends CustomResource

Starting with Consul 1.4.0, the consul..AclPolicy can be used to managed Consul ACL policies.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const test = new consul.AclPolicy("test", {
    datacenters: ["dc1"],
    rules: `nodePrefix "" {
  policy = "read"
}
`,
});

constructor

new AclPolicy(name: string, args: AclPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a AclPolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AclPolicyState, opts?: pulumi.CustomResourceOptions): AclPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AclPolicy

Returns true if the given object is an instance of AclPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property datacenters

public datacenters: pulumi.Output<string[] | undefined>;

The datacenters of the policy.

property description

public description: pulumi.Output<string | undefined>;

The description of the policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the policy.

property namespace

public namespace: pulumi.Output<string | undefined>;

The namespace to create the policy within.

property rules

public rules: pulumi.Output<string>;

The rules of the policy.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AclRole

class AclRole extends CustomResource

Starting with Consul 1.5.0, the consul..AclRole can be used to managed Consul ACL roles.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const readPolicy = new consul.AclPolicy("read-policy", {
    datacenters: ["dc1"],
    rules: "node \"\" { policy = \"read\" }",
});
const read = new consul.AclRole("read", {
    description: "bar",
    policies: [read_policy.id],
    serviceIdentities: [{
        serviceName: "foo",
    }],
});

constructor

new AclRole(name: string, args?: AclRoleArgs, opts?: pulumi.CustomResourceOptions)

Create a AclRole resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AclRoleState, opts?: pulumi.CustomResourceOptions): AclRole

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AclRole

Returns true if the given object is an instance of AclRole. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

A free form human readable description of the role.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the ACL role.

property namespace

public namespace: pulumi.Output<string | undefined>;

The namespace to create the role within.

property policies

public policies: pulumi.Output<string[] | undefined>;

The list of policies that should be applied to the role.

property serviceIdentities

public serviceIdentities: pulumi.Output<AclRoleServiceIdentity[] | undefined>;

The list of service identities that should be applied to the role.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AclToken

class AclToken extends CustomResource

The consul..AclToken resource writes an ACL token into Consul.

Example Usage

Basic usage
import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const agent = new consul.AclPolicy("agent", {
    rules: `nodePrefix "" {
  policy = "read"
}
`,
});
const test = new consul.AclToken("test", {
    description: "my test token",
    local: true,
    policies: [agent.name],
});

constructor

new AclToken(name: string, args?: AclTokenArgs, opts?: pulumi.CustomResourceOptions)

Create a AclToken resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AclTokenState, opts?: pulumi.CustomResourceOptions): AclToken

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AclToken

Returns true if the given object is an instance of AclToken. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessorId

public accessorId: pulumi.Output<string>;

The uuid of the token. If omitted, Consul will generate a random uuid.

property description

public description: pulumi.Output<string | undefined>;

The description of the token.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property local

public local: pulumi.Output<boolean | undefined>;

The flag to set the token local to the current datacenter.

property namespace

public namespace: pulumi.Output<string | undefined>;

The namespace to create the token within.

property policies

public policies: pulumi.Output<string[] | undefined>;

The list of policies attached to the token.

property roles

public roles: pulumi.Output<string[] | undefined>;

The list of roles attached to the token.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AclTokenPolicyAttachment

class AclTokenPolicyAttachment extends CustomResource

constructor

new AclTokenPolicyAttachment(name: string, args: AclTokenPolicyAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a AclTokenPolicyAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AclTokenPolicyAttachmentState, opts?: pulumi.CustomResourceOptions): AclTokenPolicyAttachment

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AclTokenPolicyAttachment

Returns true if the given object is an instance of AclTokenPolicyAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property policy

public policy: pulumi.Output<string>;

The name of the policy attached to the token.

property tokenId

public tokenId: pulumi.Output<string>;

The id of the token.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AgentService

class AgentService extends CustomResource

!> The consul..AgentService 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 for more information.

Provides access to the agent service data in Consul. This can be used to define a service associated with a particular agent. Currently, defining health checks for an agent service is not supported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const app = new consul.AgentService("app", {
    address: "www.google.com",
    port: 80,
    tags: [
        "tag0",
        "tag1",
    ],
});

constructor

new AgentService(name: string, args?: AgentServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a AgentService resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AgentServiceState, opts?: pulumi.CustomResourceOptions): AgentService

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AgentService

Returns true if the given object is an instance of AgentService. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property address

public address: pulumi.Output<string>;

The address of the service. Defaults to the address of the agent.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the service.

property port

public port: pulumi.Output<number | undefined>;

The port of the service.

property tags

public tags: pulumi.Output<string[] | undefined>;

A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AutopilotConfig

class AutopilotConfig extends CustomResource

Provides access to the Autopilot Configuration of Consul to automatically manage Consul servers.

It includes to automatically cleanup dead servers, monitor the status of the Raft cluster and stable server introduction.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const config = new consul.AutopilotConfig("config", {
    cleanupDeadServers: false,
    lastContactThreshold: "1s",
    maxTrailingLogs: 500,
});

constructor

new AutopilotConfig(name: string, args?: AutopilotConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a AutopilotConfig resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AutopilotConfigState, opts?: pulumi.CustomResourceOptions): AutopilotConfig

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AutopilotConfig

Returns true if the given object is an instance of AutopilotConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cleanupDeadServers

public cleanupDeadServers: pulumi.Output<boolean | undefined>;

Whether to remove failing servers when a replacement comes online. Defaults to true.

property datacenter

public datacenter: pulumi.Output<string | undefined>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property disableUpgradeMigration

public disableUpgradeMigration: pulumi.Output<boolean | undefined>;

Whether to disable upgrade migrations. Defaults to false.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lastContactThreshold

public lastContactThreshold: pulumi.Output<string | undefined>;

The time after which a server is considered as unhealthy and will be removed. Defaults to "200ms".

property maxTrailingLogs

public maxTrailingLogs: pulumi.Output<number | undefined>;

The maximum number of Raft log entries a server can trail the leader. Defaults to 250.

property redundancyZoneTag

public redundancyZoneTag: pulumi.Output<string | undefined>;

The redundancy zone tag to use. Consul will try to keep one voting server by zone to take advantage of isolated failure domains. Defaults to an empty string.

property serverStabilizationTime

public serverStabilizationTime: pulumi.Output<string | undefined>;

The period to wait for a server to be healthy and stable before being promoted to a full, voting member. Defaults to "10s".

property upgradeVersionTag

public upgradeVersionTag: pulumi.Output<string | undefined>;

The tag to override the version information used during a migration. Defaults to an empty string.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource CatalogEntry

class CatalogEntry extends CustomResource

!> 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 for more information.

Registers a node or service with the Consul Catalog. Currently, defining health checks is not supported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const app = new consul.CatalogEntry("app", {
    address: "192.168.10.10",
    node: "foobar",
    services: [{
        address: "127.0.0.1",
        id: "redis1",
        name: "redis",
        port: 8000,
        tags: [
            "master",
            "v1",
        ],
    }],
});

constructor

new CatalogEntry(name: string, args: CatalogEntryArgs, opts?: pulumi.CustomResourceOptions)

Create a CatalogEntry resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CatalogEntryState, opts?: pulumi.CustomResourceOptions): CatalogEntry

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is 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.

property address

public address: pulumi.Output<string>;

The address of the node being added to, or referenced in the catalog.

property datacenter

public datacenter: pulumi.Output<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property node

public node: pulumi.Output<string>;

The name of the node being added to, or referenced in the catalog.

property services

public services: pulumi.Output<CatalogEntryService[] | undefined>;

A service to optionally associated with the node. Supported values are documented below.

property token

public token: pulumi.Output<string | undefined>;

ACL token.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ConfigEntry

class ConfigEntry extends CustomResource

The Configuration Entry resource can be used to provide cluster-wide defaults for various aspects of Consul.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const proxyDefaults = new consul.ConfigEntry("proxyDefaults", {
    kind: "proxy-defaults",
    configJson: JSON.stringify({
        Config: {
            local_connect_timeout_ms: 1000,
            handshake_timeout_ms: 10000,
        },
    }),
});
const web = new consul.ConfigEntry("web", {
    kind: "service-defaults",
    configJson: JSON.stringify({
        Protocol: "http",
    }),
});
const admin = new consul.ConfigEntry("admin", {
    kind: "service-defaults",
    configJson: JSON.stringify({
        Protocol: "http",
    }),
});
const serviceResolver = new consul.ConfigEntry("serviceResolver", {
    kind: "service-resolver",
    configJson: JSON.stringify({
        DefaultSubset: "v1",
        Subsets: {
            v1: {
                Filter: "Service.Meta.version == v1",
            },
            v2: {
                Filter: "Service.Meta.version == v2",
            },
        },
    }),
});
const serviceSplitter = new consul.ConfigEntry("serviceSplitter", {
    kind: "service-splitter",
    configJson: JSON.stringify({
        Splits: [
            {
                Weight: 90,
                ServiceSubset: "v1",
            },
            {
                Weight: 10,
                ServiceSubset: "v2",
            },
        ],
    }),
});
const serviceRouter = new consul.ConfigEntry("serviceRouter", {
    kind: "service-router",
    configJson: JSON.stringify({
        Routes: [{
            Match: {
                HTTP: {
                    PathPrefix: "/admin",
                },
            },
            Destination: {
                Service: "admin",
            },
        }],
    }),
});

constructor

new ConfigEntry(name: string, args: ConfigEntryArgs, opts?: pulumi.CustomResourceOptions)

Create a ConfigEntry resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigEntryState, opts?: pulumi.CustomResourceOptions): ConfigEntry

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ConfigEntry

Returns true if the given object is an instance of ConfigEntry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property configJson

public configJson: pulumi.Output<string | undefined>;

An arbitrary map of configuration values.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<string>;

The kind of configuration entry to register.

property name

public name: pulumi.Output<string>;

The name of the configuration entry being registred.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Intention

class Intention extends CustomResource

Intentions are used to define rules for which services may connect to one another when using Consul Connect.

It is appropriate to either reference existing services or specify non-existent services that will be created in the future when creating intentions. This resource can be used in conjunction with the consul..Service datasource when referencing services registered on nodes that have a running Consul agent.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const database = new consul.Intention("database", {
    action: "allow",
    destinationName: "db",
    sourceName: "api",
});

constructor

new Intention(name: string, args: IntentionArgs, opts?: pulumi.CustomResourceOptions)

Create a Intention resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IntentionState, opts?: pulumi.CustomResourceOptions): Intention

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Intention

Returns true if the given object is an instance of Intention. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property action

public action: pulumi.Output<string>;

The intention action. Must be one of allow or deny.

property description

public description: pulumi.Output<string | undefined>;

Optional description that can be used by Consul tooling, but is not used internally.

property destinationName

public destinationName: pulumi.Output<string>;

The name of the destination service for the intention. This service does not have to exist.

property destinationNamespace

public destinationNamespace: pulumi.Output<string | undefined>;

The destination namespace of the intention.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property meta

public meta: pulumi.Output<{[key: string]: string} | undefined>;

Key/value pairs that are opaque to Consul and are associated with the intention.

property sourceName

public sourceName: pulumi.Output<string>;

The name of the source service for the intention. This service does not have to exist.

property sourceNamespace

public sourceNamespace: pulumi.Output<string | undefined>;

The source namespace of the intention.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource KeyPrefix

class KeyPrefix extends CustomResource

constructor

new KeyPrefix(name: string, args: KeyPrefixArgs, opts?: pulumi.CustomResourceOptions)

Create a KeyPrefix resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KeyPrefixState, opts?: pulumi.CustomResourceOptions): KeyPrefix

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is KeyPrefix

Returns true if the given object is an instance of KeyPrefix. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property datacenter

public datacenter: pulumi.Output<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property namespace

public namespace: pulumi.Output<string | undefined>;

The namespace to create the keys within.

property pathPrefix

public pathPrefix: pulumi.Output<string>;

Specifies the common prefix shared by all keys that will be managed by this resource instance. In most cases this will end with a slash, to manage a “folder” of keys.

property subkeyCollection

public subkeyCollection: pulumi.Output<KeyPrefixSubkeyCollection[] | undefined>;

A subkey to add. Supported values documented below. Multiple blocks supported.

property subkeys

public subkeys: pulumi.Output<{[key: string]: string} | undefined>;

A mapping from subkey name (which will be appended to the given pathPrefix) to the value that should be stored at that key. Use slashes, as shown in the above example, to create “sub-folders” under the given path prefix.

property token

public token: pulumi.Output<string | undefined>;

The ACL token to use. This overrides the token that the agent provides by default.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Keys

class Keys extends CustomResource

constructor

new Keys(name: string, args?: KeysArgs, opts?: pulumi.CustomResourceOptions)

Create a Keys resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KeysState, opts?: pulumi.CustomResourceOptions): Keys

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Keys

Returns true if the given object is an instance of Keys. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property datacenter

public datacenter: pulumi.Output<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keys

public keys: pulumi.Output<KeysKey[] | undefined>;

Specifies a key in Consul to be written. Supported values documented below.

property namespace

public namespace: pulumi.Output<string | undefined>;

The namespace to create the keys within.

property token

public token: pulumi.Output<string | undefined>;

The ACL token to use. This overrides the token that the agent provides by default.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property var

public var: pulumi.Output<{[key: string]: string}>;

Resource License

class License extends CustomResource

NOTE: This feature requires Consul Enterprise.

The consul..License resource provides datacenter-level management of the Consul Enterprise license. If ACLs are enabled then a token with operator privileges may be required in order to use this command.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";
import * from "fs";

const license = new consul.License("license", {license: fs.readFileSync("license.hclic")});

constructor

new License(name: string, args: LicenseArgs, opts?: pulumi.CustomResourceOptions)

Create a License resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LicenseState, opts?: pulumi.CustomResourceOptions): License

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is License

Returns true if the given object is an instance of License. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property customerId

public customerId: pulumi.Output<string>;

The ID of the customer the license is attached to.

property datacenter

public datacenter: pulumi.Output<string | undefined>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property expirationTime

public expirationTime: pulumi.Output<string>;

The expiration time of the license.

property features

public features: pulumi.Output<string[]>;

The features for which the license is valid.

property flags

public flags: pulumi.Output<{[key: string]: string}>;

The metadata attached to the license.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property installationId

public installationId: pulumi.Output<string>;

The ID of the current installation.

property issueTime

public issueTime: pulumi.Output<string>;

The date the license was issued.

property license

public license: pulumi.Output<string>;

The Consul license to use.

property licenseId

public licenseId: pulumi.Output<string>;

The ID of the license used.

property product

public product: pulumi.Output<string>;

The product for which the license is valid.

property startTime

public startTime: pulumi.Output<string>;

The start time of the license.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valid

public valid: pulumi.Output<boolean>;

Whether the license is valid.

property warnings

public warnings: pulumi.Output<string[]>;

A list of warning messages regarding the license validity.

Resource Namespace

class Namespace extends CustomResource

NOTE: This feature requires Consul Enterprise.

The consul..Namespace resource provides isolated Consul Enterprise Namespaces.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const production = new consul.Namespace("production", {
    description: "Production namespace",
    meta: {
        foo: "bar",
    },
});

constructor

new Namespace(name: string, args?: NamespaceArgs, opts?: pulumi.CustomResourceOptions)

Create a Namespace resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NamespaceState, opts?: pulumi.CustomResourceOptions): Namespace

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Namespace

Returns true if the given object is an instance of Namespace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

Free form namespace description.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property meta

public meta: pulumi.Output<{[key: string]: string} | undefined>;

Specifies arbitrary KV metadata to associate with the namespace.

property name

public name: pulumi.Output<string>;

The namespace name.

property policyDefaults

public policyDefaults: pulumi.Output<string[] | undefined>;

The list of default policies that should be applied to all tokens created in this namespace.

property roleDefaults

public roleDefaults: pulumi.Output<string[] | undefined>;

The list of default roles that should be applied to all tokens created in this namespace.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkArea

class NetworkArea extends CustomResource

NOTE: This feature requires Consul Enterprise.

The consul..NetworkArea resource manages a relationship between servers in two different Consul datacenters.

Unlike Consul’s WAN feature, network areas use just the server RPC port for communication, and relationships can be made between independent pairs of datacenters, so not all servers need to be fully connected. This allows for complex topologies among Consul datacenters like hub/spoke and more general trees.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const dc2 = new consul.NetworkArea("dc2", {
    peerDatacenter: "dc2",
    retryJoins: ["1.2.3.4"],
    useTls: true,
});

constructor

new NetworkArea(name: string, args: NetworkAreaArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkArea resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkAreaState, opts?: pulumi.CustomResourceOptions): NetworkArea

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkArea

Returns true if the given object is an instance of NetworkArea. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property datacenter

public datacenter: pulumi.Output<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property peerDatacenter

public peerDatacenter: pulumi.Output<string>;

The name of the Consul datacenter that will be joined to form the area.

property retryJoins

public retryJoins: pulumi.Output<string[] | undefined>;

Specifies a list of Consul servers to attempt to join. Servers can be given as IP, IP:port, hostname, or hostname:port.

property token

public token: pulumi.Output<string | undefined>;

The ACL token to use. This overrides the token that the agent provides by default.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property useTls

public useTls: pulumi.Output<boolean | undefined>;

Specifies whether gossip over this area should be encrypted with TLS if possible. Defaults to false.

Resource Node

class Node extends CustomResource

Provides access to Node data in Consul. This can be used to define a node. Currently, defining health checks is not supported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const foobar = new consul.Node("foobar", {
    address: "192.168.10.10",
});

constructor

new Node(name: string, args: NodeArgs, opts?: pulumi.CustomResourceOptions)

Create a Node resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NodeState, opts?: pulumi.CustomResourceOptions): Node

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is 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.

property address

public address: pulumi.Output<string>;

The address of the node being added to, or referenced in the catalog.

property datacenter

public datacenter: pulumi.Output<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property meta

public meta: pulumi.Output<{[key: string]: string} | undefined>;

Key/value pairs that are associated with the node.

property name

public name: pulumi.Output<string>;

The name of the node being added to, or referenced in the catalog.

property token

public token: pulumi.Output<string | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource PreparedQuery

class PreparedQuery extends CustomResource

constructor

new PreparedQuery(name: string, args: PreparedQueryArgs, opts?: pulumi.CustomResourceOptions)

Create a PreparedQuery resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PreparedQueryState, opts?: pulumi.CustomResourceOptions): PreparedQuery

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PreparedQuery

Returns true if the given object is an instance of PreparedQuery. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connect

public connect: pulumi.Output<boolean | undefined>;

When true the prepared query will return connect proxy services for a queried service. Conditions such as tags in the prepared query will be matched against the proxy service. Defaults to false.

property datacenter

public datacenter: pulumi.Output<string | undefined>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property dns

public dns: pulumi.Output<PreparedQueryDns | undefined>;

Settings for controlling the DNS response details.

property failover

public failover: pulumi.Output<PreparedQueryFailover | undefined>;

Options for controlling behavior when no healthy nodes are available in the local DC.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ignoreCheckIds

public ignoreCheckIds: pulumi.Output<string[] | undefined>;

Specifies a list of check IDs that should be ignored when filtering unhealthy instances. This is mostly useful in an emergency or as a temporary measure when a health check is found to be unreliable. Being able to ignore it in centrally-defined queries can be simpler than de-registering the check as an interim solution until the check can be fixed.

property name

public name: pulumi.Output<string>;

The name of the prepared query. Used to identify the prepared query during requests. Can be specified as an empty string to configure the query as a catch-all.

property near

public near: pulumi.Output<string | undefined>;

Allows specifying the name of a node to sort results near using Consul’s distance sorting and network coordinates. The magic _agent value can be used to always sort nearest the node servicing the request.

property nodeMeta

public nodeMeta: pulumi.Output<{[key: string]: string} | undefined>;

Specifies a list of user-defined key/value pairs that will be used for filtering the query results to nodes with the given metadata values present.

property onlyPassing

public onlyPassing: pulumi.Output<boolean | undefined>;

When true, the prepared query will only return nodes with passing health checks in the result.

property service

public service: pulumi.Output<string>;

The name of the service to query.

property serviceMeta

public serviceMeta: pulumi.Output<{[key: string]: string} | undefined>;

Specifies a list of user-defined key/value pairs that will be used for filtering the query results to services with the given metadata values present.

property session

public session: pulumi.Output<string | undefined>;

The name of the Consul session to tie this query’s lifetime to. This is an advanced parameter that should not be used without a complete understanding of Consul sessions and the implications of their use (it is recommended to leave this blank in nearly all cases). If this parameter is omitted the query will not expire.

property storedToken

public storedToken: pulumi.Output<string | undefined>;

The ACL token to store with the prepared query. This token will be used by default whenever the query is executed.

property tags

public tags: pulumi.Output<string[] | undefined>;

The list of required and/or disallowed tags. If a tag is in this list it must be present. If the tag is preceded with a “!” then it is disallowed.

property template

public template: pulumi.Output<PreparedQueryTemplate | undefined>;

Query templating options. This is used to make a single prepared query respond to many different requests.

property token

public token: pulumi.Output<string | undefined>;

The ACL token to use when saving the prepared query. This overrides the token that the agent provides by default.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Provider

class Provider extends ProviderResource

The provider type for the consul package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Service

class Service extends CustomResource

A high-level resource for creating a Service in Consul in the Consul catalog. This is appropriate for registering external services and can be used to create services addressable by Consul that cannot be registered with a local agent.

If the Consul agent is running on the node where this service is registered, it is not recommended to use this resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const compute = new consul.Node("compute", {
    address: "www.google.com",
});
const google = new consul.Service("google", {
    node: compute.name,
    port: 80,
    tags: ["tag0"],
});

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property address

public address: pulumi.Output<string>;

The address of the service. Defaults to the address of the node.

property checks

public checks: pulumi.Output<ServiceCheck[] | undefined>;

property datacenter

public datacenter: pulumi.Output<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property external

public external: pulumi.Output<boolean | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property meta

public meta: pulumi.Output<{[key: string]: string} | undefined>;

A map of arbitrary KV metadata linked to the service instance.

property name

public name: pulumi.Output<string>;

The name of the health-check.

property namespace

public namespace: pulumi.Output<string | undefined>;

The namespace to create the service within.

property node

public node: pulumi.Output<string>;

The name of the node the to register the service on.

property port

public port: pulumi.Output<number | undefined>;

The port of the service.

property serviceId

public serviceId: pulumi.Output<string>;
  • If the service ID is not provided, it will be defaulted to the value of the name attribute.

property tags

public tags: pulumi.Output<string[] | undefined>;

A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getAclAuthMethod

getAclAuthMethod(args: GetAclAuthMethodArgs, opts?: pulumi.InvokeOptions): Promise<GetAclAuthMethodResult>

The consul..AclAuthMethod data source returns the information related to a Consul Auth Method.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const test = consul.getAclAuthMethod({
    name: "minikube",
});
export const consulAclAuthMethod = test.then(test => test.config);

Function getAclPolicy

getAclPolicy(args: GetAclPolicyArgs, opts?: pulumi.InvokeOptions): Promise<GetAclPolicyResult>

The consul..AclPolicy data source returns the information related to a Consul ACL Policy.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const agent = consul.getAclPolicy({
    name: "agent",
});
export const consulAclPolicy = agent.then(agent => agent.rules);

Function getAclRole

getAclRole(args: GetAclRoleArgs, opts?: pulumi.InvokeOptions): Promise<GetAclRoleResult>

The consul..AclRole data source returns the information related to a Consul ACL Role.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const test = consul.getAclRole({
    name: "example-role",
});
export const consulAclRole = test.then(test => test.id);

Function getAclToken

getAclToken(args: GetAclTokenArgs, opts?: pulumi.InvokeOptions): Promise<GetAclTokenResult>

The consul..AclToken data source returns the information related to the consul..AclToken resource with the exception of its secret ID.

If you want to get the secret ID associated with a token, use the consul..getAclTokenSecretId data source.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const test = pulumi.output(consul.getAclToken({
    accessorId: "00000000-0000-0000-0000-000000000002",
}, { async: true }));

export const consulAclPolicies = test.policies!;

Function getAclTokenSecretId

getAclTokenSecretId(args: GetAclTokenSecretIdArgs, opts?: pulumi.InvokeOptions): Promise<GetAclTokenSecretIdResult>

Function getAgentConfig

getAgentConfig(opts?: pulumi.InvokeOptions): Promise<GetAgentConfigResult>

Note: The consul..getAgentConfig resource differs from consul..getAgentSelf, providing less information but utilizing stable APIs. consul..getAgentSelf will be deprecated in a future release.

The consul..getAgentConfig data source returns configuration data from the agent specified in the provider.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const remoteAgent = pulumi.output(consul.getAgentConfig({ async: true }));

export const consulVersion = remoteAgent.version;

Function getAgentSelf

getAgentSelf(opts?: pulumi.InvokeOptions): Promise<GetAgentSelfResult>

Warning: The consul..getAgentSelf resource has been deprecated and will be removed from a future release of the provider. Read the upgrade instructions for more information.

The consul..getAgentSelf data source returns configuration and status data from the agent specified in the provider.

Function getAutopilotHealth

getAutopilotHealth(args?: GetAutopilotHealthArgs, opts?: pulumi.InvokeOptions): Promise<GetAutopilotHealthResult>

The consul..getAutopilotHealth data source returns autopilot health information about the current Consul cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const read = pulumi.output(consul.getAutopilotHealth({ async: true }));

export const health = read.healthy;

Function getCatalogNodes

getCatalogNodes(args?: GetCatalogNodesArgs, opts?: pulumi.InvokeOptions): Promise<GetCatalogNodesResult>

Function getCatalogService

getCatalogService(args: GetCatalogServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetCatalogServiceResult>

Function getCatalogServices

getCatalogServices(args?: GetCatalogServicesArgs, opts?: pulumi.InvokeOptions): Promise<GetCatalogServicesResult>

Function getKeyPrefix

getKeyPrefix(args: GetKeyPrefixArgs, opts?: pulumi.InvokeOptions): Promise<GetKeyPrefixResult>

Function getKeys

getKeys(args?: GetKeysArgs, opts?: pulumi.InvokeOptions): Promise<GetKeysResult>

The consul..Keys resource reads values from the Consul key/value store. This is a powerful way dynamically set values in templates.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as consul from "@pulumi/consul";

const appKeys = pulumi.output(consul.getKeys({
    datacenter: "nyc1",
    // Read the launch AMI from Consul
    keys: [{
        default: "ami-1234",
        name: "ami",
        path: "service/app/launch_ami",
    }],
    token: "abcd",
}, { async: true }));
// Start our instance with the dynamic ami value
const appInstance = new aws.ec2.Instance("app", {
    ami: appKeys.var.ami,
});

Function getNetworkAreaMembers

getNetworkAreaMembers(args: GetNetworkAreaMembersArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkAreaMembersResult>

NOTE: This feature requires Consul Enterprise.

The consul..getNetworkAreaMembers data source provides a list of the Consul servers present in a specific network area.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const dc2NetworkArea = new consul.NetworkArea("dc2NetworkArea", {
    peerDatacenter: "dc2",
    retryJoins: ["1.2.3.4"],
    useTls: true,
});
const dc2NetworkAreaMembers = dc2NetworkArea.id.apply(id => consul.getNetworkAreaMembers({
    uuid: id,
}));
export const members = dc2NetworkAreaMembers.members;

Function getNetworkSegments

getNetworkSegments(args?: GetNetworkSegmentsArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkSegmentsResult>

NOTE: This feature requires Consul Enterprise.

The consulNetworkSegment data source can be used to retrieve the network segments defined in the configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const segmentsNetworkSegments = consul.getNetworkSegments({});
export const segments = segmentsNetworkSegments.then(segmentsNetworkSegments => segmentsNetworkSegments.segments);

Function getNodes

getNodes(args?: GetNodesArgs, opts?: pulumi.InvokeOptions): Promise<GetNodesResult>

The consul..getNodes data source returns a list of Consul nodes that have been registered with the Consul cluster in a given datacenter. By specifying a different datacenter in the queryOptions it is possible to retrieve a list of nodes from a different WAN-attached Consul datacenter.

Function getService

getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>

consul..Service provides details about a specific Consul service in a given datacenter. The results include a list of nodes advertising the specified service, the node’s IP address, port number, node ID, etc. By specifying a different datacenter in the queryOptions it is possible to retrieve a list of services from a different WAN-attached Consul datacenter.

This data source is different from the consul..getServices (plural) data source, which provides a summary of the current Consul services.

Function getServiceHealth

getServiceHealth(args: GetServiceHealthArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceHealthResult>

consul..getServiceHealth can be used to get the list of the instances that are currently healthy, according to their associated health-checks. The result includes the list of service instances, the node associated to each instance and its health-checks.

This resource is likely to change as frequently as the health-checks are being updated, you should expect different results in a frequent basis.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";
import * as vault from "@pulumi/vault";

const vaultServiceHealth = pulumi.output(consul.getServiceHealth({
    passing: true,
    service: "vault",
}, { async: true }));

Function getServices

getServices(args?: GetServicesArgs, opts?: pulumi.InvokeOptions): Promise<GetServicesResult>

The consul..getServices data source returns a list of Consul services that have been registered with the Consul cluster in a given datacenter. By specifying a different datacenter in the queryOptions it is possible to retrieve a list of services from a different WAN-attached Consul datacenter.

This data source is different from the consul..Service (singular) data source, which provides a detailed response about a specific Consul service.

Others

interface AclAuthMethodArgs

interface AclAuthMethodArgs

The set of arguments for constructing a AclAuthMethod resource.

property config

config: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

The raw configuration for this ACL auth method.

property description

description?: pulumi.Input<string>;

A free form human readable description of the auth method.

property name

name?: pulumi.Input<string>;

The name of the ACL auth method.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the policy within.

property type

type: pulumi.Input<string>;

The type of the ACL auth method.

interface AclAuthMethodState

interface AclAuthMethodState

Input properties used for looking up and filtering AclAuthMethod resources.

property config

config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

The raw configuration for this ACL auth method.

property description

description?: pulumi.Input<string>;

A free form human readable description of the auth method.

property name

name?: pulumi.Input<string>;

The name of the ACL auth method.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the policy within.

property type

type?: pulumi.Input<string>;

The type of the ACL auth method.

interface AclBindingRuleArgs

interface AclBindingRuleArgs

The set of arguments for constructing a AclBindingRule resource.

property authMethod

authMethod: pulumi.Input<string>;

The name of the ACL auth method this rule apply.

property bindName

bindName: pulumi.Input<string>;

The name to bind to a token at login-time.

property bindType

bindType: pulumi.Input<string>;

Specifies the way the binding rule affects a token created at login.

property description

description?: pulumi.Input<string>;

A free form human readable description of the binding rule.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the binding rule within.

property selector

selector?: pulumi.Input<string>;

The expression used to math this rule against valid identities returned from an auth method validation.

interface AclBindingRuleState

interface AclBindingRuleState

Input properties used for looking up and filtering AclBindingRule resources.

property authMethod

authMethod?: pulumi.Input<string>;

The name of the ACL auth method this rule apply.

property bindName

bindName?: pulumi.Input<string>;

The name to bind to a token at login-time.

property bindType

bindType?: pulumi.Input<string>;

Specifies the way the binding rule affects a token created at login.

property description

description?: pulumi.Input<string>;

A free form human readable description of the binding rule.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the binding rule within.

property selector

selector?: pulumi.Input<string>;

The expression used to math this rule against valid identities returned from an auth method validation.

interface AclPolicyArgs

interface AclPolicyArgs

The set of arguments for constructing a AclPolicy resource.

property datacenters

datacenters?: pulumi.Input<pulumi.Input<string>[]>;

The datacenters of the policy.

property description

description?: pulumi.Input<string>;

The description of the policy.

property name

name?: pulumi.Input<string>;

The name of the policy.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the policy within.

property rules

rules: pulumi.Input<string>;

The rules of the policy.

interface AclPolicyState

interface AclPolicyState

Input properties used for looking up and filtering AclPolicy resources.

property datacenters

datacenters?: pulumi.Input<pulumi.Input<string>[]>;

The datacenters of the policy.

property description

description?: pulumi.Input<string>;

The description of the policy.

property name

name?: pulumi.Input<string>;

The name of the policy.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the policy within.

property rules

rules?: pulumi.Input<string>;

The rules of the policy.

interface AclRoleArgs

interface AclRoleArgs

The set of arguments for constructing a AclRole resource.

property description

description?: pulumi.Input<string>;

A free form human readable description of the role.

property name

name?: pulumi.Input<string>;

The name of the ACL role.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the role within.

property policies

policies?: pulumi.Input<pulumi.Input<string>[]>;

The list of policies that should be applied to the role.

property serviceIdentities

serviceIdentities?: pulumi.Input<pulumi.Input<AclRoleServiceIdentity>[]>;

The list of service identities that should be applied to the role.

interface AclRoleState

interface AclRoleState

Input properties used for looking up and filtering AclRole resources.

property description

description?: pulumi.Input<string>;

A free form human readable description of the role.

property name

name?: pulumi.Input<string>;

The name of the ACL role.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the role within.

property policies

policies?: pulumi.Input<pulumi.Input<string>[]>;

The list of policies that should be applied to the role.

property serviceIdentities

serviceIdentities?: pulumi.Input<pulumi.Input<AclRoleServiceIdentity>[]>;

The list of service identities that should be applied to the role.

interface AclTokenArgs

interface AclTokenArgs

The set of arguments for constructing a AclToken resource.

property accessorId

accessorId?: pulumi.Input<string>;

The uuid of the token. If omitted, Consul will generate a random uuid.

property description

description?: pulumi.Input<string>;

The description of the token.

property local

local?: pulumi.Input<boolean>;

The flag to set the token local to the current datacenter.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the token within.

property policies

policies?: pulumi.Input<pulumi.Input<string>[]>;

The list of policies attached to the token.

property roles

roles?: pulumi.Input<pulumi.Input<string>[]>;

The list of roles attached to the token.

interface AclTokenPolicyAttachmentArgs

interface AclTokenPolicyAttachmentArgs

The set of arguments for constructing a AclTokenPolicyAttachment resource.

property policy

policy: pulumi.Input<string>;

The name of the policy attached to the token.

property tokenId

tokenId: pulumi.Input<string>;

The id of the token.

interface AclTokenPolicyAttachmentState

interface AclTokenPolicyAttachmentState

Input properties used for looking up and filtering AclTokenPolicyAttachment resources.

property policy

policy?: pulumi.Input<string>;

The name of the policy attached to the token.

property tokenId

tokenId?: pulumi.Input<string>;

The id of the token.

interface AclTokenState

interface AclTokenState

Input properties used for looking up and filtering AclToken resources.

property accessorId

accessorId?: pulumi.Input<string>;

The uuid of the token. If omitted, Consul will generate a random uuid.

property description

description?: pulumi.Input<string>;

The description of the token.

property local

local?: pulumi.Input<boolean>;

The flag to set the token local to the current datacenter.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the token within.

property policies

policies?: pulumi.Input<pulumi.Input<string>[]>;

The list of policies attached to the token.

property roles

roles?: pulumi.Input<pulumi.Input<string>[]>;

The list of roles attached to the token.

interface AgentServiceArgs

interface AgentServiceArgs

The set of arguments for constructing a AgentService resource.

property address

address?: pulumi.Input<string>;

The address of the service. Defaults to the address of the agent.

property name

name?: pulumi.Input<string>;

The name of the service.

property port

port?: pulumi.Input<number>;

The port of the service.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

interface AgentServiceState

interface AgentServiceState

Input properties used for looking up and filtering AgentService resources.

property address

address?: pulumi.Input<string>;

The address of the service. Defaults to the address of the agent.

property name

name?: pulumi.Input<string>;

The name of the service.

property port

port?: pulumi.Input<number>;

The port of the service.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

interface AutopilotConfigArgs

interface AutopilotConfigArgs

The set of arguments for constructing a AutopilotConfig resource.

property cleanupDeadServers

cleanupDeadServers?: pulumi.Input<boolean>;

Whether to remove failing servers when a replacement comes online. Defaults to true.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property disableUpgradeMigration

disableUpgradeMigration?: pulumi.Input<boolean>;

Whether to disable upgrade migrations. Defaults to false.

property lastContactThreshold

lastContactThreshold?: pulumi.Input<string>;

The time after which a server is considered as unhealthy and will be removed. Defaults to "200ms".

property maxTrailingLogs

maxTrailingLogs?: pulumi.Input<number>;

The maximum number of Raft log entries a server can trail the leader. Defaults to 250.

property redundancyZoneTag

redundancyZoneTag?: pulumi.Input<string>;

The redundancy zone tag to use. Consul will try to keep one voting server by zone to take advantage of isolated failure domains. Defaults to an empty string.

property serverStabilizationTime

serverStabilizationTime?: pulumi.Input<string>;

The period to wait for a server to be healthy and stable before being promoted to a full, voting member. Defaults to "10s".

property upgradeVersionTag

upgradeVersionTag?: pulumi.Input<string>;

The tag to override the version information used during a migration. Defaults to an empty string.

interface AutopilotConfigState

interface AutopilotConfigState

Input properties used for looking up and filtering AutopilotConfig resources.

property cleanupDeadServers

cleanupDeadServers?: pulumi.Input<boolean>;

Whether to remove failing servers when a replacement comes online. Defaults to true.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property disableUpgradeMigration

disableUpgradeMigration?: pulumi.Input<boolean>;

Whether to disable upgrade migrations. Defaults to false.

property lastContactThreshold

lastContactThreshold?: pulumi.Input<string>;

The time after which a server is considered as unhealthy and will be removed. Defaults to "200ms".

property maxTrailingLogs

maxTrailingLogs?: pulumi.Input<number>;

The maximum number of Raft log entries a server can trail the leader. Defaults to 250.

property redundancyZoneTag

redundancyZoneTag?: pulumi.Input<string>;

The redundancy zone tag to use. Consul will try to keep one voting server by zone to take advantage of isolated failure domains. Defaults to an empty string.

property serverStabilizationTime

serverStabilizationTime?: pulumi.Input<string>;

The period to wait for a server to be healthy and stable before being promoted to a full, voting member. Defaults to "10s".

property upgradeVersionTag

upgradeVersionTag?: pulumi.Input<string>;

The tag to override the version information used during a migration. Defaults to an empty string.

interface CatalogEntryArgs

interface CatalogEntryArgs

The set of arguments for constructing a CatalogEntry resource.

property address

address: pulumi.Input<string>;

The address of the node being added to, or referenced in the catalog.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property node

node: pulumi.Input<string>;

The name of the node being added to, or referenced in the catalog.

property services

services?: pulumi.Input<pulumi.Input<CatalogEntryService>[]>;

A service to optionally associated with the node. Supported values are documented below.

property token

token?: pulumi.Input<string>;

ACL token.

interface CatalogEntryState

interface CatalogEntryState

Input properties used for looking up and filtering CatalogEntry resources.

property address

address?: pulumi.Input<string>;

The address of the node being added to, or referenced in the catalog.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property node

node?: pulumi.Input<string>;

The name of the node being added to, or referenced in the catalog.

property services

services?: pulumi.Input<pulumi.Input<CatalogEntryService>[]>;

A service to optionally associated with the node. Supported values are documented below.

property token

token?: pulumi.Input<string>;

ACL token.

interface ConfigEntryArgs

interface ConfigEntryArgs

The set of arguments for constructing a ConfigEntry resource.

property configJson

configJson?: pulumi.Input<string>;

An arbitrary map of configuration values.

property kind

kind: pulumi.Input<string>;

The kind of configuration entry to register.

property name

name?: pulumi.Input<string>;

The name of the configuration entry being registred.

interface ConfigEntryState

interface ConfigEntryState

Input properties used for looking up and filtering ConfigEntry resources.

property configJson

configJson?: pulumi.Input<string>;

An arbitrary map of configuration values.

property kind

kind?: pulumi.Input<string>;

The kind of configuration entry to register.

property name

name?: pulumi.Input<string>;

The name of the configuration entry being registred.

interface GetAclAuthMethodArgs

interface GetAclAuthMethodArgs

A collection of arguments for invoking getAclAuthMethod.

property config

config?: undefined | {[key: string]: string};

The configuration options of the ACL Auth Method.

property description

description?: undefined | string;

The description of the ACL Auth Method.

property name

name: string;

The name of the ACL Auth Method.

property namespace

namespace?: undefined | string;

The namespace to lookup the auth method.

property type

type?: undefined | string;

The type of the ACL Auth Method.

interface GetAclAuthMethodResult

interface GetAclAuthMethodResult

A collection of values returned by getAclAuthMethod.

property config

config?: undefined | {[key: string]: string};

The configuration options of the ACL Auth Method.

property description

description?: undefined | string;

The description of the ACL Auth Method.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property namespace

namespace?: undefined | string;

property type

type?: undefined | string;

The type of the ACL Auth Method.

interface GetAclPolicyArgs

interface GetAclPolicyArgs

A collection of arguments for invoking getAclPolicy.

property datacenters

datacenters?: string[];

The datacenters associated with the ACL Policy.

property description

description?: undefined | string;

The description of the ACL Policy.

property name

name: string;

The name of the ACL Policy.

property namespace

namespace?: undefined | string;

The namespace to lookup the policy.

property rules

rules?: undefined | string;

The rules associated with the ACL Policy.

interface GetAclPolicyResult

interface GetAclPolicyResult

A collection of values returned by getAclPolicy.

property datacenters

datacenters?: string[];

The datacenters associated with the ACL Policy.

property description

description?: undefined | string;

The description of the ACL Policy.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property namespace

namespace?: undefined | string;

property rules

rules?: undefined | string;

The rules associated with the ACL Policy.

interface GetAclRoleArgs

interface GetAclRoleArgs

A collection of arguments for invoking getAclRole.

property description

description?: undefined | string;

The description of the ACL Role.

property name

name: string;

The name of the ACL Role.

property namespace

namespace?: undefined | string;

The namespace to lookup the role.

property policies

policies?: GetAclRolePolicy[];

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

property serviceIdentities

serviceIdentities?: GetAclRoleServiceIdentity[];

The list of service identities associated with the ACL Role. Each entry has a serviceName attribute and a list of datacenters.

interface GetAclRoleResult

interface GetAclRoleResult

A collection of values returned by getAclRole.

property description

description?: undefined | string;

The description of the ACL Role.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property namespace

namespace?: undefined | string;

property policies

policies?: GetAclRolePolicy[];

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

property serviceIdentities

serviceIdentities?: GetAclRoleServiceIdentity[];

The list of service identities associated with the ACL Role. Each entry has a serviceName attribute and a list of datacenters.

interface GetAclTokenArgs

interface GetAclTokenArgs

A collection of arguments for invoking getAclToken.

property accessorId

accessorId: string;

The accessor ID of the ACL token.

property description

description?: undefined | string;

The description of the ACL token.

property local

local?: undefined | false | true;

Whether the ACL token is local to the datacenter it was created within.

property namespace

namespace?: undefined | string;

The namespace to lookup the ACL token.

property policies

policies?: GetAclTokenPolicy[];

A list of policies associated with the ACL token. Each entry has an id and a name attribute.

interface GetAclTokenResult

interface GetAclTokenResult

A collection of values returned by getAclToken.

property accessorId

accessorId: string;

property description

description?: undefined | string;

The description of the ACL token.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property local

local?: undefined | false | true;

Whether the ACL token is local to the datacenter it was created within.

property namespace

namespace?: undefined | string;

property policies

policies?: GetAclTokenPolicy[];

A list of policies associated with the ACL token. Each entry has an id and a name attribute.

interface GetAclTokenSecretIdArgs

interface GetAclTokenSecretIdArgs

A collection of arguments for invoking getAclTokenSecretId.

property accessorId

accessorId: string;

The accessor ID of the ACL token.

property pgpKey

pgpKey?: undefined | string;

interface GetAclTokenSecretIdResult

interface GetAclTokenSecretIdResult

A collection of values returned by getAclTokenSecretId.

property accessorId

accessorId: string;

property encryptedSecretId

encryptedSecretId: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property pgpKey

pgpKey?: undefined | string;

property secretId

secretId: string;

The secret ID of the ACL token if pgpKey has not been set.

interface GetAgentConfigResult

interface GetAgentConfigResult

A collection of values returned by getAgentConfig.

property datacenter

datacenter: string;

The datacenter the agent is running in

property id

id: string;

The provider-assigned unique ID for this managed resource.

property nodeId

nodeId: string;

The ID of the node the agent is running on

property nodeName

nodeName: string;

The name of the node the agent is running on

property revision

revision: string;

The first 9 characters of the VCS revision of the build of Consul that is running

property server

server: boolean;

Boolean if the agent is a server or not

property version

version: string;

The version of the build of Consul that is running

interface GetAgentSelfResult

interface GetAgentSelfResult

A collection of values returned by getAgentSelf.

property aclDatacenter

aclDatacenter: string;

property aclDefaultPolicy

aclDefaultPolicy: string;

property aclDisabledTtl

aclDisabledTtl: string;

property aclDownPolicy

aclDownPolicy: string;

property aclEnforce08Semantics

aclEnforce08Semantics: boolean;

property aclTtl

aclTtl: string;

property addresses

addresses: {[key: string]: string};

property advertiseAddr

advertiseAddr: string;

property advertiseAddrWan

advertiseAddrWan: string;

property advertiseAddrs

advertiseAddrs: {[key: string]: string};

property atlasJoin

atlasJoin: boolean;

property bindAddr

bindAddr: string;

property bootstrapExpect

bootstrapExpect: number;

property bootstrapMode

bootstrapMode: boolean;

property checkDeregisterIntervalMin

checkDeregisterIntervalMin: string;

property checkReapInterval

checkReapInterval: string;

property checkUpdateInterval

checkUpdateInterval: string;

property clientAddr

clientAddr: string;

property dataDir

dataDir: string;

property datacenter

datacenter: string;

property devMode

devMode: boolean;

property dns

dns: {[key: string]: string};

A map of DNS configuration attributes. See below for details on the contents of the dns attribute. * dnsRecursors - A list of all DNS recursors. * dataDir * datacenter * devMode * domain * enableAnonymousSignature * enableCoordinates * enableDebug * enableRemoteExec * enableSyslog * enableUi * enableUpdateCheck * id * leaveOnInt * leaveOnTerm * logLevel * name * performance * pidFile * ports * protocolVersion * reconnectTimeoutLan * reconnectTimeoutWan * rejoinAfterLeave * retryJoin * retryJoinEc2 - A map of EC2 retry attributes. See below for details on the available information. * retryJoinGce - A map of GCE retry attributes. See below for details on the available information. * retryJoinWan * retryMaxAttempts * retryMaxAttemptsWan * serfLanBindAddr * serfWanBindAddr * serverMode * serverName * sessionTtlMin * startJoin * startJoinWan * syslogFacility * tlsCaFile * tlsCertFile * tlsKeyFile * tlsMinVersion * tlsVerifyIncoming * tlsVerifyOutgoing * tlsVerifyServerHostname * taggedAddresses * telemetry - A map of telemetry configuration. * translateWanAddrs * uiDir * unixSockets

property dnsRecursors

dnsRecursors: string[];

property domain

domain: string;

property enableAnonymousSignature

enableAnonymousSignature: boolean;

property enableCoordinates

enableCoordinates: boolean;

property enableDebug

enableDebug: boolean;

property enableRemoteExec

enableRemoteExec: boolean;

property enableSyslog

enableSyslog: boolean;

property enableUi

enableUi: boolean;

property enableUpdateCheck

enableUpdateCheck: boolean;

property id

id: string;

property leaveOnInt

leaveOnInt: boolean;

property leaveOnTerm

leaveOnTerm: boolean;

property logLevel

logLevel: string;

property name

name: string;

property performance

performance: {[key: string]: string};

property pidFile

pidFile: string;

property ports

ports: {[key: string]: number};

property protocolVersion

protocolVersion: number;

property reconnectTimeoutLan

reconnectTimeoutLan: string;

property reconnectTimeoutWan

reconnectTimeoutWan: string;

property rejoinAfterLeave

rejoinAfterLeave: boolean;

property retryJoinEc2

retryJoinEc2: {[key: string]: string};

property retryJoinGce

retryJoinGce: {[key: string]: string};

property retryJoinWans

retryJoinWans: string[];

property retryJoins

retryJoins: string[];

property retryMaxAttempts

retryMaxAttempts: number;

property retryMaxAttemptsWan

retryMaxAttemptsWan: number;

property serfLanBindAddr

serfLanBindAddr: string;

property serfWanBindAddr

serfWanBindAddr: string;

property serverMode

serverMode: boolean;

property serverName

serverName: string;

property sessionTtlMin

sessionTtlMin: string;

property startJoinWans

startJoinWans: string[];

property startJoins

startJoins: string[];

property syslogFacility

syslogFacility: string;

property taggedAddresses

taggedAddresses: {[key: string]: string};

property telemetry

telemetry: {[key: string]: string};

property tlsCaFile

tlsCaFile: string;

property tlsCertFile

tlsCertFile: string;

property tlsKeyFile

tlsKeyFile: string;

property tlsMinVersion

tlsMinVersion: string;

property tlsVerifyIncoming

tlsVerifyIncoming: boolean;

property tlsVerifyOutgoing

tlsVerifyOutgoing: boolean;

property tlsVerifyServerHostname

tlsVerifyServerHostname: boolean;

property translateWanAddrs

translateWanAddrs: boolean;

property uiDir

uiDir: string;

property unixSockets

unixSockets: {[key: string]: string};

property version

version: string;

The version of the Consul agent. * versionPrerelease * versionRevision

property versionPrerelease

versionPrerelease: string;

property versionRevision

versionRevision: string;

interface GetAutopilotHealthArgs

interface GetAutopilotHealthArgs

A collection of arguments for invoking getAutopilotHealth.

property datacenter

datacenter?: undefined | string;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

interface GetAutopilotHealthResult

interface GetAutopilotHealthResult

A collection of values returned by getAutopilotHealth.

property datacenter

datacenter?: undefined | string;

property failureTolerance

failureTolerance: number;

The number of redundant healthy servers that could fail without causing an outage

property healthy

healthy: boolean;

Whether the server is healthy according to the current Autopilot configuration

property id

id: string;

The provider-assigned unique ID for this managed resource.

property servers

servers: GetAutopilotHealthServer[];

A list of server health information. See below for details on the available information.

interface GetCatalogNodesArgs

interface GetCatalogNodesArgs

A collection of arguments for invoking getCatalogNodes.

property queryOptions

queryOptions?: GetCatalogNodesQueryOption[];

interface GetCatalogNodesResult

interface GetCatalogNodesResult

A collection of values returned by getCatalogNodes.

property datacenter

datacenter: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property nodeIds

nodeIds: string[];

property nodeNames

nodeNames: string[];

property nodes

nodes: GetCatalogNodesNode[];

property queryOptions

queryOptions?: GetCatalogNodesQueryOption[];

interface GetCatalogServiceArgs

interface GetCatalogServiceArgs

A collection of arguments for invoking getCatalogService.

property datacenter

datacenter?: undefined | string;

property name

name: string;

property queryOptions

queryOptions?: GetCatalogServiceQueryOption[];

property tag

tag?: undefined | string;

interface GetCatalogServiceResult

interface GetCatalogServiceResult

A collection of values returned by getCatalogService.

property datacenter

datacenter?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property queryOptions

queryOptions?: GetCatalogServiceQueryOption[];

property services

services: GetCatalogServiceService[];

property tag

tag?: undefined | string;

interface GetCatalogServicesArgs

interface GetCatalogServicesArgs

A collection of arguments for invoking getCatalogServices.

property queryOptions

queryOptions?: GetCatalogServicesQueryOption[];

interface GetCatalogServicesResult

interface GetCatalogServicesResult

A collection of values returned by getCatalogServices.

property datacenter

datacenter: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property names

names: string[];

property queryOptions

queryOptions?: GetCatalogServicesQueryOption[];

property services

services: {[key: string]: string};

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

interface GetKeyPrefixArgs

interface GetKeyPrefixArgs

A collection of arguments for invoking getKeyPrefix.

property datacenter

datacenter?: undefined | string;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property namespace

namespace?: undefined | string;

The namespace to create the keys within.

property pathPrefix

pathPrefix: string;

Specifies the common prefix shared by all keys that will be read by this data source instance. In most cases, this will end with a slash to read a “folder” of subkeys.

property subkeyCollection

subkeyCollection?: GetKeyPrefixSubkeyCollection[];

Specifies a subkey in Consul to be read. Supported values documented below. Multiple blocks supported.

property token

token?: undefined | string;

The ACL token to use. This overrides the token that the agent provides by default.

interface GetKeyPrefixResult

interface GetKeyPrefixResult

A collection of values returned by getKeyPrefix.

property datacenter

datacenter: string;

The datacenter the keys are being read from.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property namespace

namespace?: undefined | string;

property pathPrefix

pathPrefix: string;

the common prefix shared by all keys being read. * var.<name> - For each name given, the corresponding attribute has the value of the key.

property subkeyCollection

subkeyCollection?: GetKeyPrefixSubkeyCollection[];

property subkeys

subkeys: {[key: string]: string};

A map of the subkeys and values is set if no subkey block is provided.

property token

token?: undefined | string;

property var

var: {[key: string]: string};

interface GetKeysArgs

interface GetKeysArgs

A collection of arguments for invoking getKeys.

property datacenter

datacenter?: undefined | string;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property keys

keys?: GetKeysKey[];

Specifies a key in Consul to be read. Supported values documented below. Multiple blocks supported.

property namespace

namespace?: undefined | string;

The namespace to lookup the keys.

property token

token?: undefined | string;

The ACL token to use. This overrides the token that the agent provides by default.

interface GetKeysResult

interface GetKeysResult

A collection of values returned by getKeys.

property datacenter

datacenter: string;

The datacenter the keys are being read from. * var.<name> - For each name given, the corresponding attribute has the value of the key.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property keys

keys?: GetKeysKey[];

property namespace

namespace?: undefined | string;

property token

token?: undefined | string;

property var

var: {[key: string]: string};

interface GetNetworkAreaMembersArgs

interface GetNetworkAreaMembersArgs

A collection of arguments for invoking getNetworkAreaMembers.

property datacenter

datacenter?: undefined | string;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property token

token?: undefined | string;

The ACL token to use. This overrides the token that the agent provides by default.

property uuid

uuid: string;

The UUID of the area to list.

interface GetNetworkAreaMembersResult

interface GetNetworkAreaMembersResult

A collection of values returned by getNetworkAreaMembers.

property datacenter

datacenter: string;

The node’s Consul datacenter.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property members

members: GetNetworkAreaMembersMember[];

The list of Consul servers in this network area

property token

token?: undefined | string;

property uuid

uuid: string;

The UUID of the Network Area being queried.

interface GetNetworkSegmentsArgs

interface GetNetworkSegmentsArgs

A collection of arguments for invoking getNetworkSegments.

property datacenter

datacenter?: undefined | string;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property token

token?: undefined | string;

The ACL token to use. This overrides the token that the agent provides by default.

interface GetNetworkSegmentsResult

interface GetNetworkSegmentsResult

A collection of values returned by getNetworkSegments.

property datacenter

datacenter: string;

The datacenter the segments are being read from.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property segments

segments: string[];

The list of network segments.

property token

token?: undefined | string;

interface GetNodesArgs

interface GetNodesArgs

A collection of arguments for invoking getNodes.

property queryOptions

queryOptions?: GetNodesQueryOption[];

See below.

interface GetNodesResult

interface GetNodesResult

A collection of values returned by getNodes.

property datacenter

datacenter: string;

The datacenter the keys are being read from to.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property nodeIds

nodeIds: string[];

A list of the Consul node IDs.

property nodeNames

nodeNames: string[];

A list of the Consul node names.

property nodes

nodes: GetNodesNode[];

A list of nodes and details about each Consul agent. The list of per-node attributes is detailed below.

property queryOptions

queryOptions?: GetNodesQueryOption[];

interface GetServiceArgs

interface GetServiceArgs

A collection of arguments for invoking getService.

property datacenter

datacenter?: undefined | string;

The Consul datacenter to query. Defaults to the same value found in queryOptions parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to.

property name

name: string;

The service name to select.

property queryOptions

queryOptions?: GetServiceQueryOption[];

See below.

property tag

tag?: undefined | string;

A single tag that can be used to filter the list of nodes to return based on a single matching tag..

interface GetServiceHealthArgs

interface GetServiceHealthArgs

A collection of arguments for invoking getServiceHealth.

property datacenter

datacenter?: undefined | string;

The Consul datacenter to query.

property name

name: string;

The service name to select.

property near

near?: undefined | string;

Specifies a node name to sort the node list in ascending order based on the estimated round trip time from that node.

property nodeMeta

nodeMeta?: undefined | {[key: string]: string};

Filter the results to nodes with the specified key/value pairs.

property passing

passing?: undefined | false | true;

Whether to return only nodes with all checks in the passing state. Defaults to true.

property tag

tag?: undefined | string;

A single tag that can be used to filter the list to return based on a single matching tag.

property waitFor

waitFor?: undefined | string;

interface GetServiceHealthResult

interface GetServiceHealthResult

A collection of values returned by getServiceHealth.

property datacenter

datacenter?: undefined | string;

The datacenter in which the node is running. * taggedAddresses - List of explicit LAN and WAN IP addresses for the agent.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The name of this health-check.

property near

near?: undefined | string;

The node to which the result must be sorted to.

property nodeMeta

nodeMeta?: undefined | {[key: string]: string};

The list of metadata to filter the nodes.

property passing

passing?: undefined | false | true;

Whether to return only nodes with all checks in the passing state.

property results

results: GetServiceHealthResult[];

A list of entries and details about each endpoint advertising a service. Each element in the list has three attributes: node, service and checks. The list of the attributes of each one is detailed below.

property tag

tag?: undefined | string;

The name of the tag used to filter the list.

property waitFor

waitFor?: undefined | string;

interface GetServiceResult

interface GetServiceResult

A collection of values returned by getService.

property datacenter

datacenter?: undefined | string;

The datacenter the keys are being read from to.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The name of the service

property queryOptions

queryOptions?: GetServiceQueryOption[];

property services

services: GetServiceService[];

A list of nodes and details about each endpoint advertising a service. Each element in the list is a map of attributes that correspond to each individual node. The list of per-node attributes is detailed below.

property tag

tag?: undefined | string;

The name of the tag used to filter the list of nodes in service.

interface GetServicesArgs

interface GetServicesArgs

A collection of arguments for invoking getServices.

property queryOptions

queryOptions?: GetServicesQueryOption[];

See below.

interface GetServicesResult

interface GetServicesResult

A collection of values returned by getServices.

property datacenter

datacenter: string;

The datacenter the keys are being read from to.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property names

names: string[];

property queryOptions

queryOptions?: GetServicesQueryOption[];

property services

services: {[key: string]: string};

function getVersion

getVersion(): string

interface IntentionArgs

interface IntentionArgs

The set of arguments for constructing a Intention resource.

property action

action: pulumi.Input<string>;

The intention action. Must be one of allow or deny.

property description

description?: pulumi.Input<string>;

Optional description that can be used by Consul tooling, but is not used internally.

property destinationName

destinationName: pulumi.Input<string>;

The name of the destination service for the intention. This service does not have to exist.

property destinationNamespace

destinationNamespace?: pulumi.Input<string>;

The destination namespace of the intention.

property meta

meta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Key/value pairs that are opaque to Consul and are associated with the intention.

property sourceName

sourceName: pulumi.Input<string>;

The name of the source service for the intention. This service does not have to exist.

property sourceNamespace

sourceNamespace?: pulumi.Input<string>;

The source namespace of the intention.

interface IntentionState

interface IntentionState

Input properties used for looking up and filtering Intention resources.

property action

action?: pulumi.Input<string>;

The intention action. Must be one of allow or deny.

property description

description?: pulumi.Input<string>;

Optional description that can be used by Consul tooling, but is not used internally.

property destinationName

destinationName?: pulumi.Input<string>;

The name of the destination service for the intention. This service does not have to exist.

property destinationNamespace

destinationNamespace?: pulumi.Input<string>;

The destination namespace of the intention.

property meta

meta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Key/value pairs that are opaque to Consul and are associated with the intention.

property sourceName

sourceName?: pulumi.Input<string>;

The name of the source service for the intention. This service does not have to exist.

property sourceNamespace

sourceNamespace?: pulumi.Input<string>;

The source namespace of the intention.

interface KeyPrefixArgs

interface KeyPrefixArgs

The set of arguments for constructing a KeyPrefix resource.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the keys within.

property pathPrefix

pathPrefix: pulumi.Input<string>;

Specifies the common prefix shared by all keys that will be managed by this resource instance. In most cases this will end with a slash, to manage a “folder” of keys.

property subkeyCollection

subkeyCollection?: pulumi.Input<pulumi.Input<KeyPrefixSubkeyCollection>[]>;

A subkey to add. Supported values documented below. Multiple blocks supported.

property subkeys

subkeys?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping from subkey name (which will be appended to the given pathPrefix) to the value that should be stored at that key. Use slashes, as shown in the above example, to create “sub-folders” under the given path prefix.

property token

token?: pulumi.Input<string>;

The ACL token to use. This overrides the token that the agent provides by default.

interface KeyPrefixState

interface KeyPrefixState

Input properties used for looking up and filtering KeyPrefix resources.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the keys within.

property pathPrefix

pathPrefix?: pulumi.Input<string>;

Specifies the common prefix shared by all keys that will be managed by this resource instance. In most cases this will end with a slash, to manage a “folder” of keys.

property subkeyCollection

subkeyCollection?: pulumi.Input<pulumi.Input<KeyPrefixSubkeyCollection>[]>;

A subkey to add. Supported values documented below. Multiple blocks supported.

property subkeys

subkeys?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping from subkey name (which will be appended to the given pathPrefix) to the value that should be stored at that key. Use slashes, as shown in the above example, to create “sub-folders” under the given path prefix.

property token

token?: pulumi.Input<string>;

The ACL token to use. This overrides the token that the agent provides by default.

interface KeysArgs

interface KeysArgs

The set of arguments for constructing a Keys resource.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property keys

keys?: pulumi.Input<pulumi.Input<KeysKey>[]>;

Specifies a key in Consul to be written. Supported values documented below.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the keys within.

property token

token?: pulumi.Input<string>;

The ACL token to use. This overrides the token that the agent provides by default.

interface KeysState

interface KeysState

Input properties used for looking up and filtering Keys resources.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property keys

keys?: pulumi.Input<pulumi.Input<KeysKey>[]>;

Specifies a key in Consul to be written. Supported values documented below.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the keys within.

property token

token?: pulumi.Input<string>;

The ACL token to use. This overrides the token that the agent provides by default.

property var

var?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

interface LicenseArgs

interface LicenseArgs

The set of arguments for constructing a License resource.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property license

license: pulumi.Input<string>;

The Consul license to use.

interface LicenseState

interface LicenseState

Input properties used for looking up and filtering License resources.

property customerId

customerId?: pulumi.Input<string>;

The ID of the customer the license is attached to.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property expirationTime

expirationTime?: pulumi.Input<string>;

The expiration time of the license.

property features

features?: pulumi.Input<pulumi.Input<string>[]>;

The features for which the license is valid.

property flags

flags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

The metadata attached to the license.

property installationId

installationId?: pulumi.Input<string>;

The ID of the current installation.

property issueTime

issueTime?: pulumi.Input<string>;

The date the license was issued.

property license

license?: pulumi.Input<string>;

The Consul license to use.

property licenseId

licenseId?: pulumi.Input<string>;

The ID of the license used.

property product

product?: pulumi.Input<string>;

The product for which the license is valid.

property startTime

startTime?: pulumi.Input<string>;

The start time of the license.

property valid

valid?: pulumi.Input<boolean>;

Whether the license is valid.

property warnings

warnings?: pulumi.Input<pulumi.Input<string>[]>;

A list of warning messages regarding the license validity.

interface NamespaceArgs

interface NamespaceArgs

The set of arguments for constructing a Namespace resource.

property description

description?: pulumi.Input<string>;

Free form namespace description.

property meta

meta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Specifies arbitrary KV metadata to associate with the namespace.

property name

name?: pulumi.Input<string>;

The namespace name.

property policyDefaults

policyDefaults?: pulumi.Input<pulumi.Input<string>[]>;

The list of default policies that should be applied to all tokens created in this namespace.

property roleDefaults

roleDefaults?: pulumi.Input<pulumi.Input<string>[]>;

The list of default roles that should be applied to all tokens created in this namespace.

interface NamespaceState

interface NamespaceState

Input properties used for looking up and filtering Namespace resources.

property description

description?: pulumi.Input<string>;

Free form namespace description.

property meta

meta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Specifies arbitrary KV metadata to associate with the namespace.

property name

name?: pulumi.Input<string>;

The namespace name.

property policyDefaults

policyDefaults?: pulumi.Input<pulumi.Input<string>[]>;

The list of default policies that should be applied to all tokens created in this namespace.

property roleDefaults

roleDefaults?: pulumi.Input<pulumi.Input<string>[]>;

The list of default roles that should be applied to all tokens created in this namespace.

interface NetworkAreaArgs

interface NetworkAreaArgs

The set of arguments for constructing a NetworkArea resource.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property peerDatacenter

peerDatacenter: pulumi.Input<string>;

The name of the Consul datacenter that will be joined to form the area.

property retryJoins

retryJoins?: pulumi.Input<pulumi.Input<string>[]>;

Specifies a list of Consul servers to attempt to join. Servers can be given as IP, IP:port, hostname, or hostname:port.

property token

token?: pulumi.Input<string>;

The ACL token to use. This overrides the token that the agent provides by default.

property useTls

useTls?: pulumi.Input<boolean>;

Specifies whether gossip over this area should be encrypted with TLS if possible. Defaults to false.

interface NetworkAreaState

interface NetworkAreaState

Input properties used for looking up and filtering NetworkArea resources.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property peerDatacenter

peerDatacenter?: pulumi.Input<string>;

The name of the Consul datacenter that will be joined to form the area.

property retryJoins

retryJoins?: pulumi.Input<pulumi.Input<string>[]>;

Specifies a list of Consul servers to attempt to join. Servers can be given as IP, IP:port, hostname, or hostname:port.

property token

token?: pulumi.Input<string>;

The ACL token to use. This overrides the token that the agent provides by default.

property useTls

useTls?: pulumi.Input<boolean>;

Specifies whether gossip over this area should be encrypted with TLS if possible. Defaults to false.

interface NodeArgs

interface NodeArgs

The set of arguments for constructing a Node resource.

property address

address: pulumi.Input<string>;

The address of the node being added to, or referenced in the catalog.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property meta

meta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Key/value pairs that are associated with the node.

property name

name?: pulumi.Input<string>;

The name of the node being added to, or referenced in the catalog.

property token

token?: pulumi.Input<string>;

interface NodeState

interface NodeState

Input properties used for looking up and filtering Node resources.

property address

address?: pulumi.Input<string>;

The address of the node being added to, or referenced in the catalog.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property meta

meta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Key/value pairs that are associated with the node.

property name

name?: pulumi.Input<string>;

The name of the node being added to, or referenced in the catalog.

property token

token?: pulumi.Input<string>;

interface PreparedQueryArgs

interface PreparedQueryArgs

The set of arguments for constructing a PreparedQuery resource.

property connect

connect?: pulumi.Input<boolean>;

When true the prepared query will return connect proxy services for a queried service. Conditions such as tags in the prepared query will be matched against the proxy service. Defaults to false.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property dns

dns?: pulumi.Input<PreparedQueryDns>;

Settings for controlling the DNS response details.

property failover

failover?: pulumi.Input<PreparedQueryFailover>;

Options for controlling behavior when no healthy nodes are available in the local DC.

property ignoreCheckIds

ignoreCheckIds?: pulumi.Input<pulumi.Input<string>[]>;

Specifies a list of check IDs that should be ignored when filtering unhealthy instances. This is mostly useful in an emergency or as a temporary measure when a health check is found to be unreliable. Being able to ignore it in centrally-defined queries can be simpler than de-registering the check as an interim solution until the check can be fixed.

property name

name?: pulumi.Input<string>;

The name of the prepared query. Used to identify the prepared query during requests. Can be specified as an empty string to configure the query as a catch-all.

property near

near?: pulumi.Input<string>;

Allows specifying the name of a node to sort results near using Consul’s distance sorting and network coordinates. The magic _agent value can be used to always sort nearest the node servicing the request.

property nodeMeta

nodeMeta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Specifies a list of user-defined key/value pairs that will be used for filtering the query results to nodes with the given metadata values present.

property onlyPassing

onlyPassing?: pulumi.Input<boolean>;

When true, the prepared query will only return nodes with passing health checks in the result.

property service

service: pulumi.Input<string>;

The name of the service to query.

property serviceMeta

serviceMeta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Specifies a list of user-defined key/value pairs that will be used for filtering the query results to services with the given metadata values present.

property session

session?: pulumi.Input<string>;

The name of the Consul session to tie this query’s lifetime to. This is an advanced parameter that should not be used without a complete understanding of Consul sessions and the implications of their use (it is recommended to leave this blank in nearly all cases). If this parameter is omitted the query will not expire.

property storedToken

storedToken?: pulumi.Input<string>;

The ACL token to store with the prepared query. This token will be used by default whenever the query is executed.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

The list of required and/or disallowed tags. If a tag is in this list it must be present. If the tag is preceded with a “!” then it is disallowed.

property template

template?: pulumi.Input<PreparedQueryTemplate>;

Query templating options. This is used to make a single prepared query respond to many different requests.

property token

token?: pulumi.Input<string>;

The ACL token to use when saving the prepared query. This overrides the token that the agent provides by default.

interface PreparedQueryState

interface PreparedQueryState

Input properties used for looking up and filtering PreparedQuery resources.

property connect

connect?: pulumi.Input<boolean>;

When true the prepared query will return connect proxy services for a queried service. Conditions such as tags in the prepared query will be matched against the proxy service. Defaults to false.

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property dns

dns?: pulumi.Input<PreparedQueryDns>;

Settings for controlling the DNS response details.

property failover

failover?: pulumi.Input<PreparedQueryFailover>;

Options for controlling behavior when no healthy nodes are available in the local DC.

property ignoreCheckIds

ignoreCheckIds?: pulumi.Input<pulumi.Input<string>[]>;

Specifies a list of check IDs that should be ignored when filtering unhealthy instances. This is mostly useful in an emergency or as a temporary measure when a health check is found to be unreliable. Being able to ignore it in centrally-defined queries can be simpler than de-registering the check as an interim solution until the check can be fixed.

property name

name?: pulumi.Input<string>;

The name of the prepared query. Used to identify the prepared query during requests. Can be specified as an empty string to configure the query as a catch-all.

property near

near?: pulumi.Input<string>;

Allows specifying the name of a node to sort results near using Consul’s distance sorting and network coordinates. The magic _agent value can be used to always sort nearest the node servicing the request.

property nodeMeta

nodeMeta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Specifies a list of user-defined key/value pairs that will be used for filtering the query results to nodes with the given metadata values present.

property onlyPassing

onlyPassing?: pulumi.Input<boolean>;

When true, the prepared query will only return nodes with passing health checks in the result.

property service

service?: pulumi.Input<string>;

The name of the service to query.

property serviceMeta

serviceMeta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Specifies a list of user-defined key/value pairs that will be used for filtering the query results to services with the given metadata values present.

property session

session?: pulumi.Input<string>;

The name of the Consul session to tie this query’s lifetime to. This is an advanced parameter that should not be used without a complete understanding of Consul sessions and the implications of their use (it is recommended to leave this blank in nearly all cases). If this parameter is omitted the query will not expire.

property storedToken

storedToken?: pulumi.Input<string>;

The ACL token to store with the prepared query. This token will be used by default whenever the query is executed.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

The list of required and/or disallowed tags. If a tag is in this list it must be present. If the tag is preceded with a “!” then it is disallowed.

property template

template?: pulumi.Input<PreparedQueryTemplate>;

Query templating options. This is used to make a single prepared query respond to many different requests.

property token

token?: pulumi.Input<string>;

The ACL token to use when saving the prepared query. This overrides the token that the agent provides by default.

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property address

address?: pulumi.Input<string>;

property caFile

caFile?: pulumi.Input<string>;

property caPath

caPath?: pulumi.Input<string>;

property certFile

certFile?: pulumi.Input<string>;

property datacenter

datacenter?: pulumi.Input<string>;

property httpAuth

httpAuth?: pulumi.Input<string>;

property insecureHttps

insecureHttps?: pulumi.Input<boolean>;

property keyFile

keyFile?: pulumi.Input<string>;

property namespace

namespace?: pulumi.Input<string>;

property scheme

scheme?: pulumi.Input<string>;

property token

token?: pulumi.Input<string>;

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property address

address?: pulumi.Input<string>;

The address of the service. Defaults to the address of the node.

property checks

checks?: pulumi.Input<pulumi.Input<ServiceCheck>[]>;

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property external

external?: pulumi.Input<boolean>;

property meta

meta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A map of arbitrary KV metadata linked to the service instance.

property name

name?: pulumi.Input<string>;

The name of the health-check.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the service within.

property node

node: pulumi.Input<string>;

The name of the node the to register the service on.

property port

port?: pulumi.Input<number>;

The port of the service.

property serviceId

serviceId?: pulumi.Input<string>;
  • If the service ID is not provided, it will be defaulted to the value of the name attribute.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property address

address?: pulumi.Input<string>;

The address of the service. Defaults to the address of the node.

property checks

checks?: pulumi.Input<pulumi.Input<ServiceCheck>[]>;

property datacenter

datacenter?: pulumi.Input<string>;

The datacenter to use. This overrides the agent’s default datacenter and the datacenter in the provider setup.

property external

external?: pulumi.Input<boolean>;

property meta

meta?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A map of arbitrary KV metadata linked to the service instance.

property name

name?: pulumi.Input<string>;

The name of the health-check.

property namespace

namespace?: pulumi.Input<string>;

The namespace to create the service within.

property node

node?: pulumi.Input<string>;

The name of the node the to register the service on.

property port

port?: pulumi.Input<number>;

The port of the service.

property serviceId

serviceId?: pulumi.Input<string>;
  • If the service ID is not provided, it will be defaulted to the value of the name attribute.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.