Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Konnect Provider
  4. API Docs
  5. AiGatewayConsumerGroup
Viewing docs for konnect 3.23.0
published on Friday, Sep 18, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

konnect.AiGatewayConsumerGroup

Viewing docs for konnect 3.23.0
published on Friday, Sep 18, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

    AIGatewayConsumerGroup Resource

    Example Usage

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

const myAigatewayconsumergroup = new konnect.AiGatewayConsumerGroup("my_aigatewayconsumergroup", {
    displayName: "Dev Users Group",
    gatewayId: "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    labels: {
        key: "value",
    },
    managedBy: {
        key: "value",
    },
    name: "dev-users",
    policies: ["..."],
});

    import pulumi
import pulumi_konnect as konnect

my_aigatewayconsumergroup = konnect.AiGatewayConsumerGroup("my_aigatewayconsumergroup",
    display_name="Dev Users Group",
    gateway_id="5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    labels={
        "key": "value",
    },
    managed_by={
        "key": "value",
    },
    name="dev-users",
    policies=["..."])

    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.NewAiGatewayConsumerGroup(ctx, "my_aigatewayconsumergroup", &konnect.AiGatewayConsumerGroupArgs{
			DisplayName: pulumi.String("Dev Users Group"),
			GatewayId:   pulumi.String("5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			ManagedBy: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			Name: pulumi.String("dev-users"),
			Policies: pulumi.StringArray{
				pulumi.String("..."),
			},
		})
		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 myAigatewayconsumergroup = new Konnect.AiGatewayConsumerGroup("my_aigatewayconsumergroup", new()
    {
        DisplayName = "Dev Users Group",
        GatewayId = "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
        Labels = 
        {
            { "key", "value" },
        },
        ManagedBy = 
        {
            { "key", "value" },
        },
        Name = "dev-users",
        Policies = new[]
        {
            "...",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.AiGatewayConsumerGroup;
import com.pulumi.konnect.AiGatewayConsumerGroupArgs;
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 myAigatewayconsumergroup = new AiGatewayConsumerGroup("myAigatewayconsumergroup", AiGatewayConsumerGroupArgs.builder()
            .displayName("Dev Users Group")
            .gatewayId("5f9fd312-a987-4628-b4c5-bb4f4fddd5f7")
            .labels(Map.of("key", "value"))
            .managedBy(Map.of("key", "value"))
            .name("dev-users")
            .policies("...")
            .build());

    }
}

    resources:
  myAigatewayconsumergroup:
    type: konnect:AiGatewayConsumerGroup
    name: my_aigatewayconsumergroup
    properties:
      displayName: Dev Users Group
      gatewayId: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      labels:
        key: value
      managedBy:
        key: value
      name: dev-users
      policies:
        - '...'

    Example coming soon!

    Create AiGatewayConsumerGroup Resource

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

    Constructor syntax

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

@overload
def AiGatewayConsumerGroup(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           display_name: Optional[str] = None,
                           gateway_id: Optional[str] = None,
                           labels: Optional[Mapping[str, str]] = None,
                           managed_by: Optional[Mapping[str, str]] = None,
                           name: Optional[str] = None,
                           policies: Optional[Sequence[str]] = None)
    func NewAiGatewayConsumerGroup(ctx *Context, name string, args AiGatewayConsumerGroupArgs, opts ...ResourceOption) (*AiGatewayConsumerGroup, error)
    public AiGatewayConsumerGroup(string name, AiGatewayConsumerGroupArgs args, CustomResourceOptions? opts = null)
    public AiGatewayConsumerGroup(String name, AiGatewayConsumerGroupArgs args)
public AiGatewayConsumerGroup(String name, AiGatewayConsumerGroupArgs args, CustomResourceOptions options)

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


    resource "konnect_ai_gateway_consumer_group" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AiGatewayConsumerGroupArgs
    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 AiGatewayConsumerGroupArgs
    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 AiGatewayConsumerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AiGatewayConsumerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AiGatewayConsumerGroupArgs
    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 aiGatewayConsumerGroupResource = new Konnect.AiGatewayConsumerGroup("aiGatewayConsumerGroupResource", new()
{
    DisplayName = "string",
    GatewayId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    ManagedBy = 
    {
        { "string", "string" },
    },
    Name = "string",
    Policies = new[]
    {
        "string",
    },
});

    example, err := konnect.NewAiGatewayConsumerGroup(ctx, "aiGatewayConsumerGroupResource", &konnect.AiGatewayConsumerGroupArgs{
	DisplayName: pulumi.String("string"),
	GatewayId:   pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ManagedBy: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Policies: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "konnect_ai_gateway_consumer_group" "aiGatewayConsumerGroupResource" {
  lifecycle {
    create_before_destroy = true
  }
  display_name = "string"
  gateway_id   = "string"
  labels = {
    "string" = "string"
  }
  managed_by = {
    "string" = "string"
  }
  name     = "string"
  policies = ["string"]
}

    var aiGatewayConsumerGroupResource = new AiGatewayConsumerGroup("aiGatewayConsumerGroupResource", AiGatewayConsumerGroupArgs.builder()
    .displayName("string")
    .gatewayId("string")
    .labels(Map.of("string", "string"))
    .managedBy(Map.of("string", "string"))
    .name("string")
    .policies("string")
    .build());

    ai_gateway_consumer_group_resource = konnect.AiGatewayConsumerGroup("aiGatewayConsumerGroupResource",
    display_name="string",
    gateway_id="string",
    labels={
        "string": "string",
    },
    managed_by={
        "string": "string",
    },
    name="string",
    policies=["string"])

    const aiGatewayConsumerGroupResource = new konnect.AiGatewayConsumerGroup("aiGatewayConsumerGroupResource", {
    displayName: "string",
    gatewayId: "string",
    labels: {
        string: "string",
    },
    managedBy: {
        string: "string",
    },
    name: "string",
    policies: ["string"],
});

    type: konnect:AiGatewayConsumerGroup
properties:
    displayName: string
    gatewayId: string
    labels:
        string: string
    managedBy:
        string: string
    name: string
    policies:
        - string

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

    DisplayName string
    The display name for this consumer group instance.
    GatewayId string
    The unique ID of the AI Gateway.
    Labels Dictionary<string, string>
    Public labels store information about an entity that can be used for filtering a list of objects.
    ManagedBy Dictionary<string, string>
    Name string
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    Policies List<string>
    List of policy references.
    DisplayName string
    The display name for this consumer group instance.
    GatewayId string
    The unique ID of the AI Gateway.
    Labels map[string]string
    Public labels store information about an entity that can be used for filtering a list of objects.
    ManagedBy map[string]string
    Name string
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    Policies []string
    List of policy references.
    display_name string
    The display name for this consumer group instance.
    gateway_id string
    The unique ID of the AI Gateway.
    labels map(string)
    Public labels store information about an entity that can be used for filtering a list of objects.
    managed_by map(string)
    name string
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies list(string)
    List of policy references.
    displayName String
    The display name for this consumer group instance.
    gatewayId String
    The unique ID of the AI Gateway.
    labels Map<String,String>
    Public labels store information about an entity that can be used for filtering a list of objects.
    managedBy Map<String,String>
    name String
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies List<String>
    List of policy references.
    displayName string
    The display name for this consumer group instance.
    gatewayId string
    The unique ID of the AI Gateway.
    labels {[key: string]: string}
    Public labels store information about an entity that can be used for filtering a list of objects.
    managedBy {[key: string]: string}
    name string
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies string[]
    List of policy references.
    display_name str
    The display name for this consumer group instance.
    gateway_id str
    The unique ID of the AI Gateway.
    labels Mapping[str, str]
    Public labels store information about an entity that can be used for filtering a list of objects.
    managed_by Mapping[str, str]
    name str
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies Sequence[str]
    List of policy references.
    displayName String
    The display name for this consumer group instance.
    gatewayId String
    The unique ID of the AI Gateway.
    labels Map<String>
    Public labels store information about an entity that can be used for filtering a list of objects.
    managedBy Map<String>
    name String
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies List<String>
    List of policy references.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AiGatewayConsumerGroup 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.
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    updated_at 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 AiGatewayConsumerGroup Resource

    Get an existing AiGatewayConsumerGroup 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?: AiGatewayConsumerGroupState, opts?: CustomResourceOptions): AiGatewayConsumerGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        display_name: Optional[str] = None,
        gateway_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        managed_by: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        policies: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None) -> AiGatewayConsumerGroup
    func GetAiGatewayConsumerGroup(ctx *Context, name string, id IDInput, state *AiGatewayConsumerGroupState, opts ...ResourceOption) (*AiGatewayConsumerGroup, error)
    public static AiGatewayConsumerGroup Get(string name, Input<string> id, AiGatewayConsumerGroupState? state, CustomResourceOptions? opts = null)
    public static AiGatewayConsumerGroup get(String name, Output<String> id, AiGatewayConsumerGroupState state, CustomResourceOptions options)
    resources:  _:    type: konnect:AiGatewayConsumerGroup    get:      id: ${id}
    import {
  to = konnect_ai_gateway_consumer_group.example
  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.
    DisplayName string
    The display name for this consumer group instance.
    GatewayId string
    The unique ID of the AI Gateway.
    Labels Dictionary<string, string>
    Public labels store information about an entity that can be used for filtering a list of objects.
    ManagedBy Dictionary<string, string>
    Name string
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    Policies List<string>
    List of policy references.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    DisplayName string
    The display name for this consumer group instance.
    GatewayId string
    The unique ID of the AI Gateway.
    Labels map[string]string
    Public labels store information about an entity that can be used for filtering a list of objects.
    ManagedBy map[string]string
    Name string
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    Policies []string
    List of policy references.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    display_name string
    The display name for this consumer group instance.
    gateway_id string
    The unique ID of the AI Gateway.
    labels map(string)
    Public labels store information about an entity that can be used for filtering a list of objects.
    managed_by map(string)
    name string
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies list(string)
    List of policy references.
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    displayName String
    The display name for this consumer group instance.
    gatewayId String
    The unique ID of the AI Gateway.
    labels Map<String,String>
    Public labels store information about an entity that can be used for filtering a list of objects.
    managedBy Map<String,String>
    name String
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies List<String>
    List of policy references.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    displayName string
    The display name for this consumer group instance.
    gatewayId string
    The unique ID of the AI Gateway.
    labels {[key: string]: string}
    Public labels store information about an entity that can be used for filtering a list of objects.
    managedBy {[key: string]: string}
    name string
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies string[]
    List of policy references.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    display_name str
    The display name for this consumer group instance.
    gateway_id str
    The unique ID of the AI Gateway.
    labels Mapping[str, str]
    Public labels store information about an entity that can be used for filtering a list of objects.
    managed_by Mapping[str, str]
    name str
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies Sequence[str]
    List of policy references.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    displayName String
    The display name for this consumer group instance.
    gatewayId String
    The unique ID of the AI Gateway.
    labels Map<String>
    Public labels store information about an entity that can be used for filtering a list of objects.
    managedBy Map<String>
    name String
    A user-defined unique identifier for this consumer group, used as a stable human-readable reference. This value is immutable after creation.
    policies List<String>
    List of policy references.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = konnect_ai_gateway_consumer_group.my_konnect_ai_gateway_consumer_group

    id = jsonencode({

    gateway_id = "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"

id         = "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/aiGatewayConsumerGroup:AiGatewayConsumerGroup my_konnect_ai_gateway_consumer_group '{"gateway_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7", "id": "5f9fd312-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.
    Viewing docs for konnect 3.23.0
    published on Friday, Sep 18, 2026 by kong
    Schema (JSON)
    kong/terraform-provider-konnect

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial