Class CatalogEntry

!> 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

using Pulumi;
using Consul = Pulumi.Consul;

class MyStack : Stack
{
public MyStack()
{
    var app = new Consul.CatalogEntry("app", new Consul.CatalogEntryArgs
    {
        Address = "192.168.10.10",
        Node = "foobar",
        Services = 
        {
            new Consul.Inputs.CatalogEntryServiceArgs
            {
                Address = "127.0.0.1",
                Id = "redis1",
                Name = "redis",
                Port = 8000,
                Tags = 
                {
                    "master",
                    "v1",
                },
            },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

CatalogEntry

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Consul

Assembly: Pulumi.Consul.dll

Syntax

public class CatalogEntry : CustomResource

Constructors

CatalogEntry(String, CatalogEntryArgs, CustomResourceOptions)

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

Declaration

public CatalogEntry(string name, CatalogEntryArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
CatalogEntryArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Address

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

Declaration

public Output<string> Address { get; }

Property Value

Type	Description
Output<System.String>

Datacenter

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

Declaration

public Output<string> Datacenter { get; }

Property Value

Type	Description
Output<System.String>

Node

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

Declaration

public Output<string> Node { get; }

Property Value

Type	Description
Output<System.String>

Services

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

Declaration

public Output<ImmutableArray<CatalogEntryService>> Services { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<CatalogEntryService>>

Token

ACL token.

Declaration

public Output<string> Token { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, CatalogEntryState, CustomResourceOptions)

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

Declaration

public static CatalogEntry Get(string name, Input<string> id, CatalogEntryState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
CatalogEntryState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
CatalogEntry