Consul v3.12.4, Feb 12 25

Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi

consul.CatalogEntry

Explore with Pulumi AI

Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.consul.CatalogEntry;
import com.pulumi.consul.CatalogEntryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var app = new CatalogEntry("app", CatalogEntryArgs.builder()
            .address("192.168.10.10")
            .node("foobar")
            .services(CatalogEntryServiceArgs.builder()
                .address("127.0.0.1")
                .id("redis1")
                .name("redis")
                .port(8000)
                .tags(                
                    "master",
                    "v1")
                .build())
            .build());

    }
}

resources:
  app:
    type: consul:CatalogEntry
    properties:
      address: 192.168.10.10
      node: foobar
      services:
        address: 127.0.0.1
        id: redis1
        name: redis
        port: 8000
        tags:
          - master
          - v1

Create CatalogEntry Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

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

@overload
def CatalogEntry(resource_name: str,
                 args: CatalogEntryArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def CatalogEntry(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 address: Optional[str] = None,
                 node: Optional[str] = None,
                 datacenter: Optional[str] = None,
                 services: Optional[Sequence[CatalogEntryServiceArgs]] = None,
                 token: Optional[str] = None)

func NewCatalogEntry(ctx *Context, name string, args CatalogEntryArgs, opts ...ResourceOption) (*CatalogEntry, error)

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

public CatalogEntry(String name, CatalogEntryArgs args)
public CatalogEntry(String name, CatalogEntryArgs args, CustomResourceOptions options)

type: consul:CatalogEntry
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args CatalogEntryArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args CatalogEntryArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CatalogEntryArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CatalogEntryArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CatalogEntryArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var catalogEntryResource = new Consul.CatalogEntry("catalogEntryResource", new()
{
    Address = "string",
    Node = "string",
    Datacenter = "string",
    Services = new[]
    {
        new Consul.Inputs.CatalogEntryServiceArgs
        {
            Name = "string",
            Address = "string",
            Id = "string",
            Port = 0,
            Tags = new[]
            {
                "string",
            },
        },
    },
});

example, err := consul.NewCatalogEntry(ctx, "catalogEntryResource", &consul.CatalogEntryArgs{
	Address:    pulumi.String("string"),
	Node:       pulumi.String("string"),
	Datacenter: pulumi.String("string"),
	Services: consul.CatalogEntryServiceArray{
		&consul.CatalogEntryServiceArgs{
			Name:    pulumi.String("string"),
			Address: pulumi.String("string"),
			Id:      pulumi.String("string"),
			Port:    pulumi.Int(0),
			Tags: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
})

var catalogEntryResource = new CatalogEntry("catalogEntryResource", CatalogEntryArgs.builder()
    .address("string")
    .node("string")
    .datacenter("string")
    .services(CatalogEntryServiceArgs.builder()
        .name("string")
        .address("string")
        .id("string")
        .port(0)
        .tags("string")
        .build())
    .build());

catalog_entry_resource = consul.CatalogEntry("catalogEntryResource",
    address="string",
    node="string",
    datacenter="string",
    services=[{
        "name": "string",
        "address": "string",
        "id": "string",
        "port": 0,
        "tags": ["string"],
    }])

const catalogEntryResource = new consul.CatalogEntry("catalogEntryResource", {
    address: "string",
    node: "string",
    datacenter: "string",
    services: [{
        name: "string",
        address: "string",
        id: "string",
        port: 0,
        tags: ["string"],
    }],
});

type: consul:CatalogEntry
properties:
    address: string
    datacenter: string
    node: string
    services:
        - address: string
          id: string
          name: string
          port: 0
          tags:
            - string

CatalogEntry Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CatalogEntry resource accepts the following input properties:

Address string: The address of the node being added to, or referenced in the catalog.
Node string: The name of the node being added to, or referenced in the catalog.
Datacenter string: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
Services List<CatalogEntryService>: A service to optionally associated with the node. Supported values are documented below.
Token string: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

Address string: The address of the node being added to, or referenced in the catalog.
Node string: The name of the node being added to, or referenced in the catalog.
Datacenter string: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
Services []CatalogEntryServiceArgs: A service to optionally associated with the node. Supported values are documented below.
Token string: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

address String: The address of the node being added to, or referenced in the catalog.
node String: The name of the node being added to, or referenced in the catalog.
datacenter String: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
services List<CatalogEntryService>: A service to optionally associated with the node. Supported values are documented below.
token String: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

address string: The address of the node being added to, or referenced in the catalog.
node string: The name of the node being added to, or referenced in the catalog.
datacenter string: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
services CatalogEntryService[]: A service to optionally associated with the node. Supported values are documented below.
token string: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

address str: The address of the node being added to, or referenced in the catalog.
node str: The name of the node being added to, or referenced in the catalog.
datacenter str: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
services Sequence[CatalogEntryServiceArgs]: A service to optionally associated with the node. Supported values are documented below.
token str: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

address String: The address of the node being added to, or referenced in the catalog.
node String: The name of the node being added to, or referenced in the catalog.
datacenter String: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
services List<Property Map>: A service to optionally associated with the node. Supported values are documented below.
token String: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

Outputs

All input properties are implicitly available as output properties. Additionally, the CatalogEntry resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing CatalogEntry Resource

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

TypeScript
Python
Go
C#
Java
YAML

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        datacenter: Optional[str] = None,
        node: Optional[str] = None,
        services: Optional[Sequence[CatalogEntryServiceArgs]] = None,
        token: Optional[str] = None) -> CatalogEntry

func GetCatalogEntry(ctx *Context, name string, id IDInput, state *CatalogEntryState, opts ...ResourceOption) (*CatalogEntry, error)

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

public static CatalogEntry get(String name, Output<String> id, CatalogEntryState state, CustomResourceOptions options)

resources:  _:    type: consul:CatalogEntry    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Address string: The address of the node being added to, or referenced in the catalog.
Datacenter string: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
Node string: The name of the node being added to, or referenced in the catalog.
Services List<CatalogEntryService>: A service to optionally associated with the node. Supported values are documented below.
Token string: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

Address string: The address of the node being added to, or referenced in the catalog.
Datacenter string: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
Node string: The name of the node being added to, or referenced in the catalog.
Services []CatalogEntryServiceArgs: A service to optionally associated with the node. Supported values are documented below.
Token string: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

address String: The address of the node being added to, or referenced in the catalog.
datacenter String: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
node String: The name of the node being added to, or referenced in the catalog.
services List<CatalogEntryService>: A service to optionally associated with the node. Supported values are documented below.
token String: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

address string: The address of the node being added to, or referenced in the catalog.
datacenter string: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
node string: The name of the node being added to, or referenced in the catalog.
services CatalogEntryService[]: A service to optionally associated with the node. Supported values are documented below.
token string: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

address str: The address of the node being added to, or referenced in the catalog.
datacenter str: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
node str: The name of the node being added to, or referenced in the catalog.
services Sequence[CatalogEntryServiceArgs]: A service to optionally associated with the node. Supported values are documented below.
token str: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

address String: The address of the node being added to, or referenced in the catalog.
datacenter String: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
node String: The name of the node being added to, or referenced in the catalog.
services List<Property Map>: A service to optionally associated with the node. Supported values are documented below.
token String: ACL token.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

Supporting Types

CatalogEntryService
, CatalogEntryServiceArgs

Name string: The name of the service
Address string: The address of the service. Defaults to the node address.
Id string: The ID of the service. Defaults to the name.
Port int: The port of the service.
Tags List<string>: A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

Name string: The name of the service
Address string: The address of the service. Defaults to the node address.
Id string: The ID of the service. Defaults to the name.
Port int: The port of the service.
Tags []string: A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

name String: The name of the service
address String: The address of the service. Defaults to the node address.
id String: The ID of the service. Defaults to the name.
port Integer: The port of the service.
tags List<String>: A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

name string: The name of the service
address string: The address of the service. Defaults to the node address.
id string: The ID of the service. Defaults to the name.
port number: The port of the service.
tags string[]: A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

name str: The name of the service
address str: The address of the service. Defaults to the node address.
id str: The ID of the service. Defaults to the name.
port int: The port of the service.
tags Sequence[str]: A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

name String: The name of the service
address String: The address of the service. Defaults to the node address.
id String: The ID of the service. Defaults to the name.
port Number: The port of the service.
tags List<String>: A list of values that are opaque to Consul, but can be used to distinguish between services or nodes.

Package Details

Repository: HashiCorp Consul pulumi/pulumi-consul
License: Apache-2.0
Notes: This Pulumi package is based on the consul Terraform Provider.

Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi

pulumi/pulumi-consul

consul.CatalogEntry

On this page

On this page

Example Usage

Create CatalogEntry Resource

Constructor syntax

Parameters

Constructor example

CatalogEntry Resource Properties

Inputs

Outputs

Look up Existing CatalogEntry Resource

Supporting Types

CatalogEntryService
, CatalogEntryServiceArgs

Package Details

On this page

On this page

consul.CatalogEntry

On this page

On this page

Example Usage

Create CatalogEntry Resource

Constructor syntax

Parameters

Constructor example

CatalogEntry Resource Properties

Inputs

Outputs

Look up Existing CatalogEntry Resource

Supporting Types

CatalogEntryService, CatalogEntryServiceArgs

Package Details

On this page

On this page

CatalogEntryService
, CatalogEntryServiceArgs