1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginJq
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.GatewayPluginJq

Explore with Pulumi AI

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

    GatewayPluginJq Resource

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.GatewayPluginJq;
    import com.pulumi.konnect.GatewayPluginJqArgs;
    import com.pulumi.konnect.inputs.GatewayPluginJqConfigArgs;
    import com.pulumi.konnect.inputs.GatewayPluginJqConsumerArgs;
    import com.pulumi.konnect.inputs.GatewayPluginJqOrderingArgs;
    import com.pulumi.konnect.inputs.GatewayPluginJqOrderingAfterArgs;
    import com.pulumi.konnect.inputs.GatewayPluginJqOrderingBeforeArgs;
    import com.pulumi.konnect.inputs.GatewayPluginJqRouteArgs;
    import com.pulumi.konnect.inputs.GatewayPluginJqServiceArgs;
    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 myGatewaypluginjq = new GatewayPluginJq("myGatewaypluginjq", GatewayPluginJqArgs.builder()
                .config(GatewayPluginJqConfigArgs.builder()
                    .request_if_media_type("...")
                    .request_jq_program("...my_request_jq_program...")
                    .request_jq_program_options(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .response_if_media_type("...")
                    .response_if_status_code(188)
                    .response_jq_program("...my_response_jq_program...")
                    .response_jq_program_options(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build())
                .consumer(GatewayPluginJqConsumerArgs.builder()
                    .id("...my_id...")
                    .build())
                .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
                .enabled(false)
                .gatewayPluginJqId("...my_id...")
                .instanceName("...my_instance_name...")
                .ordering(GatewayPluginJqOrderingArgs.builder()
                    .after(GatewayPluginJqOrderingAfterArgs.builder()
                        .access("...")
                        .build())
                    .before(GatewayPluginJqOrderingBeforeArgs.builder()
                        .access("...")
                        .build())
                    .build())
                .protocols("grpcs")
                .route(GatewayPluginJqRouteArgs.builder()
                    .id("...my_id...")
                    .build())
                .service(GatewayPluginJqServiceArgs.builder()
                    .id("...my_id...")
                    .build())
                .tags("...")
                .build());
    
        }
    }
    
    resources:
      myGatewaypluginjq:
        type: konnect:GatewayPluginJq
        properties:
          config:
            request_if_media_type:
              - '...'
            request_jq_program: '...my_request_jq_program...'
            request_jq_program_options:
              asciiOutput: false
              compactOutput: false
              joinOutput: true
              rawOutput: true
              sortKeys: false
            response_if_media_type:
              - '...'
            response_if_status_code:
              - 188
            response_jq_program: '...my_response_jq_program...'
            response_jq_program_options:
              asciiOutput: false
              compactOutput: true
              joinOutput: true
              rawOutput: false
              sortKeys: false
          consumer:
            id: '...my_id...'
          controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
          enabled: false
          gatewayPluginJqId: '...my_id...'
          instanceName: '...my_instance_name...'
          ordering:
            after:
              access:
                - '...'
            before:
              access:
                - '...'
          protocols:
            - grpcs
          route:
            id: '...my_id...'
          service:
            id: '...my_id...'
          tags:
            - '...'
    

    Create GatewayPluginJq Resource

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

    Constructor syntax

    new GatewayPluginJq(name: string, args: GatewayPluginJqArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayPluginJq(resource_name: str,
                        args: GatewayPluginJqArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayPluginJq(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        config: Optional[GatewayPluginJqConfigArgs] = None,
                        control_plane_id: Optional[str] = None,
                        consumer: Optional[GatewayPluginJqConsumerArgs] = None,
                        enabled: Optional[bool] = None,
                        gateway_plugin_jq_id: Optional[str] = None,
                        instance_name: Optional[str] = None,
                        ordering: Optional[GatewayPluginJqOrderingArgs] = None,
                        protocols: Optional[Sequence[str]] = None,
                        route: Optional[GatewayPluginJqRouteArgs] = None,
                        service: Optional[GatewayPluginJqServiceArgs] = None,
                        tags: Optional[Sequence[str]] = None)
    func NewGatewayPluginJq(ctx *Context, name string, args GatewayPluginJqArgs, opts ...ResourceOption) (*GatewayPluginJq, error)
    public GatewayPluginJq(string name, GatewayPluginJqArgs args, CustomResourceOptions? opts = null)
    public GatewayPluginJq(String name, GatewayPluginJqArgs args)
    public GatewayPluginJq(String name, GatewayPluginJqArgs args, CustomResourceOptions options)
    
    type: konnect:GatewayPluginJq
    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 GatewayPluginJqArgs
    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 GatewayPluginJqArgs
    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 GatewayPluginJqArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayPluginJqArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayPluginJqArgs
    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 gatewayPluginJqResource = new Konnect.GatewayPluginJq("gatewayPluginJqResource", new()
    {
        Config = new Konnect.Inputs.GatewayPluginJqConfigArgs
        {
            RequestIfMediaTypes = new[]
            {
                "string",
            },
            RequestJqProgram = "string",
            RequestJqProgramOptions = new Konnect.Inputs.GatewayPluginJqConfigRequestJqProgramOptionsArgs
            {
                AsciiOutput = false,
                CompactOutput = false,
                JoinOutput = false,
                RawOutput = false,
                SortKeys = false,
            },
            ResponseIfMediaTypes = new[]
            {
                "string",
            },
            ResponseIfStatusCodes = new[]
            {
                0,
            },
            ResponseJqProgram = "string",
            ResponseJqProgramOptions = new Konnect.Inputs.GatewayPluginJqConfigResponseJqProgramOptionsArgs
            {
                AsciiOutput = false,
                CompactOutput = false,
                JoinOutput = false,
                RawOutput = false,
                SortKeys = false,
            },
        },
        ControlPlaneId = "string",
        Consumer = new Konnect.Inputs.GatewayPluginJqConsumerArgs
        {
            Id = "string",
        },
        Enabled = false,
        GatewayPluginJqId = "string",
        InstanceName = "string",
        Ordering = new Konnect.Inputs.GatewayPluginJqOrderingArgs
        {
            After = new Konnect.Inputs.GatewayPluginJqOrderingAfterArgs
            {
                Accesses = new[]
                {
                    "string",
                },
            },
            Before = new Konnect.Inputs.GatewayPluginJqOrderingBeforeArgs
            {
                Accesses = new[]
                {
                    "string",
                },
            },
        },
        Protocols = new[]
        {
            "string",
        },
        Route = new Konnect.Inputs.GatewayPluginJqRouteArgs
        {
            Id = "string",
        },
        Service = new Konnect.Inputs.GatewayPluginJqServiceArgs
        {
            Id = "string",
        },
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := konnect.NewGatewayPluginJq(ctx, "gatewayPluginJqResource", &konnect.GatewayPluginJqArgs{
    Config: &.GatewayPluginJqConfigArgs{
    RequestIfMediaTypes: pulumi.StringArray{
    pulumi.String("string"),
    },
    RequestJqProgram: pulumi.String("string"),
    RequestJqProgramOptions: &.GatewayPluginJqConfigRequestJqProgramOptionsArgs{
    AsciiOutput: pulumi.Bool(false),
    CompactOutput: pulumi.Bool(false),
    JoinOutput: pulumi.Bool(false),
    RawOutput: pulumi.Bool(false),
    SortKeys: pulumi.Bool(false),
    },
    ResponseIfMediaTypes: pulumi.StringArray{
    pulumi.String("string"),
    },
    ResponseIfStatusCodes: pulumi.Float64Array{
    pulumi.Float64(0),
    },
    ResponseJqProgram: pulumi.String("string"),
    ResponseJqProgramOptions: &.GatewayPluginJqConfigResponseJqProgramOptionsArgs{
    AsciiOutput: pulumi.Bool(false),
    CompactOutput: pulumi.Bool(false),
    JoinOutput: pulumi.Bool(false),
    RawOutput: pulumi.Bool(false),
    SortKeys: pulumi.Bool(false),
    },
    },
    ControlPlaneId: pulumi.String("string"),
    Consumer: &.GatewayPluginJqConsumerArgs{
    Id: pulumi.String("string"),
    },
    Enabled: pulumi.Bool(false),
    GatewayPluginJqId: pulumi.String("string"),
    InstanceName: pulumi.String("string"),
    Ordering: &.GatewayPluginJqOrderingArgs{
    After: &.GatewayPluginJqOrderingAfterArgs{
    Accesses: pulumi.StringArray{
    pulumi.String("string"),
    },
    },
    Before: &.GatewayPluginJqOrderingBeforeArgs{
    Accesses: pulumi.StringArray{
    pulumi.String("string"),
    },
    },
    },
    Protocols: pulumi.StringArray{
    pulumi.String("string"),
    },
    Route: &.GatewayPluginJqRouteArgs{
    Id: pulumi.String("string"),
    },
    Service: &.GatewayPluginJqServiceArgs{
    Id: pulumi.String("string"),
    },
    Tags: pulumi.StringArray{
    pulumi.String("string"),
    },
    })
    
    var gatewayPluginJqResource = new GatewayPluginJq("gatewayPluginJqResource", GatewayPluginJqArgs.builder()
        .config(GatewayPluginJqConfigArgs.builder()
            .requestIfMediaTypes("string")
            .requestJqProgram("string")
            .requestJqProgramOptions(GatewayPluginJqConfigRequestJqProgramOptionsArgs.builder()
                .asciiOutput(false)
                .compactOutput(false)
                .joinOutput(false)
                .rawOutput(false)
                .sortKeys(false)
                .build())
            .responseIfMediaTypes("string")
            .responseIfStatusCodes(0)
            .responseJqProgram("string")
            .responseJqProgramOptions(GatewayPluginJqConfigResponseJqProgramOptionsArgs.builder()
                .asciiOutput(false)
                .compactOutput(false)
                .joinOutput(false)
                .rawOutput(false)
                .sortKeys(false)
                .build())
            .build())
        .controlPlaneId("string")
        .consumer(GatewayPluginJqConsumerArgs.builder()
            .id("string")
            .build())
        .enabled(false)
        .gatewayPluginJqId("string")
        .instanceName("string")
        .ordering(GatewayPluginJqOrderingArgs.builder()
            .after(GatewayPluginJqOrderingAfterArgs.builder()
                .accesses("string")
                .build())
            .before(GatewayPluginJqOrderingBeforeArgs.builder()
                .accesses("string")
                .build())
            .build())
        .protocols("string")
        .route(GatewayPluginJqRouteArgs.builder()
            .id("string")
            .build())
        .service(GatewayPluginJqServiceArgs.builder()
            .id("string")
            .build())
        .tags("string")
        .build());
    
    gateway_plugin_jq_resource = konnect.GatewayPluginJq("gatewayPluginJqResource",
        config={
            "request_if_media_types": ["string"],
            "request_jq_program": "string",
            "request_jq_program_options": {
                "ascii_output": False,
                "compact_output": False,
                "join_output": False,
                "raw_output": False,
                "sort_keys": False,
            },
            "response_if_media_types": ["string"],
            "response_if_status_codes": [0],
            "response_jq_program": "string",
            "response_jq_program_options": {
                "ascii_output": False,
                "compact_output": False,
                "join_output": False,
                "raw_output": False,
                "sort_keys": False,
            },
        },
        control_plane_id="string",
        consumer={
            "id": "string",
        },
        enabled=False,
        gateway_plugin_jq_id="string",
        instance_name="string",
        ordering={
            "after": {
                "accesses": ["string"],
            },
            "before": {
                "accesses": ["string"],
            },
        },
        protocols=["string"],
        route={
            "id": "string",
        },
        service={
            "id": "string",
        },
        tags=["string"])
    
    const gatewayPluginJqResource = new konnect.GatewayPluginJq("gatewayPluginJqResource", {
        config: {
            requestIfMediaTypes: ["string"],
            requestJqProgram: "string",
            requestJqProgramOptions: {
                asciiOutput: false,
                compactOutput: false,
                joinOutput: false,
                rawOutput: false,
                sortKeys: false,
            },
            responseIfMediaTypes: ["string"],
            responseIfStatusCodes: [0],
            responseJqProgram: "string",
            responseJqProgramOptions: {
                asciiOutput: false,
                compactOutput: false,
                joinOutput: false,
                rawOutput: false,
                sortKeys: false,
            },
        },
        controlPlaneId: "string",
        consumer: {
            id: "string",
        },
        enabled: false,
        gatewayPluginJqId: "string",
        instanceName: "string",
        ordering: {
            after: {
                accesses: ["string"],
            },
            before: {
                accesses: ["string"],
            },
        },
        protocols: ["string"],
        route: {
            id: "string",
        },
        service: {
            id: "string",
        },
        tags: ["string"],
    });
    
    type: konnect:GatewayPluginJq
    properties:
        config:
            requestIfMediaTypes:
                - string
            requestJqProgram: string
            requestJqProgramOptions:
                asciiOutput: false
                compactOutput: false
                joinOutput: false
                rawOutput: false
                sortKeys: false
            responseIfMediaTypes:
                - string
            responseIfStatusCodes:
                - 0
            responseJqProgram: string
            responseJqProgramOptions:
                asciiOutput: false
                compactOutput: false
                joinOutput: false
                rawOutput: false
                sortKeys: false
        consumer:
            id: string
        controlPlaneId: string
        enabled: false
        gatewayPluginJqId: string
        instanceName: string
        ordering:
            after:
                accesses:
                    - string
            before:
                accesses:
                    - string
        protocols:
            - string
        route:
            id: string
        service:
            id: string
        tags:
            - string
    

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

    Config GatewayPluginJqConfig
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginJqConsumer
    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.
    GatewayPluginJqId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginJqOrdering
    Protocols List<string>
    A set of strings representing HTTP protocols.
    Route GatewayPluginJqRoute
    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 GatewayPluginJqService
    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 GatewayPluginJqConfigArgs
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginJqConsumerArgs
    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.
    GatewayPluginJqId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginJqOrderingArgs
    Protocols []string
    A set of strings representing HTTP protocols.
    Route GatewayPluginJqRouteArgs
    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 GatewayPluginJqServiceArgs
    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 GatewayPluginJqConfig
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginJqConsumer
    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.
    gatewayPluginJqId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginJqOrdering
    protocols List<String>
    A set of strings representing HTTP protocols.
    route GatewayPluginJqRoute
    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 GatewayPluginJqService
    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 GatewayPluginJqConfig
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginJqConsumer
    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.
    gatewayPluginJqId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginJqOrdering
    protocols string[]
    A set of strings representing HTTP protocols.
    route GatewayPluginJqRoute
    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 GatewayPluginJqService
    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 GatewayPluginJqConfigArgs
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginJqConsumerArgs
    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_jq_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginJqOrderingArgs
    protocols Sequence[str]
    A set of strings representing HTTP protocols.
    route GatewayPluginJqRouteArgs
    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 GatewayPluginJqServiceArgs
    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.
    gatewayPluginJqId 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 GatewayPluginJq 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 GatewayPluginJq Resource

    Get an existing GatewayPluginJq 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?: GatewayPluginJqState, opts?: CustomResourceOptions): GatewayPluginJq
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            config: Optional[GatewayPluginJqConfigArgs] = None,
            consumer: Optional[GatewayPluginJqConsumerArgs] = None,
            control_plane_id: Optional[str] = None,
            created_at: Optional[float] = None,
            enabled: Optional[bool] = None,
            gateway_plugin_jq_id: Optional[str] = None,
            instance_name: Optional[str] = None,
            ordering: Optional[GatewayPluginJqOrderingArgs] = None,
            protocols: Optional[Sequence[str]] = None,
            route: Optional[GatewayPluginJqRouteArgs] = None,
            service: Optional[GatewayPluginJqServiceArgs] = None,
            tags: Optional[Sequence[str]] = None,
            updated_at: Optional[float] = None) -> GatewayPluginJq
    func GetGatewayPluginJq(ctx *Context, name string, id IDInput, state *GatewayPluginJqState, opts ...ResourceOption) (*GatewayPluginJq, error)
    public static GatewayPluginJq Get(string name, Input<string> id, GatewayPluginJqState? state, CustomResourceOptions? opts = null)
    public static GatewayPluginJq get(String name, Output<String> id, GatewayPluginJqState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayPluginJq    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 GatewayPluginJqConfig
    Consumer GatewayPluginJqConsumer
    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.
    GatewayPluginJqId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginJqOrdering
    Protocols List<string>
    A set of strings representing HTTP protocols.
    Route GatewayPluginJqRoute
    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 GatewayPluginJqService
    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 GatewayPluginJqConfigArgs
    Consumer GatewayPluginJqConsumerArgs
    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.
    GatewayPluginJqId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginJqOrderingArgs
    Protocols []string
    A set of strings representing HTTP protocols.
    Route GatewayPluginJqRouteArgs
    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 GatewayPluginJqServiceArgs
    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 GatewayPluginJqConfig
    consumer GatewayPluginJqConsumer
    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.
    gatewayPluginJqId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginJqOrdering
    protocols List<String>
    A set of strings representing HTTP protocols.
    route GatewayPluginJqRoute
    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 GatewayPluginJqService
    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 GatewayPluginJqConfig
    consumer GatewayPluginJqConsumer
    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.
    gatewayPluginJqId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginJqOrdering
    protocols string[]
    A set of strings representing HTTP protocols.
    route GatewayPluginJqRoute
    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 GatewayPluginJqService
    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 GatewayPluginJqConfigArgs
    consumer GatewayPluginJqConsumerArgs
    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_jq_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginJqOrderingArgs
    protocols Sequence[str]
    A set of strings representing HTTP protocols.
    route GatewayPluginJqRouteArgs
    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 GatewayPluginJqServiceArgs
    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.
    gatewayPluginJqId 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

    GatewayPluginJqConfig, GatewayPluginJqConfigArgs

    GatewayPluginJqConfigRequestJqProgramOptions, GatewayPluginJqConfigRequestJqProgramOptionsArgs

    asciiOutput Boolean
    compactOutput Boolean
    joinOutput Boolean
    rawOutput Boolean
    sortKeys Boolean
    asciiOutput boolean
    compactOutput boolean
    joinOutput boolean
    rawOutput boolean
    sortKeys boolean
    asciiOutput Boolean
    compactOutput Boolean
    joinOutput Boolean
    rawOutput Boolean
    sortKeys Boolean

    GatewayPluginJqConfigResponseJqProgramOptions, GatewayPluginJqConfigResponseJqProgramOptionsArgs

    asciiOutput Boolean
    compactOutput Boolean
    joinOutput Boolean
    rawOutput Boolean
    sortKeys Boolean
    asciiOutput boolean
    compactOutput boolean
    joinOutput boolean
    rawOutput boolean
    sortKeys boolean
    asciiOutput Boolean
    compactOutput Boolean
    joinOutput Boolean
    rawOutput Boolean
    sortKeys Boolean

    GatewayPluginJqConsumer, GatewayPluginJqConsumerArgs

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

    GatewayPluginJqOrdering, GatewayPluginJqOrderingArgs

    GatewayPluginJqOrderingAfter, GatewayPluginJqOrderingAfterArgs

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

    GatewayPluginJqOrderingBefore, GatewayPluginJqOrderingBeforeArgs

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

    GatewayPluginJqRoute, GatewayPluginJqRouteArgs

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

    GatewayPluginJqService, GatewayPluginJqServiceArgs

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

    Import

    $ pulumi import konnect:index/gatewayPluginJq:GatewayPluginJq my_konnect_gateway_plugin_jq "{ \"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 logo
    konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong