Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginAiPromptGuard
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayPluginAiPromptGuard

Explore with Pulumi AI

konnect logo
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

    GatewayPluginAiPromptGuard 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.GatewayPluginAiPromptGuard;
import com.pulumi.konnect.GatewayPluginAiPromptGuardArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptGuardConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptGuardConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptGuardConsumerGroupArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptGuardOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptGuardOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptGuardOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptGuardRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginAiPromptGuardServiceArgs;
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 myGatewaypluginaipromptguard = new GatewayPluginAiPromptGuard("myGatewaypluginaipromptguard", GatewayPluginAiPromptGuardArgs.builder()
            .config(GatewayPluginAiPromptGuardConfigArgs.builder()
                .allow_all_conversation_history(false)
                .allow_patterns("...")
                .deny_patterns("...")
                .match_all_roles(false)
                .max_request_body_size(10)
                .build())
            .consumer(GatewayPluginAiPromptGuardConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerGroup(GatewayPluginAiPromptGuardConsumerGroupArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginAiPromptGuardId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginAiPromptGuardOrderingArgs.builder()
                .after(GatewayPluginAiPromptGuardOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginAiPromptGuardOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("http")
            .route(GatewayPluginAiPromptGuardRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginAiPromptGuardServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

    resources:
  myGatewaypluginaipromptguard:
    type: konnect:GatewayPluginAiPromptGuard
    properties:
      config:
        allow_all_conversation_history: false
        allow_patterns:
          - '...'
        deny_patterns:
          - '...'
        match_all_roles: false
        max_request_body_size: 10
      consumer:
        id: '...my_id...'
      consumerGroup:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginAiPromptGuardId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - http
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

    Create GatewayPluginAiPromptGuard Resource

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

    Constructor syntax

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

@overload
def GatewayPluginAiPromptGuard(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               config: Optional[GatewayPluginAiPromptGuardConfigArgs] = None,
                               control_plane_id: Optional[str] = None,
                               consumer: Optional[GatewayPluginAiPromptGuardConsumerArgs] = None,
                               consumer_group: Optional[GatewayPluginAiPromptGuardConsumerGroupArgs] = None,
                               enabled: Optional[bool] = None,
                               gateway_plugin_ai_prompt_guard_id: Optional[str] = None,
                               instance_name: Optional[str] = None,
                               ordering: Optional[GatewayPluginAiPromptGuardOrderingArgs] = None,
                               protocols: Optional[Sequence[str]] = None,
                               route: Optional[GatewayPluginAiPromptGuardRouteArgs] = None,
                               service: Optional[GatewayPluginAiPromptGuardServiceArgs] = None,
                               tags: Optional[Sequence[str]] = None)
    func NewGatewayPluginAiPromptGuard(ctx *Context, name string, args GatewayPluginAiPromptGuardArgs, opts ...ResourceOption) (*GatewayPluginAiPromptGuard, error)
    public GatewayPluginAiPromptGuard(string name, GatewayPluginAiPromptGuardArgs args, CustomResourceOptions? opts = null)
    public GatewayPluginAiPromptGuard(String name, GatewayPluginAiPromptGuardArgs args)
public GatewayPluginAiPromptGuard(String name, GatewayPluginAiPromptGuardArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args GatewayPluginAiPromptGuardArgs
    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 GatewayPluginAiPromptGuardArgs
    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 GatewayPluginAiPromptGuardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayPluginAiPromptGuardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayPluginAiPromptGuardArgs
    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 gatewayPluginAiPromptGuardResource = new Konnect.GatewayPluginAiPromptGuard("gatewayPluginAiPromptGuardResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginAiPromptGuardConfigArgs
    {
        AllowAllConversationHistory = false,
        AllowPatterns = new[]
        {
            "string",
        },
        DenyPatterns = new[]
        {
            "string",
        },
        MatchAllRoles = false,
        MaxRequestBodySize = 0,
    },
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayPluginAiPromptGuardConsumerArgs
    {
        Id = "string",
    },
    ConsumerGroup = new Konnect.Inputs.GatewayPluginAiPromptGuardConsumerGroupArgs
    {
        Id = "string",
    },
    Enabled = false,
    GatewayPluginAiPromptGuardId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginAiPromptGuardOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginAiPromptGuardOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginAiPromptGuardOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginAiPromptGuardRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginAiPromptGuardServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := konnect.NewGatewayPluginAiPromptGuard(ctx, "gatewayPluginAiPromptGuardResource", &konnect.GatewayPluginAiPromptGuardArgs{
Config: &.GatewayPluginAiPromptGuardConfigArgs{
AllowAllConversationHistory: pulumi.Bool(false),
AllowPatterns: pulumi.StringArray{
pulumi.String("string"),
},
DenyPatterns: pulumi.StringArray{
pulumi.String("string"),
},
MatchAllRoles: pulumi.Bool(false),
MaxRequestBodySize: pulumi.Float64(0),
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginAiPromptGuardConsumerArgs{
Id: pulumi.String("string"),
},
ConsumerGroup: &.GatewayPluginAiPromptGuardConsumerGroupArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginAiPromptGuardId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginAiPromptGuardOrderingArgs{
After: &.GatewayPluginAiPromptGuardOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginAiPromptGuardOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginAiPromptGuardRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginAiPromptGuardServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

    var gatewayPluginAiPromptGuardResource = new GatewayPluginAiPromptGuard("gatewayPluginAiPromptGuardResource", GatewayPluginAiPromptGuardArgs.builder()
    .config(GatewayPluginAiPromptGuardConfigArgs.builder()
        .allowAllConversationHistory(false)
        .allowPatterns("string")
        .denyPatterns("string")
        .matchAllRoles(false)
        .maxRequestBodySize(0)
        .build())
    .controlPlaneId("string")
    .consumer(GatewayPluginAiPromptGuardConsumerArgs.builder()
        .id("string")
        .build())
    .consumerGroup(GatewayPluginAiPromptGuardConsumerGroupArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .gatewayPluginAiPromptGuardId("string")
    .instanceName("string")
    .ordering(GatewayPluginAiPromptGuardOrderingArgs.builder()
        .after(GatewayPluginAiPromptGuardOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginAiPromptGuardOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginAiPromptGuardRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginAiPromptGuardServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

    gateway_plugin_ai_prompt_guard_resource = konnect.GatewayPluginAiPromptGuard("gatewayPluginAiPromptGuardResource",
    config={
        "allow_all_conversation_history": False,
        "allow_patterns": ["string"],
        "deny_patterns": ["string"],
        "match_all_roles": False,
        "max_request_body_size": 0,
    },
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    consumer_group={
        "id": "string",
    },
    enabled=False,
    gateway_plugin_ai_prompt_guard_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

    const gatewayPluginAiPromptGuardResource = new konnect.GatewayPluginAiPromptGuard("gatewayPluginAiPromptGuardResource", {
    config: {
        allowAllConversationHistory: false,
        allowPatterns: ["string"],
        denyPatterns: ["string"],
        matchAllRoles: false,
        maxRequestBodySize: 0,
    },
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    consumerGroup: {
        id: "string",
    },
    enabled: false,
    gatewayPluginAiPromptGuardId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

    type: konnect:GatewayPluginAiPromptGuard
properties:
    config:
        allowAllConversationHistory: false
        allowPatterns:
            - string
        denyPatterns:
            - string
        matchAllRoles: false
        maxRequestBodySize: 0
    consumer:
        id: string
    consumerGroup:
        id: string
    controlPlaneId: string
    enabled: false
    gatewayPluginAiPromptGuardId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

    Config GatewayPluginAiPromptGuardConfig
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginAiPromptGuardConsumer
    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 GatewayPluginAiPromptGuardConsumerGroup
    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
    Enabled bool
    Whether the plugin is applied.
    GatewayPluginAiPromptGuardId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginAiPromptGuardOrdering
    Protocols List<string>
    A set of strings representing HTTP protocols.
    Route GatewayPluginAiPromptGuardRoute
    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 GatewayPluginAiPromptGuardService
    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.
    Config GatewayPluginAiPromptGuardConfigArgs
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginAiPromptGuardConsumerArgs
    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 GatewayPluginAiPromptGuardConsumerGroupArgs
    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
    Enabled bool
    Whether the plugin is applied.
    GatewayPluginAiPromptGuardId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginAiPromptGuardOrderingArgs
    Protocols []string
    A set of strings representing HTTP protocols.
    Route GatewayPluginAiPromptGuardRouteArgs
    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 GatewayPluginAiPromptGuardServiceArgs
    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.
    config GatewayPluginAiPromptGuardConfig
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginAiPromptGuardConsumer
    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 GatewayPluginAiPromptGuardConsumerGroup
    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
    enabled Boolean
    Whether the plugin is applied.
    gatewayPluginAiPromptGuardId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginAiPromptGuardOrdering
    protocols List<String>
    A set of strings representing HTTP protocols.
    route GatewayPluginAiPromptGuardRoute
    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 GatewayPluginAiPromptGuardService
    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.
    config GatewayPluginAiPromptGuardConfig
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginAiPromptGuardConsumer
    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 GatewayPluginAiPromptGuardConsumerGroup
    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
    enabled boolean
    Whether the plugin is applied.
    gatewayPluginAiPromptGuardId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginAiPromptGuardOrdering
    protocols string[]
    A set of strings representing HTTP protocols.
    route GatewayPluginAiPromptGuardRoute
    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 GatewayPluginAiPromptGuardService
    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.
    config GatewayPluginAiPromptGuardConfigArgs
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginAiPromptGuardConsumerArgs
    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 GatewayPluginAiPromptGuardConsumerGroupArgs
    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
    enabled bool
    Whether the plugin is applied.
    gateway_plugin_ai_prompt_guard_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginAiPromptGuardOrderingArgs
    protocols Sequence[str]
    A set of strings representing HTTP protocols.
    route GatewayPluginAiPromptGuardRouteArgs
    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 GatewayPluginAiPromptGuardServiceArgs
    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.
    config Property Map
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    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
    enabled Boolean
    Whether the plugin is applied.
    gatewayPluginAiPromptGuardId 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.

    Outputs

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

    CreatedAt double
    Unix epoch when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt double
    Unix epoch when the resource was last updated.
    CreatedAt float64
    Unix epoch when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    createdAt Double
    Unix epoch when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt Double
    Unix epoch when the resource was last updated.
    createdAt number
    Unix epoch when the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt number
    Unix epoch when the resource was last updated.
    created_at float
    Unix epoch when the resource was created.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at float
    Unix epoch when the resource was last updated.
    createdAt Number
    Unix epoch when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt Number
    Unix epoch when the resource was last updated.

    Look up Existing GatewayPluginAiPromptGuard Resource

    Get an existing GatewayPluginAiPromptGuard 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?: GatewayPluginAiPromptGuardState, opts?: CustomResourceOptions): GatewayPluginAiPromptGuard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginAiPromptGuardConfigArgs] = None,
        consumer: Optional[GatewayPluginAiPromptGuardConsumerArgs] = None,
        consumer_group: Optional[GatewayPluginAiPromptGuardConsumerGroupArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_ai_prompt_guard_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginAiPromptGuardOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginAiPromptGuardRouteArgs] = None,
        service: Optional[GatewayPluginAiPromptGuardServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginAiPromptGuard
    func GetGatewayPluginAiPromptGuard(ctx *Context, name string, id IDInput, state *GatewayPluginAiPromptGuardState, opts ...ResourceOption) (*GatewayPluginAiPromptGuard, error)
    public static GatewayPluginAiPromptGuard Get(string name, Input<string> id, GatewayPluginAiPromptGuardState? state, CustomResourceOptions? opts = null)
    public static GatewayPluginAiPromptGuard get(String name, Output<String> id, GatewayPluginAiPromptGuardState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayPluginAiPromptGuard    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Config GatewayPluginAiPromptGuardConfig
    Consumer GatewayPluginAiPromptGuardConsumer
    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 GatewayPluginAiPromptGuardConsumerGroup
    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.
    GatewayPluginAiPromptGuardId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginAiPromptGuardOrdering
    Protocols List<string>
    A set of strings representing HTTP protocols.
    Route GatewayPluginAiPromptGuardRoute
    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 GatewayPluginAiPromptGuardService
    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 GatewayPluginAiPromptGuardConfigArgs
    Consumer GatewayPluginAiPromptGuardConsumerArgs
    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 GatewayPluginAiPromptGuardConsumerGroupArgs
    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.
    GatewayPluginAiPromptGuardId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginAiPromptGuardOrderingArgs
    Protocols []string
    A set of strings representing HTTP protocols.
    Route GatewayPluginAiPromptGuardRouteArgs
    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 GatewayPluginAiPromptGuardServiceArgs
    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 GatewayPluginAiPromptGuardConfig
    consumer GatewayPluginAiPromptGuardConsumer
    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 GatewayPluginAiPromptGuardConsumerGroup
    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.
    gatewayPluginAiPromptGuardId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginAiPromptGuardOrdering
    protocols List<String>
    A set of strings representing HTTP protocols.
    route GatewayPluginAiPromptGuardRoute
    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 GatewayPluginAiPromptGuardService
    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 GatewayPluginAiPromptGuardConfig
    consumer GatewayPluginAiPromptGuardConsumer
    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 GatewayPluginAiPromptGuardConsumerGroup
    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.
    gatewayPluginAiPromptGuardId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginAiPromptGuardOrdering
    protocols string[]
    A set of strings representing HTTP protocols.
    route GatewayPluginAiPromptGuardRoute
    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 GatewayPluginAiPromptGuardService
    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 GatewayPluginAiPromptGuardConfigArgs
    consumer GatewayPluginAiPromptGuardConsumerArgs
    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 GatewayPluginAiPromptGuardConsumerGroupArgs
    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_guard_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginAiPromptGuardOrderingArgs
    protocols Sequence[str]
    A set of strings representing HTTP protocols.
    route GatewayPluginAiPromptGuardRouteArgs
    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 GatewayPluginAiPromptGuardServiceArgs
    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.
    gatewayPluginAiPromptGuardId 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

    GatewayPluginAiPromptGuardConfig, GatewayPluginAiPromptGuardConfigArgs

    AllowAllConversationHistory bool
    If true, will ignore all previous chat prompts from the conversation history.
    AllowPatterns List<string>
    Array of valid regex patterns, or valid questions from the 'user' role in chat.
    DenyPatterns List<string>
    Array of invalid regex patterns, or invalid questions from the 'user' role in chat.
    MatchAllRoles bool
    If true, will match all roles in addition to 'user' role in conversation history.
    MaxRequestBodySize double
    max allowed body size allowed to be introspected
    AllowAllConversationHistory bool
    If true, will ignore all previous chat prompts from the conversation history.
    AllowPatterns []string
    Array of valid regex patterns, or valid questions from the 'user' role in chat.
    DenyPatterns []string
    Array of invalid regex patterns, or invalid questions from the 'user' role in chat.
    MatchAllRoles bool
    If true, will match all roles in addition to 'user' role in conversation history.
    MaxRequestBodySize float64
    max allowed body size allowed to be introspected
    allowAllConversationHistory Boolean
    If true, will ignore all previous chat prompts from the conversation history.
    allowPatterns List<String>
    Array of valid regex patterns, or valid questions from the 'user' role in chat.
    denyPatterns List<String>
    Array of invalid regex patterns, or invalid questions from the 'user' role in chat.
    matchAllRoles Boolean
    If true, will match all roles in addition to 'user' role in conversation history.
    maxRequestBodySize Double
    max allowed body size allowed to be introspected
    allowAllConversationHistory boolean
    If true, will ignore all previous chat prompts from the conversation history.
    allowPatterns string[]
    Array of valid regex patterns, or valid questions from the 'user' role in chat.
    denyPatterns string[]
    Array of invalid regex patterns, or invalid questions from the 'user' role in chat.
    matchAllRoles boolean
    If true, will match all roles in addition to 'user' role in conversation history.
    maxRequestBodySize number
    max allowed body size allowed to be introspected
    allow_all_conversation_history bool
    If true, will ignore all previous chat prompts from the conversation history.
    allow_patterns Sequence[str]
    Array of valid regex patterns, or valid questions from the 'user' role in chat.
    deny_patterns Sequence[str]
    Array of invalid regex patterns, or invalid questions from the 'user' role in chat.
    match_all_roles bool
    If true, will match all roles in addition to 'user' role in conversation history.
    max_request_body_size float
    max allowed body size allowed to be introspected
    allowAllConversationHistory Boolean
    If true, will ignore all previous chat prompts from the conversation history.
    allowPatterns List<String>
    Array of valid regex patterns, or valid questions from the 'user' role in chat.
    denyPatterns List<String>
    Array of invalid regex patterns, or invalid questions from the 'user' role in chat.
    matchAllRoles Boolean
    If true, will match all roles in addition to 'user' role in conversation history.
    maxRequestBodySize Number
    max allowed body size allowed to be introspected

    GatewayPluginAiPromptGuardConsumer, GatewayPluginAiPromptGuardConsumerArgs

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

    GatewayPluginAiPromptGuardConsumerGroup, GatewayPluginAiPromptGuardConsumerGroupArgs

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

    GatewayPluginAiPromptGuardOrdering, GatewayPluginAiPromptGuardOrderingArgs

    GatewayPluginAiPromptGuardOrderingAfter, GatewayPluginAiPromptGuardOrderingAfterArgs

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

    GatewayPluginAiPromptGuardOrderingBefore, GatewayPluginAiPromptGuardOrderingBeforeArgs

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

    GatewayPluginAiPromptGuardRoute, GatewayPluginAiPromptGuardRouteArgs

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

    GatewayPluginAiPromptGuardService, GatewayPluginAiPromptGuardServiceArgs

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

    Import

    $ pulumi import konnect:index/gatewayPluginAiPromptGuard:GatewayPluginAiPromptGuard my_konnect_gateway_plugin_ai_prompt_guard "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
    kong/terraform-provider-konnect