konnect 2.4.1, Mar 13 25

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

konnect.GatewayPluginResponseTransformer

Explore with Pulumi AI

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

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginResponseTransformer;
import com.pulumi.konnect.GatewayPluginResponseTransformerArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerConfigAddArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerConfigAppendArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerConfigRemoveArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerConfigRenameArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerConfigReplaceArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerConsumerGroupArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseTransformerServiceArgs;
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 myGatewaypluginresponsetransformer = new GatewayPluginResponseTransformer("myGatewaypluginresponsetransformer", GatewayPluginResponseTransformerArgs.builder()
            .config(GatewayPluginResponseTransformerConfigArgs.builder()
                .add(GatewayPluginResponseTransformerConfigAddArgs.builder()
                    .headers("...")
                    .json("...")
                    .jsonTypes("number")
                    .build())
                .append(GatewayPluginResponseTransformerConfigAppendArgs.builder()
                    .headers("...")
                    .json("...")
                    .jsonTypes("number")
                    .build())
                .remove(GatewayPluginResponseTransformerConfigRemoveArgs.builder()
                    .headers("...")
                    .json("...")
                    .build())
                .rename(GatewayPluginResponseTransformerConfigRenameArgs.builder()
                    .headers("...")
                    .json("...")
                    .build())
                .replace(GatewayPluginResponseTransformerConfigReplaceArgs.builder()
                    .headers("...")
                    .json("...")
                    .jsonTypes("string")
                    .build())
                .build())
            .consumer(GatewayPluginResponseTransformerConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerGroup(GatewayPluginResponseTransformerConsumerGroupArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginResponseTransformerId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginResponseTransformerOrderingArgs.builder()
                .after(GatewayPluginResponseTransformerOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginResponseTransformerOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("https")
            .route(GatewayPluginResponseTransformerRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginResponseTransformerServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

resources:
  myGatewaypluginresponsetransformer:
    type: konnect:GatewayPluginResponseTransformer
    properties:
      config:
        add:
          headers:
            - '...'
          json:
            - '...'
          jsonTypes:
            - number
        append:
          headers:
            - '...'
          json:
            - '...'
          jsonTypes:
            - number
        remove:
          headers:
            - '...'
          json:
            - '...'
        rename:
          headers:
            - '...'
          json:
            - '...'
        replace:
          headers:
            - '...'
          json:
            - '...'
          jsonTypes:
            - string
      consumer:
        id: '...my_id...'
      consumerGroup:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginResponseTransformerId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - https
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

Create GatewayPluginResponseTransformer Resource

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

Constructor syntax

new GatewayPluginResponseTransformer(name: string, args: GatewayPluginResponseTransformerArgs, opts?: CustomResourceOptions);

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

@overload
def GatewayPluginResponseTransformer(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     config: Optional[GatewayPluginResponseTransformerConfigArgs] = None,
                                     control_plane_id: Optional[str] = None,
                                     consumer: Optional[GatewayPluginResponseTransformerConsumerArgs] = None,
                                     consumer_group: Optional[GatewayPluginResponseTransformerConsumerGroupArgs] = None,
                                     enabled: Optional[bool] = None,
                                     gateway_plugin_response_transformer_id: Optional[str] = None,
                                     instance_name: Optional[str] = None,
                                     ordering: Optional[GatewayPluginResponseTransformerOrderingArgs] = None,
                                     protocols: Optional[Sequence[str]] = None,
                                     route: Optional[GatewayPluginResponseTransformerRouteArgs] = None,
                                     service: Optional[GatewayPluginResponseTransformerServiceArgs] = None,
                                     tags: Optional[Sequence[str]] = None)

func NewGatewayPluginResponseTransformer(ctx *Context, name string, args GatewayPluginResponseTransformerArgs, opts ...ResourceOption) (*GatewayPluginResponseTransformer, error)

public GatewayPluginResponseTransformer(string name, GatewayPluginResponseTransformerArgs args, CustomResourceOptions? opts = null)

public GatewayPluginResponseTransformer(String name, GatewayPluginResponseTransformerArgs args)
public GatewayPluginResponseTransformer(String name, GatewayPluginResponseTransformerArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args GatewayPluginResponseTransformerArgs: 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 gatewayPluginResponseTransformerResource = new Konnect.GatewayPluginResponseTransformer("gatewayPluginResponseTransformerResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginResponseTransformerConfigArgs
    {
        Add = new Konnect.Inputs.GatewayPluginResponseTransformerConfigAddArgs
        {
            Headers = new[]
            {
                "string",
            },
            JsonTypes = new[]
            {
                "string",
            },
            Jsons = new[]
            {
                "string",
            },
        },
        Append = new Konnect.Inputs.GatewayPluginResponseTransformerConfigAppendArgs
        {
            Headers = new[]
            {
                "string",
            },
            JsonTypes = new[]
            {
                "string",
            },
            Jsons = new[]
            {
                "string",
            },
        },
        Remove = new Konnect.Inputs.GatewayPluginResponseTransformerConfigRemoveArgs
        {
            Headers = new[]
            {
                "string",
            },
            Jsons = new[]
            {
                "string",
            },
        },
        Rename = new Konnect.Inputs.GatewayPluginResponseTransformerConfigRenameArgs
        {
            Headers = new[]
            {
                "string",
            },
            Jsons = new[]
            {
                "string",
            },
        },
        Replace = new Konnect.Inputs.GatewayPluginResponseTransformerConfigReplaceArgs
        {
            Headers = new[]
            {
                "string",
            },
            JsonTypes = new[]
            {
                "string",
            },
            Jsons = new[]
            {
                "string",
            },
        },
    },
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayPluginResponseTransformerConsumerArgs
    {
        Id = "string",
    },
    ConsumerGroup = new Konnect.Inputs.GatewayPluginResponseTransformerConsumerGroupArgs
    {
        Id = "string",
    },
    Enabled = false,
    GatewayPluginResponseTransformerId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginResponseTransformerOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginResponseTransformerOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginResponseTransformerOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginResponseTransformerRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginResponseTransformerServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := konnect.NewGatewayPluginResponseTransformer(ctx, "gatewayPluginResponseTransformerResource", &konnect.GatewayPluginResponseTransformerArgs{
Config: &.GatewayPluginResponseTransformerConfigArgs{
Add: &.GatewayPluginResponseTransformerConfigAddArgs{
Headers: pulumi.StringArray{
pulumi.String("string"),
},
JsonTypes: pulumi.StringArray{
pulumi.String("string"),
},
Jsons: pulumi.StringArray{
pulumi.String("string"),
},
},
Append: &.GatewayPluginResponseTransformerConfigAppendArgs{
Headers: pulumi.StringArray{
pulumi.String("string"),
},
JsonTypes: pulumi.StringArray{
pulumi.String("string"),
},
Jsons: pulumi.StringArray{
pulumi.String("string"),
},
},
Remove: &.GatewayPluginResponseTransformerConfigRemoveArgs{
Headers: pulumi.StringArray{
pulumi.String("string"),
},
Jsons: pulumi.StringArray{
pulumi.String("string"),
},
},
Rename: &.GatewayPluginResponseTransformerConfigRenameArgs{
Headers: pulumi.StringArray{
pulumi.String("string"),
},
Jsons: pulumi.StringArray{
pulumi.String("string"),
},
},
Replace: &.GatewayPluginResponseTransformerConfigReplaceArgs{
Headers: pulumi.StringArray{
pulumi.String("string"),
},
JsonTypes: pulumi.StringArray{
pulumi.String("string"),
},
Jsons: pulumi.StringArray{
pulumi.String("string"),
},
},
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginResponseTransformerConsumerArgs{
Id: pulumi.String("string"),
},
ConsumerGroup: &.GatewayPluginResponseTransformerConsumerGroupArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginResponseTransformerId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginResponseTransformerOrderingArgs{
After: &.GatewayPluginResponseTransformerOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginResponseTransformerOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginResponseTransformerRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginResponseTransformerServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

var gatewayPluginResponseTransformerResource = new GatewayPluginResponseTransformer("gatewayPluginResponseTransformerResource", GatewayPluginResponseTransformerArgs.builder()
    .config(GatewayPluginResponseTransformerConfigArgs.builder()
        .add(GatewayPluginResponseTransformerConfigAddArgs.builder()
            .headers("string")
            .jsonTypes("string")
            .jsons("string")
            .build())
        .append(GatewayPluginResponseTransformerConfigAppendArgs.builder()
            .headers("string")
            .jsonTypes("string")
            .jsons("string")
            .build())
        .remove(GatewayPluginResponseTransformerConfigRemoveArgs.builder()
            .headers("string")
            .jsons("string")
            .build())
        .rename(GatewayPluginResponseTransformerConfigRenameArgs.builder()
            .headers("string")
            .jsons("string")
            .build())
        .replace(GatewayPluginResponseTransformerConfigReplaceArgs.builder()
            .headers("string")
            .jsonTypes("string")
            .jsons("string")
            .build())
        .build())
    .controlPlaneId("string")
    .consumer(GatewayPluginResponseTransformerConsumerArgs.builder()
        .id("string")
        .build())
    .consumerGroup(GatewayPluginResponseTransformerConsumerGroupArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .gatewayPluginResponseTransformerId("string")
    .instanceName("string")
    .ordering(GatewayPluginResponseTransformerOrderingArgs.builder()
        .after(GatewayPluginResponseTransformerOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginResponseTransformerOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginResponseTransformerRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginResponseTransformerServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

gateway_plugin_response_transformer_resource = konnect.GatewayPluginResponseTransformer("gatewayPluginResponseTransformerResource",
    config={
        "add": {
            "headers": ["string"],
            "json_types": ["string"],
            "jsons": ["string"],
        },
        "append": {
            "headers": ["string"],
            "json_types": ["string"],
            "jsons": ["string"],
        },
        "remove": {
            "headers": ["string"],
            "jsons": ["string"],
        },
        "rename": {
            "headers": ["string"],
            "jsons": ["string"],
        },
        "replace": {
            "headers": ["string"],
            "json_types": ["string"],
            "jsons": ["string"],
        },
    },
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    consumer_group={
        "id": "string",
    },
    enabled=False,
    gateway_plugin_response_transformer_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

const gatewayPluginResponseTransformerResource = new konnect.GatewayPluginResponseTransformer("gatewayPluginResponseTransformerResource", {
    config: {
        add: {
            headers: ["string"],
            jsonTypes: ["string"],
            jsons: ["string"],
        },
        append: {
            headers: ["string"],
            jsonTypes: ["string"],
            jsons: ["string"],
        },
        remove: {
            headers: ["string"],
            jsons: ["string"],
        },
        rename: {
            headers: ["string"],
            jsons: ["string"],
        },
        replace: {
            headers: ["string"],
            jsonTypes: ["string"],
            jsons: ["string"],
        },
    },
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    consumerGroup: {
        id: "string",
    },
    enabled: false,
    gatewayPluginResponseTransformerId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

type: konnect:GatewayPluginResponseTransformer
properties:
    config:
        add:
            headers:
                - string
            jsonTypes:
                - string
            jsons:
                - string
        append:
            headers:
                - string
            jsonTypes:
                - string
            jsons:
                - string
        remove:
            headers:
                - string
            jsons:
                - string
        rename:
            headers:
                - string
            jsons:
                - string
        replace:
            headers:
                - string
            jsonTypes:
                - string
            jsons:
                - string
    consumer:
        id: string
    consumerGroup:
        id: string
    controlPlaneId: string
    enabled: false
    gatewayPluginResponseTransformerId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

Config GatewayPluginResponseTransformerConfig
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginResponseTransformerConsumer: 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 GatewayPluginResponseTransformerConsumerGroup: 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.
GatewayPluginResponseTransformerId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginResponseTransformerOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginResponseTransformerRoute: 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 GatewayPluginResponseTransformerService: 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 GatewayPluginResponseTransformerConfigArgs
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginResponseTransformerConsumerArgs: 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 GatewayPluginResponseTransformerConsumerGroupArgs: 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.
GatewayPluginResponseTransformerId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginResponseTransformerOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginResponseTransformerRouteArgs: 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 GatewayPluginResponseTransformerServiceArgs: 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 GatewayPluginResponseTransformerConfig
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginResponseTransformerConsumer: 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 GatewayPluginResponseTransformerConsumerGroup: 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.
gatewayPluginResponseTransformerId String: The ID of this resource.
instanceName String
ordering GatewayPluginResponseTransformerOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginResponseTransformerRoute: 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 GatewayPluginResponseTransformerService: 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 GatewayPluginResponseTransformerConfig
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginResponseTransformerConsumer: 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 GatewayPluginResponseTransformerConsumerGroup: 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.
gatewayPluginResponseTransformerId string: The ID of this resource.
instanceName string
ordering GatewayPluginResponseTransformerOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginResponseTransformerRoute: 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 GatewayPluginResponseTransformerService: 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 GatewayPluginResponseTransformerConfigArgs
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginResponseTransformerConsumerArgs: 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 GatewayPluginResponseTransformerConsumerGroupArgs: 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_response_transformer_id str: The ID of this resource.
instance_name str
ordering GatewayPluginResponseTransformerOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginResponseTransformerRouteArgs: 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 GatewayPluginResponseTransformerServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.

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

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginResponseTransformerConfigArgs] = None,
        consumer: Optional[GatewayPluginResponseTransformerConsumerArgs] = None,
        consumer_group: Optional[GatewayPluginResponseTransformerConsumerGroupArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_response_transformer_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginResponseTransformerOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginResponseTransformerRouteArgs] = None,
        service: Optional[GatewayPluginResponseTransformerServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginResponseTransformer

func GetGatewayPluginResponseTransformer(ctx *Context, name string, id IDInput, state *GatewayPluginResponseTransformerState, opts ...ResourceOption) (*GatewayPluginResponseTransformer, error)

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

public static GatewayPluginResponseTransformer get(String name, Output<String> id, GatewayPluginResponseTransformerState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginResponseTransformer    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 GatewayPluginResponseTransformerConfig
Consumer GatewayPluginResponseTransformerConsumer: 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 GatewayPluginResponseTransformerConsumerGroup: 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.
GatewayPluginResponseTransformerId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginResponseTransformerOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginResponseTransformerRoute: 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 GatewayPluginResponseTransformerService: 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 GatewayPluginResponseTransformerConfigArgs
Consumer GatewayPluginResponseTransformerConsumerArgs: 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 GatewayPluginResponseTransformerConsumerGroupArgs: 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.
GatewayPluginResponseTransformerId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginResponseTransformerOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginResponseTransformerRouteArgs: 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 GatewayPluginResponseTransformerServiceArgs: 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 GatewayPluginResponseTransformerConfig
consumer GatewayPluginResponseTransformerConsumer: 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 GatewayPluginResponseTransformerConsumerGroup: 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.
gatewayPluginResponseTransformerId String: The ID of this resource.
instanceName String
ordering GatewayPluginResponseTransformerOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginResponseTransformerRoute: 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 GatewayPluginResponseTransformerService: 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 GatewayPluginResponseTransformerConfig
consumer GatewayPluginResponseTransformerConsumer: 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 GatewayPluginResponseTransformerConsumerGroup: 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.
gatewayPluginResponseTransformerId string: The ID of this resource.
instanceName string
ordering GatewayPluginResponseTransformerOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginResponseTransformerRoute: 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 GatewayPluginResponseTransformerService: 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 GatewayPluginResponseTransformerConfigArgs
consumer GatewayPluginResponseTransformerConsumerArgs: 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 GatewayPluginResponseTransformerConsumerGroupArgs: 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_response_transformer_id str: The ID of this resource.
instance_name str
ordering GatewayPluginResponseTransformerOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginResponseTransformerRouteArgs: 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 GatewayPluginResponseTransformerServiceArgs: 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.
gatewayPluginResponseTransformerId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A set of strings representing HTTP protocols.
route Property Map: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number: Unix epoch when the resource was last updated.

Supporting Types

GatewayPluginResponseTransformerConfig, GatewayPluginResponseTransformerConfigArgs

Add GatewayPluginResponseTransformerConfigAdd
Append GatewayPluginResponseTransformerConfigAppend
Remove GatewayPluginResponseTransformerConfigRemove
Rename GatewayPluginResponseTransformerConfigRename
Replace GatewayPluginResponseTransformerConfigReplace

Add GatewayPluginResponseTransformerConfigAdd
Append GatewayPluginResponseTransformerConfigAppend
Remove GatewayPluginResponseTransformerConfigRemove
Rename GatewayPluginResponseTransformerConfigRename
Replace GatewayPluginResponseTransformerConfigReplace

add GatewayPluginResponseTransformerConfigAdd
append GatewayPluginResponseTransformerConfigAppend
remove GatewayPluginResponseTransformerConfigRemove
rename GatewayPluginResponseTransformerConfigRename
replace GatewayPluginResponseTransformerConfigReplace

add GatewayPluginResponseTransformerConfigAdd
append GatewayPluginResponseTransformerConfigAppend
remove GatewayPluginResponseTransformerConfigRemove
rename GatewayPluginResponseTransformerConfigRename
replace GatewayPluginResponseTransformerConfigReplace

add GatewayPluginResponseTransformerConfigAdd
append GatewayPluginResponseTransformerConfigAppend
remove GatewayPluginResponseTransformerConfigRemove
rename GatewayPluginResponseTransformerConfigRename
replace GatewayPluginResponseTransformerConfigReplace

add Property Map
append Property Map
remove Property Map
rename Property Map
replace Property Map

GatewayPluginResponseTransformerConfigAdd, GatewayPluginResponseTransformerConfigAddArgs

Headers List<string>
JsonTypes List<string>: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
Jsons List<string>

Headers []string
JsonTypes []string: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
Jsons []string

headers List<String>
jsonTypes List<String>: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons List<String>

headers string[]
jsonTypes string[]: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons string[]

headers Sequence[str]
json_types Sequence[str]: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons Sequence[str]

headers List<String>
jsonTypes List<String>: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons List<String>

GatewayPluginResponseTransformerConfigAppend, GatewayPluginResponseTransformerConfigAppendArgs

Headers List<string>
JsonTypes List<string>: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
Jsons List<string>

Headers []string
JsonTypes []string: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
Jsons []string

headers List<String>
jsonTypes List<String>: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons List<String>

headers string[]
jsonTypes string[]: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons string[]

headers Sequence[str]
json_types Sequence[str]: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons Sequence[str]

headers List<String>
jsonTypes List<String>: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons List<String>

GatewayPluginResponseTransformerConfigRemove, GatewayPluginResponseTransformerConfigRemoveArgs

Headers List<string>
Jsons List<string>

Headers []string
Jsons []string

headers List<String>
jsons List<String>

headers string[]
jsons string[]

headers Sequence[str]
jsons Sequence[str]

headers List<String>
jsons List<String>

GatewayPluginResponseTransformerConfigRename, GatewayPluginResponseTransformerConfigRenameArgs

Headers List<string>
Jsons List<string>

Headers []string
Jsons []string

headers List<String>
jsons List<String>

headers string[]
jsons string[]

headers Sequence[str]
jsons Sequence[str]

headers List<String>
jsons List<String>

GatewayPluginResponseTransformerConfigReplace, GatewayPluginResponseTransformerConfigReplaceArgs

Headers List<string>
JsonTypes List<string>: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
Jsons List<string>

Headers []string
JsonTypes []string: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
Jsons []string

headers List<String>
jsonTypes List<String>: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons List<String>

headers string[]
jsonTypes string[]: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons string[]

headers Sequence[str]
json_types Sequence[str]: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons Sequence[str]

headers List<String>
jsonTypes List<String>: List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.
jsons List<String>

GatewayPluginResponseTransformerConsumer, GatewayPluginResponseTransformerConsumerArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginResponseTransformerConsumerGroup, GatewayPluginResponseTransformerConsumerGroupArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginResponseTransformerOrdering, GatewayPluginResponseTransformerOrderingArgs

After GatewayPluginResponseTransformerOrderingAfter
Before GatewayPluginResponseTransformerOrderingBefore

After GatewayPluginResponseTransformerOrderingAfter
Before GatewayPluginResponseTransformerOrderingBefore

after GatewayPluginResponseTransformerOrderingAfter
before GatewayPluginResponseTransformerOrderingBefore

after GatewayPluginResponseTransformerOrderingAfter
before GatewayPluginResponseTransformerOrderingBefore

after GatewayPluginResponseTransformerOrderingAfter
before GatewayPluginResponseTransformerOrderingBefore

after Property Map
before Property Map

GatewayPluginResponseTransformerOrderingAfter, GatewayPluginResponseTransformerOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginResponseTransformerOrderingBefore, GatewayPluginResponseTransformerOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginResponseTransformerRoute, GatewayPluginResponseTransformerRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginResponseTransformerService, GatewayPluginResponseTransformerServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

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

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

Package Details

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

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

kong/terraform-provider-konnect

konnect.GatewayPluginResponseTransformer

On this page

On this page

Example Usage

Create GatewayPluginResponseTransformer Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginResponseTransformer Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginResponseTransformer Resource

Supporting Types

GatewayPluginResponseTransformerConfig, GatewayPluginResponseTransformerConfigArgs

GatewayPluginResponseTransformerConfigAdd, GatewayPluginResponseTransformerConfigAddArgs

GatewayPluginResponseTransformerConfigAppend, GatewayPluginResponseTransformerConfigAppendArgs

GatewayPluginResponseTransformerConfigRemove, GatewayPluginResponseTransformerConfigRemoveArgs

GatewayPluginResponseTransformerConfigRename, GatewayPluginResponseTransformerConfigRenameArgs

GatewayPluginResponseTransformerConfigReplace, GatewayPluginResponseTransformerConfigReplaceArgs

GatewayPluginResponseTransformerConsumer, GatewayPluginResponseTransformerConsumerArgs

GatewayPluginResponseTransformerConsumerGroup, GatewayPluginResponseTransformerConsumerGroupArgs

GatewayPluginResponseTransformerOrdering, GatewayPluginResponseTransformerOrderingArgs

GatewayPluginResponseTransformerOrderingAfter, GatewayPluginResponseTransformerOrderingAfterArgs

GatewayPluginResponseTransformerOrderingBefore, GatewayPluginResponseTransformerOrderingBeforeArgs

GatewayPluginResponseTransformerRoute, GatewayPluginResponseTransformerRouteArgs

GatewayPluginResponseTransformerService, GatewayPluginResponseTransformerServiceArgs

Import

Package Details

On this page

On this page