Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. KafkaQuota
Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.KafkaQuota

Explore with Pulumi AI

aiven logo
Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-aiven

    Creates and manages quotas for an Aiven for Apache Kafka® service user.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const exampleQuota = new aiven.KafkaQuota("example_quota", {
    project: foo.project,
    serviceName: exampleKafka.serviceName,
    user: "example-kafka-user",
    clientId: "example_client",
    consumerByteRate: 1000,
    producerByteRate: 1000,
    requestPercentage: 50,
});

    import pulumi
import pulumi_aiven as aiven

example_quota = aiven.KafkaQuota("example_quota",
    project=foo["project"],
    service_name=example_kafka["serviceName"],
    user="example-kafka-user",
    client_id="example_client",
    consumer_byte_rate=1000,
    producer_byte_rate=1000,
    request_percentage=50)

    package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewKafkaQuota(ctx, "example_quota", &aiven.KafkaQuotaArgs{
			Project:           pulumi.Any(foo.Project),
			ServiceName:       pulumi.Any(exampleKafka.ServiceName),
			User:              pulumi.String("example-kafka-user"),
			ClientId:          pulumi.String("example_client"),
			ConsumerByteRate:  pulumi.Int(1000),
			ProducerByteRate:  pulumi.Int(1000),
			RequestPercentage: pulumi.Float64(50),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleQuota = new Aiven.KafkaQuota("example_quota", new()
    {
        Project = foo.Project,
        ServiceName = exampleKafka.ServiceName,
        User = "example-kafka-user",
        ClientId = "example_client",
        ConsumerByteRate = 1000,
        ProducerByteRate = 1000,
        RequestPercentage = 50,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.KafkaQuota;
import com.pulumi.aiven.KafkaQuotaArgs;
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 exampleQuota = new KafkaQuota("exampleQuota", KafkaQuotaArgs.builder()
            .project(foo.project())
            .serviceName(exampleKafka.serviceName())
            .user("example-kafka-user")
            .clientId("example_client")
            .consumerByteRate(1000)
            .producerByteRate(1000)
            .requestPercentage(50)
            .build());

    }
}

    resources:
  exampleQuota:
    type: aiven:KafkaQuota
    name: example_quota
    properties:
      project: ${foo.project}
      serviceName: ${exampleKafka.serviceName}
      user: example-kafka-user
      clientId: example_client
      consumerByteRate: 1000
      producerByteRate: 1000
      requestPercentage: 50

    Create KafkaQuota Resource

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

    Constructor syntax

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

@overload
def KafkaQuota(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               project: Optional[str] = None,
               service_name: Optional[str] = None,
               client_id: Optional[str] = None,
               consumer_byte_rate: Optional[int] = None,
               producer_byte_rate: Optional[int] = None,
               request_percentage: Optional[float] = None,
               user: Optional[str] = None)
    func NewKafkaQuota(ctx *Context, name string, args KafkaQuotaArgs, opts ...ResourceOption) (*KafkaQuota, error)
    public KafkaQuota(string name, KafkaQuotaArgs args, CustomResourceOptions? opts = null)
    public KafkaQuota(String name, KafkaQuotaArgs args)
public KafkaQuota(String name, KafkaQuotaArgs args, CustomResourceOptions options)

    type: aiven:KafkaQuota
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 KafkaQuotaArgs
    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 KafkaQuotaArgs
    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 KafkaQuotaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KafkaQuotaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KafkaQuotaArgs
    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 kafkaQuotaResource = new Aiven.KafkaQuota("kafkaQuotaResource", new()
{
    Project = "string",
    ServiceName = "string",
    ClientId = "string",
    ConsumerByteRate = 0,
    ProducerByteRate = 0,
    RequestPercentage = 0,
    User = "string",
});

    example, err := aiven.NewKafkaQuota(ctx, "kafkaQuotaResource", &aiven.KafkaQuotaArgs{
	Project:           pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	ClientId:          pulumi.String("string"),
	ConsumerByteRate:  pulumi.Int(0),
	ProducerByteRate:  pulumi.Int(0),
	RequestPercentage: pulumi.Float64(0),
	User:              pulumi.String("string"),
})

    var kafkaQuotaResource = new KafkaQuota("kafkaQuotaResource", KafkaQuotaArgs.builder()
    .project("string")
    .serviceName("string")
    .clientId("string")
    .consumerByteRate(0)
    .producerByteRate(0)
    .requestPercentage(0)
    .user("string")
    .build());

    kafka_quota_resource = aiven.KafkaQuota("kafkaQuotaResource",
    project="string",
    service_name="string",
    client_id="string",
    consumer_byte_rate=0,
    producer_byte_rate=0,
    request_percentage=0,
    user="string")

    const kafkaQuotaResource = new aiven.KafkaQuota("kafkaQuotaResource", {
    project: "string",
    serviceName: "string",
    clientId: "string",
    consumerByteRate: 0,
    producerByteRate: 0,
    requestPercentage: 0,
    user: "string",
});

    type: aiven:KafkaQuota
properties:
    clientId: string
    consumerByteRate: 0
    producerByteRate: 0
    project: string
    requestPercentage: 0
    serviceName: string
    user: string

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

    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ClientId string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    ConsumerByteRate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    ProducerByteRate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    RequestPercentage double
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    User string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ClientId string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    ConsumerByteRate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    ProducerByteRate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    RequestPercentage float64
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    User string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    clientId String
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    consumerByteRate Integer
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    producerByteRate Integer
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    requestPercentage Double
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    user String
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    clientId string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    consumerByteRate number
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    producerByteRate number
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    requestPercentage number
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    user string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    client_id str
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    consumer_byte_rate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    producer_byte_rate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    request_percentage float
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    user str
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    clientId String
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    consumerByteRate Number
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    producerByteRate Number
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    requestPercentage Number
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    user String
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'

    Outputs

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

    Get an existing KafkaQuota 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?: KafkaQuotaState, opts?: CustomResourceOptions): KafkaQuota
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        consumer_byte_rate: Optional[int] = None,
        producer_byte_rate: Optional[int] = None,
        project: Optional[str] = None,
        request_percentage: Optional[float] = None,
        service_name: Optional[str] = None,
        user: Optional[str] = None) -> KafkaQuota
    func GetKafkaQuota(ctx *Context, name string, id IDInput, state *KafkaQuotaState, opts ...ResourceOption) (*KafkaQuota, error)
    public static KafkaQuota Get(string name, Input<string> id, KafkaQuotaState? state, CustomResourceOptions? opts = null)
    public static KafkaQuota get(String name, Output<String> id, KafkaQuotaState state, CustomResourceOptions options)
    resources:  _:    type: aiven:KafkaQuota    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:
    ClientId string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    ConsumerByteRate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    ProducerByteRate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    RequestPercentage double
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    User string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    ClientId string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    ConsumerByteRate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    ProducerByteRate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    RequestPercentage float64
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    User string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    clientId String
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    consumerByteRate Integer
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    producerByteRate Integer
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    requestPercentage Double
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    user String
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    clientId string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    consumerByteRate number
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    producerByteRate number
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    requestPercentage number
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    user string
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    client_id str
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    consumer_byte_rate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    producer_byte_rate int
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    request_percentage float
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    user str
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    clientId String
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'
    consumerByteRate Number
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    producerByteRate Number
    Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    requestPercentage Number
    Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    user String
    Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. It is possible to set default quotas for each (user, client-id), user or client-id group by specifying 'default'

    Import

    When both USER and CLIENT_ID are specified

    $ pulumi import aiven:index/kafkaQuota:KafkaQuota example_quota PROJECT/SERVICE_NAME/CLIENT_ID/USER

    When only USER is specified

    $ pulumi import aiven:index/kafkaQuota:KafkaQuota example_quota PROJECT/SERVICE_NAME//USER

    When only CLIENT_ID is specified

    $ pulumi import aiven:index/kafkaQuota:KafkaQuota example_quota PROJECT/SERVICE_NAME/CLIENT_ID/

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

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.36.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-aiven