Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginAiPromptTemplate
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayPluginAiPromptTemplate

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

GatewayPluginAiPromptTemplate Resource

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginAiPromptTemplate;
import com.pulumi.konnect.GatewayPluginAiPromptTemplateArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptTemplateConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptTemplateConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptTemplateConsumerGroupArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptTemplateOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptTemplateOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptTemplateOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptTemplateRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptTemplateServiceArgs;
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 myGatewaypluginaiprompttemplate = new GatewayPluginAiPromptTemplate("myGatewaypluginaiprompttemplate", GatewayPluginAiPromptTemplateArgs.builder()
            .config(GatewayPluginAiPromptTemplateConfigArgs.builder()
                .allow_untemplated_requests(true)
                .log_original_request(false)
                .max_request_body_size(9)
                .templates(GatewayPluginAiPromptTemplateConfigTemplateArgs.builder()
                    .name("...my_name...")
                    .template("...my_template...")
                    .build())
                .build())
            .consumer(GatewayPluginAiPromptTemplateConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerGroup(GatewayPluginAiPromptTemplateConsumerGroupArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(1)
            .enabled(false)
            .gatewayPluginAiPromptTemplateId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginAiPromptTemplateOrderingArgs.builder()
                .after(GatewayPluginAiPromptTemplateOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginAiPromptTemplateOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("https")
            .route(GatewayPluginAiPromptTemplateRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginAiPromptTemplateServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .updatedAt(6)
            .build());

    }
}
Copy
resources:
  myGatewaypluginaiprompttemplate:
    type: konnect:GatewayPluginAiPromptTemplate
    properties:
      config:
        allow_untemplated_requests: true
        log_original_request: false
        max_request_body_size: 9
        templates:
          - name: '...my_name...'
            template: '...my_template...'
      consumer:
        id: '...my_id...'
      consumerGroup:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 1
      enabled: false
      gatewayPluginAiPromptTemplateId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - https
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
      updatedAt: 6
Copy

Create GatewayPluginAiPromptTemplate Resource

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

Constructor syntax

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

@overload
def GatewayPluginAiPromptTemplate(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  control_plane_id: Optional[str] = None,
                                  gateway_plugin_ai_prompt_template_id: Optional[str] = None,
                                  consumer_group: Optional[GatewayPluginAiPromptTemplateConsumerGroupArgs] = None,
                                  consumer: Optional[GatewayPluginAiPromptTemplateConsumerArgs] = None,
                                  created_at: Optional[float] = None,
                                  enabled: Optional[bool] = None,
                                  config: Optional[GatewayPluginAiPromptTemplateConfigArgs] = None,
                                  instance_name: Optional[str] = None,
                                  ordering: Optional[GatewayPluginAiPromptTemplateOrderingArgs] = None,
                                  protocols: Optional[Sequence[str]] = None,
                                  route: Optional[GatewayPluginAiPromptTemplateRouteArgs] = None,
                                  service: Optional[GatewayPluginAiPromptTemplateServiceArgs] = None,
                                  tags: Optional[Sequence[str]] = None,
                                  updated_at: Optional[float] = None)
func NewGatewayPluginAiPromptTemplate(ctx *Context, name string, args GatewayPluginAiPromptTemplateArgs, opts ...ResourceOption) (*GatewayPluginAiPromptTemplate, error)
public GatewayPluginAiPromptTemplate(string name, GatewayPluginAiPromptTemplateArgs args, CustomResourceOptions? opts = null)
public GatewayPluginAiPromptTemplate(String name, GatewayPluginAiPromptTemplateArgs args)
public GatewayPluginAiPromptTemplate(String name, GatewayPluginAiPromptTemplateArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginAiPromptTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayPluginAiPromptTemplateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginAiPromptTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginAiPromptTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayPluginAiPromptTemplateArgs
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 gatewayPluginAiPromptTemplateResource = new Konnect.GatewayPluginAiPromptTemplate("gatewayPluginAiPromptTemplateResource", new()
{
    ControlPlaneId = "string",
    GatewayPluginAiPromptTemplateId = "string",
    ConsumerGroup = new Konnect.Inputs.GatewayPluginAiPromptTemplateConsumerGroupArgs
    {
        Id = "string",
    },
    Consumer = new Konnect.Inputs.GatewayPluginAiPromptTemplateConsumerArgs
    {
        Id = "string",
    },
    CreatedAt = 0,
    Enabled = false,
    Config = new Konnect.Inputs.GatewayPluginAiPromptTemplateConfigArgs
    {
        AllowUntemplatedRequests = false,
        LogOriginalRequest = false,
        MaxRequestBodySize = 0,
        Templates = new[]
        {
            new Konnect.Inputs.GatewayPluginAiPromptTemplateConfigTemplateArgs
            {
                Name = "string",
                Template = "string",
            },
        },
    },
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginAiPromptTemplateOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginAiPromptTemplateOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginAiPromptTemplateOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginAiPromptTemplateRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginAiPromptTemplateServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
});
Copy
example, err := konnect.NewGatewayPluginAiPromptTemplate(ctx, "gatewayPluginAiPromptTemplateResource", &konnect.GatewayPluginAiPromptTemplateArgs{
ControlPlaneId: pulumi.String("string"),
GatewayPluginAiPromptTemplateId: pulumi.String("string"),
ConsumerGroup: &.GatewayPluginAiPromptTemplateConsumerGroupArgs{
Id: pulumi.String("string"),
},
Consumer: &.GatewayPluginAiPromptTemplateConsumerArgs{
Id: pulumi.String("string"),
},
CreatedAt: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
Config: &.GatewayPluginAiPromptTemplateConfigArgs{
AllowUntemplatedRequests: pulumi.Bool(false),
LogOriginalRequest: pulumi.Bool(false),
MaxRequestBodySize: pulumi.Float64(0),
Templates: .GatewayPluginAiPromptTemplateConfigTemplateArray{
&.GatewayPluginAiPromptTemplateConfigTemplateArgs{
Name: pulumi.String("string"),
Template: pulumi.String("string"),
},
},
},
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginAiPromptTemplateOrderingArgs{
After: &.GatewayPluginAiPromptTemplateOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginAiPromptTemplateOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginAiPromptTemplateRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginAiPromptTemplateServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
})
Copy
var gatewayPluginAiPromptTemplateResource = new GatewayPluginAiPromptTemplate("gatewayPluginAiPromptTemplateResource", GatewayPluginAiPromptTemplateArgs.builder()
    .controlPlaneId("string")
    .gatewayPluginAiPromptTemplateId("string")
    .consumerGroup(GatewayPluginAiPromptTemplateConsumerGroupArgs.builder()
        .id("string")
        .build())
    .consumer(GatewayPluginAiPromptTemplateConsumerArgs.builder()
        .id("string")
        .build())
    .createdAt(0)
    .enabled(false)
    .config(GatewayPluginAiPromptTemplateConfigArgs.builder()
        .allowUntemplatedRequests(false)
        .logOriginalRequest(false)
        .maxRequestBodySize(0)
        .templates(GatewayPluginAiPromptTemplateConfigTemplateArgs.builder()
            .name("string")
            .template("string")
            .build())
        .build())
    .instanceName("string")
    .ordering(GatewayPluginAiPromptTemplateOrderingArgs.builder()
        .after(GatewayPluginAiPromptTemplateOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginAiPromptTemplateOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginAiPromptTemplateRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginAiPromptTemplateServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .updatedAt(0)
    .build());
Copy
gateway_plugin_ai_prompt_template_resource = konnect.GatewayPluginAiPromptTemplate("gatewayPluginAiPromptTemplateResource",
    control_plane_id="string",
    gateway_plugin_ai_prompt_template_id="string",
    consumer_group={
        "id": "string",
    },
    consumer={
        "id": "string",
    },
    created_at=0,
    enabled=False,
    config={
        "allow_untemplated_requests": False,
        "log_original_request": False,
        "max_request_body_size": 0,
        "templates": [{
            "name": "string",
            "template": "string",
        }],
    },
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"],
    updated_at=0)
Copy
const gatewayPluginAiPromptTemplateResource = new konnect.GatewayPluginAiPromptTemplate("gatewayPluginAiPromptTemplateResource", {
    controlPlaneId: "string",
    gatewayPluginAiPromptTemplateId: "string",
    consumerGroup: {
        id: "string",
    },
    consumer: {
        id: "string",
    },
    createdAt: 0,
    enabled: false,
    config: {
        allowUntemplatedRequests: false,
        logOriginalRequest: false,
        maxRequestBodySize: 0,
        templates: [{
            name: "string",
            template: "string",
        }],
    },
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
    updatedAt: 0,
});
Copy
type: konnect:GatewayPluginAiPromptTemplate
properties:
    config:
        allowUntemplatedRequests: false
        logOriginalRequest: false
        maxRequestBodySize: 0
        templates:
            - name: string
              template: string
    consumer:
        id: string
    consumerGroup:
        id: string
    controlPlaneId: string
    createdAt: 0
    enabled: false
    gatewayPluginAiPromptTemplateId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
    updatedAt: 0
Copy

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

ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config GatewayPluginAiPromptTemplateConfig
Consumer GatewayPluginAiPromptTemplateConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginAiPromptTemplateConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
CreatedAt double
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginAiPromptTemplateId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginAiPromptTemplateOrdering
Protocols List<string>
A set of strings representing HTTP protocols.
Route GatewayPluginAiPromptTemplateRoute
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginAiPromptTemplateService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>
An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt double
Unix epoch when the resource was last updated.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config GatewayPluginAiPromptTemplateConfigArgs
Consumer GatewayPluginAiPromptTemplateConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginAiPromptTemplateConsumerGroupArgs
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
CreatedAt float64
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginAiPromptTemplateId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginAiPromptTemplateOrderingArgs
Protocols []string
A set of strings representing HTTP protocols.
Route GatewayPluginAiPromptTemplateRouteArgs
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginAiPromptTemplateServiceArgs
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string
An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt float64
Unix epoch when the resource was last updated.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginAiPromptTemplateConfig
consumer GatewayPluginAiPromptTemplateConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginAiPromptTemplateConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
createdAt Double
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginAiPromptTemplateId String
The ID of this resource.
instanceName String
ordering GatewayPluginAiPromptTemplateOrdering
protocols List<String>
A set of strings representing HTTP protocols.
route GatewayPluginAiPromptTemplateRoute
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginAiPromptTemplateService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Double
Unix epoch when the resource was last updated.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginAiPromptTemplateConfig
consumer GatewayPluginAiPromptTemplateConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginAiPromptTemplateConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
createdAt number
Unix epoch when the resource was created.
enabled boolean
Whether the plugin is applied.
gatewayPluginAiPromptTemplateId string
The ID of this resource.
instanceName string
ordering GatewayPluginAiPromptTemplateOrdering
protocols string[]
A set of strings representing HTTP protocols.
route GatewayPluginAiPromptTemplateRoute
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginAiPromptTemplateService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt number
Unix epoch when the resource was last updated.
control_plane_id This property is required. str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginAiPromptTemplateConfigArgs
consumer GatewayPluginAiPromptTemplateConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumer_group GatewayPluginAiPromptTemplateConsumerGroupArgs
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
created_at float
Unix epoch when the resource was created.
enabled bool
Whether the plugin is applied.
gateway_plugin_ai_prompt_template_id str
The ID of this resource.
instance_name str
ordering GatewayPluginAiPromptTemplateOrderingArgs
protocols Sequence[str]
A set of strings representing HTTP protocols.
route GatewayPluginAiPromptTemplateRouteArgs
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginAiPromptTemplateServiceArgs
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]
An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float
Unix epoch when the resource was last updated.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config Property Map
consumer Property Map
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup Property Map
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
createdAt Number
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginAiPromptTemplateId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing HTTP protocols.
route Property Map
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GatewayPluginAiPromptTemplate Resource

Get an existing GatewayPluginAiPromptTemplate 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?: GatewayPluginAiPromptTemplateState, opts?: CustomResourceOptions): GatewayPluginAiPromptTemplate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginAiPromptTemplateConfigArgs] = None,
        consumer: Optional[GatewayPluginAiPromptTemplateConsumerArgs] = None,
        consumer_group: Optional[GatewayPluginAiPromptTemplateConsumerGroupArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_ai_prompt_template_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginAiPromptTemplateOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginAiPromptTemplateRouteArgs] = None,
        service: Optional[GatewayPluginAiPromptTemplateServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginAiPromptTemplate
func GetGatewayPluginAiPromptTemplate(ctx *Context, name string, id IDInput, state *GatewayPluginAiPromptTemplateState, opts ...ResourceOption) (*GatewayPluginAiPromptTemplate, error)
public static GatewayPluginAiPromptTemplate Get(string name, Input<string> id, GatewayPluginAiPromptTemplateState? state, CustomResourceOptions? opts = null)
public static GatewayPluginAiPromptTemplate get(String name, Output<String> id, GatewayPluginAiPromptTemplateState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayPluginAiPromptTemplate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Config GatewayPluginAiPromptTemplateConfig
Consumer GatewayPluginAiPromptTemplateConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginAiPromptTemplateConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginAiPromptTemplateId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginAiPromptTemplateOrdering
Protocols List<string>
A set of strings representing HTTP protocols.
Route GatewayPluginAiPromptTemplateRoute
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginAiPromptTemplateService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>
An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt double
Unix epoch when the resource was last updated.
Config GatewayPluginAiPromptTemplateConfigArgs
Consumer GatewayPluginAiPromptTemplateConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginAiPromptTemplateConsumerGroupArgs
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginAiPromptTemplateId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginAiPromptTemplateOrderingArgs
Protocols []string
A set of strings representing HTTP protocols.
Route GatewayPluginAiPromptTemplateRouteArgs
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginAiPromptTemplateServiceArgs
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string
An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt float64
Unix epoch when the resource was last updated.
config GatewayPluginAiPromptTemplateConfig
consumer GatewayPluginAiPromptTemplateConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginAiPromptTemplateConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginAiPromptTemplateId String
The ID of this resource.
instanceName String
ordering GatewayPluginAiPromptTemplateOrdering
protocols List<String>
A set of strings representing HTTP protocols.
route GatewayPluginAiPromptTemplateRoute
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginAiPromptTemplateService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Double
Unix epoch when the resource was last updated.
config GatewayPluginAiPromptTemplateConfig
consumer GatewayPluginAiPromptTemplateConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginAiPromptTemplateConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
controlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number
Unix epoch when the resource was created.
enabled boolean
Whether the plugin is applied.
gatewayPluginAiPromptTemplateId string
The ID of this resource.
instanceName string
ordering GatewayPluginAiPromptTemplateOrdering
protocols string[]
A set of strings representing HTTP protocols.
route GatewayPluginAiPromptTemplateRoute
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginAiPromptTemplateService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt number
Unix epoch when the resource was last updated.
config GatewayPluginAiPromptTemplateConfigArgs
consumer GatewayPluginAiPromptTemplateConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumer_group GatewayPluginAiPromptTemplateConsumerGroupArgs
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
control_plane_id str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
created_at float
Unix epoch when the resource was created.
enabled bool
Whether the plugin is applied.
gateway_plugin_ai_prompt_template_id str
The ID of this resource.
instance_name str
ordering GatewayPluginAiPromptTemplateOrderingArgs
protocols Sequence[str]
A set of strings representing HTTP protocols.
route GatewayPluginAiPromptTemplateRouteArgs
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginAiPromptTemplateServiceArgs
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]
An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float
Unix epoch when the resource was last updated.
config Property Map
consumer Property Map
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup Property Map
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginAiPromptTemplateId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing HTTP protocols.
route Property Map
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.

Supporting Types

GatewayPluginAiPromptTemplateConfig
, GatewayPluginAiPromptTemplateConfigArgs

AllowUntemplatedRequests bool
Set true to allow requests that don't call or match any template.
LogOriginalRequest bool
Set true to add the original request to the Kong log plugin(s) output.
MaxRequestBodySize double
max allowed body size allowed to be introspected
Templates List<GatewayPluginAiPromptTemplateConfigTemplate>
Array of templates available to the request context.
AllowUntemplatedRequests bool
Set true to allow requests that don't call or match any template.
LogOriginalRequest bool
Set true to add the original request to the Kong log plugin(s) output.
MaxRequestBodySize float64
max allowed body size allowed to be introspected
Templates []GatewayPluginAiPromptTemplateConfigTemplate
Array of templates available to the request context.
allowUntemplatedRequests Boolean
Set true to allow requests that don't call or match any template.
logOriginalRequest Boolean
Set true to add the original request to the Kong log plugin(s) output.
maxRequestBodySize Double
max allowed body size allowed to be introspected
templates List<GatewayPluginAiPromptTemplateConfigTemplate>
Array of templates available to the request context.
allowUntemplatedRequests boolean
Set true to allow requests that don't call or match any template.
logOriginalRequest boolean
Set true to add the original request to the Kong log plugin(s) output.
maxRequestBodySize number
max allowed body size allowed to be introspected
templates GatewayPluginAiPromptTemplateConfigTemplate[]
Array of templates available to the request context.
allow_untemplated_requests bool
Set true to allow requests that don't call or match any template.
log_original_request bool
Set true to add the original request to the Kong log plugin(s) output.
max_request_body_size float
max allowed body size allowed to be introspected
templates Sequence[GatewayPluginAiPromptTemplateConfigTemplate]
Array of templates available to the request context.
allowUntemplatedRequests Boolean
Set true to allow requests that don't call or match any template.
logOriginalRequest Boolean
Set true to add the original request to the Kong log plugin(s) output.
maxRequestBodySize Number
max allowed body size allowed to be introspected
templates List<Property Map>
Array of templates available to the request context.

GatewayPluginAiPromptTemplateConfigTemplate
, GatewayPluginAiPromptTemplateConfigTemplateArgs

Name string
Unique name for the template, can be called with {template://NAME}. Not Null
Template string
Template string for this request, supports mustache-style {{placeholders}}. Not Null
Name string
Unique name for the template, can be called with {template://NAME}. Not Null
Template string
Template string for this request, supports mustache-style {{placeholders}}. Not Null
name String
Unique name for the template, can be called with {template://NAME}. Not Null
template String
Template string for this request, supports mustache-style {{placeholders}}. Not Null
name string
Unique name for the template, can be called with {template://NAME}. Not Null
template string
Template string for this request, supports mustache-style {{placeholders}}. Not Null
name str
Unique name for the template, can be called with {template://NAME}. Not Null
template str
Template string for this request, supports mustache-style {{placeholders}}. Not Null
name String
Unique name for the template, can be called with {template://NAME}. Not Null
template String
Template string for this request, supports mustache-style {{placeholders}}. Not Null

GatewayPluginAiPromptTemplateConsumer
, GatewayPluginAiPromptTemplateConsumerArgs

Id string
Id string
id String
id string
id str
id String

GatewayPluginAiPromptTemplateConsumerGroup
, GatewayPluginAiPromptTemplateConsumerGroupArgs

Id string
Id string
id String
id string
id str
id String

GatewayPluginAiPromptTemplateOrdering
, GatewayPluginAiPromptTemplateOrderingArgs

GatewayPluginAiPromptTemplateOrderingAfter
, GatewayPluginAiPromptTemplateOrderingAfterArgs

Accesses List<string>
Accesses []string
accesses List<String>
accesses string[]
accesses Sequence[str]
accesses List<String>

GatewayPluginAiPromptTemplateOrderingBefore
, GatewayPluginAiPromptTemplateOrderingBeforeArgs

Accesses List<string>
Accesses []string
accesses List<String>
accesses string[]
accesses Sequence[str]
accesses List<String>

GatewayPluginAiPromptTemplateRoute
, GatewayPluginAiPromptTemplateRouteArgs

Id string
Id string
id String
id string
id str
id String

GatewayPluginAiPromptTemplateService
, GatewayPluginAiPromptTemplateServiceArgs

Id string
Id string
id String
id string
id str
id String

Import

$ pulumi import konnect:index/gatewayPluginAiPromptTemplate:GatewayPluginAiPromptTemplate my_konnect_gateway_plugin_ai_prompt_template "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
Copy

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 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect