konnect 2.4.1, Mar 13 25

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

konnect.GatewayPluginCorrelationId

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.GatewayPluginCorrelationId;
import com.pulumi.konnect.GatewayPluginCorrelationIdArgs;
import com.pulumi.konnect.inputs.GatewayPluginCorrelationIdConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginCorrelationIdConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginCorrelationIdOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginCorrelationIdOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginCorrelationIdOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginCorrelationIdRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginCorrelationIdServiceArgs;
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 myGatewayplugincorrelationid = new GatewayPluginCorrelationId("myGatewayplugincorrelationid", GatewayPluginCorrelationIdArgs.builder()
            .config(GatewayPluginCorrelationIdConfigArgs.builder()
                .echo_downstream(false)
                .generator("uuid")
                .header_name("...my_header_name...")
                .build())
            .consumer(GatewayPluginCorrelationIdConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginCorrelationIdId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginCorrelationIdOrderingArgs.builder()
                .after(GatewayPluginCorrelationIdOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginCorrelationIdOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("grpc")
            .route(GatewayPluginCorrelationIdRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginCorrelationIdServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

resources:
  myGatewayplugincorrelationid:
    type: konnect:GatewayPluginCorrelationId
    properties:
      config:
        echo_downstream: false
        generator: uuid
        header_name: '...my_header_name...'
      consumer:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginCorrelationIdId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - grpc
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

Create GatewayPluginCorrelationId Resource

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

Constructor syntax

new GatewayPluginCorrelationId(name: string, args: GatewayPluginCorrelationIdArgs, opts?: CustomResourceOptions);

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

@overload
def GatewayPluginCorrelationId(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               config: Optional[GatewayPluginCorrelationIdConfigArgs] = None,
                               control_plane_id: Optional[str] = None,
                               consumer: Optional[GatewayPluginCorrelationIdConsumerArgs] = None,
                               enabled: Optional[bool] = None,
                               gateway_plugin_correlation_id_id: Optional[str] = None,
                               instance_name: Optional[str] = None,
                               ordering: Optional[GatewayPluginCorrelationIdOrderingArgs] = None,
                               protocols: Optional[Sequence[str]] = None,
                               route: Optional[GatewayPluginCorrelationIdRouteArgs] = None,
                               service: Optional[GatewayPluginCorrelationIdServiceArgs] = None,
                               tags: Optional[Sequence[str]] = None)

func NewGatewayPluginCorrelationId(ctx *Context, name string, args GatewayPluginCorrelationIdArgs, opts ...ResourceOption) (*GatewayPluginCorrelationId, error)

public GatewayPluginCorrelationId(string name, GatewayPluginCorrelationIdArgs args, CustomResourceOptions? opts = null)

public GatewayPluginCorrelationId(String name, GatewayPluginCorrelationIdArgs args)
public GatewayPluginCorrelationId(String name, GatewayPluginCorrelationIdArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args GatewayPluginCorrelationIdArgs: 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 gatewayPluginCorrelationIdResource = new Konnect.GatewayPluginCorrelationId("gatewayPluginCorrelationIdResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginCorrelationIdConfigArgs
    {
        EchoDownstream = false,
        Generator = "string",
        HeaderName = "string",
    },
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayPluginCorrelationIdConsumerArgs
    {
        Id = "string",
    },
    Enabled = false,
    GatewayPluginCorrelationIdId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginCorrelationIdOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginCorrelationIdOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginCorrelationIdOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginCorrelationIdRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginCorrelationIdServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := konnect.NewGatewayPluginCorrelationId(ctx, "gatewayPluginCorrelationIdResource", &konnect.GatewayPluginCorrelationIdArgs{
Config: &.GatewayPluginCorrelationIdConfigArgs{
EchoDownstream: pulumi.Bool(false),
Generator: pulumi.String("string"),
HeaderName: pulumi.String("string"),
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginCorrelationIdConsumerArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginCorrelationIdId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginCorrelationIdOrderingArgs{
After: &.GatewayPluginCorrelationIdOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginCorrelationIdOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginCorrelationIdRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginCorrelationIdServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

var gatewayPluginCorrelationIdResource = new GatewayPluginCorrelationId("gatewayPluginCorrelationIdResource", GatewayPluginCorrelationIdArgs.builder()
    .config(GatewayPluginCorrelationIdConfigArgs.builder()
        .echoDownstream(false)
        .generator("string")
        .headerName("string")
        .build())
    .controlPlaneId("string")
    .consumer(GatewayPluginCorrelationIdConsumerArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .gatewayPluginCorrelationIdId("string")
    .instanceName("string")
    .ordering(GatewayPluginCorrelationIdOrderingArgs.builder()
        .after(GatewayPluginCorrelationIdOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginCorrelationIdOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginCorrelationIdRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginCorrelationIdServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

gateway_plugin_correlation_id_resource = konnect.GatewayPluginCorrelationId("gatewayPluginCorrelationIdResource",
    config={
        "echo_downstream": False,
        "generator": "string",
        "header_name": "string",
    },
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    enabled=False,
    gateway_plugin_correlation_id_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

const gatewayPluginCorrelationIdResource = new konnect.GatewayPluginCorrelationId("gatewayPluginCorrelationIdResource", {
    config: {
        echoDownstream: false,
        generator: "string",
        headerName: "string",
    },
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    enabled: false,
    gatewayPluginCorrelationIdId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

type: konnect:GatewayPluginCorrelationId
properties:
    config:
        echoDownstream: false
        generator: string
        headerName: string
    consumer:
        id: string
    controlPlaneId: string
    enabled: false
    gatewayPluginCorrelationIdId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

Config GatewayPluginCorrelationIdConfig
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginCorrelationIdConsumer: 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.
Enabled bool: Whether the plugin is applied.
GatewayPluginCorrelationIdId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginCorrelationIdOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginCorrelationIdRoute: 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 GatewayPluginCorrelationIdService: 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 GatewayPluginCorrelationIdConfigArgs
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginCorrelationIdConsumerArgs: 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.
Enabled bool: Whether the plugin is applied.
GatewayPluginCorrelationIdId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginCorrelationIdOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginCorrelationIdRouteArgs: 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 GatewayPluginCorrelationIdServiceArgs: 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 GatewayPluginCorrelationIdConfig
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginCorrelationIdConsumer: 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.
enabled Boolean: Whether the plugin is applied.
gatewayPluginCorrelationIdId String: The ID of this resource.
instanceName String
ordering GatewayPluginCorrelationIdOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginCorrelationIdRoute: 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 GatewayPluginCorrelationIdService: 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 GatewayPluginCorrelationIdConfig
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginCorrelationIdConsumer: 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.
enabled boolean: Whether the plugin is applied.
gatewayPluginCorrelationIdId string: The ID of this resource.
instanceName string
ordering GatewayPluginCorrelationIdOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginCorrelationIdRoute: 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 GatewayPluginCorrelationIdService: 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 GatewayPluginCorrelationIdConfigArgs
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginCorrelationIdConsumerArgs: 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.
enabled bool: Whether the plugin is applied.
gateway_plugin_correlation_id_id str: The ID of this resource.
instance_name str
ordering GatewayPluginCorrelationIdOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginCorrelationIdRouteArgs: 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 GatewayPluginCorrelationIdServiceArgs: 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.
enabled Boolean: Whether the plugin is applied.
gatewayPluginCorrelationIdId 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 GatewayPluginCorrelationId 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 GatewayPluginCorrelationId Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginCorrelationIdConfigArgs] = None,
        consumer: Optional[GatewayPluginCorrelationIdConsumerArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_correlation_id_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginCorrelationIdOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginCorrelationIdRouteArgs] = None,
        service: Optional[GatewayPluginCorrelationIdServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginCorrelationId

func GetGatewayPluginCorrelationId(ctx *Context, name string, id IDInput, state *GatewayPluginCorrelationIdState, opts ...ResourceOption) (*GatewayPluginCorrelationId, error)

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

public static GatewayPluginCorrelationId get(String name, Output<String> id, GatewayPluginCorrelationIdState state, CustomResourceOptions options)

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

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

GatewayPluginCorrelationIdConfig, GatewayPluginCorrelationIdConfigArgs

EchoDownstream bool: Whether to echo the header back to downstream (the client).
Generator string: The generator to use for the correlation ID. Accepted values are uuid, uuid#counter, and tracker. See Generators. must be one of ["tracker", "uuid", "uuid#counter"]
HeaderName string: The HTTP header name to use for the correlation ID.

EchoDownstream bool: Whether to echo the header back to downstream (the client).
Generator string: The generator to use for the correlation ID. Accepted values are uuid, uuid#counter, and tracker. See Generators. must be one of ["tracker", "uuid", "uuid#counter"]
HeaderName string: The HTTP header name to use for the correlation ID.

echoDownstream Boolean: Whether to echo the header back to downstream (the client).
generator String: The generator to use for the correlation ID. Accepted values are uuid, uuid#counter, and tracker. See Generators. must be one of ["tracker", "uuid", "uuid#counter"]
headerName String: The HTTP header name to use for the correlation ID.

echoDownstream boolean: Whether to echo the header back to downstream (the client).
generator string: The generator to use for the correlation ID. Accepted values are uuid, uuid#counter, and tracker. See Generators. must be one of ["tracker", "uuid", "uuid#counter"]
headerName string: The HTTP header name to use for the correlation ID.

echo_downstream bool: Whether to echo the header back to downstream (the client).
generator str: The generator to use for the correlation ID. Accepted values are uuid, uuid#counter, and tracker. See Generators. must be one of ["tracker", "uuid", "uuid#counter"]
header_name str: The HTTP header name to use for the correlation ID.

echoDownstream Boolean: Whether to echo the header back to downstream (the client).
generator String: The generator to use for the correlation ID. Accepted values are uuid, uuid#counter, and tracker. See Generators. must be one of ["tracker", "uuid", "uuid#counter"]
headerName String: The HTTP header name to use for the correlation ID.

GatewayPluginCorrelationIdConsumer, GatewayPluginCorrelationIdConsumerArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginCorrelationIdOrdering, GatewayPluginCorrelationIdOrderingArgs

After GatewayPluginCorrelationIdOrderingAfter
Before GatewayPluginCorrelationIdOrderingBefore

After GatewayPluginCorrelationIdOrderingAfter
Before GatewayPluginCorrelationIdOrderingBefore

after GatewayPluginCorrelationIdOrderingAfter
before GatewayPluginCorrelationIdOrderingBefore

after GatewayPluginCorrelationIdOrderingAfter
before GatewayPluginCorrelationIdOrderingBefore

after GatewayPluginCorrelationIdOrderingAfter
before GatewayPluginCorrelationIdOrderingBefore

after Property Map
before Property Map

GatewayPluginCorrelationIdOrderingAfter, GatewayPluginCorrelationIdOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginCorrelationIdOrderingBefore, GatewayPluginCorrelationIdOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginCorrelationIdRoute, GatewayPluginCorrelationIdRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginCorrelationIdService, GatewayPluginCorrelationIdServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginCorrelationId:GatewayPluginCorrelationId my_konnect_gateway_plugin_correlation_id "{ \"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.GatewayPluginCorrelationId

On this page

On this page

Example Usage

Create GatewayPluginCorrelationId Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginCorrelationId Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginCorrelationId Resource

Supporting Types

GatewayPluginCorrelationIdConfig, GatewayPluginCorrelationIdConfigArgs

GatewayPluginCorrelationIdConsumer, GatewayPluginCorrelationIdConsumerArgs

GatewayPluginCorrelationIdOrdering, GatewayPluginCorrelationIdOrderingArgs

GatewayPluginCorrelationIdOrderingAfter, GatewayPluginCorrelationIdOrderingAfterArgs

GatewayPluginCorrelationIdOrderingBefore, GatewayPluginCorrelationIdOrderingBeforeArgs

GatewayPluginCorrelationIdRoute, GatewayPluginCorrelationIdRouteArgs

GatewayPluginCorrelationIdService, GatewayPluginCorrelationIdServiceArgs

Import

Package Details

On this page

On this page