konnect 2.4.1, Mar 13 25

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

konnect.GatewayPluginOpa

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.GatewayPluginOpa;
import com.pulumi.konnect.GatewayPluginOpaArgs;
import com.pulumi.konnect.inputs.GatewayPluginOpaConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginOpaOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginOpaOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginOpaOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginOpaRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginOpaServiceArgs;
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 myGatewaypluginopa = new GatewayPluginOpa("myGatewaypluginopa", GatewayPluginOpaArgs.builder()
            .config(GatewayPluginOpaConfigArgs.builder()
                .include_body_in_opa_input(true)
                .include_consumer_in_opa_input(true)
                .include_parsed_json_body_in_opa_input(true)
                .include_route_in_opa_input(false)
                .include_service_in_opa_input(true)
                .include_uri_captures_in_opa_input(false)
                .opa_host("...my_opa_host...")
                .opa_path("...my_opa_path...")
                .opa_port(43549)
                .opa_protocol("https")
                .ssl_verify(false)
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .gatewayPluginOpaId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginOpaOrderingArgs.builder()
                .after(GatewayPluginOpaOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginOpaOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("grpcs")
            .route(GatewayPluginOpaRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginOpaServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

resources:
  myGatewaypluginopa:
    type: konnect:GatewayPluginOpa
    properties:
      config:
        include_body_in_opa_input: true
        include_consumer_in_opa_input: true
        include_parsed_json_body_in_opa_input: true
        include_route_in_opa_input: false
        include_service_in_opa_input: true
        include_uri_captures_in_opa_input: false
        opa_host: '...my_opa_host...'
        opa_path: '...my_opa_path...'
        opa_port: 43549
        opa_protocol: https
        ssl_verify: false
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      gatewayPluginOpaId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - grpcs
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

Create GatewayPluginOpa Resource

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

Constructor syntax

new GatewayPluginOpa(name: string, args: GatewayPluginOpaArgs, opts?: CustomResourceOptions);

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

@overload
def GatewayPluginOpa(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     config: Optional[GatewayPluginOpaConfigArgs] = None,
                     control_plane_id: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     gateway_plugin_opa_id: Optional[str] = None,
                     instance_name: Optional[str] = None,
                     ordering: Optional[GatewayPluginOpaOrderingArgs] = None,
                     protocols: Optional[Sequence[str]] = None,
                     route: Optional[GatewayPluginOpaRouteArgs] = None,
                     service: Optional[GatewayPluginOpaServiceArgs] = None,
                     tags: Optional[Sequence[str]] = None)

func NewGatewayPluginOpa(ctx *Context, name string, args GatewayPluginOpaArgs, opts ...ResourceOption) (*GatewayPluginOpa, error)

public GatewayPluginOpa(string name, GatewayPluginOpaArgs args, CustomResourceOptions? opts = null)

public GatewayPluginOpa(String name, GatewayPluginOpaArgs args)
public GatewayPluginOpa(String name, GatewayPluginOpaArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args GatewayPluginOpaArgs: 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 gatewayPluginOpaResource = new Konnect.GatewayPluginOpa("gatewayPluginOpaResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginOpaConfigArgs
    {
        IncludeBodyInOpaInput = false,
        IncludeConsumerInOpaInput = false,
        IncludeParsedJsonBodyInOpaInput = false,
        IncludeRouteInOpaInput = false,
        IncludeServiceInOpaInput = false,
        IncludeUriCapturesInOpaInput = false,
        OpaHost = "string",
        OpaPath = "string",
        OpaPort = 0,
        OpaProtocol = "string",
        SslVerify = false,
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginOpaId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginOpaOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginOpaOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginOpaOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginOpaRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginOpaServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := konnect.NewGatewayPluginOpa(ctx, "gatewayPluginOpaResource", &konnect.GatewayPluginOpaArgs{
Config: &.GatewayPluginOpaConfigArgs{
IncludeBodyInOpaInput: pulumi.Bool(false),
IncludeConsumerInOpaInput: pulumi.Bool(false),
IncludeParsedJsonBodyInOpaInput: pulumi.Bool(false),
IncludeRouteInOpaInput: pulumi.Bool(false),
IncludeServiceInOpaInput: pulumi.Bool(false),
IncludeUriCapturesInOpaInput: pulumi.Bool(false),
OpaHost: pulumi.String("string"),
OpaPath: pulumi.String("string"),
OpaPort: pulumi.Float64(0),
OpaProtocol: pulumi.String("string"),
SslVerify: pulumi.Bool(false),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginOpaId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginOpaOrderingArgs{
After: &.GatewayPluginOpaOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginOpaOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginOpaRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginOpaServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

var gatewayPluginOpaResource = new GatewayPluginOpa("gatewayPluginOpaResource", GatewayPluginOpaArgs.builder()
    .config(GatewayPluginOpaConfigArgs.builder()
        .includeBodyInOpaInput(false)
        .includeConsumerInOpaInput(false)
        .includeParsedJsonBodyInOpaInput(false)
        .includeRouteInOpaInput(false)
        .includeServiceInOpaInput(false)
        .includeUriCapturesInOpaInput(false)
        .opaHost("string")
        .opaPath("string")
        .opaPort(0)
        .opaProtocol("string")
        .sslVerify(false)
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginOpaId("string")
    .instanceName("string")
    .ordering(GatewayPluginOpaOrderingArgs.builder()
        .after(GatewayPluginOpaOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginOpaOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginOpaRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginOpaServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

gateway_plugin_opa_resource = konnect.GatewayPluginOpa("gatewayPluginOpaResource",
    config={
        "include_body_in_opa_input": False,
        "include_consumer_in_opa_input": False,
        "include_parsed_json_body_in_opa_input": False,
        "include_route_in_opa_input": False,
        "include_service_in_opa_input": False,
        "include_uri_captures_in_opa_input": False,
        "opa_host": "string",
        "opa_path": "string",
        "opa_port": 0,
        "opa_protocol": "string",
        "ssl_verify": False,
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_opa_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

const gatewayPluginOpaResource = new konnect.GatewayPluginOpa("gatewayPluginOpaResource", {
    config: {
        includeBodyInOpaInput: false,
        includeConsumerInOpaInput: false,
        includeParsedJsonBodyInOpaInput: false,
        includeRouteInOpaInput: false,
        includeServiceInOpaInput: false,
        includeUriCapturesInOpaInput: false,
        opaHost: "string",
        opaPath: "string",
        opaPort: 0,
        opaProtocol: "string",
        sslVerify: false,
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginOpaId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

type: konnect:GatewayPluginOpa
properties:
    config:
        includeBodyInOpaInput: false
        includeConsumerInOpaInput: false
        includeParsedJsonBodyInOpaInput: false
        includeRouteInOpaInput: false
        includeServiceInOpaInput: false
        includeUriCapturesInOpaInput: false
        opaHost: string
        opaPath: string
        opaPort: 0
        opaProtocol: string
        sslVerify: false
    controlPlaneId: string
    enabled: false
    gatewayPluginOpaId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

Config GatewayPluginOpaConfig
ControlPlaneId 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.
GatewayPluginOpaId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginOpaOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginOpaRoute: 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 GatewayPluginOpaService: 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 GatewayPluginOpaConfigArgs
ControlPlaneId 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.
GatewayPluginOpaId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginOpaOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginOpaRouteArgs: 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 GatewayPluginOpaServiceArgs: 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 GatewayPluginOpaConfig
controlPlaneId 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.
gatewayPluginOpaId String: The ID of this resource.
instanceName String
ordering GatewayPluginOpaOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginOpaRoute: 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 GatewayPluginOpaService: 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 GatewayPluginOpaConfig
controlPlaneId 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.
gatewayPluginOpaId string: The ID of this resource.
instanceName string
ordering GatewayPluginOpaOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginOpaRoute: 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 GatewayPluginOpaService: 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 GatewayPluginOpaConfigArgs
control_plane_id 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_opa_id str: The ID of this resource.
instance_name str
ordering GatewayPluginOpaOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginOpaRouteArgs: 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 GatewayPluginOpaServiceArgs: 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.
enabled Boolean: Whether the plugin is applied.
gatewayPluginOpaId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A set of strings representing HTTP 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 GatewayPluginOpa 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 GatewayPluginOpa Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginOpaConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_opa_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginOpaOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginOpaRouteArgs] = None,
        service: Optional[GatewayPluginOpaServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginOpa

func GetGatewayPluginOpa(ctx *Context, name string, id IDInput, state *GatewayPluginOpaState, opts ...ResourceOption) (*GatewayPluginOpa, error)

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

public static GatewayPluginOpa get(String name, Output<String> id, GatewayPluginOpaState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginOpa    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 GatewayPluginOpaConfig
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.
GatewayPluginOpaId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginOpaOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginOpaRoute: 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 GatewayPluginOpaService: 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 GatewayPluginOpaConfigArgs
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.
GatewayPluginOpaId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginOpaOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginOpaRouteArgs: 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 GatewayPluginOpaServiceArgs: 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 GatewayPluginOpaConfig
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.
gatewayPluginOpaId String: The ID of this resource.
instanceName String
ordering GatewayPluginOpaOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginOpaRoute: 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 GatewayPluginOpaService: 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 GatewayPluginOpaConfig
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.
gatewayPluginOpaId string: The ID of this resource.
instanceName string
ordering GatewayPluginOpaOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginOpaRoute: 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 GatewayPluginOpaService: 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 GatewayPluginOpaConfigArgs
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_opa_id str: The ID of this resource.
instance_name str
ordering GatewayPluginOpaOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginOpaRouteArgs: 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 GatewayPluginOpaServiceArgs: 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.
gatewayPluginOpaId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A set of strings representing HTTP 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

GatewayPluginOpaConfig, GatewayPluginOpaConfigArgs

IncludeBodyInOpaInput bool
IncludeConsumerInOpaInput bool: If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.
IncludeParsedJsonBodyInOpaInput bool: If set to true and the Content-Type header of the current request is application/json, the request body will be JSON decoded and the decoded struct is included as input to OPA.
IncludeRouteInOpaInput bool: If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.
IncludeServiceInOpaInput bool: If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.
IncludeUriCapturesInOpaInput bool: If set to true, the regex capture groups captured on the Kong Gateway Route's path field in the current request (if any) are included as input to OPA.
OpaHost string: A string representing a host name, such as example.com.
OpaPath string: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
OpaPort double: An integer representing a port number between 0 and 65535, inclusive.
OpaProtocol string: The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are http and https. must be one of ["http", "https"]
SslVerify bool: If set to true, the OPA certificate will be verified according to the CA certificates specified in luassltrusted_certificate.

IncludeBodyInOpaInput bool
IncludeConsumerInOpaInput bool: If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.
IncludeParsedJsonBodyInOpaInput bool: If set to true and the Content-Type header of the current request is application/json, the request body will be JSON decoded and the decoded struct is included as input to OPA.
IncludeRouteInOpaInput bool: If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.
IncludeServiceInOpaInput bool: If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.
IncludeUriCapturesInOpaInput bool: If set to true, the regex capture groups captured on the Kong Gateway Route's path field in the current request (if any) are included as input to OPA.
OpaHost string: A string representing a host name, such as example.com.
OpaPath string: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
OpaPort float64: An integer representing a port number between 0 and 65535, inclusive.
OpaProtocol string: The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are http and https. must be one of ["http", "https"]
SslVerify bool: If set to true, the OPA certificate will be verified according to the CA certificates specified in luassltrusted_certificate.

includeBodyInOpaInput Boolean
includeConsumerInOpaInput Boolean: If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.
includeParsedJsonBodyInOpaInput Boolean: If set to true and the Content-Type header of the current request is application/json, the request body will be JSON decoded and the decoded struct is included as input to OPA.
includeRouteInOpaInput Boolean: If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.
includeServiceInOpaInput Boolean: If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.
includeUriCapturesInOpaInput Boolean: If set to true, the regex capture groups captured on the Kong Gateway Route's path field in the current request (if any) are included as input to OPA.
opaHost String: A string representing a host name, such as example.com.
opaPath String: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
opaPort Double: An integer representing a port number between 0 and 65535, inclusive.
opaProtocol String: The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are http and https. must be one of ["http", "https"]
sslVerify Boolean: If set to true, the OPA certificate will be verified according to the CA certificates specified in luassltrusted_certificate.

includeBodyInOpaInput boolean
includeConsumerInOpaInput boolean: If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.
includeParsedJsonBodyInOpaInput boolean: If set to true and the Content-Type header of the current request is application/json, the request body will be JSON decoded and the decoded struct is included as input to OPA.
includeRouteInOpaInput boolean: If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.
includeServiceInOpaInput boolean: If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.
includeUriCapturesInOpaInput boolean: If set to true, the regex capture groups captured on the Kong Gateway Route's path field in the current request (if any) are included as input to OPA.
opaHost string: A string representing a host name, such as example.com.
opaPath string: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
opaPort number: An integer representing a port number between 0 and 65535, inclusive.
opaProtocol string: The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are http and https. must be one of ["http", "https"]
sslVerify boolean: If set to true, the OPA certificate will be verified according to the CA certificates specified in luassltrusted_certificate.

include_body_in_opa_input bool
include_consumer_in_opa_input bool: If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.
include_parsed_json_body_in_opa_input bool: If set to true and the Content-Type header of the current request is application/json, the request body will be JSON decoded and the decoded struct is included as input to OPA.
include_route_in_opa_input bool: If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.
include_service_in_opa_input bool: If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.
include_uri_captures_in_opa_input bool: If set to true, the regex capture groups captured on the Kong Gateway Route's path field in the current request (if any) are included as input to OPA.
opa_host str: A string representing a host name, such as example.com.
opa_path str: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
opa_port float: An integer representing a port number between 0 and 65535, inclusive.
opa_protocol str: The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are http and https. must be one of ["http", "https"]
ssl_verify bool: If set to true, the OPA certificate will be verified according to the CA certificates specified in luassltrusted_certificate.

includeBodyInOpaInput Boolean
includeConsumerInOpaInput Boolean: If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.
includeParsedJsonBodyInOpaInput Boolean: If set to true and the Content-Type header of the current request is application/json, the request body will be JSON decoded and the decoded struct is included as input to OPA.
includeRouteInOpaInput Boolean: If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.
includeServiceInOpaInput Boolean: If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.
includeUriCapturesInOpaInput Boolean: If set to true, the regex capture groups captured on the Kong Gateway Route's path field in the current request (if any) are included as input to OPA.
opaHost String: A string representing a host name, such as example.com.
opaPath String: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
opaPort Number: An integer representing a port number between 0 and 65535, inclusive.
opaProtocol String: The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are http and https. must be one of ["http", "https"]
sslVerify Boolean: If set to true, the OPA certificate will be verified according to the CA certificates specified in luassltrusted_certificate.

GatewayPluginOpaOrdering, GatewayPluginOpaOrderingArgs

After GatewayPluginOpaOrderingAfter
Before GatewayPluginOpaOrderingBefore

After GatewayPluginOpaOrderingAfter
Before GatewayPluginOpaOrderingBefore

after GatewayPluginOpaOrderingAfter
before GatewayPluginOpaOrderingBefore

after GatewayPluginOpaOrderingAfter
before GatewayPluginOpaOrderingBefore

after GatewayPluginOpaOrderingAfter
before GatewayPluginOpaOrderingBefore

after Property Map
before Property Map

GatewayPluginOpaOrderingAfter, GatewayPluginOpaOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginOpaOrderingBefore, GatewayPluginOpaOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginOpaRoute, GatewayPluginOpaRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginOpaService, GatewayPluginOpaServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginOpa:GatewayPluginOpa my_konnect_gateway_plugin_opa "{ \"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.GatewayPluginOpa

On this page

On this page

Example Usage

Create GatewayPluginOpa Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginOpa Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginOpa Resource

Supporting Types

GatewayPluginOpaConfig, GatewayPluginOpaConfigArgs

GatewayPluginOpaOrdering, GatewayPluginOpaOrderingArgs

GatewayPluginOpaOrderingAfter, GatewayPluginOpaOrderingAfterArgs

GatewayPluginOpaOrderingBefore, GatewayPluginOpaOrderingBeforeArgs

GatewayPluginOpaRoute, GatewayPluginOpaRouteArgs

GatewayPluginOpaService, GatewayPluginOpaServiceArgs

Import

Package Details

On this page

On this page