1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginServiceProtection
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.GatewayPluginServiceProtection

Explore with Pulumi AI

GatewayPluginServiceProtection 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.GatewayPluginServiceProtection;
import com.pulumi.konnect.GatewayPluginServiceProtectionArgs;
import com.pulumi.konnect.inputs.GatewayPluginServiceProtectionConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginServiceProtectionConfigRedisArgs;
import com.pulumi.konnect.inputs.GatewayPluginServiceProtectionOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginServiceProtectionOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginServiceProtectionOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginServiceProtectionServiceArgs;
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 myGatewaypluginserviceprotection = new GatewayPluginServiceProtection("myGatewaypluginserviceprotection", GatewayPluginServiceProtectionArgs.builder()
            .config(GatewayPluginServiceProtectionConfigArgs.builder()
                .dictionary_name("...my_dictionary_name...")
                .disable_penalty(true)
                .error_code(2.21)
                .error_message("...my_error_message...")
                .hide_client_headers(false)
                .limit(3.19)
                .lock_dictionary_name("...my_lock_dictionary_name...")
                .namespace("...my_namespace...")
                .redis(GatewayPluginServiceProtectionConfigRedisArgs.builder()
                    .clusterMaxRedirections(3)
                    .clusterNodes(GatewayPluginServiceProtectionConfigRedisClusterNodeArgs.builder()
                        .ip("...my_ip...")
                        .port(33693)
                        .build())
                    .connectTimeout(498772011)
                    .connectionIsProxied(false)
                    .database(3)
                    .host("...my_host...")
                    .keepaliveBacklog(312843254)
                    .keepalivePoolSize(1451118259)
                    .password("...my_password...")
                    .port(56514)
                    .readTimeout(206958009)
                    .sendTimeout(408106576)
                    .sentinelMaster("...my_sentinel_master...")
                    .sentinelNodes(GatewayPluginServiceProtectionConfigRedisSentinelNodeArgs.builder()
                        .host("...my_host...")
                        .port(32122)
                        .build())
                    .sentinelPassword("...my_sentinel_password...")
                    .sentinelRole("any")
                    .sentinelUsername("...my_sentinel_username...")
                    .serverName("...my_server_name...")
                    .ssl(false)
                    .sslVerify(true)
                    .username("...my_username...")
                    .build())
                .retry_after_jitter_max(4.23)
                .strategy("redis")
                .sync_rate(5.69)
                .window_size(5.81)
                .window_type("sliding")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .gatewayPluginServiceProtectionId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginServiceProtectionOrderingArgs.builder()
                .after(GatewayPluginServiceProtectionOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginServiceProtectionOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("http")
            .service(GatewayPluginServiceProtectionServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}
Copy
resources:
  myGatewaypluginserviceprotection:
    type: konnect:GatewayPluginServiceProtection
    properties:
      config:
        dictionary_name: '...my_dictionary_name...'
        disable_penalty: true
        error_code: 2.21
        error_message: '...my_error_message...'
        hide_client_headers: false
        limit:
          - 3.19
        lock_dictionary_name: '...my_lock_dictionary_name...'
        namespace: '...my_namespace...'
        redis:
          clusterMaxRedirections: 3
          clusterNodes:
            - ip: '...my_ip...'
              port: 33693
          connectTimeout: 4.98772011e+08
          connectionIsProxied: false
          database: 3
          host: '...my_host...'
          keepaliveBacklog: 3.12843254e+08
          keepalivePoolSize: 1.451118259e+09
          password: '...my_password...'
          port: 56514
          readTimeout: 2.06958009e+08
          sendTimeout: 4.08106576e+08
          sentinelMaster: '...my_sentinel_master...'
          sentinelNodes:
            - host: '...my_host...'
              port: 32122
          sentinelPassword: '...my_sentinel_password...'
          sentinelRole: any
          sentinelUsername: '...my_sentinel_username...'
          serverName: '...my_server_name...'
          ssl: false
          sslVerify: true
          username: '...my_username...'
        retry_after_jitter_max: 4.23
        strategy: redis
        sync_rate: 5.69
        window_size:
          - 5.81
        window_type: sliding
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      gatewayPluginServiceProtectionId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - http
      service:
        id: '...my_id...'
      tags:
        - '...'
Copy

Create GatewayPluginServiceProtection Resource

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

Constructor syntax

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

@overload
def GatewayPluginServiceProtection(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   config: Optional[GatewayPluginServiceProtectionConfigArgs] = None,
                                   control_plane_id: Optional[str] = None,
                                   enabled: Optional[bool] = None,
                                   gateway_plugin_service_protection_id: Optional[str] = None,
                                   instance_name: Optional[str] = None,
                                   ordering: Optional[GatewayPluginServiceProtectionOrderingArgs] = None,
                                   protocols: Optional[Sequence[str]] = None,
                                   service: Optional[GatewayPluginServiceProtectionServiceArgs] = None,
                                   tags: Optional[Sequence[str]] = None)
func NewGatewayPluginServiceProtection(ctx *Context, name string, args GatewayPluginServiceProtectionArgs, opts ...ResourceOption) (*GatewayPluginServiceProtection, error)
public GatewayPluginServiceProtection(string name, GatewayPluginServiceProtectionArgs args, CustomResourceOptions? opts = null)
public GatewayPluginServiceProtection(String name, GatewayPluginServiceProtectionArgs args)
public GatewayPluginServiceProtection(String name, GatewayPluginServiceProtectionArgs args, CustomResourceOptions options)
type: konnect:GatewayPluginServiceProtection
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. GatewayPluginServiceProtectionArgs
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. GatewayPluginServiceProtectionArgs
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. GatewayPluginServiceProtectionArgs
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. GatewayPluginServiceProtectionArgs
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. GatewayPluginServiceProtectionArgs
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 gatewayPluginServiceProtectionResource = new Konnect.GatewayPluginServiceProtection("gatewayPluginServiceProtectionResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginServiceProtectionConfigArgs
    {
        DictionaryName = "string",
        DisablePenalty = false,
        ErrorCode = 0,
        ErrorMessage = "string",
        HideClientHeaders = false,
        Limits = new[]
        {
            0,
        },
        LockDictionaryName = "string",
        Namespace = "string",
        Redis = new Konnect.Inputs.GatewayPluginServiceProtectionConfigRedisArgs
        {
            ClusterMaxRedirections = 0,
            ClusterNodes = new[]
            {
                new Konnect.Inputs.GatewayPluginServiceProtectionConfigRedisClusterNodeArgs
                {
                    Ip = "string",
                    Port = 0,
                },
            },
            ConnectTimeout = 0,
            ConnectionIsProxied = false,
            Database = 0,
            Host = "string",
            KeepaliveBacklog = 0,
            KeepalivePoolSize = 0,
            Password = "string",
            Port = 0,
            ReadTimeout = 0,
            SendTimeout = 0,
            SentinelMaster = "string",
            SentinelNodes = new[]
            {
                new Konnect.Inputs.GatewayPluginServiceProtectionConfigRedisSentinelNodeArgs
                {
                    Host = "string",
                    Port = 0,
                },
            },
            SentinelPassword = "string",
            SentinelRole = "string",
            SentinelUsername = "string",
            ServerName = "string",
            Ssl = false,
            SslVerify = false,
            Username = "string",
        },
        RetryAfterJitterMax = 0,
        Strategy = "string",
        SyncRate = 0,
        WindowSizes = new[]
        {
            0,
        },
        WindowType = "string",
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginServiceProtectionId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginServiceProtectionOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginServiceProtectionOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginServiceProtectionOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Service = new Konnect.Inputs.GatewayPluginServiceProtectionServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := konnect.NewGatewayPluginServiceProtection(ctx, "gatewayPluginServiceProtectionResource", &konnect.GatewayPluginServiceProtectionArgs{
Config: &.GatewayPluginServiceProtectionConfigArgs{
DictionaryName: pulumi.String("string"),
DisablePenalty: pulumi.Bool(false),
ErrorCode: pulumi.Float64(0),
ErrorMessage: pulumi.String("string"),
HideClientHeaders: pulumi.Bool(false),
Limits: pulumi.Float64Array{
pulumi.Float64(0),
},
LockDictionaryName: pulumi.String("string"),
Namespace: pulumi.String("string"),
Redis: &.GatewayPluginServiceProtectionConfigRedisArgs{
ClusterMaxRedirections: pulumi.Float64(0),
ClusterNodes: .GatewayPluginServiceProtectionConfigRedisClusterNodeArray{
&.GatewayPluginServiceProtectionConfigRedisClusterNodeArgs{
Ip: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
ConnectTimeout: pulumi.Float64(0),
ConnectionIsProxied: pulumi.Bool(false),
Database: pulumi.Float64(0),
Host: pulumi.String("string"),
KeepaliveBacklog: pulumi.Float64(0),
KeepalivePoolSize: pulumi.Float64(0),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
ReadTimeout: pulumi.Float64(0),
SendTimeout: pulumi.Float64(0),
SentinelMaster: pulumi.String("string"),
SentinelNodes: .GatewayPluginServiceProtectionConfigRedisSentinelNodeArray{
&.GatewayPluginServiceProtectionConfigRedisSentinelNodeArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
SentinelPassword: pulumi.String("string"),
SentinelRole: pulumi.String("string"),
SentinelUsername: pulumi.String("string"),
ServerName: pulumi.String("string"),
Ssl: pulumi.Bool(false),
SslVerify: pulumi.Bool(false),
Username: pulumi.String("string"),
},
RetryAfterJitterMax: pulumi.Float64(0),
Strategy: pulumi.String("string"),
SyncRate: pulumi.Float64(0),
WindowSizes: pulumi.Float64Array{
pulumi.Float64(0),
},
WindowType: pulumi.String("string"),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginServiceProtectionId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginServiceProtectionOrderingArgs{
After: &.GatewayPluginServiceProtectionOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginServiceProtectionOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Service: &.GatewayPluginServiceProtectionServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var gatewayPluginServiceProtectionResource = new GatewayPluginServiceProtection("gatewayPluginServiceProtectionResource", GatewayPluginServiceProtectionArgs.builder()
    .config(GatewayPluginServiceProtectionConfigArgs.builder()
        .dictionaryName("string")
        .disablePenalty(false)
        .errorCode(0)
        .errorMessage("string")
        .hideClientHeaders(false)
        .limits(0)
        .lockDictionaryName("string")
        .namespace("string")
        .redis(GatewayPluginServiceProtectionConfigRedisArgs.builder()
            .clusterMaxRedirections(0)
            .clusterNodes(GatewayPluginServiceProtectionConfigRedisClusterNodeArgs.builder()
                .ip("string")
                .port(0)
                .build())
            .connectTimeout(0)
            .connectionIsProxied(false)
            .database(0)
            .host("string")
            .keepaliveBacklog(0)
            .keepalivePoolSize(0)
            .password("string")
            .port(0)
            .readTimeout(0)
            .sendTimeout(0)
            .sentinelMaster("string")
            .sentinelNodes(GatewayPluginServiceProtectionConfigRedisSentinelNodeArgs.builder()
                .host("string")
                .port(0)
                .build())
            .sentinelPassword("string")
            .sentinelRole("string")
            .sentinelUsername("string")
            .serverName("string")
            .ssl(false)
            .sslVerify(false)
            .username("string")
            .build())
        .retryAfterJitterMax(0)
        .strategy("string")
        .syncRate(0)
        .windowSizes(0)
        .windowType("string")
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginServiceProtectionId("string")
    .instanceName("string")
    .ordering(GatewayPluginServiceProtectionOrderingArgs.builder()
        .after(GatewayPluginServiceProtectionOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginServiceProtectionOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .service(GatewayPluginServiceProtectionServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());
Copy
gateway_plugin_service_protection_resource = konnect.GatewayPluginServiceProtection("gatewayPluginServiceProtectionResource",
    config={
        "dictionary_name": "string",
        "disable_penalty": False,
        "error_code": 0,
        "error_message": "string",
        "hide_client_headers": False,
        "limits": [0],
        "lock_dictionary_name": "string",
        "namespace": "string",
        "redis": {
            "cluster_max_redirections": 0,
            "cluster_nodes": [{
                "ip": "string",
                "port": 0,
            }],
            "connect_timeout": 0,
            "connection_is_proxied": False,
            "database": 0,
            "host": "string",
            "keepalive_backlog": 0,
            "keepalive_pool_size": 0,
            "password": "string",
            "port": 0,
            "read_timeout": 0,
            "send_timeout": 0,
            "sentinel_master": "string",
            "sentinel_nodes": [{
                "host": "string",
                "port": 0,
            }],
            "sentinel_password": "string",
            "sentinel_role": "string",
            "sentinel_username": "string",
            "server_name": "string",
            "ssl": False,
            "ssl_verify": False,
            "username": "string",
        },
        "retry_after_jitter_max": 0,
        "strategy": "string",
        "sync_rate": 0,
        "window_sizes": [0],
        "window_type": "string",
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_service_protection_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    service={
        "id": "string",
    },
    tags=["string"])
Copy
const gatewayPluginServiceProtectionResource = new konnect.GatewayPluginServiceProtection("gatewayPluginServiceProtectionResource", {
    config: {
        dictionaryName: "string",
        disablePenalty: false,
        errorCode: 0,
        errorMessage: "string",
        hideClientHeaders: false,
        limits: [0],
        lockDictionaryName: "string",
        namespace: "string",
        redis: {
            clusterMaxRedirections: 0,
            clusterNodes: [{
                ip: "string",
                port: 0,
            }],
            connectTimeout: 0,
            connectionIsProxied: false,
            database: 0,
            host: "string",
            keepaliveBacklog: 0,
            keepalivePoolSize: 0,
            password: "string",
            port: 0,
            readTimeout: 0,
            sendTimeout: 0,
            sentinelMaster: "string",
            sentinelNodes: [{
                host: "string",
                port: 0,
            }],
            sentinelPassword: "string",
            sentinelRole: "string",
            sentinelUsername: "string",
            serverName: "string",
            ssl: false,
            sslVerify: false,
            username: "string",
        },
        retryAfterJitterMax: 0,
        strategy: "string",
        syncRate: 0,
        windowSizes: [0],
        windowType: "string",
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginServiceProtectionId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    service: {
        id: "string",
    },
    tags: ["string"],
});
Copy
type: konnect:GatewayPluginServiceProtection
properties:
    config:
        dictionaryName: string
        disablePenalty: false
        errorCode: 0
        errorMessage: string
        hideClientHeaders: false
        limits:
            - 0
        lockDictionaryName: string
        namespace: string
        redis:
            clusterMaxRedirections: 0
            clusterNodes:
                - ip: string
                  port: 0
            connectTimeout: 0
            connectionIsProxied: false
            database: 0
            host: string
            keepaliveBacklog: 0
            keepalivePoolSize: 0
            password: string
            port: 0
            readTimeout: 0
            sendTimeout: 0
            sentinelMaster: string
            sentinelNodes:
                - host: string
                  port: 0
            sentinelPassword: string
            sentinelRole: string
            sentinelUsername: string
            serverName: string
            ssl: false
            sslVerify: false
            username: string
        retryAfterJitterMax: 0
        strategy: string
        syncRate: 0
        windowSizes:
            - 0
        windowType: string
    controlPlaneId: string
    enabled: false
    gatewayPluginServiceProtectionId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    service:
        id: string
    tags:
        - string
Copy

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

Config This property is required. GatewayPluginServiceProtectionConfig
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool
Whether the plugin is applied.
GatewayPluginServiceProtectionId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginServiceProtectionOrdering
Protocols List<string>
A set of strings representing HTTP protocols.
Service GatewayPluginServiceProtectionService
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 This property is required. GatewayPluginServiceProtectionConfigArgs
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool
Whether the plugin is applied.
GatewayPluginServiceProtectionId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginServiceProtectionOrderingArgs
Protocols []string
A set of strings representing HTTP protocols.
Service GatewayPluginServiceProtectionServiceArgs
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 This property is required. GatewayPluginServiceProtectionConfig
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean
Whether the plugin is applied.
gatewayPluginServiceProtectionId String
The ID of this resource.
instanceName String
ordering GatewayPluginServiceProtectionOrdering
protocols List<String>
A set of strings representing HTTP protocols.
service GatewayPluginServiceProtectionService
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 This property is required. GatewayPluginServiceProtectionConfig
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled boolean
Whether the plugin is applied.
gatewayPluginServiceProtectionId string
The ID of this resource.
instanceName string
ordering GatewayPluginServiceProtectionOrdering
protocols string[]
A set of strings representing HTTP protocols.
service GatewayPluginServiceProtectionService
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 This property is required. GatewayPluginServiceProtectionConfigArgs
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.
enabled bool
Whether the plugin is applied.
gateway_plugin_service_protection_id str
The ID of this resource.
instance_name str
ordering GatewayPluginServiceProtectionOrderingArgs
protocols Sequence[str]
A set of strings representing HTTP protocols.
service GatewayPluginServiceProtectionServiceArgs
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 This property is required. Property Map
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean
Whether the plugin is applied.
gatewayPluginServiceProtectionId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing HTTP protocols.
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 GatewayPluginServiceProtection 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 GatewayPluginServiceProtection Resource

Get an existing GatewayPluginServiceProtection 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?: GatewayPluginServiceProtectionState, opts?: CustomResourceOptions): GatewayPluginServiceProtection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginServiceProtectionConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_service_protection_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginServiceProtectionOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        service: Optional[GatewayPluginServiceProtectionServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginServiceProtection
func GetGatewayPluginServiceProtection(ctx *Context, name string, id IDInput, state *GatewayPluginServiceProtectionState, opts ...ResourceOption) (*GatewayPluginServiceProtection, error)
public static GatewayPluginServiceProtection Get(string name, Input<string> id, GatewayPluginServiceProtectionState? state, CustomResourceOptions? opts = null)
public static GatewayPluginServiceProtection get(String name, Output<String> id, GatewayPluginServiceProtectionState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayPluginServiceProtection    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 GatewayPluginServiceProtectionConfig
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.
GatewayPluginServiceProtectionId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginServiceProtectionOrdering
Protocols List<string>
A set of strings representing HTTP protocols.
Service GatewayPluginServiceProtectionService
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 GatewayPluginServiceProtectionConfigArgs
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.
GatewayPluginServiceProtectionId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginServiceProtectionOrderingArgs
Protocols []string
A set of strings representing HTTP protocols.
Service GatewayPluginServiceProtectionServiceArgs
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 GatewayPluginServiceProtectionConfig
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.
gatewayPluginServiceProtectionId String
The ID of this resource.
instanceName String
ordering GatewayPluginServiceProtectionOrdering
protocols List<String>
A set of strings representing HTTP protocols.
service GatewayPluginServiceProtectionService
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 GatewayPluginServiceProtectionConfig
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.
gatewayPluginServiceProtectionId string
The ID of this resource.
instanceName string
ordering GatewayPluginServiceProtectionOrdering
protocols string[]
A set of strings representing HTTP protocols.
service GatewayPluginServiceProtectionService
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 GatewayPluginServiceProtectionConfigArgs
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_service_protection_id str
The ID of this resource.
instance_name str
ordering GatewayPluginServiceProtectionOrderingArgs
protocols Sequence[str]
A set of strings representing HTTP protocols.
service GatewayPluginServiceProtectionServiceArgs
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
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.
gatewayPluginServiceProtectionId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing HTTP protocols.
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

GatewayPluginServiceProtectionConfig
, GatewayPluginServiceProtectionConfigArgs

DictionaryName string
The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
DisablePenalty bool
If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
ErrorCode double
Set a custom error code to return when the rate limit is exceeded.
ErrorMessage string
Set a custom error message to return when the rate limit is exceeded.
HideClientHeaders bool
Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
Limits List<double>
One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
LockDictionaryName string
The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared in nginx-kong.conf.
Namespace string
The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
Redis GatewayPluginServiceProtectionConfigRedis
RetryAfterJitterMax double
The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
Strategy string
The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster. must be one of ["cluster", "local", "redis"]
SyncRate double
How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
WindowSizes List<double>
One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
WindowType string
Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]
DictionaryName string
The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
DisablePenalty bool
If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
ErrorCode float64
Set a custom error code to return when the rate limit is exceeded.
ErrorMessage string
Set a custom error message to return when the rate limit is exceeded.
HideClientHeaders bool
Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
Limits []float64
One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
LockDictionaryName string
The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared in nginx-kong.conf.
Namespace string
The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
Redis GatewayPluginServiceProtectionConfigRedis
RetryAfterJitterMax float64
The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
Strategy string
The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster. must be one of ["cluster", "local", "redis"]
SyncRate float64
How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
WindowSizes []float64
One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
WindowType string
Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]
dictionaryName String
The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
disablePenalty Boolean
If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
errorCode Double
Set a custom error code to return when the rate limit is exceeded.
errorMessage String
Set a custom error message to return when the rate limit is exceeded.
hideClientHeaders Boolean
Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
limits List<Double>
One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
lockDictionaryName String
The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared in nginx-kong.conf.
namespace String
The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
redis GatewayPluginServiceProtectionConfigRedis
retryAfterJitterMax Double
The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
strategy String
The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster. must be one of ["cluster", "local", "redis"]
syncRate Double
How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
windowSizes List<Double>
One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
windowType String
Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]
dictionaryName string
The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
disablePenalty boolean
If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
errorCode number
Set a custom error code to return when the rate limit is exceeded.
errorMessage string
Set a custom error message to return when the rate limit is exceeded.
hideClientHeaders boolean
Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
limits number[]
One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
lockDictionaryName string
The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared in nginx-kong.conf.
namespace string
The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
redis GatewayPluginServiceProtectionConfigRedis
retryAfterJitterMax number
The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
strategy string
The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster. must be one of ["cluster", "local", "redis"]
syncRate number
How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
windowSizes number[]
One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
windowType string
Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]
dictionary_name str
The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
disable_penalty bool
If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
error_code float
Set a custom error code to return when the rate limit is exceeded.
error_message str
Set a custom error message to return when the rate limit is exceeded.
hide_client_headers bool
Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
limits Sequence[float]
One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
lock_dictionary_name str
The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared in nginx-kong.conf.
namespace str
The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
redis GatewayPluginServiceProtectionConfigRedis
retry_after_jitter_max float
The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
strategy str
The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster. must be one of ["cluster", "local", "redis"]
sync_rate float
How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
window_sizes Sequence[float]
One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
window_type str
Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]
dictionaryName String
The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
disablePenalty Boolean
If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
errorCode Number
Set a custom error code to return when the rate limit is exceeded.
errorMessage String
Set a custom error message to return when the rate limit is exceeded.
hideClientHeaders Boolean
Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
limits List<Number>
One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
lockDictionaryName String
The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared in nginx-kong.conf.
namespace String
The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
redis Property Map
retryAfterJitterMax Number
The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
strategy String
The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster. must be one of ["cluster", "local", "redis"]
syncRate Number
How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
windowSizes List<Number>
One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
windowType String
Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]

GatewayPluginServiceProtectionConfigRedis
, GatewayPluginServiceProtectionConfigRedisArgs

ClusterMaxRedirections double
Maximum retry attempts for redirection.
ClusterNodes List<GatewayPluginServiceProtectionConfigRedisClusterNode>
Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
ConnectTimeout double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
ConnectionIsProxied bool
If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
Database double
Database to use for the Redis connection when using the redis strategy
Host string
A string representing a host name, such as example.com.
KeepaliveBacklog double
Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
KeepalivePoolSize double
The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
Password string
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
Port double
An integer representing a port number between 0 and 65535, inclusive.
ReadTimeout double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
SendTimeout double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
SentinelMaster string
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
SentinelNodes List<GatewayPluginServiceProtectionConfigRedisSentinelNode>
Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
SentinelPassword string
Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
SentinelRole string
Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
SentinelUsername string
Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
ServerName string
A string representing an SNI (server name indication) value for TLS.
Ssl bool
If set to true, uses SSL to connect to Redis.
SslVerify bool
If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
Username string
Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
ClusterMaxRedirections float64
Maximum retry attempts for redirection.
ClusterNodes []GatewayPluginServiceProtectionConfigRedisClusterNode
Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
ConnectTimeout float64
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
ConnectionIsProxied bool
If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
Database float64
Database to use for the Redis connection when using the redis strategy
Host string
A string representing a host name, such as example.com.
KeepaliveBacklog float64
Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
KeepalivePoolSize float64
The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
Password string
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
Port float64
An integer representing a port number between 0 and 65535, inclusive.
ReadTimeout float64
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
SendTimeout float64
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
SentinelMaster string
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
SentinelNodes []GatewayPluginServiceProtectionConfigRedisSentinelNode
Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
SentinelPassword string
Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
SentinelRole string
Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
SentinelUsername string
Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
ServerName string
A string representing an SNI (server name indication) value for TLS.
Ssl bool
If set to true, uses SSL to connect to Redis.
SslVerify bool
If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
Username string
Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
clusterMaxRedirections Double
Maximum retry attempts for redirection.
clusterNodes List<GatewayPluginServiceProtectionConfigRedisClusterNode>
Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
connectTimeout Double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
connectionIsProxied Boolean
If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
database Double
Database to use for the Redis connection when using the redis strategy
host String
A string representing a host name, such as example.com.
keepaliveBacklog Double
Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
keepalivePoolSize Double
The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
password String
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port Double
An integer representing a port number between 0 and 65535, inclusive.
readTimeout Double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sendTimeout Double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sentinelMaster String
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
sentinelNodes List<GatewayPluginServiceProtectionConfigRedisSentinelNode>
Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
sentinelPassword String
Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
sentinelRole String
Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
sentinelUsername String
Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
serverName String
A string representing an SNI (server name indication) value for TLS.
ssl Boolean
If set to true, uses SSL to connect to Redis.
sslVerify Boolean
If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
username String
Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
clusterMaxRedirections number
Maximum retry attempts for redirection.
clusterNodes GatewayPluginServiceProtectionConfigRedisClusterNode[]
Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
connectTimeout number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
connectionIsProxied boolean
If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
database number
Database to use for the Redis connection when using the redis strategy
host string
A string representing a host name, such as example.com.
keepaliveBacklog number
Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
keepalivePoolSize number
The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
password string
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port number
An integer representing a port number between 0 and 65535, inclusive.
readTimeout number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sendTimeout number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sentinelMaster string
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
sentinelNodes GatewayPluginServiceProtectionConfigRedisSentinelNode[]
Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
sentinelPassword string
Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
sentinelRole string
Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
sentinelUsername string
Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
serverName string
A string representing an SNI (server name indication) value for TLS.
ssl boolean
If set to true, uses SSL to connect to Redis.
sslVerify boolean
If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
username string
Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
cluster_max_redirections float
Maximum retry attempts for redirection.
cluster_nodes Sequence[GatewayPluginServiceProtectionConfigRedisClusterNode]
Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
connect_timeout float
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
connection_is_proxied bool
If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
database float
Database to use for the Redis connection when using the redis strategy
host str
A string representing a host name, such as example.com.
keepalive_backlog float
Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
keepalive_pool_size float
The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
password str
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port float
An integer representing a port number between 0 and 65535, inclusive.
read_timeout float
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
send_timeout float
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sentinel_master str
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
sentinel_nodes Sequence[GatewayPluginServiceProtectionConfigRedisSentinelNode]
Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
sentinel_password str
Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
sentinel_role str
Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
sentinel_username str
Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
server_name str
A string representing an SNI (server name indication) value for TLS.
ssl bool
If set to true, uses SSL to connect to Redis.
ssl_verify bool
If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
username str
Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
clusterMaxRedirections Number
Maximum retry attempts for redirection.
clusterNodes List<Property Map>
Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
connectTimeout Number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
connectionIsProxied Boolean
If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
database Number
Database to use for the Redis connection when using the redis strategy
host String
A string representing a host name, such as example.com.
keepaliveBacklog Number
Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
keepalivePoolSize Number
The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
password String
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port Number
An integer representing a port number between 0 and 65535, inclusive.
readTimeout Number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sendTimeout Number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sentinelMaster String
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
sentinelNodes List<Property Map>
Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
sentinelPassword String
Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
sentinelRole String
Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]
sentinelUsername String
Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
serverName String
A string representing an SNI (server name indication) value for TLS.
ssl Boolean
If set to true, uses SSL to connect to Redis.
sslVerify Boolean
If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
username String
Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.

GatewayPluginServiceProtectionConfigRedisClusterNode
, GatewayPluginServiceProtectionConfigRedisClusterNodeArgs

Ip string
A string representing a host name, such as example.com.
Port double
An integer representing a port number between 0 and 65535, inclusive.
Ip string
A string representing a host name, such as example.com.
Port float64
An integer representing a port number between 0 and 65535, inclusive.
ip String
A string representing a host name, such as example.com.
port Double
An integer representing a port number between 0 and 65535, inclusive.
ip string
A string representing a host name, such as example.com.
port number
An integer representing a port number between 0 and 65535, inclusive.
ip str
A string representing a host name, such as example.com.
port float
An integer representing a port number between 0 and 65535, inclusive.
ip String
A string representing a host name, such as example.com.
port Number
An integer representing a port number between 0 and 65535, inclusive.

GatewayPluginServiceProtectionConfigRedisSentinelNode
, GatewayPluginServiceProtectionConfigRedisSentinelNodeArgs

Host string
A string representing a host name, such as example.com.
Port double
An integer representing a port number between 0 and 65535, inclusive.
Host string
A string representing a host name, such as example.com.
Port float64
An integer representing a port number between 0 and 65535, inclusive.
host String
A string representing a host name, such as example.com.
port Double
An integer representing a port number between 0 and 65535, inclusive.
host string
A string representing a host name, such as example.com.
port number
An integer representing a port number between 0 and 65535, inclusive.
host str
A string representing a host name, such as example.com.
port float
An integer representing a port number between 0 and 65535, inclusive.
host String
A string representing a host name, such as example.com.
port Number
An integer representing a port number between 0 and 65535, inclusive.

GatewayPluginServiceProtectionOrdering
, GatewayPluginServiceProtectionOrderingArgs

GatewayPluginServiceProtectionOrderingAfter
, GatewayPluginServiceProtectionOrderingAfterArgs

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

GatewayPluginServiceProtectionOrderingBefore
, GatewayPluginServiceProtectionOrderingBeforeArgs

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

GatewayPluginServiceProtectionService
, GatewayPluginServiceProtectionServiceArgs

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

Import

$ pulumi import konnect:index/gatewayPluginServiceProtection:GatewayPluginServiceProtection my_konnect_gateway_plugin_service_protection "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_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.