Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginPrometheus
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayPluginPrometheus

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

GatewayPluginPrometheus 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.GatewayPluginPrometheus;
import com.pulumi.konnect.GatewayPluginPrometheusArgs;
import com.pulumi.konnect.inputs.GatewayPluginPrometheusConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginPrometheusConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginPrometheusOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginPrometheusOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginPrometheusOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginPrometheusRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginPrometheusServiceArgs;
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 myGatewaypluginprometheus = new GatewayPluginPrometheus("myGatewaypluginprometheus", GatewayPluginPrometheusArgs.builder()
            .config(GatewayPluginPrometheusConfigArgs.builder()
                .ai_metrics(true)
                .bandwidth_metrics(false)
                .latency_metrics(false)
                .per_consumer(true)
                .status_code_metrics(true)
                .upstream_health_metrics(true)
                .build())
            .consumer(GatewayPluginPrometheusConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(7)
            .enabled(true)
            .gatewayPluginPrometheusId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginPrometheusOrderingArgs.builder()
                .after(GatewayPluginPrometheusOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginPrometheusOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("tls_passthrough")
            .route(GatewayPluginPrometheusRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginPrometheusServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .updatedAt(1)
            .build());

    }
}
Copy
resources:
  myGatewaypluginprometheus:
    type: konnect:GatewayPluginPrometheus
    properties:
      config:
        ai_metrics: true
        bandwidth_metrics: false
        latency_metrics: false
        per_consumer: true
        status_code_metrics: true
        upstream_health_metrics: true
      consumer:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 7
      enabled: true
      gatewayPluginPrometheusId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - tls_passthrough
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
      updatedAt: 1
Copy

Create GatewayPluginPrometheus Resource

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

Constructor syntax

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

@overload
def GatewayPluginPrometheus(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            control_plane_id: Optional[str] = None,
                            instance_name: Optional[str] = None,
                            consumer: Optional[GatewayPluginPrometheusConsumerArgs] = None,
                            created_at: Optional[float] = None,
                            enabled: Optional[bool] = None,
                            gateway_plugin_prometheus_id: Optional[str] = None,
                            config: Optional[GatewayPluginPrometheusConfigArgs] = None,
                            ordering: Optional[GatewayPluginPrometheusOrderingArgs] = None,
                            protocols: Optional[Sequence[str]] = None,
                            route: Optional[GatewayPluginPrometheusRouteArgs] = None,
                            service: Optional[GatewayPluginPrometheusServiceArgs] = None,
                            tags: Optional[Sequence[str]] = None,
                            updated_at: Optional[float] = None)
func NewGatewayPluginPrometheus(ctx *Context, name string, args GatewayPluginPrometheusArgs, opts ...ResourceOption) (*GatewayPluginPrometheus, error)
public GatewayPluginPrometheus(string name, GatewayPluginPrometheusArgs args, CustomResourceOptions? opts = null)
public GatewayPluginPrometheus(String name, GatewayPluginPrometheusArgs args)
public GatewayPluginPrometheus(String name, GatewayPluginPrometheusArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginPrometheusArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayPluginPrometheusArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginPrometheusArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginPrometheusArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayPluginPrometheusArgs
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 gatewayPluginPrometheusResource = new Konnect.GatewayPluginPrometheus("gatewayPluginPrometheusResource", new()
{
    ControlPlaneId = "string",
    InstanceName = "string",
    Consumer = new Konnect.Inputs.GatewayPluginPrometheusConsumerArgs
    {
        Id = "string",
    },
    CreatedAt = 0,
    Enabled = false,
    GatewayPluginPrometheusId = "string",
    Config = new Konnect.Inputs.GatewayPluginPrometheusConfigArgs
    {
        AiMetrics = false,
        BandwidthMetrics = false,
        LatencyMetrics = false,
        PerConsumer = false,
        StatusCodeMetrics = false,
        UpstreamHealthMetrics = false,
    },
    Ordering = new Konnect.Inputs.GatewayPluginPrometheusOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginPrometheusOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginPrometheusOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginPrometheusRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginPrometheusServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
});
Copy
example, err := konnect.NewGatewayPluginPrometheus(ctx, "gatewayPluginPrometheusResource", &konnect.GatewayPluginPrometheusArgs{
ControlPlaneId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Consumer: &.GatewayPluginPrometheusConsumerArgs{
Id: pulumi.String("string"),
},
CreatedAt: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
GatewayPluginPrometheusId: pulumi.String("string"),
Config: &.GatewayPluginPrometheusConfigArgs{
AiMetrics: pulumi.Bool(false),
BandwidthMetrics: pulumi.Bool(false),
LatencyMetrics: pulumi.Bool(false),
PerConsumer: pulumi.Bool(false),
StatusCodeMetrics: pulumi.Bool(false),
UpstreamHealthMetrics: pulumi.Bool(false),
},
Ordering: &.GatewayPluginPrometheusOrderingArgs{
After: &.GatewayPluginPrometheusOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginPrometheusOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginPrometheusRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginPrometheusServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
})
Copy
var gatewayPluginPrometheusResource = new GatewayPluginPrometheus("gatewayPluginPrometheusResource", GatewayPluginPrometheusArgs.builder()
    .controlPlaneId("string")
    .instanceName("string")
    .consumer(GatewayPluginPrometheusConsumerArgs.builder()
        .id("string")
        .build())
    .createdAt(0)
    .enabled(false)
    .gatewayPluginPrometheusId("string")
    .config(GatewayPluginPrometheusConfigArgs.builder()
        .aiMetrics(false)
        .bandwidthMetrics(false)
        .latencyMetrics(false)
        .perConsumer(false)
        .statusCodeMetrics(false)
        .upstreamHealthMetrics(false)
        .build())
    .ordering(GatewayPluginPrometheusOrderingArgs.builder()
        .after(GatewayPluginPrometheusOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginPrometheusOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginPrometheusRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginPrometheusServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .updatedAt(0)
    .build());
Copy
gateway_plugin_prometheus_resource = konnect.GatewayPluginPrometheus("gatewayPluginPrometheusResource",
    control_plane_id="string",
    instance_name="string",
    consumer={
        "id": "string",
    },
    created_at=0,
    enabled=False,
    gateway_plugin_prometheus_id="string",
    config={
        "ai_metrics": False,
        "bandwidth_metrics": False,
        "latency_metrics": False,
        "per_consumer": False,
        "status_code_metrics": False,
        "upstream_health_metrics": False,
    },
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"],
    updated_at=0)
Copy
const gatewayPluginPrometheusResource = new konnect.GatewayPluginPrometheus("gatewayPluginPrometheusResource", {
    controlPlaneId: "string",
    instanceName: "string",
    consumer: {
        id: "string",
    },
    createdAt: 0,
    enabled: false,
    gatewayPluginPrometheusId: "string",
    config: {
        aiMetrics: false,
        bandwidthMetrics: false,
        latencyMetrics: false,
        perConsumer: false,
        statusCodeMetrics: false,
        upstreamHealthMetrics: false,
    },
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
    updatedAt: 0,
});
Copy
type: konnect:GatewayPluginPrometheus
properties:
    config:
        aiMetrics: false
        bandwidthMetrics: false
        latencyMetrics: false
        perConsumer: false
        statusCodeMetrics: false
        upstreamHealthMetrics: false
    consumer:
        id: string
    controlPlaneId: string
    createdAt: 0
    enabled: false
    gatewayPluginPrometheusId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
    updatedAt: 0
Copy

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

ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config GatewayPluginPrometheusConfig
Consumer GatewayPluginPrometheusConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
CreatedAt double
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginPrometheusId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginPrometheusOrdering
Protocols List<string>
A set of strings representing protocols.
Route GatewayPluginPrometheusRoute
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 GatewayPluginPrometheusService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>
An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt double
Unix epoch when the resource was last updated.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config GatewayPluginPrometheusConfigArgs
Consumer GatewayPluginPrometheusConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
CreatedAt float64
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginPrometheusId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginPrometheusOrderingArgs
Protocols []string
A set of strings representing protocols.
Route GatewayPluginPrometheusRouteArgs
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 GatewayPluginPrometheusServiceArgs
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string
An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt float64
Unix epoch when the resource was last updated.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginPrometheusConfig
consumer GatewayPluginPrometheusConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
createdAt Double
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginPrometheusId String
The ID of this resource.
instanceName String
ordering GatewayPluginPrometheusOrdering
protocols List<String>
A set of strings representing protocols.
route GatewayPluginPrometheusRoute
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 GatewayPluginPrometheusService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Double
Unix epoch when the resource was last updated.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginPrometheusConfig
consumer GatewayPluginPrometheusConsumer
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
createdAt number
Unix epoch when the resource was created.
enabled boolean
Whether the plugin is applied.
gatewayPluginPrometheusId string
The ID of this resource.
instanceName string
ordering GatewayPluginPrometheusOrdering
protocols string[]
A set of strings representing protocols.
route GatewayPluginPrometheusRoute
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 GatewayPluginPrometheusService
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt number
Unix epoch when the resource was last updated.
control_plane_id This property is required. str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginPrometheusConfigArgs
consumer GatewayPluginPrometheusConsumerArgs
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
created_at float
Unix epoch when the resource was created.
enabled bool
Whether the plugin is applied.
gateway_plugin_prometheus_id str
The ID of this resource.
instance_name str
ordering GatewayPluginPrometheusOrderingArgs
protocols Sequence[str]
A set of strings representing protocols.
route GatewayPluginPrometheusRouteArgs
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 GatewayPluginPrometheusServiceArgs
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]
An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float
Unix epoch when the resource was last updated.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config Property Map
consumer Property Map
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
createdAt Number
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginPrometheusId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing protocols.
route Property Map
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GatewayPluginPrometheus Resource

Get an existing GatewayPluginPrometheus 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?: GatewayPluginPrometheusState, opts?: CustomResourceOptions): GatewayPluginPrometheus
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginPrometheusConfigArgs] = None,
        consumer: Optional[GatewayPluginPrometheusConsumerArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_prometheus_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginPrometheusOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginPrometheusRouteArgs] = None,
        service: Optional[GatewayPluginPrometheusServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginPrometheus
func GetGatewayPluginPrometheus(ctx *Context, name string, id IDInput, state *GatewayPluginPrometheusState, opts ...ResourceOption) (*GatewayPluginPrometheus, error)
public static GatewayPluginPrometheus Get(string name, Input<string> id, GatewayPluginPrometheusState? state, CustomResourceOptions? opts = null)
public static GatewayPluginPrometheus get(String name, Output<String> id, GatewayPluginPrometheusState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayPluginPrometheus    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Config GatewayPluginPrometheusConfig
Consumer GatewayPluginPrometheusConsumer
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.
GatewayPluginPrometheusId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginPrometheusOrdering
Protocols List<string>
A set of strings representing protocols.
Route GatewayPluginPrometheusRoute
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 GatewayPluginPrometheusService
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 GatewayPluginPrometheusConfigArgs
Consumer GatewayPluginPrometheusConsumerArgs
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.
GatewayPluginPrometheusId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginPrometheusOrderingArgs
Protocols []string
A set of strings representing protocols.
Route GatewayPluginPrometheusRouteArgs
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 GatewayPluginPrometheusServiceArgs
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 GatewayPluginPrometheusConfig
consumer GatewayPluginPrometheusConsumer
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.
gatewayPluginPrometheusId String
The ID of this resource.
instanceName String
ordering GatewayPluginPrometheusOrdering
protocols List<String>
A set of strings representing protocols.
route GatewayPluginPrometheusRoute
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 GatewayPluginPrometheusService
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 GatewayPluginPrometheusConfig
consumer GatewayPluginPrometheusConsumer
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.
gatewayPluginPrometheusId string
The ID of this resource.
instanceName string
ordering GatewayPluginPrometheusOrdering
protocols string[]
A set of strings representing protocols.
route GatewayPluginPrometheusRoute
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 GatewayPluginPrometheusService
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 GatewayPluginPrometheusConfigArgs
consumer GatewayPluginPrometheusConsumerArgs
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_prometheus_id str
The ID of this resource.
instance_name str
ordering GatewayPluginPrometheusOrderingArgs
protocols Sequence[str]
A set of strings representing protocols.
route GatewayPluginPrometheusRouteArgs
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 GatewayPluginPrometheusServiceArgs
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.
gatewayPluginPrometheusId String
The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>
A set of strings representing protocols.
route Property Map
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.

Supporting Types

GatewayPluginPrometheusConfig
, GatewayPluginPrometheusConfigArgs

AiMetrics bool
A boolean value that determines if ai metrics should be collected. If enabled, the ai_llm_requests_total, ai_llm_cost_total and ai_llm_tokens_total metrics will be exported.
BandwidthMetrics bool
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
LatencyMetrics bool
A boolean value that determines if latency metrics should be collected. If enabled, kong_latency_ms, upstream_latency_ms and request_latency_ms metrics will be exported.
PerConsumer bool
A boolean value that determines if per-consumer metrics should be collected. If enabled, the kong_http_requests_total and kong_bandwidth_bytes metrics fill in the consumer label when available.
StatusCodeMetrics bool
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
UpstreamHealthMetrics bool
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
AiMetrics bool
A boolean value that determines if ai metrics should be collected. If enabled, the ai_llm_requests_total, ai_llm_cost_total and ai_llm_tokens_total metrics will be exported.
BandwidthMetrics bool
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
LatencyMetrics bool
A boolean value that determines if latency metrics should be collected. If enabled, kong_latency_ms, upstream_latency_ms and request_latency_ms metrics will be exported.
PerConsumer bool
A boolean value that determines if per-consumer metrics should be collected. If enabled, the kong_http_requests_total and kong_bandwidth_bytes metrics fill in the consumer label when available.
StatusCodeMetrics bool
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
UpstreamHealthMetrics bool
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
aiMetrics Boolean
A boolean value that determines if ai metrics should be collected. If enabled, the ai_llm_requests_total, ai_llm_cost_total and ai_llm_tokens_total metrics will be exported.
bandwidthMetrics Boolean
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
latencyMetrics Boolean
A boolean value that determines if latency metrics should be collected. If enabled, kong_latency_ms, upstream_latency_ms and request_latency_ms metrics will be exported.
perConsumer Boolean
A boolean value that determines if per-consumer metrics should be collected. If enabled, the kong_http_requests_total and kong_bandwidth_bytes metrics fill in the consumer label when available.
statusCodeMetrics Boolean
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
upstreamHealthMetrics Boolean
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
aiMetrics boolean
A boolean value that determines if ai metrics should be collected. If enabled, the ai_llm_requests_total, ai_llm_cost_total and ai_llm_tokens_total metrics will be exported.
bandwidthMetrics boolean
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
latencyMetrics boolean
A boolean value that determines if latency metrics should be collected. If enabled, kong_latency_ms, upstream_latency_ms and request_latency_ms metrics will be exported.
perConsumer boolean
A boolean value that determines if per-consumer metrics should be collected. If enabled, the kong_http_requests_total and kong_bandwidth_bytes metrics fill in the consumer label when available.
statusCodeMetrics boolean
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
upstreamHealthMetrics boolean
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
ai_metrics bool
A boolean value that determines if ai metrics should be collected. If enabled, the ai_llm_requests_total, ai_llm_cost_total and ai_llm_tokens_total metrics will be exported.
bandwidth_metrics bool
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
latency_metrics bool
A boolean value that determines if latency metrics should be collected. If enabled, kong_latency_ms, upstream_latency_ms and request_latency_ms metrics will be exported.
per_consumer bool
A boolean value that determines if per-consumer metrics should be collected. If enabled, the kong_http_requests_total and kong_bandwidth_bytes metrics fill in the consumer label when available.
status_code_metrics bool
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
upstream_health_metrics bool
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
aiMetrics Boolean
A boolean value that determines if ai metrics should be collected. If enabled, the ai_llm_requests_total, ai_llm_cost_total and ai_llm_tokens_total metrics will be exported.
bandwidthMetrics Boolean
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
latencyMetrics Boolean
A boolean value that determines if latency metrics should be collected. If enabled, kong_latency_ms, upstream_latency_ms and request_latency_ms metrics will be exported.
perConsumer Boolean
A boolean value that determines if per-consumer metrics should be collected. If enabled, the kong_http_requests_total and kong_bandwidth_bytes metrics fill in the consumer label when available.
statusCodeMetrics Boolean
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
upstreamHealthMetrics Boolean
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.

GatewayPluginPrometheusConsumer
, GatewayPluginPrometheusConsumerArgs

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

GatewayPluginPrometheusOrdering
, GatewayPluginPrometheusOrderingArgs

GatewayPluginPrometheusOrderingAfter
, GatewayPluginPrometheusOrderingAfterArgs

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

GatewayPluginPrometheusOrderingBefore
, GatewayPluginPrometheusOrderingBeforeArgs

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

GatewayPluginPrometheusRoute
, GatewayPluginPrometheusRouteArgs

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

GatewayPluginPrometheusService
, GatewayPluginPrometheusServiceArgs

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

Import

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

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

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect