konnect 2.4.1, Mar 13 25

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.GatewayPluginWebsocketSizeLimit

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

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.GatewayPluginWebsocketSizeLimit;
import com.pulumi.konnect.GatewayPluginWebsocketSizeLimitArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketSizeLimitConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketSizeLimitConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketSizeLimitOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketSizeLimitOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketSizeLimitOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketSizeLimitRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginWebsocketSizeLimitServiceArgs;
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 myGatewaypluginwebsocketsizelimit = new GatewayPluginWebsocketSizeLimit("myGatewaypluginwebsocketsizelimit", GatewayPluginWebsocketSizeLimitArgs.builder()
            .config(GatewayPluginWebsocketSizeLimitConfigArgs.builder()
                .client_max_payload(33127457)
                .upstream_max_payload(17682985)
                .build())
            .consumer(GatewayPluginWebsocketSizeLimitConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .gatewayPluginWebsocketSizeLimitId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginWebsocketSizeLimitOrderingArgs.builder()
                .after(GatewayPluginWebsocketSizeLimitOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginWebsocketSizeLimitOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("ws")
            .route(GatewayPluginWebsocketSizeLimitRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginWebsocketSizeLimitServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

resources:
  myGatewaypluginwebsocketsizelimit:
    type: konnect:GatewayPluginWebsocketSizeLimit
    properties:
      config:
        client_max_payload: 3.3127457e+07
        upstream_max_payload: 1.7682985e+07
      consumer:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      gatewayPluginWebsocketSizeLimitId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - ws
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

Create GatewayPluginWebsocketSizeLimit Resource

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

Constructor syntax

new GatewayPluginWebsocketSizeLimit(name: string, args: GatewayPluginWebsocketSizeLimitArgs, opts?: CustomResourceOptions);

@overload
def GatewayPluginWebsocketSizeLimit(resource_name: str,
                                    args: GatewayPluginWebsocketSizeLimitArgs,
                                    opts: Optional[ResourceOptions] = None)

@overload
def GatewayPluginWebsocketSizeLimit(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    config: Optional[GatewayPluginWebsocketSizeLimitConfigArgs] = None,
                                    control_plane_id: Optional[str] = None,
                                    consumer: Optional[GatewayPluginWebsocketSizeLimitConsumerArgs] = None,
                                    enabled: Optional[bool] = None,
                                    gateway_plugin_websocket_size_limit_id: Optional[str] = None,
                                    instance_name: Optional[str] = None,
                                    ordering: Optional[GatewayPluginWebsocketSizeLimitOrderingArgs] = None,
                                    protocols: Optional[Sequence[str]] = None,
                                    route: Optional[GatewayPluginWebsocketSizeLimitRouteArgs] = None,
                                    service: Optional[GatewayPluginWebsocketSizeLimitServiceArgs] = None,
                                    tags: Optional[Sequence[str]] = None)

func NewGatewayPluginWebsocketSizeLimit(ctx *Context, name string, args GatewayPluginWebsocketSizeLimitArgs, opts ...ResourceOption) (*GatewayPluginWebsocketSizeLimit, error)

public GatewayPluginWebsocketSizeLimit(string name, GatewayPluginWebsocketSizeLimitArgs args, CustomResourceOptions? opts = null)

public GatewayPluginWebsocketSizeLimit(String name, GatewayPluginWebsocketSizeLimitArgs args)
public GatewayPluginWebsocketSizeLimit(String name, GatewayPluginWebsocketSizeLimitArgs args, CustomResourceOptions options)

type: konnect:GatewayPluginWebsocketSizeLimit
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 GatewayPluginWebsocketSizeLimitArgs: 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 GatewayPluginWebsocketSizeLimitArgs: 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 GatewayPluginWebsocketSizeLimitArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GatewayPluginWebsocketSizeLimitArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GatewayPluginWebsocketSizeLimitArgs: 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 gatewayPluginWebsocketSizeLimitResource = new Konnect.GatewayPluginWebsocketSizeLimit("gatewayPluginWebsocketSizeLimitResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginWebsocketSizeLimitConfigArgs
    {
        ClientMaxPayload = 0,
        UpstreamMaxPayload = 0,
    },
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayPluginWebsocketSizeLimitConsumerArgs
    {
        Id = "string",
    },
    Enabled = false,
    GatewayPluginWebsocketSizeLimitId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginWebsocketSizeLimitOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginWebsocketSizeLimitOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginWebsocketSizeLimitOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginWebsocketSizeLimitRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginWebsocketSizeLimitServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := konnect.NewGatewayPluginWebsocketSizeLimit(ctx, "gatewayPluginWebsocketSizeLimitResource", &konnect.GatewayPluginWebsocketSizeLimitArgs{
Config: &.GatewayPluginWebsocketSizeLimitConfigArgs{
ClientMaxPayload: pulumi.Float64(0),
UpstreamMaxPayload: pulumi.Float64(0),
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginWebsocketSizeLimitConsumerArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginWebsocketSizeLimitId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginWebsocketSizeLimitOrderingArgs{
After: &.GatewayPluginWebsocketSizeLimitOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginWebsocketSizeLimitOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginWebsocketSizeLimitRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginWebsocketSizeLimitServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

var gatewayPluginWebsocketSizeLimitResource = new GatewayPluginWebsocketSizeLimit("gatewayPluginWebsocketSizeLimitResource", GatewayPluginWebsocketSizeLimitArgs.builder()
    .config(GatewayPluginWebsocketSizeLimitConfigArgs.builder()
        .clientMaxPayload(0)
        .upstreamMaxPayload(0)
        .build())
    .controlPlaneId("string")
    .consumer(GatewayPluginWebsocketSizeLimitConsumerArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .gatewayPluginWebsocketSizeLimitId("string")
    .instanceName("string")
    .ordering(GatewayPluginWebsocketSizeLimitOrderingArgs.builder()
        .after(GatewayPluginWebsocketSizeLimitOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginWebsocketSizeLimitOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginWebsocketSizeLimitRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginWebsocketSizeLimitServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

gateway_plugin_websocket_size_limit_resource = konnect.GatewayPluginWebsocketSizeLimit("gatewayPluginWebsocketSizeLimitResource",
    config={
        "client_max_payload": 0,
        "upstream_max_payload": 0,
    },
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    enabled=False,
    gateway_plugin_websocket_size_limit_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

const gatewayPluginWebsocketSizeLimitResource = new konnect.GatewayPluginWebsocketSizeLimit("gatewayPluginWebsocketSizeLimitResource", {
    config: {
        clientMaxPayload: 0,
        upstreamMaxPayload: 0,
    },
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    enabled: false,
    gatewayPluginWebsocketSizeLimitId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

type: konnect:GatewayPluginWebsocketSizeLimit
properties:
    config:
        clientMaxPayload: 0
        upstreamMaxPayload: 0
    consumer:
        id: string
    controlPlaneId: string
    enabled: false
    gatewayPluginWebsocketSizeLimitId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

Config GatewayPluginWebsocketSizeLimitConfig
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginWebsocketSizeLimitConsumer: 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.
GatewayPluginWebsocketSizeLimitId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginWebsocketSizeLimitOrdering
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 GatewayPluginWebsocketSizeLimitRoute: 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 GatewayPluginWebsocketSizeLimitService: 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 GatewayPluginWebsocketSizeLimitConfigArgs
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginWebsocketSizeLimitConsumerArgs: 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.
GatewayPluginWebsocketSizeLimitId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginWebsocketSizeLimitOrderingArgs
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 GatewayPluginWebsocketSizeLimitRouteArgs: 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 GatewayPluginWebsocketSizeLimitServiceArgs: 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 GatewayPluginWebsocketSizeLimitConfig
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginWebsocketSizeLimitConsumer: 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.
gatewayPluginWebsocketSizeLimitId String: The ID of this resource.
instanceName String
ordering GatewayPluginWebsocketSizeLimitOrdering
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 GatewayPluginWebsocketSizeLimitRoute: 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 GatewayPluginWebsocketSizeLimitService: 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 GatewayPluginWebsocketSizeLimitConfig
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginWebsocketSizeLimitConsumer: 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.
gatewayPluginWebsocketSizeLimitId string: The ID of this resource.
instanceName string
ordering GatewayPluginWebsocketSizeLimitOrdering
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 GatewayPluginWebsocketSizeLimitRoute: 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 GatewayPluginWebsocketSizeLimitService: 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 GatewayPluginWebsocketSizeLimitConfigArgs
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginWebsocketSizeLimitConsumerArgs: 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_size_limit_id str: The ID of this resource.
instance_name str
ordering GatewayPluginWebsocketSizeLimitOrderingArgs
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 GatewayPluginWebsocketSizeLimitRouteArgs: 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 GatewayPluginWebsocketSizeLimitServiceArgs: 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.
gatewayPluginWebsocketSizeLimitId 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 GatewayPluginWebsocketSizeLimit 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 GatewayPluginWebsocketSizeLimit Resource

Get an existing GatewayPluginWebsocketSizeLimit 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?: GatewayPluginWebsocketSizeLimitState, opts?: CustomResourceOptions): GatewayPluginWebsocketSizeLimit

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginWebsocketSizeLimitConfigArgs] = None,
        consumer: Optional[GatewayPluginWebsocketSizeLimitConsumerArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_websocket_size_limit_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginWebsocketSizeLimitOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginWebsocketSizeLimitRouteArgs] = None,
        service: Optional[GatewayPluginWebsocketSizeLimitServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginWebsocketSizeLimit

func GetGatewayPluginWebsocketSizeLimit(ctx *Context, name string, id IDInput, state *GatewayPluginWebsocketSizeLimitState, opts ...ResourceOption) (*GatewayPluginWebsocketSizeLimit, error)

public static GatewayPluginWebsocketSizeLimit Get(string name, Input<string> id, GatewayPluginWebsocketSizeLimitState? state, CustomResourceOptions? opts = null)

public static GatewayPluginWebsocketSizeLimit get(String name, Output<String> id, GatewayPluginWebsocketSizeLimitState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginWebsocketSizeLimit    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 GatewayPluginWebsocketSizeLimitConfig
Consumer GatewayPluginWebsocketSizeLimitConsumer: 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.
GatewayPluginWebsocketSizeLimitId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginWebsocketSizeLimitOrdering
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 GatewayPluginWebsocketSizeLimitRoute: 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 GatewayPluginWebsocketSizeLimitService: 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 GatewayPluginWebsocketSizeLimitConfigArgs
Consumer GatewayPluginWebsocketSizeLimitConsumerArgs: 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.
GatewayPluginWebsocketSizeLimitId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginWebsocketSizeLimitOrderingArgs
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 GatewayPluginWebsocketSizeLimitRouteArgs: 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 GatewayPluginWebsocketSizeLimitServiceArgs: 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 GatewayPluginWebsocketSizeLimitConfig
consumer GatewayPluginWebsocketSizeLimitConsumer: 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.
gatewayPluginWebsocketSizeLimitId String: The ID of this resource.
instanceName String
ordering GatewayPluginWebsocketSizeLimitOrdering
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 GatewayPluginWebsocketSizeLimitRoute: 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 GatewayPluginWebsocketSizeLimitService: 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 GatewayPluginWebsocketSizeLimitConfig
consumer GatewayPluginWebsocketSizeLimitConsumer: 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.
gatewayPluginWebsocketSizeLimitId string: The ID of this resource.
instanceName string
ordering GatewayPluginWebsocketSizeLimitOrdering
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 GatewayPluginWebsocketSizeLimitRoute: 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 GatewayPluginWebsocketSizeLimitService: 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 GatewayPluginWebsocketSizeLimitConfigArgs
consumer GatewayPluginWebsocketSizeLimitConsumerArgs: 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_size_limit_id str: The ID of this resource.
instance_name str
ordering GatewayPluginWebsocketSizeLimitOrderingArgs
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 GatewayPluginWebsocketSizeLimitRouteArgs: 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 GatewayPluginWebsocketSizeLimitServiceArgs: 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.
gatewayPluginWebsocketSizeLimitId 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

GatewayPluginWebsocketSizeLimitConfig, GatewayPluginWebsocketSizeLimitConfigArgs

ClientMaxPayload double
UpstreamMaxPayload double

ClientMaxPayload float64
UpstreamMaxPayload float64

clientMaxPayload Double
upstreamMaxPayload Double

clientMaxPayload number
upstreamMaxPayload number

client_max_payload float
upstream_max_payload float

clientMaxPayload Number
upstreamMaxPayload Number

GatewayPluginWebsocketSizeLimitConsumer, GatewayPluginWebsocketSizeLimitConsumerArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginWebsocketSizeLimitOrdering, GatewayPluginWebsocketSizeLimitOrderingArgs

After GatewayPluginWebsocketSizeLimitOrderingAfter
Before GatewayPluginWebsocketSizeLimitOrderingBefore

After GatewayPluginWebsocketSizeLimitOrderingAfter
Before GatewayPluginWebsocketSizeLimitOrderingBefore

after GatewayPluginWebsocketSizeLimitOrderingAfter
before GatewayPluginWebsocketSizeLimitOrderingBefore

after GatewayPluginWebsocketSizeLimitOrderingAfter
before GatewayPluginWebsocketSizeLimitOrderingBefore

after GatewayPluginWebsocketSizeLimitOrderingAfter
before GatewayPluginWebsocketSizeLimitOrderingBefore

after Property Map
before Property Map

GatewayPluginWebsocketSizeLimitOrderingAfter, GatewayPluginWebsocketSizeLimitOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginWebsocketSizeLimitOrderingBefore, GatewayPluginWebsocketSizeLimitOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginWebsocketSizeLimitRoute, GatewayPluginWebsocketSizeLimitRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginWebsocketSizeLimitService, GatewayPluginWebsocketSizeLimitServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginWebsocketSizeLimit:GatewayPluginWebsocketSizeLimit my_konnect_gateway_plugin_websocket_size_limit "{ \"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 2.4.1 published on Thursday, Mar 13, 2025 by kong

kong/terraform-provider-konnect

konnect.GatewayPluginWebsocketSizeLimit

On this page

On this page

Example Usage

Create GatewayPluginWebsocketSizeLimit Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginWebsocketSizeLimit Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginWebsocketSizeLimit Resource

Supporting Types

GatewayPluginWebsocketSizeLimitConfig, GatewayPluginWebsocketSizeLimitConfigArgs

GatewayPluginWebsocketSizeLimitConsumer, GatewayPluginWebsocketSizeLimitConsumerArgs

GatewayPluginWebsocketSizeLimitOrdering, GatewayPluginWebsocketSizeLimitOrderingArgs

GatewayPluginWebsocketSizeLimitOrderingAfter, GatewayPluginWebsocketSizeLimitOrderingAfterArgs

GatewayPluginWebsocketSizeLimitOrderingBefore, GatewayPluginWebsocketSizeLimitOrderingBeforeArgs

GatewayPluginWebsocketSizeLimitRoute, GatewayPluginWebsocketSizeLimitRouteArgs

GatewayPluginWebsocketSizeLimitService, GatewayPluginWebsocketSizeLimitServiceArgs

Import

Package Details

On this page

On this page