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

konnect.GatewayPluginWebsocketSizeLimit

Explore with Pulumi AI

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

GatewayPluginWebsocketSizeLimit 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.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")
            .createdAt(8)
            .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("...")
            .updatedAt(4)
            .build());

    }
}
Copy
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
      createdAt: 8
      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:
        - '...'
      updatedAt: 4
Copy

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,
                                    control_plane_id: Optional[str] = None,
                                    instance_name: Optional[str] = None,
                                    consumer: Optional[GatewayPluginWebsocketSizeLimitConsumerArgs] = None,
                                    created_at: Optional[float] = None,
                                    enabled: Optional[bool] = None,
                                    gateway_plugin_websocket_size_limit_id: Optional[str] = None,
                                    config: Optional[GatewayPluginWebsocketSizeLimitConfigArgs] = 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)
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 This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginWebsocketSizeLimitArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginWebsocketSizeLimitArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginWebsocketSizeLimitArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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()
{
    ControlPlaneId = "string",
    InstanceName = "string",
    Consumer = new Konnect.Inputs.GatewayPluginWebsocketSizeLimitConsumerArgs
    {
        Id = "string",
    },
    CreatedAt = 0,
    Enabled = false,
    GatewayPluginWebsocketSizeLimitId = "string",
    Config = new Konnect.Inputs.GatewayPluginWebsocketSizeLimitConfigArgs
    {
        ClientMaxPayload = 0,
        UpstreamMaxPayload = 0,
    },
    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",
    },
    UpdatedAt = 0,
});
Copy
example, err := konnect.NewGatewayPluginWebsocketSizeLimit(ctx, "gatewayPluginWebsocketSizeLimitResource", &konnect.GatewayPluginWebsocketSizeLimitArgs{
ControlPlaneId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Consumer: &.GatewayPluginWebsocketSizeLimitConsumerArgs{
Id: pulumi.String("string"),
},
CreatedAt: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
GatewayPluginWebsocketSizeLimitId: pulumi.String("string"),
Config: &.GatewayPluginWebsocketSizeLimitConfigArgs{
ClientMaxPayload: pulumi.Float64(0),
UpstreamMaxPayload: pulumi.Float64(0),
},
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"),
},
UpdatedAt: pulumi.Float64(0),
})
Copy
var gatewayPluginWebsocketSizeLimitResource = new GatewayPluginWebsocketSizeLimit("gatewayPluginWebsocketSizeLimitResource", GatewayPluginWebsocketSizeLimitArgs.builder()
    .controlPlaneId("string")
    .instanceName("string")
    .consumer(GatewayPluginWebsocketSizeLimitConsumerArgs.builder()
        .id("string")
        .build())
    .createdAt(0)
    .enabled(false)
    .gatewayPluginWebsocketSizeLimitId("string")
    .config(GatewayPluginWebsocketSizeLimitConfigArgs.builder()
        .clientMaxPayload(0)
        .upstreamMaxPayload(0)
        .build())
    .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")
    .updatedAt(0)
    .build());
Copy
gateway_plugin_websocket_size_limit_resource = konnect.GatewayPluginWebsocketSizeLimit("gatewayPluginWebsocketSizeLimitResource",
    control_plane_id="string",
    instance_name="string",
    consumer={
        "id": "string",
    },
    created_at=0,
    enabled=False,
    gateway_plugin_websocket_size_limit_id="string",
    config={
        "client_max_payload": 0,
        "upstream_max_payload": 0,
    },
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"],
    updated_at=0)
Copy
const gatewayPluginWebsocketSizeLimitResource = new konnect.GatewayPluginWebsocketSizeLimit("gatewayPluginWebsocketSizeLimitResource", {
    controlPlaneId: "string",
    instanceName: "string",
    consumer: {
        id: "string",
    },
    createdAt: 0,
    enabled: false,
    gatewayPluginWebsocketSizeLimitId: "string",
    config: {
        clientMaxPayload: 0,
        upstreamMaxPayload: 0,
    },
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
    updatedAt: 0,
});
Copy
type: konnect:GatewayPluginWebsocketSizeLimit
properties:
    config:
        clientMaxPayload: 0
        upstreamMaxPayload: 0
    consumer:
        id: string
    controlPlaneId: string
    createdAt: 0
    enabled: false
    gatewayPluginWebsocketSizeLimitId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
    updatedAt: 0
Copy

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:

ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config 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.
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.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config 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.
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.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config 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.
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.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config 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.
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.
control_plane_id This property is required. str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config 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.
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.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config Property Map
consumer Property Map
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
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.

Outputs

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

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

Look up Existing 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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Config 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

GatewayPluginWebsocketSizeLimitConsumer
, GatewayPluginWebsocketSizeLimitConsumerArgs

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

GatewayPluginWebsocketSizeLimitOrdering
, GatewayPluginWebsocketSizeLimitOrderingArgs

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\", \"id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
Copy

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

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect