Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Kafka Provider
  3. API Docs
  4. Quota
Kafka v3.10.3 published on Thursday, Jul 24, 2025 by Pulumi
pulumi/pulumi-kafka

kafka.Quota

Explore with Pulumi AI

kafka logo
Kafka v3.10.3 published on Thursday, Jul 24, 2025 by Pulumi
pulumi/pulumi-kafka

    Create Quota Resource

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

    Constructor syntax

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

@overload
def Quota(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          entity_type: Optional[str] = None,
          config: Optional[Mapping[str, str]] = None,
          entity_name: Optional[str] = None)
    func NewQuota(ctx *Context, name string, args QuotaArgs, opts ...ResourceOption) (*Quota, error)
    public Quota(string name, QuotaArgs args, CustomResourceOptions? opts = null)
    public Quota(String name, QuotaArgs args)
public Quota(String name, QuotaArgs args, CustomResourceOptions options)

    type: kafka:Quota
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 QuotaArgs
    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 QuotaArgs
    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 QuotaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QuotaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QuotaArgs
    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 quotaResource = new Kafka.Quota("quotaResource", new()
{
    EntityType = "string",
    Config = 
    {
        { "string", "string" },
    },
    EntityName = "string",
});

    example, err := kafka.NewQuota(ctx, "quotaResource", &kafka.QuotaArgs{
	EntityType: pulumi.String("string"),
	Config: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EntityName: pulumi.String("string"),
})

    var quotaResource = new Quota("quotaResource", QuotaArgs.builder()
    .entityType("string")
    .config(Map.of("string", "string"))
    .entityName("string")
    .build());

    quota_resource = kafka.Quota("quotaResource",
    entity_type="string",
    config={
        "string": "string",
    },
    entity_name="string")

    const quotaResource = new kafka.Quota("quotaResource", {
    entityType: "string",
    config: {
        string: "string",
    },
    entityName: "string",
});

    type: kafka:Quota
properties:
    config:
        string: string
    entityName: string
    entityType: string

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

    EntityType string
    The type of the entity (client-id, user, ip)
    Config Dictionary<string, string>
    A map of string k/v properties.
    EntityName string
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    EntityType string
    The type of the entity (client-id, user, ip)
    Config map[string]string
    A map of string k/v properties.
    EntityName string
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    entityType String
    The type of the entity (client-id, user, ip)
    config Map<String,String>
    A map of string k/v properties.
    entityName String
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    entityType string
    The type of the entity (client-id, user, ip)
    config {[key: string]: string}
    A map of string k/v properties.
    entityName string
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    entity_type str
    The type of the entity (client-id, user, ip)
    config Mapping[str, str]
    A map of string k/v properties.
    entity_name str
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    entityType String
    The type of the entity (client-id, user, ip)
    config Map<String>
    A map of string k/v properties.
    entityName String
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)

    Outputs

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

    Get an existing Quota 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?: QuotaState, opts?: CustomResourceOptions): Quota
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[Mapping[str, str]] = None,
        entity_name: Optional[str] = None,
        entity_type: Optional[str] = None) -> Quota
    func GetQuota(ctx *Context, name string, id IDInput, state *QuotaState, opts ...ResourceOption) (*Quota, error)
    public static Quota Get(string name, Input<string> id, QuotaState? state, CustomResourceOptions? opts = null)
    public static Quota get(String name, Output<String> id, QuotaState state, CustomResourceOptions options)
    resources:  _:    type: kafka:Quota    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Config Dictionary<string, string>
    A map of string k/v properties.
    EntityName string
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    EntityType string
    The type of the entity (client-id, user, ip)
    Config map[string]string
    A map of string k/v properties.
    EntityName string
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    EntityType string
    The type of the entity (client-id, user, ip)
    config Map<String,String>
    A map of string k/v properties.
    entityName String
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    entityType String
    The type of the entity (client-id, user, ip)
    config {[key: string]: string}
    A map of string k/v properties.
    entityName string
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    entityType string
    The type of the entity (client-id, user, ip)
    config Mapping[str, str]
    A map of string k/v properties.
    entity_name str
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    entity_type str
    The type of the entity (client-id, user, ip)
    config Map<String>
    A map of string k/v properties.
    entityName String
    The name of the entity (if entity_name is not provided, it will create entity-default Kafka quota)
    entityType String
    The type of the entity (client-id, user, ip)

    Package Details

    Repository
    Kafka pulumi/pulumi-kafka
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the kafka Terraform Provider.
    kafka logo
    Kafka v3.10.3 published on Thursday, Jul 24, 2025 by Pulumi
    pulumi/pulumi-kafka