1. Packages
  2. Konnect Provider
  3. API Docs
  4. CentralizedConsumerKey
konnect 2.12.0 published on Tuesday, Jul 22, 2025 by kong

konnect.CentralizedConsumerKey

Explore with Pulumi AI

konnect logo
konnect 2.12.0 published on Tuesday, Jul 22, 2025 by kong

    CentralizedConsumerKey Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as konnect from "@pulumi/konnect";
    
    const myCentralizedconsumerkey = new konnect.CentralizedConsumerKey("myCentralizedconsumerkey", {
        consumerId: "...my_consumer_id...",
        realmId: "75fbe6fe-cfd5-48fb-8590-5c6e31cc0859",
        secret: "...my_secret...",
        tags: ["..."],
        type: "legacy",
    });
    
    import pulumi
    import pulumi_konnect as konnect
    
    my_centralizedconsumerkey = konnect.CentralizedConsumerKey("myCentralizedconsumerkey",
        consumer_id="...my_consumer_id...",
        realm_id="75fbe6fe-cfd5-48fb-8590-5c6e31cc0859",
        secret="...my_secret...",
        tags=["..."],
        type="legacy")
    
    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.NewCentralizedConsumerKey(ctx, "myCentralizedconsumerkey", &konnect.CentralizedConsumerKeyArgs{
    			ConsumerId: pulumi.String("...my_consumer_id..."),
    			RealmId:    pulumi.String("75fbe6fe-cfd5-48fb-8590-5c6e31cc0859"),
    			Secret:     pulumi.String("...my_secret..."),
    			Tags: pulumi.StringArray{
    				pulumi.String("..."),
    			},
    			Type: pulumi.String("legacy"),
    		})
    		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 myCentralizedconsumerkey = new Konnect.CentralizedConsumerKey("myCentralizedconsumerkey", new()
        {
            ConsumerId = "...my_consumer_id...",
            RealmId = "75fbe6fe-cfd5-48fb-8590-5c6e31cc0859",
            Secret = "...my_secret...",
            Tags = new[]
            {
                "...",
            },
            Type = "legacy",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.CentralizedConsumerKey;
    import com.pulumi.konnect.CentralizedConsumerKeyArgs;
    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 myCentralizedconsumerkey = new CentralizedConsumerKey("myCentralizedconsumerkey", CentralizedConsumerKeyArgs.builder()
                .consumerId("...my_consumer_id...")
                .realmId("75fbe6fe-cfd5-48fb-8590-5c6e31cc0859")
                .secret("...my_secret...")
                .tags("...")
                .type("legacy")
                .build());
    
        }
    }
    
    resources:
      myCentralizedconsumerkey:
        type: konnect:CentralizedConsumerKey
        properties:
          consumerId: '...my_consumer_id...'
          realmId: 75fbe6fe-cfd5-48fb-8590-5c6e31cc0859
          secret: '...my_secret...'
          tags:
            - '...'
          type: legacy
    

    Create CentralizedConsumerKey Resource

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

    Constructor syntax

    new CentralizedConsumerKey(name: string, args: CentralizedConsumerKeyArgs, opts?: CustomResourceOptions);
    @overload
    def CentralizedConsumerKey(resource_name: str,
                               args: CentralizedConsumerKeyArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def CentralizedConsumerKey(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               consumer_id: Optional[str] = None,
                               realm_id: Optional[str] = None,
                               type: Optional[str] = None,
                               secret: Optional[str] = None,
                               tags: Optional[Sequence[str]] = None)
    func NewCentralizedConsumerKey(ctx *Context, name string, args CentralizedConsumerKeyArgs, opts ...ResourceOption) (*CentralizedConsumerKey, error)
    public CentralizedConsumerKey(string name, CentralizedConsumerKeyArgs args, CustomResourceOptions? opts = null)
    public CentralizedConsumerKey(String name, CentralizedConsumerKeyArgs args)
    public CentralizedConsumerKey(String name, CentralizedConsumerKeyArgs args, CustomResourceOptions options)
    
    type: konnect:CentralizedConsumerKey
    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 CentralizedConsumerKeyArgs
    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 CentralizedConsumerKeyArgs
    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 CentralizedConsumerKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CentralizedConsumerKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CentralizedConsumerKeyArgs
    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 centralizedConsumerKeyResource = new Konnect.CentralizedConsumerKey("centralizedConsumerKeyResource", new()
    {
        ConsumerId = "string",
        RealmId = "string",
        Type = "string",
        Secret = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := konnect.NewCentralizedConsumerKey(ctx, "centralizedConsumerKeyResource", &konnect.CentralizedConsumerKeyArgs{
    	ConsumerId: pulumi.String("string"),
    	RealmId:    pulumi.String("string"),
    	Type:       pulumi.String("string"),
    	Secret:     pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var centralizedConsumerKeyResource = new CentralizedConsumerKey("centralizedConsumerKeyResource", CentralizedConsumerKeyArgs.builder()
        .consumerId("string")
        .realmId("string")
        .type("string")
        .secret("string")
        .tags("string")
        .build());
    
    centralized_consumer_key_resource = konnect.CentralizedConsumerKey("centralizedConsumerKeyResource",
        consumer_id="string",
        realm_id="string",
        type="string",
        secret="string",
        tags=["string"])
    
    const centralizedConsumerKeyResource = new konnect.CentralizedConsumerKey("centralizedConsumerKeyResource", {
        consumerId: "string",
        realmId: "string",
        type: "string",
        secret: "string",
        tags: ["string"],
    });
    
    type: konnect:CentralizedConsumerKey
    properties:
        consumerId: string
        realmId: string
        secret: string
        tags:
            - string
        type: string
    

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

    ConsumerId string
    ID of the of the consumer. Requires replacement if changed.
    RealmId string
    ID of the realm. Requires replacement if changed.
    Type string
    must be one of ["new", "legacy"]; Requires replacement if changed.
    Secret string
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    Tags List<string>
    Requires replacement if changed.
    ConsumerId string
    ID of the of the consumer. Requires replacement if changed.
    RealmId string
    ID of the realm. Requires replacement if changed.
    Type string
    must be one of ["new", "legacy"]; Requires replacement if changed.
    Secret string
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    Tags []string
    Requires replacement if changed.
    consumerId String
    ID of the of the consumer. Requires replacement if changed.
    realmId String
    ID of the realm. Requires replacement if changed.
    type String
    must be one of ["new", "legacy"]; Requires replacement if changed.
    secret String
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.
    consumerId string
    ID of the of the consumer. Requires replacement if changed.
    realmId string
    ID of the realm. Requires replacement if changed.
    type string
    must be one of ["new", "legacy"]; Requires replacement if changed.
    secret string
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    tags string[]
    Requires replacement if changed.
    consumer_id str
    ID of the of the consumer. Requires replacement if changed.
    realm_id str
    ID of the realm. Requires replacement if changed.
    type str
    must be one of ["new", "legacy"]; Requires replacement if changed.
    secret str
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    tags Sequence[str]
    Requires replacement if changed.
    consumerId String
    ID of the of the consumer. Requires replacement if changed.
    realmId String
    ID of the realm. Requires replacement if changed.
    type String
    must be one of ["new", "legacy"]; Requires replacement if changed.
    secret String
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.

    Outputs

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

    Get an existing CentralizedConsumerKey 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?: CentralizedConsumerKeyState, opts?: CustomResourceOptions): CentralizedConsumerKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            consumer_id: Optional[str] = None,
            created_at: Optional[str] = None,
            realm_id: Optional[str] = None,
            secret: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            type: Optional[str] = None,
            updated_at: Optional[str] = None) -> CentralizedConsumerKey
    func GetCentralizedConsumerKey(ctx *Context, name string, id IDInput, state *CentralizedConsumerKeyState, opts ...ResourceOption) (*CentralizedConsumerKey, error)
    public static CentralizedConsumerKey Get(string name, Input<string> id, CentralizedConsumerKeyState? state, CustomResourceOptions? opts = null)
    public static CentralizedConsumerKey get(String name, Output<String> id, CentralizedConsumerKeyState state, CustomResourceOptions options)
    resources:  _:    type: konnect:CentralizedConsumerKey    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:
    ConsumerId string
    ID of the of the consumer. Requires replacement if changed.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    RealmId string
    ID of the realm. Requires replacement if changed.
    Secret string
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    Tags List<string>
    Requires replacement if changed.
    Type string
    must be one of ["new", "legacy"]; Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    ConsumerId string
    ID of the of the consumer. Requires replacement if changed.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    RealmId string
    ID of the realm. Requires replacement if changed.
    Secret string
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    Tags []string
    Requires replacement if changed.
    Type string
    must be one of ["new", "legacy"]; Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    consumerId String
    ID of the of the consumer. Requires replacement if changed.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    realmId String
    ID of the realm. Requires replacement if changed.
    secret String
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.
    type String
    must be one of ["new", "legacy"]; Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    consumerId string
    ID of the of the consumer. Requires replacement if changed.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    realmId string
    ID of the realm. Requires replacement if changed.
    secret string
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    tags string[]
    Requires replacement if changed.
    type string
    must be one of ["new", "legacy"]; Requires replacement if changed.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    consumer_id str
    ID of the of the consumer. Requires replacement if changed.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    realm_id str
    ID of the realm. Requires replacement if changed.
    secret str
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    tags Sequence[str]
    Requires replacement if changed.
    type str
    must be one of ["new", "legacy"]; Requires replacement if changed.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    consumerId String
    ID of the of the consumer. Requires replacement if changed.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    realmId String
    ID of the realm. Requires replacement if changed.
    secret String
    secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated. Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.
    type String
    must be one of ["new", "legacy"]; Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Import

    $ pulumi import konnect:index/centralizedConsumerKey:CentralizedConsumerKey my_konnect_centralized_consumer_key '{"consumer_id": "", "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