Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. CentralizedConsumer
konnect 2.12.0 published on Tuesday, Jul 22, 2025 by kong
kong/terraform-provider-konnect

konnect.CentralizedConsumer

Explore with Pulumi AI

konnect logo
konnect 2.12.0 published on Tuesday, Jul 22, 2025 by kong
kong/terraform-provider-konnect

    CentralizedConsumer Resource

    Example Usage

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

const myCentralizedconsumer = new konnect.CentralizedConsumer("myCentralizedconsumer", {
    consumerGroups: ["..."],
    customId: "...my_custom_id...",
    realmId: "44e96a35-843f-4590-b0ec-3a958e6297cb",
    tags: ["..."],
    type: "application",
    username: "...my_username...",
});

    import pulumi
import pulumi_konnect as konnect

my_centralizedconsumer = konnect.CentralizedConsumer("myCentralizedconsumer",
    consumer_groups=["..."],
    custom_id="...my_custom_id...",
    realm_id="44e96a35-843f-4590-b0ec-3a958e6297cb",
    tags=["..."],
    type="application",
    username="...my_username...")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewCentralizedConsumer(ctx, "myCentralizedconsumer", &konnect.CentralizedConsumerArgs{
			ConsumerGroups: pulumi.StringArray{
				pulumi.String("..."),
			},
			CustomId: pulumi.String("...my_custom_id..."),
			RealmId:  pulumi.String("44e96a35-843f-4590-b0ec-3a958e6297cb"),
			Tags: pulumi.StringArray{
				pulumi.String("..."),
			},
			Type:     pulumi.String("application"),
			Username: pulumi.String("...my_username..."),
		})
		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 myCentralizedconsumer = new Konnect.CentralizedConsumer("myCentralizedconsumer", new()
    {
        ConsumerGroups = new[]
        {
            "...",
        },
        CustomId = "...my_custom_id...",
        RealmId = "44e96a35-843f-4590-b0ec-3a958e6297cb",
        Tags = new[]
        {
            "...",
        },
        Type = "application",
        Username = "...my_username...",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.CentralizedConsumer;
import com.pulumi.konnect.CentralizedConsumerArgs;
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 myCentralizedconsumer = new CentralizedConsumer("myCentralizedconsumer", CentralizedConsumerArgs.builder()
            .consumerGroups("...")
            .customId("...my_custom_id...")
            .realmId("44e96a35-843f-4590-b0ec-3a958e6297cb")
            .tags("...")
            .type("application")
            .username("...my_username...")
            .build());

    }
}

    resources:
  myCentralizedconsumer:
    type: konnect:CentralizedConsumer
    properties:
      consumerGroups:
        - '...'
      customId: '...my_custom_id...'
      realmId: 44e96a35-843f-4590-b0ec-3a958e6297cb
      tags:
        - '...'
      type: application
      username: '...my_username...'

    Create CentralizedConsumer Resource

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

    Constructor syntax

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

@overload
def CentralizedConsumer(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        realm_id: Optional[str] = None,
                        username: Optional[str] = None,
                        consumer_groups: Optional[Sequence[str]] = None,
                        custom_id: Optional[str] = None,
                        tags: Optional[Sequence[str]] = None,
                        type: Optional[str] = None)
    func NewCentralizedConsumer(ctx *Context, name string, args CentralizedConsumerArgs, opts ...ResourceOption) (*CentralizedConsumer, error)
    public CentralizedConsumer(string name, CentralizedConsumerArgs args, CustomResourceOptions? opts = null)
    public CentralizedConsumer(String name, CentralizedConsumerArgs args)
public CentralizedConsumer(String name, CentralizedConsumerArgs args, CustomResourceOptions options)

    type: konnect:CentralizedConsumer
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 CentralizedConsumerArgs
    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 CentralizedConsumerArgs
    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 CentralizedConsumerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CentralizedConsumerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CentralizedConsumerArgs
    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 centralizedConsumerResource = new Konnect.CentralizedConsumer("centralizedConsumerResource", new()
{
    RealmId = "string",
    Username = "string",
    ConsumerGroups = new[]
    {
        "string",
    },
    CustomId = "string",
    Tags = new[]
    {
        "string",
    },
    Type = "string",
});

    example, err := konnect.NewCentralizedConsumer(ctx, "centralizedConsumerResource", &konnect.CentralizedConsumerArgs{
	RealmId:  pulumi.String("string"),
	Username: pulumi.String("string"),
	ConsumerGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	CustomId: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Type: pulumi.String("string"),
})

    var centralizedConsumerResource = new CentralizedConsumer("centralizedConsumerResource", CentralizedConsumerArgs.builder()
    .realmId("string")
    .username("string")
    .consumerGroups("string")
    .customId("string")
    .tags("string")
    .type("string")
    .build());

    centralized_consumer_resource = konnect.CentralizedConsumer("centralizedConsumerResource",
    realm_id="string",
    username="string",
    consumer_groups=["string"],
    custom_id="string",
    tags=["string"],
    type="string")

    const centralizedConsumerResource = new konnect.CentralizedConsumer("centralizedConsumerResource", {
    realmId: "string",
    username: "string",
    consumerGroups: ["string"],
    customId: "string",
    tags: ["string"],
    type: "string",
});

    type: konnect:CentralizedConsumer
properties:
    consumerGroups:
        - string
    customId: string
    realmId: string
    tags:
        - string
    type: string
    username: string

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

    RealmId string
    ID of the realm
    Username string
    The unique username of the Consumer.
    ConsumerGroups List<string>
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    CustomId string
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    Tags List<string>
    Type string
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    RealmId string
    ID of the realm
    Username string
    The unique username of the Consumer.
    ConsumerGroups []string
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    CustomId string
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    Tags []string
    Type string
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    realmId String
    ID of the realm
    username String
    The unique username of the Consumer.
    consumerGroups List<String>
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    customId String
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    tags List<String>
    type String
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    realmId string
    ID of the realm
    username string
    The unique username of the Consumer.
    consumerGroups string[]
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    customId string
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    tags string[]
    type string
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    realm_id str
    ID of the realm
    username str
    The unique username of the Consumer.
    consumer_groups Sequence[str]
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    custom_id str
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    tags Sequence[str]
    type str
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    realmId String
    ID of the realm
    username String
    The unique username of the Consumer.
    consumerGroups List<String>
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    customId String
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    tags List<String>
    type String
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CentralizedConsumer 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 CentralizedConsumer Resource

    Get an existing CentralizedConsumer 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?: CentralizedConsumerState, opts?: CustomResourceOptions): CentralizedConsumer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consumer_groups: Optional[Sequence[str]] = None,
        created_at: Optional[str] = None,
        custom_id: Optional[str] = None,
        realm_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        username: Optional[str] = None) -> CentralizedConsumer
    func GetCentralizedConsumer(ctx *Context, name string, id IDInput, state *CentralizedConsumerState, opts ...ResourceOption) (*CentralizedConsumer, error)
    public static CentralizedConsumer Get(string name, Input<string> id, CentralizedConsumerState? state, CustomResourceOptions? opts = null)
    public static CentralizedConsumer get(String name, Output<String> id, CentralizedConsumerState state, CustomResourceOptions options)
    resources:  _:    type: konnect:CentralizedConsumer    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:
    ConsumerGroups List<string>
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    CustomId string
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    RealmId string
    ID of the realm
    Tags List<string>
    Type string
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Username string
    The unique username of the Consumer.
    ConsumerGroups []string
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    CustomId string
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    RealmId string
    ID of the realm
    Tags []string
    Type string
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Username string
    The unique username of the Consumer.
    consumerGroups List<String>
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    customId String
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    realmId String
    ID of the realm
    tags List<String>
    type String
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    username String
    The unique username of the Consumer.
    consumerGroups string[]
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    customId string
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    realmId string
    ID of the realm
    tags string[]
    type string
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    username string
    The unique username of the Consumer.
    consumer_groups Sequence[str]
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    custom_id str
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    realm_id str
    ID of the realm
    tags Sequence[str]
    type str
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    username str
    The unique username of the Consumer.
    consumerGroups List<String>
    A list of consumer groups that the Consumer is in. If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    customId String
    Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
    realmId String
    ID of the realm
    tags List<String>
    type String
    Type of the consumer. Default: "proxy"; must be one of ["proxy", "developer", "admin", "application"]
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    username String
    The unique username of the Consumer.

    Import

    $ pulumi import konnect:index/centralizedConsumer:CentralizedConsumer my_konnect_centralized_consumer '{"id": "", "realm_id": ""}'

    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 2.12.0 published on Tuesday, Jul 22, 2025 by kong
    kong/terraform-provider-konnect