1. Packages
  2. Confluent Cloud
  3. API Docs
  4. getKafkaClientQuota
Confluent v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi

confluentcloud.getKafkaClientQuota

Explore with Pulumi AI

confluentcloud logo
Confluent v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi

    General Availability

    confluentcloud.KafkaClientQuota describes a Kafka Client Quota.

    Note: See Control application usage with Client Quotas for more details.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    export = async () => {
        const example = await confluentcloud.getKafkaClientQuota({
            id: "cq-abc123",
        });
        return {
            example: example,
        };
    }
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    example = confluentcloud.get_kafka_client_quota(id="cq-abc123")
    pulumi.export("example", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-confluentcloud/sdk/go/confluentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := confluentcloud.LookupKafkaClientQuota(ctx, &confluentcloud.LookupKafkaClientQuotaArgs{
    			Id: "cq-abc123",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("example", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ConfluentCloud = Pulumi.ConfluentCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = ConfluentCloud.GetKafkaClientQuota.Invoke(new()
        {
            Id = "cq-abc123",
        });
    
        return new Dictionary<string, object?>
        {
            ["example"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.confluentcloud.ConfluentcloudFunctions;
    import com.pulumi.confluentcloud.inputs.GetKafkaClientQuotaArgs;
    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) {
            final var example = ConfluentcloudFunctions.getKafkaClientQuota(GetKafkaClientQuotaArgs.builder()
                .id("cq-abc123")
                .build());
    
            ctx.export("example", example.applyValue(getKafkaClientQuotaResult -> getKafkaClientQuotaResult));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: confluentcloud:getKafkaClientQuota
          Arguments:
            id: cq-abc123
    outputs:
      example: ${example}
    

    Using getKafkaClientQuota

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKafkaClientQuota(args: GetKafkaClientQuotaArgs, opts?: InvokeOptions): Promise<GetKafkaClientQuotaResult>
    function getKafkaClientQuotaOutput(args: GetKafkaClientQuotaOutputArgs, opts?: InvokeOptions): Output<GetKafkaClientQuotaResult>
    def get_kafka_client_quota(id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetKafkaClientQuotaResult
    def get_kafka_client_quota_output(id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetKafkaClientQuotaResult]
    func LookupKafkaClientQuota(ctx *Context, args *LookupKafkaClientQuotaArgs, opts ...InvokeOption) (*LookupKafkaClientQuotaResult, error)
    func LookupKafkaClientQuotaOutput(ctx *Context, args *LookupKafkaClientQuotaOutputArgs, opts ...InvokeOption) LookupKafkaClientQuotaResultOutput

    > Note: This function is named LookupKafkaClientQuota in the Go SDK.

    public static class GetKafkaClientQuota 
    {
        public static Task<GetKafkaClientQuotaResult> InvokeAsync(GetKafkaClientQuotaArgs args, InvokeOptions? opts = null)
        public static Output<GetKafkaClientQuotaResult> Invoke(GetKafkaClientQuotaInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKafkaClientQuotaResult> getKafkaClientQuota(GetKafkaClientQuotaArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: confluentcloud:index/getKafkaClientQuota:getKafkaClientQuota
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the Kafka Client Quota (for example, cq-abc123).
    Id string
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id String
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id string
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id str
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id String
    The ID of the Kafka Client Quota (for example, cq-abc123).

    getKafkaClientQuota Result

    The following output properties are available:

    Description string
    (Required String) The description of the Kafka Client Quota.
    DisplayName string
    (Required String) The name of the Kafka Client Quota.
    Environments List<Pulumi.ConfluentCloud.Outputs.GetKafkaClientQuotaEnvironment>
    (Required Configuration Block) supports the following:
    Id string
    (Required String) The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, env-abc123.
    KafkaClusters List<Pulumi.ConfluentCloud.Outputs.GetKafkaClientQuotaKafkaCluster>
    (Required Configuration Block) supports the following:
    Principals List<string>
    (Required Set of Strings) The list of principals (i.e., service accounts or identity pools) to apply the Kafka Client Quota to. Use the special name, "", to represent the default quota for all users and service accounts.
    Throughputs List<Pulumi.ConfluentCloud.Outputs.GetKafkaClientQuotaThroughput>
    (Required Configuration Block) supports the following:
    Description string
    (Required String) The description of the Kafka Client Quota.
    DisplayName string
    (Required String) The name of the Kafka Client Quota.
    Environments []GetKafkaClientQuotaEnvironment
    (Required Configuration Block) supports the following:
    Id string
    (Required String) The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, env-abc123.
    KafkaClusters []GetKafkaClientQuotaKafkaCluster
    (Required Configuration Block) supports the following:
    Principals []string
    (Required Set of Strings) The list of principals (i.e., service accounts or identity pools) to apply the Kafka Client Quota to. Use the special name, "", to represent the default quota for all users and service accounts.
    Throughputs []GetKafkaClientQuotaThroughput
    (Required Configuration Block) supports the following:
    description String
    (Required String) The description of the Kafka Client Quota.
    displayName String
    (Required String) The name of the Kafka Client Quota.
    environments List<GetKafkaClientQuotaEnvironment>
    (Required Configuration Block) supports the following:
    id String
    (Required String) The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, env-abc123.
    kafkaClusters List<GetKafkaClientQuotaKafkaCluster>
    (Required Configuration Block) supports the following:
    principals List<String>
    (Required Set of Strings) The list of principals (i.e., service accounts or identity pools) to apply the Kafka Client Quota to. Use the special name, "", to represent the default quota for all users and service accounts.
    throughputs List<GetKafkaClientQuotaThroughput>
    (Required Configuration Block) supports the following:
    description string
    (Required String) The description of the Kafka Client Quota.
    displayName string
    (Required String) The name of the Kafka Client Quota.
    environments GetKafkaClientQuotaEnvironment[]
    (Required Configuration Block) supports the following:
    id string
    (Required String) The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, env-abc123.
    kafkaClusters GetKafkaClientQuotaKafkaCluster[]
    (Required Configuration Block) supports the following:
    principals string[]
    (Required Set of Strings) The list of principals (i.e., service accounts or identity pools) to apply the Kafka Client Quota to. Use the special name, "", to represent the default quota for all users and service accounts.
    throughputs GetKafkaClientQuotaThroughput[]
    (Required Configuration Block) supports the following:
    description str
    (Required String) The description of the Kafka Client Quota.
    display_name str
    (Required String) The name of the Kafka Client Quota.
    environments Sequence[GetKafkaClientQuotaEnvironment]
    (Required Configuration Block) supports the following:
    id str
    (Required String) The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, env-abc123.
    kafka_clusters Sequence[GetKafkaClientQuotaKafkaCluster]
    (Required Configuration Block) supports the following:
    principals Sequence[str]
    (Required Set of Strings) The list of principals (i.e., service accounts or identity pools) to apply the Kafka Client Quota to. Use the special name, "", to represent the default quota for all users and service accounts.
    throughputs Sequence[GetKafkaClientQuotaThroughput]
    (Required Configuration Block) supports the following:
    description String
    (Required String) The description of the Kafka Client Quota.
    displayName String
    (Required String) The name of the Kafka Client Quota.
    environments List<Property Map>
    (Required Configuration Block) supports the following:
    id String
    (Required String) The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, env-abc123.
    kafkaClusters List<Property Map>
    (Required Configuration Block) supports the following:
    principals List<String>
    (Required Set of Strings) The list of principals (i.e., service accounts or identity pools) to apply the Kafka Client Quota to. Use the special name, "", to represent the default quota for all users and service accounts.
    throughputs List<Property Map>
    (Required Configuration Block) supports the following:

    Supporting Types

    GetKafkaClientQuotaEnvironment

    Id string
    The ID of the Kafka Client Quota (for example, cq-abc123).
    Id string
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id String
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id string
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id str
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id String
    The ID of the Kafka Client Quota (for example, cq-abc123).

    GetKafkaClientQuotaKafkaCluster

    Id string
    The ID of the Kafka Client Quota (for example, cq-abc123).
    Id string
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id String
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id string
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id str
    The ID of the Kafka Client Quota (for example, cq-abc123).
    id String
    The ID of the Kafka Client Quota (for example, cq-abc123).

    GetKafkaClientQuotaThroughput

    EgressByteRate string
    (Required String) The egress throughput limit in bytes per second.
    IngressByteRate string
    (Required String) The ingress throughput limit in bytes per second.
    EgressByteRate string
    (Required String) The egress throughput limit in bytes per second.
    IngressByteRate string
    (Required String) The ingress throughput limit in bytes per second.
    egressByteRate String
    (Required String) The egress throughput limit in bytes per second.
    ingressByteRate String
    (Required String) The ingress throughput limit in bytes per second.
    egressByteRate string
    (Required String) The egress throughput limit in bytes per second.
    ingressByteRate string
    (Required String) The ingress throughput limit in bytes per second.
    egress_byte_rate str
    (Required String) The egress throughput limit in bytes per second.
    ingress_byte_rate str
    (Required String) The ingress throughput limit in bytes per second.
    egressByteRate String
    (Required String) The egress throughput limit in bytes per second.
    ingressByteRate String
    (Required String) The ingress throughput limit in bytes per second.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi