konnect 2.4.1, Mar 13 25

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

konnect.GatewayPluginIpRestriction

Explore with Pulumi AI

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

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginIpRestriction;
import com.pulumi.konnect.GatewayPluginIpRestrictionArgs;
import com.pulumi.konnect.inputs.GatewayPluginIpRestrictionConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginIpRestrictionConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginIpRestrictionConsumerGroupArgs;
import com.pulumi.konnect.inputs.GatewayPluginIpRestrictionOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginIpRestrictionOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginIpRestrictionOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginIpRestrictionRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginIpRestrictionServiceArgs;
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 myGatewaypluginiprestriction = new GatewayPluginIpRestriction("myGatewaypluginiprestriction", GatewayPluginIpRestrictionArgs.builder()
            .config(GatewayPluginIpRestrictionConfigArgs.builder()
                .allow("...")
                .deny("...")
                .message("...my_message...")
                .status(3.69)
                .build())
            .consumer(GatewayPluginIpRestrictionConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerGroup(GatewayPluginIpRestrictionConsumerGroupArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginIpRestrictionId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginIpRestrictionOrderingArgs.builder()
                .after(GatewayPluginIpRestrictionOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginIpRestrictionOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("tls")
            .route(GatewayPluginIpRestrictionRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginIpRestrictionServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

resources:
  myGatewaypluginiprestriction:
    type: konnect:GatewayPluginIpRestriction
    properties:
      config:
        allow:
          - '...'
        deny:
          - '...'
        message: '...my_message...'
        status: 3.69
      consumer:
        id: '...my_id...'
      consumerGroup:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginIpRestrictionId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - tls
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

Create GatewayPluginIpRestriction Resource

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

Constructor syntax

new GatewayPluginIpRestriction(name: string, args: GatewayPluginIpRestrictionArgs, opts?: CustomResourceOptions);

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

@overload
def GatewayPluginIpRestriction(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               config: Optional[GatewayPluginIpRestrictionConfigArgs] = None,
                               control_plane_id: Optional[str] = None,
                               consumer: Optional[GatewayPluginIpRestrictionConsumerArgs] = None,
                               consumer_group: Optional[GatewayPluginIpRestrictionConsumerGroupArgs] = None,
                               enabled: Optional[bool] = None,
                               gateway_plugin_ip_restriction_id: Optional[str] = None,
                               instance_name: Optional[str] = None,
                               ordering: Optional[GatewayPluginIpRestrictionOrderingArgs] = None,
                               protocols: Optional[Sequence[str]] = None,
                               route: Optional[GatewayPluginIpRestrictionRouteArgs] = None,
                               service: Optional[GatewayPluginIpRestrictionServiceArgs] = None,
                               tags: Optional[Sequence[str]] = None)

func NewGatewayPluginIpRestriction(ctx *Context, name string, args GatewayPluginIpRestrictionArgs, opts ...ResourceOption) (*GatewayPluginIpRestriction, error)

public GatewayPluginIpRestriction(string name, GatewayPluginIpRestrictionArgs args, CustomResourceOptions? opts = null)

public GatewayPluginIpRestriction(String name, GatewayPluginIpRestrictionArgs args)
public GatewayPluginIpRestriction(String name, GatewayPluginIpRestrictionArgs args, CustomResourceOptions options)

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

Parameters

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

resource_name str: The unique name of the resource.
args GatewayPluginIpRestrictionArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GatewayPluginIpRestrictionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args GatewayPluginIpRestrictionArgs: 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 gatewayPluginIpRestrictionResource = new Konnect.GatewayPluginIpRestriction("gatewayPluginIpRestrictionResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginIpRestrictionConfigArgs
    {
        Allows = new[]
        {
            "string",
        },
        Denies = new[]
        {
            "string",
        },
        Message = "string",
        Status = 0,
    },
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayPluginIpRestrictionConsumerArgs
    {
        Id = "string",
    },
    ConsumerGroup = new Konnect.Inputs.GatewayPluginIpRestrictionConsumerGroupArgs
    {
        Id = "string",
    },
    Enabled = false,
    GatewayPluginIpRestrictionId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginIpRestrictionOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginIpRestrictionOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginIpRestrictionOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginIpRestrictionRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginIpRestrictionServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := konnect.NewGatewayPluginIpRestriction(ctx, "gatewayPluginIpRestrictionResource", &konnect.GatewayPluginIpRestrictionArgs{
Config: &.GatewayPluginIpRestrictionConfigArgs{
Allows: pulumi.StringArray{
pulumi.String("string"),
},
Denies: pulumi.StringArray{
pulumi.String("string"),
},
Message: pulumi.String("string"),
Status: pulumi.Float64(0),
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginIpRestrictionConsumerArgs{
Id: pulumi.String("string"),
},
ConsumerGroup: &.GatewayPluginIpRestrictionConsumerGroupArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginIpRestrictionId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginIpRestrictionOrderingArgs{
After: &.GatewayPluginIpRestrictionOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginIpRestrictionOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginIpRestrictionRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginIpRestrictionServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

var gatewayPluginIpRestrictionResource = new GatewayPluginIpRestriction("gatewayPluginIpRestrictionResource", GatewayPluginIpRestrictionArgs.builder()
    .config(GatewayPluginIpRestrictionConfigArgs.builder()
        .allows("string")
        .denies("string")
        .message("string")
        .status(0)
        .build())
    .controlPlaneId("string")
    .consumer(GatewayPluginIpRestrictionConsumerArgs.builder()
        .id("string")
        .build())
    .consumerGroup(GatewayPluginIpRestrictionConsumerGroupArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .gatewayPluginIpRestrictionId("string")
    .instanceName("string")
    .ordering(GatewayPluginIpRestrictionOrderingArgs.builder()
        .after(GatewayPluginIpRestrictionOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginIpRestrictionOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginIpRestrictionRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginIpRestrictionServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

gateway_plugin_ip_restriction_resource = konnect.GatewayPluginIpRestriction("gatewayPluginIpRestrictionResource",
    config={
        "allows": ["string"],
        "denies": ["string"],
        "message": "string",
        "status": 0,
    },
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    consumer_group={
        "id": "string",
    },
    enabled=False,
    gateway_plugin_ip_restriction_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

const gatewayPluginIpRestrictionResource = new konnect.GatewayPluginIpRestriction("gatewayPluginIpRestrictionResource", {
    config: {
        allows: ["string"],
        denies: ["string"],
        message: "string",
        status: 0,
    },
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    consumerGroup: {
        id: "string",
    },
    enabled: false,
    gatewayPluginIpRestrictionId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

type: konnect:GatewayPluginIpRestriction
properties:
    config:
        allows:
            - string
        denies:
            - string
        message: string
        status: 0
    consumer:
        id: string
    consumerGroup:
        id: string
    controlPlaneId: string
    enabled: false
    gatewayPluginIpRestrictionId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

Config GatewayPluginIpRestrictionConfig
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginIpRestrictionConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginIpRestrictionConsumerGroup: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
Enabled bool: Whether the plugin is applied.
GatewayPluginIpRestrictionId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginIpRestrictionOrdering
Protocols List<string>: A set of strings representing protocols.
Route GatewayPluginIpRestrictionRoute: 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 GatewayPluginIpRestrictionService: 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 GatewayPluginIpRestrictionConfigArgs
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginIpRestrictionConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginIpRestrictionConsumerGroupArgs: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
Enabled bool: Whether the plugin is applied.
GatewayPluginIpRestrictionId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginIpRestrictionOrderingArgs
Protocols []string: A set of strings representing protocols.
Route GatewayPluginIpRestrictionRouteArgs: 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 GatewayPluginIpRestrictionServiceArgs: 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 GatewayPluginIpRestrictionConfig
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginIpRestrictionConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginIpRestrictionConsumerGroup: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
enabled Boolean: Whether the plugin is applied.
gatewayPluginIpRestrictionId String: The ID of this resource.
instanceName String
ordering GatewayPluginIpRestrictionOrdering
protocols List<String>: A set of strings representing protocols.
route GatewayPluginIpRestrictionRoute: 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 GatewayPluginIpRestrictionService: 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 GatewayPluginIpRestrictionConfig
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginIpRestrictionConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginIpRestrictionConsumerGroup: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
enabled boolean: Whether the plugin is applied.
gatewayPluginIpRestrictionId string: The ID of this resource.
instanceName string
ordering GatewayPluginIpRestrictionOrdering
protocols string[]: A set of strings representing protocols.
route GatewayPluginIpRestrictionRoute: 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 GatewayPluginIpRestrictionService: 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 GatewayPluginIpRestrictionConfigArgs
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginIpRestrictionConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumer_group GatewayPluginIpRestrictionConsumerGroupArgs: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
enabled bool: Whether the plugin is applied.
gateway_plugin_ip_restriction_id str: The ID of this resource.
instance_name str
ordering GatewayPluginIpRestrictionOrderingArgs
protocols Sequence[str]: A set of strings representing protocols.
route GatewayPluginIpRestrictionRouteArgs: 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 GatewayPluginIpRestrictionServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.

config Property Map
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer Property Map: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup Property Map: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
enabled Boolean: Whether the plugin is applied.
gatewayPluginIpRestrictionId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A set of strings representing protocols.
route Property Map: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayPluginIpRestriction 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 GatewayPluginIpRestriction Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginIpRestrictionConfigArgs] = None,
        consumer: Optional[GatewayPluginIpRestrictionConsumerArgs] = None,
        consumer_group: Optional[GatewayPluginIpRestrictionConsumerGroupArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_ip_restriction_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginIpRestrictionOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginIpRestrictionRouteArgs] = None,
        service: Optional[GatewayPluginIpRestrictionServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginIpRestriction

func GetGatewayPluginIpRestriction(ctx *Context, name string, id IDInput, state *GatewayPluginIpRestrictionState, opts ...ResourceOption) (*GatewayPluginIpRestriction, error)

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

public static GatewayPluginIpRestriction get(String name, Output<String> id, GatewayPluginIpRestrictionState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginIpRestriction    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Config GatewayPluginIpRestrictionConfig
Consumer GatewayPluginIpRestrictionConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginIpRestrictionConsumerGroup: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginIpRestrictionId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginIpRestrictionOrdering
Protocols List<string>: A set of strings representing protocols.
Route GatewayPluginIpRestrictionRoute: 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 GatewayPluginIpRestrictionService: 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 GatewayPluginIpRestrictionConfigArgs
Consumer GatewayPluginIpRestrictionConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginIpRestrictionConsumerGroupArgs: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginIpRestrictionId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginIpRestrictionOrderingArgs
Protocols []string: A set of strings representing protocols.
Route GatewayPluginIpRestrictionRouteArgs: 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 GatewayPluginIpRestrictionServiceArgs: 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 GatewayPluginIpRestrictionConfig
consumer GatewayPluginIpRestrictionConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginIpRestrictionConsumerGroup: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginIpRestrictionId String: The ID of this resource.
instanceName String
ordering GatewayPluginIpRestrictionOrdering
protocols List<String>: A set of strings representing protocols.
route GatewayPluginIpRestrictionRoute: 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 GatewayPluginIpRestrictionService: 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 GatewayPluginIpRestrictionConfig
consumer GatewayPluginIpRestrictionConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginIpRestrictionConsumerGroup: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number: Unix epoch when the resource was created.
enabled boolean: Whether the plugin is applied.
gatewayPluginIpRestrictionId string: The ID of this resource.
instanceName string
ordering GatewayPluginIpRestrictionOrdering
protocols string[]: A set of strings representing protocols.
route GatewayPluginIpRestrictionRoute: 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 GatewayPluginIpRestrictionService: 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 GatewayPluginIpRestrictionConfigArgs
consumer GatewayPluginIpRestrictionConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumer_group GatewayPluginIpRestrictionConsumerGroupArgs: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
created_at float: Unix epoch when the resource was created.
enabled bool: Whether the plugin is applied.
gateway_plugin_ip_restriction_id str: The ID of this resource.
instance_name str
ordering GatewayPluginIpRestrictionOrderingArgs
protocols Sequence[str]: A set of strings representing protocols.
route GatewayPluginIpRestrictionRouteArgs: 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 GatewayPluginIpRestrictionServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float: Unix epoch when the resource was last updated.

config Property Map
consumer Property Map: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup Property Map: If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginIpRestrictionId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A set of strings representing protocols.
route Property Map: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number: Unix epoch when the resource was last updated.

Supporting Types

GatewayPluginIpRestrictionConfig, GatewayPluginIpRestrictionConfigArgs

Allows List<string>: List of IPs or CIDR ranges to allow. One of config.allow or config.deny must be specified.
Denies List<string>: List of IPs or CIDR ranges to deny. One of config.allow or config.deny must be specified.
Message string: The message to send as a response body to rejected requests.
Status double: The HTTP status of the requests that will be rejected by the plugin.

Allows []string: List of IPs or CIDR ranges to allow. One of config.allow or config.deny must be specified.
Denies []string: List of IPs or CIDR ranges to deny. One of config.allow or config.deny must be specified.
Message string: The message to send as a response body to rejected requests.
Status float64: The HTTP status of the requests that will be rejected by the plugin.

allows List<String>: List of IPs or CIDR ranges to allow. One of config.allow or config.deny must be specified.
denies List<String>: List of IPs or CIDR ranges to deny. One of config.allow or config.deny must be specified.
message String: The message to send as a response body to rejected requests.
status Double: The HTTP status of the requests that will be rejected by the plugin.

allows string[]: List of IPs or CIDR ranges to allow. One of config.allow or config.deny must be specified.
denies string[]: List of IPs or CIDR ranges to deny. One of config.allow or config.deny must be specified.
message string: The message to send as a response body to rejected requests.
status number: The HTTP status of the requests that will be rejected by the plugin.

allows Sequence[str]: List of IPs or CIDR ranges to allow. One of config.allow or config.deny must be specified.
denies Sequence[str]: List of IPs or CIDR ranges to deny. One of config.allow or config.deny must be specified.
message str: The message to send as a response body to rejected requests.
status float: The HTTP status of the requests that will be rejected by the plugin.

allows List<String>: List of IPs or CIDR ranges to allow. One of config.allow or config.deny must be specified.
denies List<String>: List of IPs or CIDR ranges to deny. One of config.allow or config.deny must be specified.
message String: The message to send as a response body to rejected requests.
status Number: The HTTP status of the requests that will be rejected by the plugin.

GatewayPluginIpRestrictionConsumer, GatewayPluginIpRestrictionConsumerArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginIpRestrictionConsumerGroup, GatewayPluginIpRestrictionConsumerGroupArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginIpRestrictionOrdering, GatewayPluginIpRestrictionOrderingArgs

After GatewayPluginIpRestrictionOrderingAfter
Before GatewayPluginIpRestrictionOrderingBefore

After GatewayPluginIpRestrictionOrderingAfter
Before GatewayPluginIpRestrictionOrderingBefore

after GatewayPluginIpRestrictionOrderingAfter
before GatewayPluginIpRestrictionOrderingBefore

after GatewayPluginIpRestrictionOrderingAfter
before GatewayPluginIpRestrictionOrderingBefore

after GatewayPluginIpRestrictionOrderingAfter
before GatewayPluginIpRestrictionOrderingBefore

after Property Map
before Property Map

GatewayPluginIpRestrictionOrderingAfter, GatewayPluginIpRestrictionOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginIpRestrictionOrderingBefore, GatewayPluginIpRestrictionOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginIpRestrictionRoute, GatewayPluginIpRestrictionRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginIpRestrictionService, GatewayPluginIpRestrictionServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

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

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

Package Details

Repository: konnect kong/terraform-provider-konnect
License
Notes: This Pulumi package is based on the konnect Terraform Provider.

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

kong/terraform-provider-konnect

konnect.GatewayPluginIpRestriction

On this page

On this page

Example Usage

Create GatewayPluginIpRestriction Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginIpRestriction Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginIpRestriction Resource

Supporting Types

GatewayPluginIpRestrictionConfig, GatewayPluginIpRestrictionConfigArgs

GatewayPluginIpRestrictionConsumer, GatewayPluginIpRestrictionConsumerArgs

GatewayPluginIpRestrictionConsumerGroup, GatewayPluginIpRestrictionConsumerGroupArgs

GatewayPluginIpRestrictionOrdering, GatewayPluginIpRestrictionOrderingArgs

GatewayPluginIpRestrictionOrderingAfter, GatewayPluginIpRestrictionOrderingAfterArgs

GatewayPluginIpRestrictionOrderingBefore, GatewayPluginIpRestrictionOrderingBeforeArgs

GatewayPluginIpRestrictionRoute, GatewayPluginIpRestrictionRouteArgs

GatewayPluginIpRestrictionService, GatewayPluginIpRestrictionServiceArgs

Import

Package Details

On this page

On this page