konnect 2.11.1, Jul 15 25

konnect 2.11.1 published on Tuesday, Jul 15, 2025 by kong

konnect.GatewayPluginOasValidation

Explore with Pulumi AI

konnect 2.11.1 published on Tuesday, Jul 15, 2025 by kong

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginOasValidation;
import com.pulumi.konnect.GatewayPluginOasValidationArgs;
import com.pulumi.konnect.inputs.GatewayPluginOasValidationConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginOasValidationConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginOasValidationOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginOasValidationOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginOasValidationOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginOasValidationPartialArgs;
import com.pulumi.konnect.inputs.GatewayPluginOasValidationRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginOasValidationServiceArgs;
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 myGatewaypluginoasvalidation = new GatewayPluginOasValidation("myGatewaypluginoasvalidation", GatewayPluginOasValidationArgs.builder()
            .config(GatewayPluginOasValidationConfigArgs.builder()
                .allowed_header_parameters("...my_allowed_header_parameters...")
                .api_spec("...my_api_spec...")
                .api_spec_encoded(false)
                .custom_base_path("...my_custom_base_path...")
                .header_parameter_check(false)
                .include_base_path(true)
                .notify_only_request_validation_failure(false)
                .notify_only_response_body_validation_failure(true)
                .query_parameter_check(true)
                .validate_request_body(true)
                .validate_request_header_params(true)
                .validate_request_query_params(false)
                .validate_request_uri_params(true)
                .validate_response_body(false)
                .verbose_response(true)
                .build())
            .consumer(GatewayPluginOasValidationConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(4)
            .enabled(true)
            .gatewayPluginOasValidationId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginOasValidationOrderingArgs.builder()
                .after(GatewayPluginOasValidationOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginOasValidationOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .partials(GatewayPluginOasValidationPartialArgs.builder()
                .id("...my_id...")
                .name("...my_name...")
                .path("...my_path...")
                .build())
            .protocols("https")
            .route(GatewayPluginOasValidationRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginOasValidationServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .updatedAt(9)
            .build());

    }
}

resources:
  myGatewaypluginoasvalidation:
    type: konnect:GatewayPluginOasValidation
    properties:
      config:
        allowed_header_parameters: '...my_allowed_header_parameters...'
        api_spec: '...my_api_spec...'
        api_spec_encoded: false
        custom_base_path: '...my_custom_base_path...'
        header_parameter_check: false
        include_base_path: true
        notify_only_request_validation_failure: false
        notify_only_response_body_validation_failure: true
        query_parameter_check: true
        validate_request_body: true
        validate_request_header_params: true
        validate_request_query_params: false
        validate_request_uri_params: true
        validate_response_body: false
        verbose_response: true
      consumer:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 4
      enabled: true
      gatewayPluginOasValidationId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      partials:
        - id: '...my_id...'
          name: '...my_name...'
          path: '...my_path...'
      protocols:
        - https
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
      updatedAt: 9

Create GatewayPluginOasValidation Resource

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

Constructor syntax

new GatewayPluginOasValidation(name: string, args: GatewayPluginOasValidationArgs, opts?: CustomResourceOptions);

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

@overload
def GatewayPluginOasValidation(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               control_plane_id: Optional[str] = None,
                               instance_name: Optional[str] = None,
                               consumer: Optional[GatewayPluginOasValidationConsumerArgs] = None,
                               created_at: Optional[float] = None,
                               enabled: Optional[bool] = None,
                               gateway_plugin_oas_validation_id: Optional[str] = None,
                               config: Optional[GatewayPluginOasValidationConfigArgs] = None,
                               ordering: Optional[GatewayPluginOasValidationOrderingArgs] = None,
                               partials: Optional[Sequence[GatewayPluginOasValidationPartialArgs]] = None,
                               protocols: Optional[Sequence[str]] = None,
                               route: Optional[GatewayPluginOasValidationRouteArgs] = None,
                               service: Optional[GatewayPluginOasValidationServiceArgs] = None,
                               tags: Optional[Sequence[str]] = None,
                               updated_at: Optional[float] = None)

func NewGatewayPluginOasValidation(ctx *Context, name string, args GatewayPluginOasValidationArgs, opts ...ResourceOption) (*GatewayPluginOasValidation, error)

public GatewayPluginOasValidation(string name, GatewayPluginOasValidationArgs args, CustomResourceOptions? opts = null)

public GatewayPluginOasValidation(String name, GatewayPluginOasValidationArgs args)
public GatewayPluginOasValidation(String name, GatewayPluginOasValidationArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args GatewayPluginOasValidationArgs: 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 gatewayPluginOasValidationResource = new Konnect.GatewayPluginOasValidation("gatewayPluginOasValidationResource", new()
{
    ControlPlaneId = "string",
    InstanceName = "string",
    Consumer = new Konnect.Inputs.GatewayPluginOasValidationConsumerArgs
    {
        Id = "string",
    },
    CreatedAt = 0,
    Enabled = false,
    GatewayPluginOasValidationId = "string",
    Config = new Konnect.Inputs.GatewayPluginOasValidationConfigArgs
    {
        AllowedHeaderParameters = "string",
        ApiSpec = "string",
        ApiSpecEncoded = false,
        CustomBasePath = "string",
        HeaderParameterCheck = false,
        IncludeBasePath = false,
        NotifyOnlyRequestValidationFailure = false,
        NotifyOnlyResponseBodyValidationFailure = false,
        QueryParameterCheck = false,
        ValidateRequestBody = false,
        ValidateRequestHeaderParams = false,
        ValidateRequestQueryParams = false,
        ValidateRequestUriParams = false,
        ValidateResponseBody = false,
        VerboseResponse = false,
    },
    Ordering = new Konnect.Inputs.GatewayPluginOasValidationOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginOasValidationOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginOasValidationOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Partials = new[]
    {
        new Konnect.Inputs.GatewayPluginOasValidationPartialArgs
        {
            Id = "string",
            Name = "string",
            Path = "string",
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginOasValidationRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginOasValidationServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
});

example, err := konnect.NewGatewayPluginOasValidation(ctx, "gatewayPluginOasValidationResource", &konnect.GatewayPluginOasValidationArgs{
	ControlPlaneId: pulumi.String("string"),
	InstanceName:   pulumi.String("string"),
	Consumer: &konnect.GatewayPluginOasValidationConsumerArgs{
		Id: pulumi.String("string"),
	},
	CreatedAt:                    pulumi.Float64(0),
	Enabled:                      pulumi.Bool(false),
	GatewayPluginOasValidationId: pulumi.String("string"),
	Config: &konnect.GatewayPluginOasValidationConfigArgs{
		AllowedHeaderParameters:                 pulumi.String("string"),
		ApiSpec:                                 pulumi.String("string"),
		ApiSpecEncoded:                          pulumi.Bool(false),
		CustomBasePath:                          pulumi.String("string"),
		HeaderParameterCheck:                    pulumi.Bool(false),
		IncludeBasePath:                         pulumi.Bool(false),
		NotifyOnlyRequestValidationFailure:      pulumi.Bool(false),
		NotifyOnlyResponseBodyValidationFailure: pulumi.Bool(false),
		QueryParameterCheck:                     pulumi.Bool(false),
		ValidateRequestBody:                     pulumi.Bool(false),
		ValidateRequestHeaderParams:             pulumi.Bool(false),
		ValidateRequestQueryParams:              pulumi.Bool(false),
		ValidateRequestUriParams:                pulumi.Bool(false),
		ValidateResponseBody:                    pulumi.Bool(false),
		VerboseResponse:                         pulumi.Bool(false),
	},
	Ordering: &konnect.GatewayPluginOasValidationOrderingArgs{
		After: &konnect.GatewayPluginOasValidationOrderingAfterArgs{
			Accesses: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Before: &konnect.GatewayPluginOasValidationOrderingBeforeArgs{
			Accesses: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Partials: konnect.GatewayPluginOasValidationPartialArray{
		&konnect.GatewayPluginOasValidationPartialArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
			Path: pulumi.String("string"),
		},
	},
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	Route: &konnect.GatewayPluginOasValidationRouteArgs{
		Id: pulumi.String("string"),
	},
	Service: &konnect.GatewayPluginOasValidationServiceArgs{
		Id: pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UpdatedAt: pulumi.Float64(0),
})

var gatewayPluginOasValidationResource = new GatewayPluginOasValidation("gatewayPluginOasValidationResource", GatewayPluginOasValidationArgs.builder()
    .controlPlaneId("string")
    .instanceName("string")
    .consumer(GatewayPluginOasValidationConsumerArgs.builder()
        .id("string")
        .build())
    .createdAt(0.0)
    .enabled(false)
    .gatewayPluginOasValidationId("string")
    .config(GatewayPluginOasValidationConfigArgs.builder()
        .allowedHeaderParameters("string")
        .apiSpec("string")
        .apiSpecEncoded(false)
        .customBasePath("string")
        .headerParameterCheck(false)
        .includeBasePath(false)
        .notifyOnlyRequestValidationFailure(false)
        .notifyOnlyResponseBodyValidationFailure(false)
        .queryParameterCheck(false)
        .validateRequestBody(false)
        .validateRequestHeaderParams(false)
        .validateRequestQueryParams(false)
        .validateRequestUriParams(false)
        .validateResponseBody(false)
        .verboseResponse(false)
        .build())
    .ordering(GatewayPluginOasValidationOrderingArgs.builder()
        .after(GatewayPluginOasValidationOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginOasValidationOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .partials(GatewayPluginOasValidationPartialArgs.builder()
        .id("string")
        .name("string")
        .path("string")
        .build())
    .protocols("string")
    .route(GatewayPluginOasValidationRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginOasValidationServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .updatedAt(0.0)
    .build());

gateway_plugin_oas_validation_resource = konnect.GatewayPluginOasValidation("gatewayPluginOasValidationResource",
    control_plane_id="string",
    instance_name="string",
    consumer={
        "id": "string",
    },
    created_at=0,
    enabled=False,
    gateway_plugin_oas_validation_id="string",
    config={
        "allowed_header_parameters": "string",
        "api_spec": "string",
        "api_spec_encoded": False,
        "custom_base_path": "string",
        "header_parameter_check": False,
        "include_base_path": False,
        "notify_only_request_validation_failure": False,
        "notify_only_response_body_validation_failure": False,
        "query_parameter_check": False,
        "validate_request_body": False,
        "validate_request_header_params": False,
        "validate_request_query_params": False,
        "validate_request_uri_params": False,
        "validate_response_body": False,
        "verbose_response": False,
    },
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    partials=[{
        "id": "string",
        "name": "string",
        "path": "string",
    }],
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"],
    updated_at=0)

const gatewayPluginOasValidationResource = new konnect.GatewayPluginOasValidation("gatewayPluginOasValidationResource", {
    controlPlaneId: "string",
    instanceName: "string",
    consumer: {
        id: "string",
    },
    createdAt: 0,
    enabled: false,
    gatewayPluginOasValidationId: "string",
    config: {
        allowedHeaderParameters: "string",
        apiSpec: "string",
        apiSpecEncoded: false,
        customBasePath: "string",
        headerParameterCheck: false,
        includeBasePath: false,
        notifyOnlyRequestValidationFailure: false,
        notifyOnlyResponseBodyValidationFailure: false,
        queryParameterCheck: false,
        validateRequestBody: false,
        validateRequestHeaderParams: false,
        validateRequestQueryParams: false,
        validateRequestUriParams: false,
        validateResponseBody: false,
        verboseResponse: false,
    },
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    partials: [{
        id: "string",
        name: "string",
        path: "string",
    }],
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
    updatedAt: 0,
});

type: konnect:GatewayPluginOasValidation
properties:
    config:
        allowedHeaderParameters: string
        apiSpec: string
        apiSpecEncoded: false
        customBasePath: string
        headerParameterCheck: false
        includeBasePath: false
        notifyOnlyRequestValidationFailure: false
        notifyOnlyResponseBodyValidationFailure: false
        queryParameterCheck: false
        validateRequestBody: false
        validateRequestHeaderParams: false
        validateRequestQueryParams: false
        validateRequestUriParams: false
        validateResponseBody: false
        verboseResponse: false
    consumer:
        id: string
    controlPlaneId: string
    createdAt: 0
    enabled: false
    gatewayPluginOasValidationId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    partials:
        - id: string
          name: string
          path: string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
    updatedAt: 0

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

ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config GatewayPluginOasValidationConfig
Consumer GatewayPluginOasValidationConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
CreatedAt double: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginOasValidationId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginOasValidationOrdering
Partials List<GatewayPluginOasValidationPartial>
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginOasValidationRoute: 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 GatewayPluginOasValidationService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt double: Unix epoch when the resource was last updated.

ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config GatewayPluginOasValidationConfigArgs
Consumer GatewayPluginOasValidationConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
CreatedAt float64: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginOasValidationId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginOasValidationOrderingArgs
Partials []GatewayPluginOasValidationPartialArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginOasValidationRouteArgs: 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 GatewayPluginOasValidationServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt float64: Unix epoch when the resource was last updated.

controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginOasValidationConfig
consumer GatewayPluginOasValidationConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
createdAt Double: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginOasValidationId String: The ID of this resource.
instanceName String
ordering GatewayPluginOasValidationOrdering
partials List<GatewayPluginOasValidationPartial>
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginOasValidationRoute: 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 GatewayPluginOasValidationService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Double: Unix epoch when the resource was last updated.

controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginOasValidationConfig
consumer GatewayPluginOasValidationConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
createdAt number: Unix epoch when the resource was created.
enabled boolean: Whether the plugin is applied.
gatewayPluginOasValidationId string: The ID of this resource.
instanceName string
ordering GatewayPluginOasValidationOrdering
partials GatewayPluginOasValidationPartial[]
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginOasValidationRoute: 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 GatewayPluginOasValidationService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt number: Unix epoch when the resource was last updated.

control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginOasValidationConfigArgs
consumer GatewayPluginOasValidationConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
created_at float: Unix epoch when the resource was created.
enabled bool: Whether the plugin is applied.
gateway_plugin_oas_validation_id str: The ID of this resource.
instance_name str
ordering GatewayPluginOasValidationOrderingArgs
partials Sequence[GatewayPluginOasValidationPartialArgs]
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginOasValidationRouteArgs: 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 GatewayPluginOasValidationServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float: Unix epoch when the resource was last updated.

controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config Property Map
consumer Property Map: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
createdAt Number: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginOasValidationId String: The ID of this resource.
instanceName String
ordering Property Map
partials List<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.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing GatewayPluginOasValidation Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginOasValidationConfigArgs] = None,
        consumer: Optional[GatewayPluginOasValidationConsumerArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_oas_validation_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginOasValidationOrderingArgs] = None,
        partials: Optional[Sequence[GatewayPluginOasValidationPartialArgs]] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginOasValidationRouteArgs] = None,
        service: Optional[GatewayPluginOasValidationServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginOasValidation

func GetGatewayPluginOasValidation(ctx *Context, name string, id IDInput, state *GatewayPluginOasValidationState, opts ...ResourceOption) (*GatewayPluginOasValidation, error)

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

public static GatewayPluginOasValidation get(String name, Output<String> id, GatewayPluginOasValidationState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginOasValidation    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 GatewayPluginOasValidationConfig
Consumer GatewayPluginOasValidationConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginOasValidationId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginOasValidationOrdering
Partials List<GatewayPluginOasValidationPartial>
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginOasValidationRoute: 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 GatewayPluginOasValidationService: 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 GatewayPluginOasValidationConfigArgs
Consumer GatewayPluginOasValidationConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginOasValidationId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginOasValidationOrderingArgs
Partials []GatewayPluginOasValidationPartialArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginOasValidationRouteArgs: 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 GatewayPluginOasValidationServiceArgs: 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 GatewayPluginOasValidationConfig
consumer GatewayPluginOasValidationConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginOasValidationId String: The ID of this resource.
instanceName String
ordering GatewayPluginOasValidationOrdering
partials List<GatewayPluginOasValidationPartial>
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginOasValidationRoute: 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 GatewayPluginOasValidationService: 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 GatewayPluginOasValidationConfig
consumer GatewayPluginOasValidationConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number: Unix epoch when the resource was created.
enabled boolean: Whether the plugin is applied.
gatewayPluginOasValidationId string: The ID of this resource.
instanceName string
ordering GatewayPluginOasValidationOrdering
partials GatewayPluginOasValidationPartial[]
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginOasValidationRoute: 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 GatewayPluginOasValidationService: 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 GatewayPluginOasValidationConfigArgs
consumer GatewayPluginOasValidationConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
created_at float: Unix epoch when the resource was created.
enabled bool: Whether the plugin is applied.
gateway_plugin_oas_validation_id str: The ID of this resource.
instance_name str
ordering GatewayPluginOasValidationOrderingArgs
partials Sequence[GatewayPluginOasValidationPartialArgs]
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginOasValidationRouteArgs: 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 GatewayPluginOasValidationServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float: Unix epoch when the resource was last updated.

config Property Map
consumer Property Map: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginOasValidationId String: The ID of this resource.
instanceName String
ordering Property Map
partials List<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

GatewayPluginOasValidationConfig, GatewayPluginOasValidationConfigArgs

AllowedHeaderParameters string: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
ApiSpec string: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
ApiSpecEncoded bool: Indicates whether the api_spec is URI-Encoded.
CustomBasePath string: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
HeaderParameterCheck bool: If set to true, checks if HTTP header parameters in the request exist in the API specification.
IncludeBasePath bool: Indicates whether to include the base path when performing path match evaluation.
NotifyOnlyRequestValidationFailure bool: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
NotifyOnlyResponseBodyValidationFailure bool: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
QueryParameterCheck bool: If set to true, checks if query parameters in the request exist in the API specification.
ValidateRequestBody bool: If set to true, validates the request body content against the API specification.
ValidateRequestHeaderParams bool: If set to true, validates HTTP header parameters against the API specification.
ValidateRequestQueryParams bool: If set to true, validates query parameters against the API specification.
ValidateRequestUriParams bool: If set to true, validates URI parameters in the request against the API specification.
ValidateResponseBody bool: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
VerboseResponse bool: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

AllowedHeaderParameters string: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
ApiSpec string: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
ApiSpecEncoded bool: Indicates whether the api_spec is URI-Encoded.
CustomBasePath string: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
HeaderParameterCheck bool: If set to true, checks if HTTP header parameters in the request exist in the API specification.
IncludeBasePath bool: Indicates whether to include the base path when performing path match evaluation.
NotifyOnlyRequestValidationFailure bool: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
NotifyOnlyResponseBodyValidationFailure bool: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
QueryParameterCheck bool: If set to true, checks if query parameters in the request exist in the API specification.
ValidateRequestBody bool: If set to true, validates the request body content against the API specification.
ValidateRequestHeaderParams bool: If set to true, validates HTTP header parameters against the API specification.
ValidateRequestQueryParams bool: If set to true, validates query parameters against the API specification.
ValidateRequestUriParams bool: If set to true, validates URI parameters in the request against the API specification.
ValidateResponseBody bool: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
VerboseResponse bool: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

allowedHeaderParameters String: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
apiSpec String: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
apiSpecEncoded Boolean: Indicates whether the api_spec is URI-Encoded.
customBasePath String: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
headerParameterCheck Boolean: If set to true, checks if HTTP header parameters in the request exist in the API specification.
includeBasePath Boolean: Indicates whether to include the base path when performing path match evaluation.
notifyOnlyRequestValidationFailure Boolean: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notifyOnlyResponseBodyValidationFailure Boolean: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
queryParameterCheck Boolean: If set to true, checks if query parameters in the request exist in the API specification.
validateRequestBody Boolean: If set to true, validates the request body content against the API specification.
validateRequestHeaderParams Boolean: If set to true, validates HTTP header parameters against the API specification.
validateRequestQueryParams Boolean: If set to true, validates query parameters against the API specification.
validateRequestUriParams Boolean: If set to true, validates URI parameters in the request against the API specification.
validateResponseBody Boolean: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
verboseResponse Boolean: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

allowedHeaderParameters string: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
apiSpec string: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
apiSpecEncoded boolean: Indicates whether the api_spec is URI-Encoded.
customBasePath string: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
headerParameterCheck boolean: If set to true, checks if HTTP header parameters in the request exist in the API specification.
includeBasePath boolean: Indicates whether to include the base path when performing path match evaluation.
notifyOnlyRequestValidationFailure boolean: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notifyOnlyResponseBodyValidationFailure boolean: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
queryParameterCheck boolean: If set to true, checks if query parameters in the request exist in the API specification.
validateRequestBody boolean: If set to true, validates the request body content against the API specification.
validateRequestHeaderParams boolean: If set to true, validates HTTP header parameters against the API specification.
validateRequestQueryParams boolean: If set to true, validates query parameters against the API specification.
validateRequestUriParams boolean: If set to true, validates URI parameters in the request against the API specification.
validateResponseBody boolean: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
verboseResponse boolean: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

allowed_header_parameters str: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
api_spec str: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
api_spec_encoded bool: Indicates whether the api_spec is URI-Encoded.
custom_base_path str: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
header_parameter_check bool: If set to true, checks if HTTP header parameters in the request exist in the API specification.
include_base_path bool: Indicates whether to include the base path when performing path match evaluation.
notify_only_request_validation_failure bool: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notify_only_response_body_validation_failure bool: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
query_parameter_check bool: If set to true, checks if query parameters in the request exist in the API specification.
validate_request_body bool: If set to true, validates the request body content against the API specification.
validate_request_header_params bool: If set to true, validates HTTP header parameters against the API specification.
validate_request_query_params bool: If set to true, validates query parameters against the API specification.
validate_request_uri_params bool: If set to true, validates URI parameters in the request against the API specification.
validate_response_body bool: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
verbose_response bool: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

allowedHeaderParameters String: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
apiSpec String: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
apiSpecEncoded Boolean: Indicates whether the api_spec is URI-Encoded.
customBasePath String: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
headerParameterCheck Boolean: If set to true, checks if HTTP header parameters in the request exist in the API specification.
includeBasePath Boolean: Indicates whether to include the base path when performing path match evaluation.
notifyOnlyRequestValidationFailure Boolean: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notifyOnlyResponseBodyValidationFailure Boolean: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
queryParameterCheck Boolean: If set to true, checks if query parameters in the request exist in the API specification.
validateRequestBody Boolean: If set to true, validates the request body content against the API specification.
validateRequestHeaderParams Boolean: If set to true, validates HTTP header parameters against the API specification.
validateRequestQueryParams Boolean: If set to true, validates query parameters against the API specification.
validateRequestUriParams Boolean: If set to true, validates URI parameters in the request against the API specification.
validateResponseBody Boolean: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
verboseResponse Boolean: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

GatewayPluginOasValidationConsumer, GatewayPluginOasValidationConsumerArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginOasValidationOrdering, GatewayPluginOasValidationOrderingArgs

After GatewayPluginOasValidationOrderingAfter
Before GatewayPluginOasValidationOrderingBefore

After GatewayPluginOasValidationOrderingAfter
Before GatewayPluginOasValidationOrderingBefore

after GatewayPluginOasValidationOrderingAfter
before GatewayPluginOasValidationOrderingBefore

after GatewayPluginOasValidationOrderingAfter
before GatewayPluginOasValidationOrderingBefore

after GatewayPluginOasValidationOrderingAfter
before GatewayPluginOasValidationOrderingBefore

after Property Map
before Property Map

GatewayPluginOasValidationOrderingAfter, GatewayPluginOasValidationOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginOasValidationOrderingBefore, GatewayPluginOasValidationOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginOasValidationPartial, GatewayPluginOasValidationPartialArgs

Id string
Name string
Path string

Id string
Name string
Path string

id String
name String
path String

id string
name string
path string

id str
name str
path str

id String
name String
path String

GatewayPluginOasValidationRoute, GatewayPluginOasValidationRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginOasValidationService, GatewayPluginOasValidationServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginOasValidation:GatewayPluginOasValidation my_konnect_gateway_plugin_oas_validation '{"control_plane_id": "9524ec7d-36d9-465d-a8c5-83a3c9390458", "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.11.1 published on Tuesday, Jul 15, 2025 by kong

kong/terraform-provider-konnect

konnect.GatewayPluginOasValidation

On this page

On this page

Example Usage

Create GatewayPluginOasValidation Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginOasValidation Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginOasValidation Resource

Supporting Types

GatewayPluginOasValidationConfig, GatewayPluginOasValidationConfigArgs

GatewayPluginOasValidationConsumer, GatewayPluginOasValidationConsumerArgs

GatewayPluginOasValidationOrdering, GatewayPluginOasValidationOrderingArgs

GatewayPluginOasValidationOrderingAfter, GatewayPluginOasValidationOrderingAfterArgs

GatewayPluginOasValidationOrderingBefore, GatewayPluginOasValidationOrderingBeforeArgs

GatewayPluginOasValidationPartial, GatewayPluginOasValidationPartialArgs

GatewayPluginOasValidationRoute, GatewayPluginOasValidationRouteArgs

GatewayPluginOasValidationService, GatewayPluginOasValidationServiceArgs

Import

Package Details

On this page

On this page