Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginRequestTransformer
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayPluginRequestTransformer

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

GatewayPluginRequestTransformer Resource

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginRequestTransformer;
import com.pulumi.konnect.GatewayPluginRequestTransformerArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerConfigAddArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerConfigAppendArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerConfigRemoveArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerConfigRenameArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerConfigReplaceArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerConsumerGroupArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestTransformerServiceArgs;
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 myGatewaypluginrequesttransformer = new GatewayPluginRequestTransformer("myGatewaypluginrequesttransformer", GatewayPluginRequestTransformerArgs.builder()
            .config(GatewayPluginRequestTransformerConfigArgs.builder()
                .add(GatewayPluginRequestTransformerConfigAddArgs.builder()
                    .body("...")
                    .headers("...")
                    .querystring("...")
                    .build())
                .append(GatewayPluginRequestTransformerConfigAppendArgs.builder()
                    .body("...")
                    .headers("...")
                    .querystring("...")
                    .build())
                .http_method("...my_http_method...")
                .remove(GatewayPluginRequestTransformerConfigRemoveArgs.builder()
                    .body("...")
                    .headers("...")
                    .querystring("...")
                    .build())
                .rename(GatewayPluginRequestTransformerConfigRenameArgs.builder()
                    .body("...")
                    .headers("...")
                    .querystring("...")
                    .build())
                .replace(GatewayPluginRequestTransformerConfigReplaceArgs.builder()
                    .body("...")
                    .headers("...")
                    .querystring("...")
                    .uri("...my_uri...")
                    .build())
                .build())
            .consumer(GatewayPluginRequestTransformerConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerGroup(GatewayPluginRequestTransformerConsumerGroupArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .gatewayPluginRequestTransformerId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginRequestTransformerOrderingArgs.builder()
                .after(GatewayPluginRequestTransformerOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginRequestTransformerOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("https")
            .route(GatewayPluginRequestTransformerRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginRequestTransformerServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}
Copy
resources:
  myGatewaypluginrequesttransformer:
    type: konnect:GatewayPluginRequestTransformer
    properties:
      config:
        add:
          body:
            - '...'
          headers:
            - '...'
          querystring:
            - '...'
        append:
          body:
            - '...'
          headers:
            - '...'
          querystring:
            - '...'
        http_method: '...my_http_method...'
        remove:
          body:
            - '...'
          headers:
            - '...'
          querystring:
            - '...'
        rename:
          body:
            - '...'
          headers:
            - '...'
          querystring:
            - '...'
        replace:
          body:
            - '...'
          headers:
            - '...'
          querystring:
            - '...'
          uri: '...my_uri...'
      consumer:
        id: '...my_id...'
      consumerGroup:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      gatewayPluginRequestTransformerId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - https
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
Copy

Create GatewayPluginRequestTransformer Resource

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

Constructor syntax

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

@overload
def GatewayPluginRequestTransformer(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    config: Optional[GatewayPluginRequestTransformerConfigArgs] = None,
                                    control_plane_id: Optional[str] = None,
                                    consumer: Optional[GatewayPluginRequestTransformerConsumerArgs] = None,
                                    consumer_group: Optional[GatewayPluginRequestTransformerConsumerGroupArgs] = None,
                                    enabled: Optional[bool] = None,
                                    gateway_plugin_request_transformer_id: Optional[str] = None,
                                    instance_name: Optional[str] = None,
                                    ordering: Optional[GatewayPluginRequestTransformerOrderingArgs] = None,
                                    protocols: Optional[Sequence[str]] = None,
                                    route: Optional[GatewayPluginRequestTransformerRouteArgs] = None,
                                    service: Optional[GatewayPluginRequestTransformerServiceArgs] = None,
                                    tags: Optional[Sequence[str]] = None)
func NewGatewayPluginRequestTransformer(ctx *Context, name string, args GatewayPluginRequestTransformerArgs, opts ...ResourceOption) (*GatewayPluginRequestTransformer, error)
public GatewayPluginRequestTransformer(string name, GatewayPluginRequestTransformerArgs args, CustomResourceOptions? opts = null)
public GatewayPluginRequestTransformer(String name, GatewayPluginRequestTransformerArgs args)
public GatewayPluginRequestTransformer(String name, GatewayPluginRequestTransformerArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginRequestTransformerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayPluginRequestTransformerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginRequestTransformerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginRequestTransformerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayPluginRequestTransformerArgs
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 gatewayPluginRequestTransformerResource = new Konnect.GatewayPluginRequestTransformer("gatewayPluginRequestTransformerResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginRequestTransformerConfigArgs
    {
        Add = new Konnect.Inputs.GatewayPluginRequestTransformerConfigAddArgs
        {
            Bodies = new[]
            {
                "string",
            },
            Headers = new[]
            {
                "string",
            },
            Querystrings = new[]
            {
                "string",
            },
        },
        Append = new Konnect.Inputs.GatewayPluginRequestTransformerConfigAppendArgs
        {
            Bodies = new[]
            {
                "string",
            },
            Headers = new[]
            {
                "string",
            },
            Querystrings = new[]
            {
                "string",
            },
        },
        HttpMethod = "string",
        Remove = new Konnect.Inputs.GatewayPluginRequestTransformerConfigRemoveArgs
        {
            Bodies = new[]
            {
                "string",
            },
            Headers = new[]
            {
                "string",
            },
            Querystrings = new[]
            {
                "string",
            },
        },
        Rename = new Konnect.Inputs.GatewayPluginRequestTransformerConfigRenameArgs
        {
            Bodies = new[]
            {
                "string",
            },
            Headers = new[]
            {
                "string",
            },
            Querystrings = new[]
            {
                "string",
            },
        },
        Replace = new Konnect.Inputs.GatewayPluginRequestTransformerConfigReplaceArgs
        {
            Bodies = new[]
            {
                "string",
            },
            Headers = new[]
            {
                "string",
            },
            Querystrings = new[]
            {
                "string",
            },
            Uri = "string",
        },
    },
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayPluginRequestTransformerConsumerArgs
    {
        Id = "string",
    },
    ConsumerGroup = new Konnect.Inputs.GatewayPluginRequestTransformerConsumerGroupArgs
    {
        Id = "string",
    },
    Enabled = false,
    GatewayPluginRequestTransformerId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginRequestTransformerOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginRequestTransformerOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginRequestTransformerOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginRequestTransformerRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginRequestTransformerServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := konnect.NewGatewayPluginRequestTransformer(ctx, "gatewayPluginRequestTransformerResource", &konnect.GatewayPluginRequestTransformerArgs{
Config: &.GatewayPluginRequestTransformerConfigArgs{
Add: &.GatewayPluginRequestTransformerConfigAddArgs{
Bodies: pulumi.StringArray{
pulumi.String("string"),
},
Headers: pulumi.StringArray{
pulumi.String("string"),
},
Querystrings: pulumi.StringArray{
pulumi.String("string"),
},
},
Append: &.GatewayPluginRequestTransformerConfigAppendArgs{
Bodies: pulumi.StringArray{
pulumi.String("string"),
},
Headers: pulumi.StringArray{
pulumi.String("string"),
},
Querystrings: pulumi.StringArray{
pulumi.String("string"),
},
},
HttpMethod: pulumi.String("string"),
Remove: &.GatewayPluginRequestTransformerConfigRemoveArgs{
Bodies: pulumi.StringArray{
pulumi.String("string"),
},
Headers: pulumi.StringArray{
pulumi.String("string"),
},
Querystrings: pulumi.StringArray{
pulumi.String("string"),
},
},
Rename: &.GatewayPluginRequestTransformerConfigRenameArgs{
Bodies: pulumi.StringArray{
pulumi.String("string"),
},
Headers: pulumi.StringArray{
pulumi.String("string"),
},
Querystrings: pulumi.StringArray{
pulumi.String("string"),
},
},
Replace: &.GatewayPluginRequestTransformerConfigReplaceArgs{
Bodies: pulumi.StringArray{
pulumi.String("string"),
},
Headers: pulumi.StringArray{
pulumi.String("string"),
},
Querystrings: pulumi.StringArray{
pulumi.String("string"),
},
Uri: pulumi.String("string"),
},
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginRequestTransformerConsumerArgs{
Id: pulumi.String("string"),
},
ConsumerGroup: &.GatewayPluginRequestTransformerConsumerGroupArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginRequestTransformerId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginRequestTransformerOrderingArgs{
After: &.GatewayPluginRequestTransformerOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginRequestTransformerOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginRequestTransformerRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginRequestTransformerServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var gatewayPluginRequestTransformerResource = new GatewayPluginRequestTransformer("gatewayPluginRequestTransformerResource", GatewayPluginRequestTransformerArgs.builder()
    .config(GatewayPluginRequestTransformerConfigArgs.builder()
        .add(GatewayPluginRequestTransformerConfigAddArgs.builder()
            .bodies("string")
            .headers("string")
            .querystrings("string")
            .build())
        .append(GatewayPluginRequestTransformerConfigAppendArgs.builder()
            .bodies("string")
            .headers("string")
            .querystrings("string")
            .build())
        .httpMethod("string")
        .remove(GatewayPluginRequestTransformerConfigRemoveArgs.builder()
            .bodies("string")
            .headers("string")
            .querystrings("string")
            .build())
        .rename(GatewayPluginRequestTransformerConfigRenameArgs.builder()
            .bodies("string")
            .headers("string")
            .querystrings("string")
            .build())
        .replace(GatewayPluginRequestTransformerConfigReplaceArgs.builder()
            .bodies("string")
            .headers("string")
            .querystrings("string")
            .uri("string")
            .build())
        .build())
    .controlPlaneId("string")
    .consumer(GatewayPluginRequestTransformerConsumerArgs.builder()
        .id("string")
        .build())
    .consumerGroup(GatewayPluginRequestTransformerConsumerGroupArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .gatewayPluginRequestTransformerId("string")
    .instanceName("string")
    .ordering(GatewayPluginRequestTransformerOrderingArgs.builder()
        .after(GatewayPluginRequestTransformerOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginRequestTransformerOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginRequestTransformerRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginRequestTransformerServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());
Copy
gateway_plugin_request_transformer_resource = konnect.GatewayPluginRequestTransformer("gatewayPluginRequestTransformerResource",
    config={
        "add": {
            "bodies": ["string"],
            "headers": ["string"],
            "querystrings": ["string"],
        },
        "append": {
            "bodies": ["string"],
            "headers": ["string"],
            "querystrings": ["string"],
        },
        "http_method": "string",
        "remove": {
            "bodies": ["string"],
            "headers": ["string"],
            "querystrings": ["string"],
        },
        "rename": {
            "bodies": ["string"],
            "headers": ["string"],
            "querystrings": ["string"],
        },
        "replace": {
            "bodies": ["string"],
            "headers": ["string"],
            "querystrings": ["string"],
            "uri": "string",
        },
    },
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    consumer_group={
        "id": "string",
    },
    enabled=False,
    gateway_plugin_request_transformer_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])
Copy
const gatewayPluginRequestTransformerResource = new konnect.GatewayPluginRequestTransformer("gatewayPluginRequestTransformerResource", {
    config: {
        add: {
            bodies: ["string"],
            headers: ["string"],
            querystrings: ["string"],
        },
        append: {
            bodies: ["string"],
            headers: ["string"],
            querystrings: ["string"],
        },
        httpMethod: "string",
        remove: {
            bodies: ["string"],
            headers: ["string"],
            querystrings: ["string"],
        },
        rename: {
            bodies: ["string"],
            headers: ["string"],
            querystrings: ["string"],
        },
        replace: {
            bodies: ["string"],
            headers: ["string"],
            querystrings: ["string"],
            uri: "string",
        },
    },
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    consumerGroup: {
        id: "string",
    },
    enabled: false,
    gatewayPluginRequestTransformerId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});
Copy
type: konnect:GatewayPluginRequestTransformer
properties:
    config:
        add:
            bodies:
                - string
            headers:
                - string
            querystrings:
                - string
        append:
            bodies:
                - string
            headers:
                - string
            querystrings:
                - string
        httpMethod: string
        remove:
            bodies:
                - string
            headers:
                - string
            querystrings:
                - string
        rename:
            bodies:
                - string
            headers:
                - string
            querystrings:
                - string
        replace:
            bodies:
                - string
            headers:
                - string
            querystrings:
                - string
            uri: string
    consumer:
        id: string
    consumerGroup:
        id: string
    controlPlaneId: string
    enabled: false
    gatewayPluginRequestTransformerId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
Copy

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

Config This property is required. GatewayPluginRequestTransformerConfig
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginRequestTransformerConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginRequestTransformerConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
Enabled bool
Whether the plugin is applied.
GatewayPluginRequestTransformerId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginRequestTransformerOrdering
Protocols List<string>
A set of strings representing protocols.
Route GatewayPluginRequestTransformerRoute
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 GatewayPluginRequestTransformerService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>
An optional set of strings associated with the Plugin for grouping and filtering.
Config This property is required. GatewayPluginRequestTransformerConfigArgs
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginRequestTransformerConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginRequestTransformerConsumerGroupArgs
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
Enabled bool
Whether the plugin is applied.
GatewayPluginRequestTransformerId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginRequestTransformerOrderingArgs
Protocols []string
A set of strings representing protocols.
Route GatewayPluginRequestTransformerRouteArgs
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 GatewayPluginRequestTransformerServiceArgs
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string
An optional set of strings associated with the Plugin for grouping and filtering.
config This property is required. GatewayPluginRequestTransformerConfig
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginRequestTransformerConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginRequestTransformerConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
enabled Boolean
Whether the plugin is applied.
gatewayPluginRequestTransformerId String
The ID of this resource.
instanceName String
ordering GatewayPluginRequestTransformerOrdering
protocols List<String>
A set of strings representing protocols.
route GatewayPluginRequestTransformerRoute
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 GatewayPluginRequestTransformerService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
config This property is required. GatewayPluginRequestTransformerConfig
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginRequestTransformerConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginRequestTransformerConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
enabled boolean
Whether the plugin is applied.
gatewayPluginRequestTransformerId string
The ID of this resource.
instanceName string
ordering GatewayPluginRequestTransformerOrdering
protocols string[]
A set of strings representing protocols.
route GatewayPluginRequestTransformerRoute
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 GatewayPluginRequestTransformerService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]
An optional set of strings associated with the Plugin for grouping and filtering.
config This property is required. GatewayPluginRequestTransformerConfigArgs
control_plane_id This property is required. str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginRequestTransformerConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumer_group GatewayPluginRequestTransformerConsumerGroupArgs
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
enabled bool
Whether the plugin is applied.
gateway_plugin_request_transformer_id str
The ID of this resource.
instance_name str
ordering GatewayPluginRequestTransformerOrderingArgs
protocols Sequence[str]
A set of strings representing protocols.
route GatewayPluginRequestTransformerRouteArgs
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 GatewayPluginRequestTransformerServiceArgs
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]
An optional set of strings associated with the Plugin for grouping and filtering.
config This property is required. Property Map
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer Property Map
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup Property Map
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
enabled Boolean
Whether the plugin is applied.
gatewayPluginRequestTransformerId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing protocols.
route Property Map
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.

Outputs

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

Get an existing GatewayPluginRequestTransformer 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?: GatewayPluginRequestTransformerState, opts?: CustomResourceOptions): GatewayPluginRequestTransformer
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginRequestTransformerConfigArgs] = None,
        consumer: Optional[GatewayPluginRequestTransformerConsumerArgs] = None,
        consumer_group: Optional[GatewayPluginRequestTransformerConsumerGroupArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_request_transformer_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginRequestTransformerOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginRequestTransformerRouteArgs] = None,
        service: Optional[GatewayPluginRequestTransformerServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginRequestTransformer
func GetGatewayPluginRequestTransformer(ctx *Context, name string, id IDInput, state *GatewayPluginRequestTransformerState, opts ...ResourceOption) (*GatewayPluginRequestTransformer, error)
public static GatewayPluginRequestTransformer Get(string name, Input<string> id, GatewayPluginRequestTransformerState? state, CustomResourceOptions? opts = null)
public static GatewayPluginRequestTransformer get(String name, Output<String> id, GatewayPluginRequestTransformerState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayPluginRequestTransformer    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Config GatewayPluginRequestTransformerConfig
Consumer GatewayPluginRequestTransformerConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginRequestTransformerConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginRequestTransformerId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginRequestTransformerOrdering
Protocols List<string>
A set of strings representing protocols.
Route GatewayPluginRequestTransformerRoute
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 GatewayPluginRequestTransformerService
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 GatewayPluginRequestTransformerConfigArgs
Consumer GatewayPluginRequestTransformerConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ConsumerGroup GatewayPluginRequestTransformerConsumerGroupArgs
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginRequestTransformerId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginRequestTransformerOrderingArgs
Protocols []string
A set of strings representing protocols.
Route GatewayPluginRequestTransformerRouteArgs
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 GatewayPluginRequestTransformerServiceArgs
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 GatewayPluginRequestTransformerConfig
consumer GatewayPluginRequestTransformerConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginRequestTransformerConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginRequestTransformerId String
The ID of this resource.
instanceName String
ordering GatewayPluginRequestTransformerOrdering
protocols List<String>
A set of strings representing protocols.
route GatewayPluginRequestTransformerRoute
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 GatewayPluginRequestTransformerService
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 GatewayPluginRequestTransformerConfig
consumer GatewayPluginRequestTransformerConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup GatewayPluginRequestTransformerConsumerGroup
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
controlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number
Unix epoch when the resource was created.
enabled boolean
Whether the plugin is applied.
gatewayPluginRequestTransformerId string
The ID of this resource.
instanceName string
ordering GatewayPluginRequestTransformerOrdering
protocols string[]
A set of strings representing protocols.
route GatewayPluginRequestTransformerRoute
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 GatewayPluginRequestTransformerService
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 GatewayPluginRequestTransformerConfigArgs
consumer GatewayPluginRequestTransformerConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumer_group GatewayPluginRequestTransformerConsumerGroupArgs
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
control_plane_id str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
created_at float
Unix epoch when the resource was created.
enabled bool
Whether the plugin is applied.
gateway_plugin_request_transformer_id str
The ID of this resource.
instance_name str
ordering GatewayPluginRequestTransformerOrderingArgs
protocols Sequence[str]
A set of strings representing protocols.
route GatewayPluginRequestTransformerRouteArgs
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 GatewayPluginRequestTransformerServiceArgs
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]
An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float
Unix epoch when the resource was last updated.
config Property Map
consumer Property Map
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup Property Map
If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginRequestTransformerId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing protocols.
route Property Map
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.

Supporting Types

GatewayPluginRequestTransformerConfig
, GatewayPluginRequestTransformerConfigArgs

add Property Map
append Property Map
httpMethod String
A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.
remove Property Map
rename Property Map
replace Property Map

GatewayPluginRequestTransformerConfigAdd
, GatewayPluginRequestTransformerConfigAddArgs

Bodies List<string>
Headers List<string>
Querystrings List<string>
Bodies []string
Headers []string
Querystrings []string
bodies List<String>
headers List<String>
querystrings List<String>
bodies string[]
headers string[]
querystrings string[]
bodies Sequence[str]
headers Sequence[str]
querystrings Sequence[str]
bodies List<String>
headers List<String>
querystrings List<String>

GatewayPluginRequestTransformerConfigAppend
, GatewayPluginRequestTransformerConfigAppendArgs

Bodies List<string>
Headers List<string>
Querystrings List<string>
Bodies []string
Headers []string
Querystrings []string
bodies List<String>
headers List<String>
querystrings List<String>
bodies string[]
headers string[]
querystrings string[]
bodies Sequence[str]
headers Sequence[str]
querystrings Sequence[str]
bodies List<String>
headers List<String>
querystrings List<String>

GatewayPluginRequestTransformerConfigRemove
, GatewayPluginRequestTransformerConfigRemoveArgs

Bodies List<string>
Headers List<string>
Querystrings List<string>
Bodies []string
Headers []string
Querystrings []string
bodies List<String>
headers List<String>
querystrings List<String>
bodies string[]
headers string[]
querystrings string[]
bodies Sequence[str]
headers Sequence[str]
querystrings Sequence[str]
bodies List<String>
headers List<String>
querystrings List<String>

GatewayPluginRequestTransformerConfigRename
, GatewayPluginRequestTransformerConfigRenameArgs

Bodies List<string>
Headers List<string>
Querystrings List<string>
Bodies []string
Headers []string
Querystrings []string
bodies List<String>
headers List<String>
querystrings List<String>
bodies string[]
headers string[]
querystrings string[]
bodies Sequence[str]
headers Sequence[str]
querystrings Sequence[str]
bodies List<String>
headers List<String>
querystrings List<String>

GatewayPluginRequestTransformerConfigReplace
, GatewayPluginRequestTransformerConfigReplaceArgs

Bodies List<string>
Headers List<string>
Querystrings List<string>
Uri string
Bodies []string
Headers []string
Querystrings []string
Uri string
bodies List<String>
headers List<String>
querystrings List<String>
uri String
bodies string[]
headers string[]
querystrings string[]
uri string
bodies Sequence[str]
headers Sequence[str]
querystrings Sequence[str]
uri str
bodies List<String>
headers List<String>
querystrings List<String>
uri String

GatewayPluginRequestTransformerConsumer
, GatewayPluginRequestTransformerConsumerArgs

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

GatewayPluginRequestTransformerConsumerGroup
, GatewayPluginRequestTransformerConsumerGroupArgs

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

GatewayPluginRequestTransformerOrdering
, GatewayPluginRequestTransformerOrderingArgs

GatewayPluginRequestTransformerOrderingAfter
, GatewayPluginRequestTransformerOrderingAfterArgs

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

GatewayPluginRequestTransformerOrderingBefore
, GatewayPluginRequestTransformerOrderingBeforeArgs

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

GatewayPluginRequestTransformerRoute
, GatewayPluginRequestTransformerRouteArgs

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

GatewayPluginRequestTransformerService
, GatewayPluginRequestTransformerServiceArgs

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

Import

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

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

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect