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

konnect.GatewayPluginWebsocketValidator

Explore with Pulumi AI

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

    GatewayPluginWebsocketValidator 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.GatewayPluginWebsocketValidator;
import com.pulumi.konnect.GatewayPluginWebsocketValidatorArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorConfigClientArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorConfigClientBinaryArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorConfigClientTextArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorConfigUpstreamArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorConfigUpstreamBinaryArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorConfigUpstreamTextArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketValidatorServiceArgs;
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 myGatewaypluginwebsocketvalidator = new GatewayPluginWebsocketValidator("myGatewaypluginwebsocketvalidator", GatewayPluginWebsocketValidatorArgs.builder()
            .config(GatewayPluginWebsocketValidatorConfigArgs.builder()
                .client(GatewayPluginWebsocketValidatorConfigClientArgs.builder()
                    .binary(GatewayPluginWebsocketValidatorConfigClientBinaryArgs.builder()
                        .schema("...my_schema...")
                        .type("draft4")
                        .build())
                    .text(GatewayPluginWebsocketValidatorConfigClientTextArgs.builder()
                        .schema("...my_schema...")
                        .type("draft4")
                        .build())
                    .build())
                .upstream(GatewayPluginWebsocketValidatorConfigUpstreamArgs.builder()
                    .binary(GatewayPluginWebsocketValidatorConfigUpstreamBinaryArgs.builder()
                        .schema("...my_schema...")
                        .type("draft4")
                        .build())
                    .text(GatewayPluginWebsocketValidatorConfigUpstreamTextArgs.builder()
                        .schema("...my_schema...")
                        .type("draft4")
                        .build())
                    .build())
                .build())
            .consumer(GatewayPluginWebsocketValidatorConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .gatewayPluginWebsocketValidatorId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginWebsocketValidatorOrderingArgs.builder()
                .after(GatewayPluginWebsocketValidatorOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginWebsocketValidatorOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("wss")
            .route(GatewayPluginWebsocketValidatorRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginWebsocketValidatorServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

    resources:
  myGatewaypluginwebsocketvalidator:
    type: konnect:GatewayPluginWebsocketValidator
    properties:
      config:
        client:
          binary:
            schema: '...my_schema...'
            type: draft4
          text:
            schema: '...my_schema...'
            type: draft4
        upstream:
          binary:
            schema: '...my_schema...'
            type: draft4
          text:
            schema: '...my_schema...'
            type: draft4
      consumer:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      gatewayPluginWebsocketValidatorId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - wss
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

    Create GatewayPluginWebsocketValidator Resource

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

    Constructor syntax

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

@overload
def GatewayPluginWebsocketValidator(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    config: Optional[GatewayPluginWebsocketValidatorConfigArgs] = None,
                                    control_plane_id: Optional[str] = None,
                                    consumer: Optional[GatewayPluginWebsocketValidatorConsumerArgs] = None,
                                    enabled: Optional[bool] = None,
                                    gateway_plugin_websocket_validator_id: Optional[str] = None,
                                    instance_name: Optional[str] = None,
                                    ordering: Optional[GatewayPluginWebsocketValidatorOrderingArgs] = None,
                                    protocols: Optional[Sequence[str]] = None,
                                    route: Optional[GatewayPluginWebsocketValidatorRouteArgs] = None,
                                    service: Optional[GatewayPluginWebsocketValidatorServiceArgs] = None,
                                    tags: Optional[Sequence[str]] = None)
    func NewGatewayPluginWebsocketValidator(ctx *Context, name string, args GatewayPluginWebsocketValidatorArgs, opts ...ResourceOption) (*GatewayPluginWebsocketValidator, error)
    public GatewayPluginWebsocketValidator(string name, GatewayPluginWebsocketValidatorArgs args, CustomResourceOptions? opts = null)
    public GatewayPluginWebsocketValidator(String name, GatewayPluginWebsocketValidatorArgs args)
public GatewayPluginWebsocketValidator(String name, GatewayPluginWebsocketValidatorArgs args, CustomResourceOptions options)

    type: konnect:GatewayPluginWebsocketValidator
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 GatewayPluginWebsocketValidatorArgs
    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 GatewayPluginWebsocketValidatorArgs
    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 GatewayPluginWebsocketValidatorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayPluginWebsocketValidatorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayPluginWebsocketValidatorArgs
    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 gatewayPluginWebsocketValidatorResource = new Konnect.GatewayPluginWebsocketValidator("gatewayPluginWebsocketValidatorResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginWebsocketValidatorConfigArgs
    {
        Client = new Konnect.Inputs.GatewayPluginWebsocketValidatorConfigClientArgs
        {
            Binary = new Konnect.Inputs.GatewayPluginWebsocketValidatorConfigClientBinaryArgs
            {
                Schema = "string",
                Type = "string",
            },
            Text = new Konnect.Inputs.GatewayPluginWebsocketValidatorConfigClientTextArgs
            {
                Schema = "string",
                Type = "string",
            },
        },
        Upstream = new Konnect.Inputs.GatewayPluginWebsocketValidatorConfigUpstreamArgs
        {
            Binary = new Konnect.Inputs.GatewayPluginWebsocketValidatorConfigUpstreamBinaryArgs
            {
                Schema = "string",
                Type = "string",
            },
            Text = new Konnect.Inputs.GatewayPluginWebsocketValidatorConfigUpstreamTextArgs
            {
                Schema = "string",
                Type = "string",
            },
        },
    },
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayPluginWebsocketValidatorConsumerArgs
    {
        Id = "string",
    },
    Enabled = false,
    GatewayPluginWebsocketValidatorId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginWebsocketValidatorOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginWebsocketValidatorOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginWebsocketValidatorOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginWebsocketValidatorRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginWebsocketValidatorServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := konnect.NewGatewayPluginWebsocketValidator(ctx, "gatewayPluginWebsocketValidatorResource", &konnect.GatewayPluginWebsocketValidatorArgs{
Config: &.GatewayPluginWebsocketValidatorConfigArgs{
Client: &.GatewayPluginWebsocketValidatorConfigClientArgs{
Binary: &.GatewayPluginWebsocketValidatorConfigClientBinaryArgs{
Schema: pulumi.String("string"),
Type: pulumi.String("string"),
},
Text: &.GatewayPluginWebsocketValidatorConfigClientTextArgs{
Schema: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Upstream: &.GatewayPluginWebsocketValidatorConfigUpstreamArgs{
Binary: &.GatewayPluginWebsocketValidatorConfigUpstreamBinaryArgs{
Schema: pulumi.String("string"),
Type: pulumi.String("string"),
},
Text: &.GatewayPluginWebsocketValidatorConfigUpstreamTextArgs{
Schema: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginWebsocketValidatorConsumerArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginWebsocketValidatorId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginWebsocketValidatorOrderingArgs{
After: &.GatewayPluginWebsocketValidatorOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginWebsocketValidatorOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginWebsocketValidatorRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginWebsocketValidatorServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

    var gatewayPluginWebsocketValidatorResource = new GatewayPluginWebsocketValidator("gatewayPluginWebsocketValidatorResource", GatewayPluginWebsocketValidatorArgs.builder()
    .config(GatewayPluginWebsocketValidatorConfigArgs.builder()
        .client(GatewayPluginWebsocketValidatorConfigClientArgs.builder()
            .binary(GatewayPluginWebsocketValidatorConfigClientBinaryArgs.builder()
                .schema("string")
                .type("string")
                .build())
            .text(GatewayPluginWebsocketValidatorConfigClientTextArgs.builder()
                .schema("string")
                .type("string")
                .build())
            .build())
        .upstream(GatewayPluginWebsocketValidatorConfigUpstreamArgs.builder()
            .binary(GatewayPluginWebsocketValidatorConfigUpstreamBinaryArgs.builder()
                .schema("string")
                .type("string")
                .build())
            .text(GatewayPluginWebsocketValidatorConfigUpstreamTextArgs.builder()
                .schema("string")
                .type("string")
                .build())
            .build())
        .build())
    .controlPlaneId("string")
    .consumer(GatewayPluginWebsocketValidatorConsumerArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .gatewayPluginWebsocketValidatorId("string")
    .instanceName("string")
    .ordering(GatewayPluginWebsocketValidatorOrderingArgs.builder()
        .after(GatewayPluginWebsocketValidatorOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginWebsocketValidatorOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginWebsocketValidatorRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginWebsocketValidatorServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

    gateway_plugin_websocket_validator_resource = konnect.GatewayPluginWebsocketValidator("gatewayPluginWebsocketValidatorResource",
    config={
        "client": {
            "binary": {
                "schema": "string",
                "type": "string",
            },
            "text": {
                "schema": "string",
                "type": "string",
            },
        },
        "upstream": {
            "binary": {
                "schema": "string",
                "type": "string",
            },
            "text": {
                "schema": "string",
                "type": "string",
            },
        },
    },
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    enabled=False,
    gateway_plugin_websocket_validator_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

    const gatewayPluginWebsocketValidatorResource = new konnect.GatewayPluginWebsocketValidator("gatewayPluginWebsocketValidatorResource", {
    config: {
        client: {
            binary: {
                schema: "string",
                type: "string",
            },
            text: {
                schema: "string",
                type: "string",
            },
        },
        upstream: {
            binary: {
                schema: "string",
                type: "string",
            },
            text: {
                schema: "string",
                type: "string",
            },
        },
    },
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    enabled: false,
    gatewayPluginWebsocketValidatorId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

    type: konnect:GatewayPluginWebsocketValidator
properties:
    config:
        client:
            binary:
                schema: string
                type: string
            text:
                schema: string
                type: string
        upstream:
            binary:
                schema: string
                type: string
            text:
                schema: string
                type: string
    consumer:
        id: string
    controlPlaneId: string
    enabled: false
    gatewayPluginWebsocketValidatorId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

    Config GatewayPluginWebsocketValidatorConfig
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginWebsocketValidatorConsumer
    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.
    Enabled bool
    Whether the plugin is applied.
    GatewayPluginWebsocketValidatorId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginWebsocketValidatorOrdering
    Protocols List<string>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    Route GatewayPluginWebsocketValidatorRoute
    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 GatewayPluginWebsocketValidatorService
    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 GatewayPluginWebsocketValidatorConfigArgs
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginWebsocketValidatorConsumerArgs
    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.
    Enabled bool
    Whether the plugin is applied.
    GatewayPluginWebsocketValidatorId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginWebsocketValidatorOrderingArgs
    Protocols []string
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    Route GatewayPluginWebsocketValidatorRouteArgs
    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 GatewayPluginWebsocketValidatorServiceArgs
    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 GatewayPluginWebsocketValidatorConfig
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginWebsocketValidatorConsumer
    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.
    enabled Boolean
    Whether the plugin is applied.
    gatewayPluginWebsocketValidatorId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginWebsocketValidatorOrdering
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginWebsocketValidatorRoute
    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 GatewayPluginWebsocketValidatorService
    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 GatewayPluginWebsocketValidatorConfig
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginWebsocketValidatorConsumer
    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.
    enabled boolean
    Whether the plugin is applied.
    gatewayPluginWebsocketValidatorId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginWebsocketValidatorOrdering
    protocols string[]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginWebsocketValidatorRoute
    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 GatewayPluginWebsocketValidatorService
    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 GatewayPluginWebsocketValidatorConfigArgs
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginWebsocketValidatorConsumerArgs
    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.
    enabled bool
    Whether the plugin is applied.
    gateway_plugin_websocket_validator_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginWebsocketValidatorOrderingArgs
    protocols Sequence[str]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginWebsocketValidatorRouteArgs
    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 GatewayPluginWebsocketValidatorServiceArgs
    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.
    enabled Boolean
    Whether the plugin is applied.
    gatewayPluginWebsocketValidatorId String
    The ID of this resource.
    instanceName String
    ordering Property Map
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    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 GatewayPluginWebsocketValidator 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 GatewayPluginWebsocketValidator Resource

    Get an existing GatewayPluginWebsocketValidator 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?: GatewayPluginWebsocketValidatorState, opts?: CustomResourceOptions): GatewayPluginWebsocketValidator
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginWebsocketValidatorConfigArgs] = None,
        consumer: Optional[GatewayPluginWebsocketValidatorConsumerArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_websocket_validator_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginWebsocketValidatorOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginWebsocketValidatorRouteArgs] = None,
        service: Optional[GatewayPluginWebsocketValidatorServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginWebsocketValidator
    func GetGatewayPluginWebsocketValidator(ctx *Context, name string, id IDInput, state *GatewayPluginWebsocketValidatorState, opts ...ResourceOption) (*GatewayPluginWebsocketValidator, error)
    public static GatewayPluginWebsocketValidator Get(string name, Input<string> id, GatewayPluginWebsocketValidatorState? state, CustomResourceOptions? opts = null)
    public static GatewayPluginWebsocketValidator get(String name, Output<String> id, GatewayPluginWebsocketValidatorState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayPluginWebsocketValidator    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 GatewayPluginWebsocketValidatorConfig
    Consumer GatewayPluginWebsocketValidatorConsumer
    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.
    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.
    GatewayPluginWebsocketValidatorId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginWebsocketValidatorOrdering
    Protocols List<string>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    Route GatewayPluginWebsocketValidatorRoute
    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 GatewayPluginWebsocketValidatorService
    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 GatewayPluginWebsocketValidatorConfigArgs
    Consumer GatewayPluginWebsocketValidatorConsumerArgs
    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.
    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.
    GatewayPluginWebsocketValidatorId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginWebsocketValidatorOrderingArgs
    Protocols []string
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    Route GatewayPluginWebsocketValidatorRouteArgs
    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 GatewayPluginWebsocketValidatorServiceArgs
    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 GatewayPluginWebsocketValidatorConfig
    consumer GatewayPluginWebsocketValidatorConsumer
    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.
    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.
    gatewayPluginWebsocketValidatorId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginWebsocketValidatorOrdering
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginWebsocketValidatorRoute
    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 GatewayPluginWebsocketValidatorService
    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 GatewayPluginWebsocketValidatorConfig
    consumer GatewayPluginWebsocketValidatorConsumer
    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.
    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.
    gatewayPluginWebsocketValidatorId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginWebsocketValidatorOrdering
    protocols string[]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginWebsocketValidatorRoute
    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 GatewayPluginWebsocketValidatorService
    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 GatewayPluginWebsocketValidatorConfigArgs
    consumer GatewayPluginWebsocketValidatorConsumerArgs
    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.
    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_websocket_validator_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginWebsocketValidatorOrderingArgs
    protocols Sequence[str]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginWebsocketValidatorRouteArgs
    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 GatewayPluginWebsocketValidatorServiceArgs
    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.
    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.
    gatewayPluginWebsocketValidatorId String
    The ID of this resource.
    instanceName String
    ordering Property Map
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    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

    GatewayPluginWebsocketValidatorConfig, GatewayPluginWebsocketValidatorConfigArgs

    GatewayPluginWebsocketValidatorConfigClient, GatewayPluginWebsocketValidatorConfigClientArgs

    GatewayPluginWebsocketValidatorConfigClientBinary, GatewayPluginWebsocketValidatorConfigClientBinaryArgs

    Schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    Type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    Schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    Type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema String
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type String
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema str
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type str
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema String
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type String
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"

    GatewayPluginWebsocketValidatorConfigClientText, GatewayPluginWebsocketValidatorConfigClientTextArgs

    Schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    Type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    Schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    Type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema String
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type String
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema str
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type str
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema String
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type String
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"

    GatewayPluginWebsocketValidatorConfigUpstream, GatewayPluginWebsocketValidatorConfigUpstreamArgs

    GatewayPluginWebsocketValidatorConfigUpstreamBinary, GatewayPluginWebsocketValidatorConfigUpstreamBinaryArgs

    Schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    Type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    Schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    Type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema String
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type String
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema str
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type str
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema String
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type String
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"

    GatewayPluginWebsocketValidatorConfigUpstreamText, GatewayPluginWebsocketValidatorConfigUpstreamTextArgs

    Schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    Type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    Schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    Type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema String
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type String
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema string
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type string
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema str
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type str
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"
    schema String
    Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type. Not Null
    type String
    The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported. Not Null; must be "draft4"

    GatewayPluginWebsocketValidatorConsumer, GatewayPluginWebsocketValidatorConsumerArgs

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

    GatewayPluginWebsocketValidatorOrdering, GatewayPluginWebsocketValidatorOrderingArgs

    GatewayPluginWebsocketValidatorOrderingAfter, GatewayPluginWebsocketValidatorOrderingAfterArgs

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

    GatewayPluginWebsocketValidatorOrderingBefore, GatewayPluginWebsocketValidatorOrderingBeforeArgs

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

    GatewayPluginWebsocketValidatorRoute, GatewayPluginWebsocketValidatorRouteArgs

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

    GatewayPluginWebsocketValidatorService, GatewayPluginWebsocketValidatorServiceArgs

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

    Import

    $ pulumi import konnect:index/gatewayPluginWebsocketValidator:GatewayPluginWebsocketValidator my_konnect_gateway_plugin_websocket_validator "{ \"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