Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. CatalogService
konnect 3.0.0 published on Friday, Aug 22, 2025 by kong
kong/terraform-provider-konnect

konnect.CatalogService

Explore with Pulumi AI

konnect logo
konnect 3.0.0 published on Friday, Aug 22, 2025 by kong
kong/terraform-provider-konnect

    CatalogService Resource

    Example Usage

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

const myCatalogservice = new konnect.CatalogService("myCatalogservice", {
    customFields: "{ \"see\": \"documentation\" }",
    description: "...my_description...",
    displayName: "User Service",
    labels: {
        key: "value",
    },
});

    import pulumi
import pulumi_konnect as konnect

my_catalogservice = konnect.CatalogService("myCatalogservice",
    custom_fields="{ \"see\": \"documentation\" }",
    description="...my_description...",
    display_name="User Service",
    labels={
        "key": "value",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/konnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewCatalogService(ctx, "myCatalogservice", &konnect.CatalogServiceArgs{
			CustomFields: pulumi.String("{ \"see\": \"documentation\" }"),
			Description:  pulumi.String("...my_description..."),
			DisplayName:  pulumi.String("User Service"),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myCatalogservice = new Konnect.CatalogService("myCatalogservice", new()
    {
        CustomFields = "{ \"see\": \"documentation\" }",
        Description = "...my_description...",
        DisplayName = "User Service",
        Labels = 
        {
            { "key", "value" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.CatalogService;
import com.pulumi.konnect.CatalogServiceArgs;
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 myCatalogservice = new CatalogService("myCatalogservice", CatalogServiceArgs.builder()
            .customFields("{ \"see\": \"documentation\" }")
            .description("...my_description...")
            .displayName("User Service")
            .labels(Map.of("key", "value"))
            .build());

    }
}

    resources:
  myCatalogservice:
    type: konnect:CatalogService
    properties:
      customFields: '{ "see": "documentation" }'
      description: '...my_description...'
      displayName: User Service
      labels:
        key: value

    Create CatalogService Resource

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

    Constructor syntax

    new CatalogService(name: string, args: CatalogServiceArgs, opts?: CustomResourceOptions);
    @overload
def CatalogService(resource_name: str,
                   args: CatalogServiceArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def CatalogService(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   display_name: Optional[str] = None,
                   custom_fields: Optional[str] = None,
                   description: Optional[str] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   name: Optional[str] = None)
    func NewCatalogService(ctx *Context, name string, args CatalogServiceArgs, opts ...ResourceOption) (*CatalogService, error)
    public CatalogService(string name, CatalogServiceArgs args, CustomResourceOptions? opts = null)
    public CatalogService(String name, CatalogServiceArgs args)
public CatalogService(String name, CatalogServiceArgs args, CustomResourceOptions options)

    type: konnect:CatalogService
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 CatalogServiceArgs
    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 CatalogServiceArgs
    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 CatalogServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogServiceArgs
    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.

    var catalogServiceResource = new Konnect.CatalogService("catalogServiceResource", new()
{
    DisplayName = "string",
    CustomFields = "string",
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
});

    example, err := konnect.NewCatalogService(ctx, "catalogServiceResource", &konnect.CatalogServiceArgs{
	DisplayName:  pulumi.String("string"),
	CustomFields: pulumi.String("string"),
	Description:  pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var catalogServiceResource = new CatalogService("catalogServiceResource", CatalogServiceArgs.builder()
    .displayName("string")
    .customFields("string")
    .description("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .build());

    catalog_service_resource = konnect.CatalogService("catalogServiceResource",
    display_name="string",
    custom_fields="string",
    description="string",
    labels={
        "string": "string",
    },
    name="string")

    const catalogServiceResource = new konnect.CatalogService("catalogServiceResource", {
    displayName: "string",
    customFields: "string",
    description: "string",
    labels: {
        string: "string",
    },
    name: "string",
});

    type: konnect:CatalogService
properties:
    customFields: string
    description: string
    displayName: string
    labels:
        string: string
    name: string

    CatalogService 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 CatalogService resource accepts the following input properties:

    DisplayName string
    The display name of the Service.
    CustomFields string
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    Description string
    Optionally provide a description of the Service.
    Labels Dictionary<string, string>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    Name string
    The machine name of the Service that uniquely identifies it within the catalog.
    DisplayName string
    The display name of the Service.
    CustomFields string
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    Description string
    Optionally provide a description of the Service.
    Labels map[string]string
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    Name string
    The machine name of the Service that uniquely identifies it within the catalog.
    displayName String
    The display name of the Service.
    customFields String
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    description String
    Optionally provide a description of the Service.
    labels Map<String,String>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    name String
    The machine name of the Service that uniquely identifies it within the catalog.
    displayName string
    The display name of the Service.
    customFields string
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    description string
    Optionally provide a description of the Service.
    labels {[key: string]: string}
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    name string
    The machine name of the Service that uniquely identifies it within the catalog.
    display_name str
    The display name of the Service.
    custom_fields str
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    description str
    Optionally provide a description of the Service.
    labels Mapping[str, str]
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    name str
    The machine name of the Service that uniquely identifies it within the catalog.
    displayName String
    The display name of the Service.
    customFields String
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    description String
    Optionally provide a description of the Service.
    labels Map<String>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    name String
    The machine name of the Service that uniquely identifies it within the catalog.

    Outputs

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

    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Look up Existing CatalogService Resource

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

    public static get(name: string, id: Input<ID>, state?: CatalogServiceState, opts?: CustomResourceOptions): CatalogService
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        custom_fields: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        updated_at: Optional[str] = None) -> CatalogService
    func GetCatalogService(ctx *Context, name string, id IDInput, state *CatalogServiceState, opts ...ResourceOption) (*CatalogService, error)
    public static CatalogService Get(string name, Input<string> id, CatalogServiceState? state, CustomResourceOptions? opts = null)
    public static CatalogService get(String name, Output<String> id, CatalogServiceState state, CustomResourceOptions options)
    resources:  _:    type: konnect:CatalogService    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:
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    CustomFields string
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    Description string
    Optionally provide a description of the Service.
    DisplayName string
    The display name of the Service.
    Labels Dictionary<string, string>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    Name string
    The machine name of the Service that uniquely identifies it within the catalog.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    CustomFields string
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    Description string
    Optionally provide a description of the Service.
    DisplayName string
    The display name of the Service.
    Labels map[string]string
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    Name string
    The machine name of the Service that uniquely identifies it within the catalog.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    customFields String
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    description String
    Optionally provide a description of the Service.
    displayName String
    The display name of the Service.
    labels Map<String,String>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    name String
    The machine name of the Service that uniquely identifies it within the catalog.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    customFields string
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    description string
    Optionally provide a description of the Service.
    displayName string
    The display name of the Service.
    labels {[key: string]: string}
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    name string
    The machine name of the Service that uniquely identifies it within the catalog.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    custom_fields str
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    description str
    Optionally provide a description of the Service.
    display_name str
    The display name of the Service.
    labels Mapping[str, str]
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    name str
    The machine name of the Service that uniquely identifies it within the catalog.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    customFields String
    Map of customizable, catalog-defined fields providing information about a service. Parsed as JSON.
    description String
    Optionally provide a description of the Service.
    displayName String
    The display name of the Service.
    labels Map<String>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    name String
    The machine name of the Service that uniquely identifies it within the catalog.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Import

    $ pulumi import konnect:index/catalogService:CatalogService my_konnect_catalog_service "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 3.0.0 published on Friday, Aug 22, 2025 by kong
    kong/terraform-provider-konnect