Viewing docs for konnect 3.23.0
published on Friday, Sep 18, 2026 by kong
published on Friday, Sep 18, 2026 by kong
Viewing docs for konnect 3.23.0
published on Friday, Sep 18, 2026 by kong
published on Friday, Sep 18, 2026 by kong
AIGatewayConsumer Resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";
const myAigatewayconsumer = new konnect.AiGatewayConsumer("my_aigatewayconsumer", {
customId: "dev-users",
displayName: "Greg's Dev Consumer",
gatewayId: "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
labels: {
key: "value",
},
managedBy: {
key: "value",
},
name: "gregs-dev-consumer",
policies: ["..."],
type: "oauth",
});
import pulumi
import pulumi_konnect as konnect
my_aigatewayconsumer = konnect.AiGatewayConsumer("my_aigatewayconsumer",
custom_id="dev-users",
display_name="Greg's Dev Consumer",
gateway_id="5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
labels={
"key": "value",
},
managed_by={
"key": "value",
},
name="gregs-dev-consumer",
policies=["..."],
type="oauth")
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.NewAiGatewayConsumer(ctx, "my_aigatewayconsumer", &konnect.AiGatewayConsumerArgs{
CustomId: pulumi.String("dev-users"),
DisplayName: pulumi.String("Greg's Dev Consumer"),
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("gregs-dev-consumer"),
Policies: pulumi.StringArray{
pulumi.String("..."),
},
Type: pulumi.String("oauth"),
})
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 myAigatewayconsumer = new Konnect.AiGatewayConsumer("my_aigatewayconsumer", new()
{
CustomId = "dev-users",
DisplayName = "Greg's Dev Consumer",
GatewayId = "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
Labels =
{
{ "key", "value" },
},
ManagedBy =
{
{ "key", "value" },
},
Name = "gregs-dev-consumer",
Policies = new[]
{
"...",
},
Type = "oauth",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.AiGatewayConsumer;
import com.pulumi.konnect.AiGatewayConsumerArgs;
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 myAigatewayconsumer = new AiGatewayConsumer("myAigatewayconsumer", AiGatewayConsumerArgs.builder()
.customId("dev-users")
.displayName("Greg's Dev Consumer")
.gatewayId("5f9fd312-a987-4628-b4c5-bb4f4fddd5f7")
.labels(Map.of("key", "value"))
.managedBy(Map.of("key", "value"))
.name("gregs-dev-consumer")
.policies("...")
.type("oauth")
.build());
}
}
resources:
myAigatewayconsumer:
type: konnect:AiGatewayConsumer
name: my_aigatewayconsumer
properties:
customId: dev-users
displayName: Greg's Dev Consumer
gatewayId: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
labels:
key: value
managedBy:
key: value
name: gregs-dev-consumer
policies:
- '...'
type: oauth
Example coming soon!
Create AiGatewayConsumer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AiGatewayConsumer(name: string, args: AiGatewayConsumerArgs, opts?: CustomResourceOptions);@overload
def AiGatewayConsumer(resource_name: str,
args: AiGatewayConsumerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AiGatewayConsumer(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
gateway_id: Optional[str] = None,
type: Optional[str] = None,
custom_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 NewAiGatewayConsumer(ctx *Context, name string, args AiGatewayConsumerArgs, opts ...ResourceOption) (*AiGatewayConsumer, error)public AiGatewayConsumer(string name, AiGatewayConsumerArgs args, CustomResourceOptions? opts = null)
public AiGatewayConsumer(String name, AiGatewayConsumerArgs args)
public AiGatewayConsumer(String name, AiGatewayConsumerArgs args, CustomResourceOptions options)
type: konnect:AiGatewayConsumer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "konnect_ai_gateway_consumer" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AiGatewayConsumerArgs
- 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 AiGatewayConsumerArgs
- 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 AiGatewayConsumerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AiGatewayConsumerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AiGatewayConsumerArgs
- 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 aiGatewayConsumerResource = new Konnect.AiGatewayConsumer("aiGatewayConsumerResource", new()
{
DisplayName = "string",
GatewayId = "string",
Type = "string",
CustomId = "string",
Labels =
{
{ "string", "string" },
},
ManagedBy =
{
{ "string", "string" },
},
Name = "string",
Policies = new[]
{
"string",
},
});
example, err := konnect.NewAiGatewayConsumer(ctx, "aiGatewayConsumerResource", &konnect.AiGatewayConsumerArgs{
DisplayName: pulumi.String("string"),
GatewayId: pulumi.String("string"),
Type: pulumi.String("string"),
CustomId: 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" "aiGatewayConsumerResource" {
lifecycle {
create_before_destroy = true
}
display_name = "string"
gateway_id = "string"
type = "string"
custom_id = "string"
labels = {
"string" = "string"
}
managed_by = {
"string" = "string"
}
name = "string"
policies = ["string"]
}
var aiGatewayConsumerResource = new AiGatewayConsumer("aiGatewayConsumerResource", AiGatewayConsumerArgs.builder()
.displayName("string")
.gatewayId("string")
.type("string")
.customId("string")
.labels(Map.of("string", "string"))
.managedBy(Map.of("string", "string"))
.name("string")
.policies("string")
.build());
ai_gateway_consumer_resource = konnect.AiGatewayConsumer("aiGatewayConsumerResource",
display_name="string",
gateway_id="string",
type="string",
custom_id="string",
labels={
"string": "string",
},
managed_by={
"string": "string",
},
name="string",
policies=["string"])
const aiGatewayConsumerResource = new konnect.AiGatewayConsumer("aiGatewayConsumerResource", {
displayName: "string",
gatewayId: "string",
type: "string",
customId: "string",
labels: {
string: "string",
},
managedBy: {
string: "string",
},
name: "string",
policies: ["string"],
});
type: konnect:AiGatewayConsumer
properties:
customId: string
displayName: string
gatewayId: string
labels:
string: string
managedBy:
string: string
name: string
policies:
- string
type: string
AiGatewayConsumer 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 AiGatewayConsumer resource accepts the following input properties:
- Display
Name string - The display name for this consumer instance.
- Gateway
Id string - The unique ID of the AI Gateway.
- Type string
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- Custom
Id string - Identifier for mapping the consumer when using OAuth authentication.
- Labels Dictionary<string, string>
- Public labels store information about an entity that can be used for filtering a list of objects.
- Managed
By Dictionary<string, string> - Name string
- A user-defined unique identifier for this consumer, used as a stable human-readable reference. This value is immutable after creation.
- Policies List<string>
- List of policy references.
- Display
Name string - The display name for this consumer instance.
- Gateway
Id string - The unique ID of the AI Gateway.
- Type string
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- Custom
Id string - Identifier for mapping the consumer when using OAuth authentication.
- Labels map[string]string
- Public labels store information about an entity that can be used for filtering a list of objects.
- Managed
By map[string]string - Name string
- A user-defined unique identifier for this consumer, 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 instance.
- gateway_
id string - The unique ID of the AI Gateway.
- type string
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- custom_
id string - Identifier for mapping the consumer when using OAuth authentication.
- 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, used as a stable human-readable reference. This value is immutable after creation.
- policies list(string)
- List of policy references.
- display
Name String - The display name for this consumer instance.
- gateway
Id String - The unique ID of the AI Gateway.
- type String
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- custom
Id String - Identifier for mapping the consumer when using OAuth authentication.
- labels Map<String,String>
- Public labels store information about an entity that can be used for filtering a list of objects.
- managed
By Map<String,String> - name String
- A user-defined unique identifier for this consumer, used as a stable human-readable reference. This value is immutable after creation.
- policies List<String>
- List of policy references.
- display
Name string - The display name for this consumer instance.
- gateway
Id string - The unique ID of the AI Gateway.
- type string
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- custom
Id string - Identifier for mapping the consumer when using OAuth authentication.
- labels {[key: string]: string}
- Public labels store information about an entity that can be used for filtering a list of objects.
- managed
By {[key: string]: string} - name string
- A user-defined unique identifier for this consumer, 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 instance.
- gateway_
id str - The unique ID of the AI Gateway.
- type str
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- custom_
id str - Identifier for mapping the consumer when using OAuth authentication.
- 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, used as a stable human-readable reference. This value is immutable after creation.
- policies Sequence[str]
- List of policy references.
- display
Name String - The display name for this consumer instance.
- gateway
Id String - The unique ID of the AI Gateway.
- type String
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- custom
Id String - Identifier for mapping the consumer when using OAuth authentication.
- 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, 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 AiGatewayConsumer resource produces the following output properties:
- 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.
- 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.
Look up Existing AiGatewayConsumer Resource
Get an existing AiGatewayConsumer 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?: AiGatewayConsumerState, opts?: CustomResourceOptions): AiGatewayConsumer@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
custom_id: 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,
type: Optional[str] = None,
updated_at: Optional[str] = None) -> AiGatewayConsumerfunc GetAiGatewayConsumer(ctx *Context, name string, id IDInput, state *AiGatewayConsumerState, opts ...ResourceOption) (*AiGatewayConsumer, error)public static AiGatewayConsumer Get(string name, Input<string> id, AiGatewayConsumerState? state, CustomResourceOptions? opts = null)public static AiGatewayConsumer get(String name, Output<String> id, AiGatewayConsumerState state, CustomResourceOptions options)resources: _: type: konnect:AiGatewayConsumer get: id: ${id}import {
to = konnect_ai_gateway_consumer.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.
- Created
At string - An ISO-8601 timestamp representation of entity creation date.
- Custom
Id string - Identifier for mapping the consumer when using OAuth authentication.
- Display
Name string - The display name for this consumer instance.
- Gateway
Id 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.
- Managed
By Dictionary<string, string> - Name string
- A user-defined unique identifier for this consumer, used as a stable human-readable reference. This value is immutable after creation.
- Policies List<string>
- List of policy references.
- Type string
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- Updated
At string - An ISO-8601 timestamp representation of entity update date.
- Created
At string - An ISO-8601 timestamp representation of entity creation date.
- Custom
Id string - Identifier for mapping the consumer when using OAuth authentication.
- Display
Name string - The display name for this consumer instance.
- Gateway
Id 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.
- Managed
By map[string]string - Name string
- A user-defined unique identifier for this consumer, used as a stable human-readable reference. This value is immutable after creation.
- Policies []string
- List of policy references.
- Type string
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- Updated
At string - An ISO-8601 timestamp representation of entity update date.
- created_
at string - An ISO-8601 timestamp representation of entity creation date.
- custom_
id string - Identifier for mapping the consumer when using OAuth authentication.
- display_
name string - The display name for this consumer 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, used as a stable human-readable reference. This value is immutable after creation.
- policies list(string)
- List of policy references.
- type string
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- updated_
at string - An ISO-8601 timestamp representation of entity update date.
- created
At String - An ISO-8601 timestamp representation of entity creation date.
- custom
Id String - Identifier for mapping the consumer when using OAuth authentication.
- display
Name String - The display name for this consumer instance.
- gateway
Id 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.
- managed
By Map<String,String> - name String
- A user-defined unique identifier for this consumer, used as a stable human-readable reference. This value is immutable after creation.
- policies List<String>
- List of policy references.
- type String
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- updated
At String - An ISO-8601 timestamp representation of entity update date.
- created
At string - An ISO-8601 timestamp representation of entity creation date.
- custom
Id string - Identifier for mapping the consumer when using OAuth authentication.
- display
Name string - The display name for this consumer instance.
- gateway
Id 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.
- managed
By {[key: string]: string} - name string
- A user-defined unique identifier for this consumer, used as a stable human-readable reference. This value is immutable after creation.
- policies string[]
- List of policy references.
- type string
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- updated
At string - An ISO-8601 timestamp representation of entity update date.
- created_
at str - An ISO-8601 timestamp representation of entity creation date.
- custom_
id str - Identifier for mapping the consumer when using OAuth authentication.
- display_
name str - The display name for this consumer 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, used as a stable human-readable reference. This value is immutable after creation.
- policies Sequence[str]
- List of policy references.
- type str
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- updated_
at str - An ISO-8601 timestamp representation of entity update date.
- created
At String - An ISO-8601 timestamp representation of entity creation date.
- custom
Id String - Identifier for mapping the consumer when using OAuth authentication.
- display
Name String - The display name for this consumer 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, used as a stable human-readable reference. This value is immutable after creation.
- policies List<String>
- List of policy references.
- type String
- The type of the consumer. possible known values include one of ["api-key", "oauth"]
- updated
At 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.my_konnect_ai_gateway_consumer
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/aiGatewayConsumer:AiGatewayConsumer my_konnect_ai_gateway_consumer '{"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
konnectTerraform Provider.
Viewing docs for konnect 3.23.0
published on Friday, Sep 18, 2026 by kong
published on Friday, Sep 18, 2026 by kong