import * as pulumi from "@pulumi/pulumi"; /** * Creates and manages quotas for an Aiven for Apache Kafka® service user. * * ## Example Usage * * ```typescript * 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 * * When both USER and CLIENT_ID are specified * * ```sh * $ pulumi import aiven:index/kafkaQuota:KafkaQuota example_quota PROJECT/SERVICE_NAME/CLIENT_ID/USER * ``` * * When only USER is specified * * ```sh * $ pulumi import aiven:index/kafkaQuota:KafkaQuota example_quota PROJECT/SERVICE_NAME//USER * ``` * * When only CLIENT_ID is specified * * ```sh * $ pulumi import aiven:index/kafkaQuota:KafkaQuota example_quota PROJECT/SERVICE_NAME/CLIENT_ID/ * ``` */ export declare class KafkaQuota extends pulumi.CustomResource { /** * Get an existing KafkaQuota resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: KafkaQuotaState, opts?: pulumi.CustomResourceOptions): KafkaQuota; /** * Returns true if the given object is an instance of KafkaQuota. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is KafkaQuota; /** * 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' */ readonly clientId: pulumi.Output; /** * 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. */ readonly consumerByteRate: pulumi.Output; /** * 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. */ readonly producerByteRate: pulumi.Output; /** * 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. */ readonly project: pulumi.Output; /** * 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. */ readonly requestPercentage: pulumi.Output; /** * 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. */ readonly serviceName: pulumi.Output; /** * 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' */ readonly user: pulumi.Output; /** * Create a KafkaQuota resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: KafkaQuotaArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering KafkaQuota resources. */ export interface KafkaQuotaState { /** * 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?: pulumi.Input; /** * 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. */ consumerByteRate?: pulumi.Input; /** * 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?: pulumi.Input; /** * 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. */ project?: pulumi.Input; /** * 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. */ requestPercentage?: pulumi.Input; /** * 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. */ serviceName?: pulumi.Input; /** * 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' */ user?: pulumi.Input; } /** * The set of arguments for constructing a KafkaQuota resource. */ export interface KafkaQuotaArgs { /** * 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?: pulumi.Input; /** * 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. */ consumerByteRate?: pulumi.Input; /** * 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?: pulumi.Input; /** * 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. */ project: pulumi.Input; /** * 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. */ requestPercentage?: pulumi.Input; /** * 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. */ serviceName: pulumi.Input; /** * 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' */ user?: pulumi.Input; } //# sourceMappingURL=kafkaQuota.d.ts.map