1. Packages
  2. Avi Provider
  3. API Docs
  4. Ratelimitconfiguration
avi 31.2.1 published on Monday, Dec 22, 2025 by vmware
Schema (JSON)
vmware/terraform-provider-avi

avi.Ratelimitconfiguration

avi logo
avi 31.2.1 published on Monday, Dec 22, 2025 by vmware
Schema (JSON)
vmware/terraform-provider-avi

    <!–

    Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

    –>

    layout: “avi”

    page_title: “Avi:<span pulumi-lang-nodejs=” avi.Ratelimitconfiguration"" pulumi-lang-dotnet=" avi.Ratelimitconfiguration"" pulumi-lang-go=" Ratelimitconfiguration"" pulumi-lang-python=" Ratelimitconfiguration"" pulumi-lang-yaml=" avi.Ratelimitconfiguration"" pulumi-lang-java=" avi.Ratelimitconfiguration""> avi.Ratelimitconfiguration" sidebar_current: “docs-avi-resource-ratelimitconfiguration” description: |- Creates and manages Avi RateLimitConfiguration.

    # avi.Ratelimitconfiguration The RateLimitConfiguration resource allows the creation and management of Avi RateLimitConfiguration

    Example Usage

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

const foo = new avi.Ratelimitconfiguration("foo", {
    name: "terraform-example-foo",
    tenantRef: "/api/tenant/?name=admin",
});

    import pulumi
import pulumi_avi as avi

foo = avi.Ratelimitconfiguration("foo",
    name="terraform-example-foo",
    tenant_ref="/api/tenant/?name=admin")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewRatelimitconfiguration(ctx, "foo", &avi.RatelimitconfigurationArgs{
			Name:      pulumi.String("terraform-example-foo"),
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Ratelimitconfiguration("foo", new()
    {
        Name = "terraform-example-foo",
        TenantRef = "/api/tenant/?name=admin",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Ratelimitconfiguration;
import com.pulumi.avi.RatelimitconfigurationArgs;
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 foo = new Ratelimitconfiguration("foo", RatelimitconfigurationArgs.builder()
            .name("terraform-example-foo")
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

    resources:
  foo:
    type: avi:Ratelimitconfiguration
    properties:
      name: terraform-example-foo
      tenantRef: /api/tenant/?name=admin

    Create Ratelimitconfiguration Resource

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

    Constructor syntax

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

@overload
def Ratelimitconfiguration(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           http_methods: Optional[Sequence[str]] = None,
                           resource: Optional[str] = None,
                           token_refill_rates: Optional[Sequence[RatelimitconfigurationTokenRefillRateArgs]] = None,
                           burst: Optional[str] = None,
                           configpb_attributes: Optional[Sequence[RatelimitconfigurationConfigpbAttributeArgs]] = None,
                           description: Optional[str] = None,
                           name: Optional[str] = None,
                           ratelimitconfiguration_id: Optional[str] = None,
                           tenant_ref: Optional[str] = None,
                           type: Optional[str] = None,
                           uuid: Optional[str] = None)
    func NewRatelimitconfiguration(ctx *Context, name string, args RatelimitconfigurationArgs, opts ...ResourceOption) (*Ratelimitconfiguration, error)
    public Ratelimitconfiguration(string name, RatelimitconfigurationArgs args, CustomResourceOptions? opts = null)
    public Ratelimitconfiguration(String name, RatelimitconfigurationArgs args)
public Ratelimitconfiguration(String name, RatelimitconfigurationArgs args, CustomResourceOptions options)

    type: avi:Ratelimitconfiguration
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 RatelimitconfigurationArgs
    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 RatelimitconfigurationArgs
    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 RatelimitconfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RatelimitconfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RatelimitconfigurationArgs
    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 ratelimitconfigurationResource = new Avi.Ratelimitconfiguration("ratelimitconfigurationResource", new()
{
    HttpMethods = new[]
    {
        "string",
    },
    Resource = "string",
    TokenRefillRates = new[]
    {
        new Avi.Inputs.RatelimitconfigurationTokenRefillRateArgs
        {
            Interval = "string",
            RefillRate = "string",
        },
    },
    Burst = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.RatelimitconfigurationConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    Description = "string",
    Name = "string",
    RatelimitconfigurationId = "string",
    TenantRef = "string",
    Type = "string",
    Uuid = "string",
});

    example, err := avi.NewRatelimitconfiguration(ctx, "ratelimitconfigurationResource", &avi.RatelimitconfigurationArgs{
	HttpMethods: pulumi.StringArray{
		pulumi.String("string"),
	},
	Resource: pulumi.String("string"),
	TokenRefillRates: avi.RatelimitconfigurationTokenRefillRateArray{
		&avi.RatelimitconfigurationTokenRefillRateArgs{
			Interval:   pulumi.String("string"),
			RefillRate: pulumi.String("string"),
		},
	},
	Burst: pulumi.String("string"),
	ConfigpbAttributes: avi.RatelimitconfigurationConfigpbAttributeArray{
		&avi.RatelimitconfigurationConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	Description:              pulumi.String("string"),
	Name:                     pulumi.String("string"),
	RatelimitconfigurationId: pulumi.String("string"),
	TenantRef:                pulumi.String("string"),
	Type:                     pulumi.String("string"),
	Uuid:                     pulumi.String("string"),
})

    var ratelimitconfigurationResource = new Ratelimitconfiguration("ratelimitconfigurationResource", RatelimitconfigurationArgs.builder()
    .httpMethods("string")
    .resource("string")
    .tokenRefillRates(RatelimitconfigurationTokenRefillRateArgs.builder()
        .interval("string")
        .refillRate("string")
        .build())
    .burst("string")
    .configpbAttributes(RatelimitconfigurationConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .description("string")
    .name("string")
    .ratelimitconfigurationId("string")
    .tenantRef("string")
    .type("string")
    .uuid("string")
    .build());

    ratelimitconfiguration_resource = avi.Ratelimitconfiguration("ratelimitconfigurationResource",
    http_methods=["string"],
    resource="string",
    token_refill_rates=[{
        "interval": "string",
        "refill_rate": "string",
    }],
    burst="string",
    configpb_attributes=[{
        "version": "string",
    }],
    description="string",
    name="string",
    ratelimitconfiguration_id="string",
    tenant_ref="string",
    type="string",
    uuid="string")

    const ratelimitconfigurationResource = new avi.Ratelimitconfiguration("ratelimitconfigurationResource", {
    httpMethods: ["string"],
    resource: "string",
    tokenRefillRates: [{
        interval: "string",
        refillRate: "string",
    }],
    burst: "string",
    configpbAttributes: [{
        version: "string",
    }],
    description: "string",
    name: "string",
    ratelimitconfigurationId: "string",
    tenantRef: "string",
    type: "string",
    uuid: "string",
});

    type: avi:Ratelimitconfiguration
properties:
    burst: string
    configpbAttributes:
        - version: string
    description: string
    httpMethods:
        - string
    name: string
    ratelimitconfigurationId: string
    resource: string
    tenantRef: string
    tokenRefillRates:
        - interval: string
          refillRate: string
    type: string
    uuid: string

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

    HttpMethods List<string>
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    Resource string
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TokenRefillRates List<RatelimitconfigurationTokenRefillRate>
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Burst string
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ConfigpbAttributes List<RatelimitconfigurationConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RatelimitconfigurationId string
    TenantRef string
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Type string
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    HttpMethods []string
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    Resource string
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TokenRefillRates []RatelimitconfigurationTokenRefillRateArgs
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Burst string
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ConfigpbAttributes []RatelimitconfigurationConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RatelimitconfigurationId string
    TenantRef string
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Type string
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    httpMethods List<String>
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    resource String
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tokenRefillRates List<RatelimitconfigurationTokenRefillRate>
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    burst String
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes List<RatelimitconfigurationConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ratelimitconfigurationId String
    tenantRef String
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    type String
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    httpMethods string[]
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    resource string
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tokenRefillRates RatelimitconfigurationTokenRefillRate[]
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    burst string
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes RatelimitconfigurationConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description string
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name string
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ratelimitconfigurationId string
    tenantRef string
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    type string
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    http_methods Sequence[str]
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    resource str
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    token_refill_rates Sequence[RatelimitconfigurationTokenRefillRateArgs]
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    burst str
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpb_attributes Sequence[RatelimitconfigurationConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description str
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name str
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ratelimitconfiguration_id str
    tenant_ref str
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    type str
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    httpMethods List<String>
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    resource String
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tokenRefillRates List<Property Map>
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    burst String
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ratelimitconfigurationId String
    tenantRef String
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    type String
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

    Outputs

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

    Get an existing Ratelimitconfiguration 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?: RatelimitconfigurationState, opts?: CustomResourceOptions): Ratelimitconfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        burst: Optional[str] = None,
        configpb_attributes: Optional[Sequence[RatelimitconfigurationConfigpbAttributeArgs]] = None,
        description: Optional[str] = None,
        http_methods: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        ratelimitconfiguration_id: Optional[str] = None,
        resource: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        token_refill_rates: Optional[Sequence[RatelimitconfigurationTokenRefillRateArgs]] = None,
        type: Optional[str] = None,
        uuid: Optional[str] = None) -> Ratelimitconfiguration
    func GetRatelimitconfiguration(ctx *Context, name string, id IDInput, state *RatelimitconfigurationState, opts ...ResourceOption) (*Ratelimitconfiguration, error)
    public static Ratelimitconfiguration Get(string name, Input<string> id, RatelimitconfigurationState? state, CustomResourceOptions? opts = null)
    public static Ratelimitconfiguration get(String name, Output<String> id, RatelimitconfigurationState state, CustomResourceOptions options)
    resources:  _:    type: avi:Ratelimitconfiguration    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:
    Burst string
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ConfigpbAttributes List<RatelimitconfigurationConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    HttpMethods List<string>
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RatelimitconfigurationId string
    Resource string
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TenantRef string
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TokenRefillRates List<RatelimitconfigurationTokenRefillRate>
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Type string
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Burst string
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ConfigpbAttributes []RatelimitconfigurationConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    HttpMethods []string
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RatelimitconfigurationId string
    Resource string
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TenantRef string
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    TokenRefillRates []RatelimitconfigurationTokenRefillRateArgs
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Type string
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    burst String
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes List<RatelimitconfigurationConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    httpMethods List<String>
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ratelimitconfigurationId String
    resource String
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenantRef String
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tokenRefillRates List<RatelimitconfigurationTokenRefillRate>
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    type String
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    burst string
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes RatelimitconfigurationConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description string
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    httpMethods string[]
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    name string
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ratelimitconfigurationId string
    resource string
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenantRef string
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tokenRefillRates RatelimitconfigurationTokenRefillRate[]
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    type string
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    burst str
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpb_attributes Sequence[RatelimitconfigurationConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description str
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    http_methods Sequence[str]
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    name str
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ratelimitconfiguration_id str
    resource str
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenant_ref str
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    token_refill_rates Sequence[RatelimitconfigurationTokenRefillRateArgs]
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    type str
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    burst String
    The maximum request per second(rps) user intends to support for this category.this is not guaranteed as this will be the minimum of the rps supported by the resources in the category and this value.if user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 31.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Description for the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    httpMethods List<String>
    List of http method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    Name of the rate limit configuration(unique). Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ratelimitconfigurationId String
    resource String
    Ratelimitresource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tenantRef String
    Tenant ref for the auth rate limit configuration. It is a reference to an object of type tenant. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    tokenRefillRates List<Property Map>
    Token refill rate. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    type String
    Type of the rate limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the rate limit configuration. Field introduced in 31.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.

    Supporting Types

    RatelimitconfigurationConfigpbAttribute, RatelimitconfigurationConfigpbAttributeArgs

    Version string
    Version string
    version String
    version string
    version String

    RatelimitconfigurationTokenRefillRate, RatelimitconfigurationTokenRefillRateArgs

    Interval string
    RefillRate string
    Interval string
    RefillRate string
    interval String
    refillRate String
    interval string
    refillRate string
    interval String
    refillRate String

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.2.1 published on Monday, Dec 22, 2025 by vmware
    Schema (JSON)
    vmware/terraform-provider-avi
      Meet Neo: Your AI Platform Teammate