Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. ApigThrottlingPolicy
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.ApigThrottlingPolicy

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    Manages an APIG (API) throttling policy resource within FlexibleEngine.

    Example Usage

    Create a basic throttling policy

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

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const policyName = config.requireObject("policyName");
const description = config.requireObject("description");
const test = new flexibleengine.ApigThrottlingPolicy("test", {
    instanceId: instanceId,
    description: description,
    type: "API-based",
    period: 10,
    periodUnit: "MINUTE",
    maxApiRequests: 70,
    maxUserRequests: 45,
    maxAppRequests: 45,
    maxIpRequests: 45,
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
policy_name = config.require_object("policyName")
description = config.require_object("description")
test = flexibleengine.ApigThrottlingPolicy("test",
    instance_id=instance_id,
    description=description,
    type="API-based",
    period=10,
    period_unit="MINUTE",
    max_api_requests=70,
    max_user_requests=45,
    max_app_requests=45,
    max_ip_requests=45)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		policyName := cfg.RequireObject("policyName")
		description := cfg.RequireObject("description")
		_, err := flexibleengine.NewApigThrottlingPolicy(ctx, "test", &flexibleengine.ApigThrottlingPolicyArgs{
			InstanceId:      pulumi.Any(instanceId),
			Description:     pulumi.Any(description),
			Type:            pulumi.String("API-based"),
			Period:          pulumi.Float64(10),
			PeriodUnit:      pulumi.String("MINUTE"),
			MaxApiRequests:  pulumi.Float64(70),
			MaxUserRequests: pulumi.Float64(45),
			MaxAppRequests:  pulumi.Float64(45),
			MaxIpRequests:   pulumi.Float64(45),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var policyName = config.RequireObject<dynamic>("policyName");
    var description = config.RequireObject<dynamic>("description");
    var test = new Flexibleengine.ApigThrottlingPolicy("test", new()
    {
        InstanceId = instanceId,
        Description = description,
        Type = "API-based",
        Period = 10,
        PeriodUnit = "MINUTE",
        MaxApiRequests = 70,
        MaxUserRequests = 45,
        MaxAppRequests = 45,
        MaxIpRequests = 45,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApigThrottlingPolicy;
import com.pulumi.flexibleengine.ApigThrottlingPolicyArgs;
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 config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var policyName = config.get("policyName");
        final var description = config.get("description");
        var test = new ApigThrottlingPolicy("test", ApigThrottlingPolicyArgs.builder()
            .instanceId(instanceId)
            .description(description)
            .type("API-based")
            .period(10)
            .periodUnit("MINUTE")
            .maxApiRequests(70)
            .maxUserRequests(45)
            .maxAppRequests(45)
            .maxIpRequests(45)
            .build());

    }
}

    configuration:
  instanceId:
    type: dynamic
  policyName:
    type: dynamic
  description:
    type: dynamic
resources:
  test:
    type: flexibleengine:ApigThrottlingPolicy
    properties:
      instanceId: ${instanceId}
      description: ${description}
      type: API-based
      period: 10
      periodUnit: MINUTE
      maxApiRequests: 70
      maxUserRequests: 45
      maxAppRequests: 45
      maxIpRequests: 45

    Create a throttling policy with a special throttle

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

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const policyName = config.requireObject("policyName");
const description = config.requireObject("description");
const applicationId = config.requireObject("applicationId");
const test = new flexibleengine.ApigThrottlingPolicy("test", {
    instanceId: instanceId,
    description: description,
    type: "API-based",
    period: 10,
    periodUnit: "MINUTE",
    maxApiRequests: 70,
    maxUserRequests: 45,
    maxAppRequests: 45,
    maxIpRequests: 45,
    appThrottles: [{
        maxApiRequests: 40,
        throttlingObjectId: applicationId,
    }],
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
policy_name = config.require_object("policyName")
description = config.require_object("description")
application_id = config.require_object("applicationId")
test = flexibleengine.ApigThrottlingPolicy("test",
    instance_id=instance_id,
    description=description,
    type="API-based",
    period=10,
    period_unit="MINUTE",
    max_api_requests=70,
    max_user_requests=45,
    max_app_requests=45,
    max_ip_requests=45,
    app_throttles=[{
        "max_api_requests": 40,
        "throttling_object_id": application_id,
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		policyName := cfg.RequireObject("policyName")
		description := cfg.RequireObject("description")
		applicationId := cfg.RequireObject("applicationId")
		_, err := flexibleengine.NewApigThrottlingPolicy(ctx, "test", &flexibleengine.ApigThrottlingPolicyArgs{
			InstanceId:      pulumi.Any(instanceId),
			Description:     pulumi.Any(description),
			Type:            pulumi.String("API-based"),
			Period:          pulumi.Float64(10),
			PeriodUnit:      pulumi.String("MINUTE"),
			MaxApiRequests:  pulumi.Float64(70),
			MaxUserRequests: pulumi.Float64(45),
			MaxAppRequests:  pulumi.Float64(45),
			MaxIpRequests:   pulumi.Float64(45),
			AppThrottles: flexibleengine.ApigThrottlingPolicyAppThrottleArray{
				&flexibleengine.ApigThrottlingPolicyAppThrottleArgs{
					MaxApiRequests:     pulumi.Float64(40),
					ThrottlingObjectId: pulumi.Any(applicationId),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var policyName = config.RequireObject<dynamic>("policyName");
    var description = config.RequireObject<dynamic>("description");
    var applicationId = config.RequireObject<dynamic>("applicationId");
    var test = new Flexibleengine.ApigThrottlingPolicy("test", new()
    {
        InstanceId = instanceId,
        Description = description,
        Type = "API-based",
        Period = 10,
        PeriodUnit = "MINUTE",
        MaxApiRequests = 70,
        MaxUserRequests = 45,
        MaxAppRequests = 45,
        MaxIpRequests = 45,
        AppThrottles = new[]
        {
            new Flexibleengine.Inputs.ApigThrottlingPolicyAppThrottleArgs
            {
                MaxApiRequests = 40,
                ThrottlingObjectId = applicationId,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApigThrottlingPolicy;
import com.pulumi.flexibleengine.ApigThrottlingPolicyArgs;
import com.pulumi.flexibleengine.inputs.ApigThrottlingPolicyAppThrottleArgs;
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 config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var policyName = config.get("policyName");
        final var description = config.get("description");
        final var applicationId = config.get("applicationId");
        var test = new ApigThrottlingPolicy("test", ApigThrottlingPolicyArgs.builder()
            .instanceId(instanceId)
            .description(description)
            .type("API-based")
            .period(10)
            .periodUnit("MINUTE")
            .maxApiRequests(70)
            .maxUserRequests(45)
            .maxAppRequests(45)
            .maxIpRequests(45)
            .appThrottles(ApigThrottlingPolicyAppThrottleArgs.builder()
                .maxApiRequests(40)
                .throttlingObjectId(applicationId)
                .build())
            .build());

    }
}

    configuration:
  instanceId:
    type: dynamic
  policyName:
    type: dynamic
  description:
    type: dynamic
  applicationId:
    type: dynamic
resources:
  test:
    type: flexibleengine:ApigThrottlingPolicy
    properties:
      instanceId: ${instanceId}
      description: ${description}
      type: API-based
      period: 10
      periodUnit: MINUTE
      maxApiRequests: 70
      maxUserRequests: 45
      maxAppRequests: 45
      maxIpRequests: 45
      appThrottles:
        - maxApiRequests: 40
          throttlingObjectId: ${applicationId}

    Create ApigThrottlingPolicy Resource

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

    Constructor syntax

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

@overload
def ApigThrottlingPolicy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         period: Optional[float] = None,
                         instance_id: Optional[str] = None,
                         max_api_requests: Optional[float] = None,
                         type: Optional[str] = None,
                         description: Optional[str] = None,
                         max_app_requests: Optional[float] = None,
                         name: Optional[str] = None,
                         max_ip_requests: Optional[float] = None,
                         app_throttles: Optional[Sequence[ApigThrottlingPolicyAppThrottleArgs]] = None,
                         apig_throttling_policy_id: Optional[str] = None,
                         period_unit: Optional[str] = None,
                         region: Optional[str] = None,
                         max_user_requests: Optional[float] = None,
                         user_throttles: Optional[Sequence[ApigThrottlingPolicyUserThrottleArgs]] = None)
    func NewApigThrottlingPolicy(ctx *Context, name string, args ApigThrottlingPolicyArgs, opts ...ResourceOption) (*ApigThrottlingPolicy, error)
    public ApigThrottlingPolicy(string name, ApigThrottlingPolicyArgs args, CustomResourceOptions? opts = null)
    public ApigThrottlingPolicy(String name, ApigThrottlingPolicyArgs args)
public ApigThrottlingPolicy(String name, ApigThrottlingPolicyArgs args, CustomResourceOptions options)

    type: flexibleengine:ApigThrottlingPolicy
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 ApigThrottlingPolicyArgs
    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 ApigThrottlingPolicyArgs
    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 ApigThrottlingPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigThrottlingPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigThrottlingPolicyArgs
    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 apigThrottlingPolicyResource = new Flexibleengine.ApigThrottlingPolicy("apigThrottlingPolicyResource", new()
{
    Period = 0,
    InstanceId = "string",
    MaxApiRequests = 0,
    Type = "string",
    Description = "string",
    MaxAppRequests = 0,
    Name = "string",
    MaxIpRequests = 0,
    AppThrottles = new[]
    {
        new Flexibleengine.Inputs.ApigThrottlingPolicyAppThrottleArgs
        {
            MaxApiRequests = 0,
            ThrottlingObjectId = "string",
            Id = "string",
            ThrottlingObjectName = "string",
        },
    },
    ApigThrottlingPolicyId = "string",
    PeriodUnit = "string",
    Region = "string",
    MaxUserRequests = 0,
    UserThrottles = new[]
    {
        new Flexibleengine.Inputs.ApigThrottlingPolicyUserThrottleArgs
        {
            MaxApiRequests = 0,
            ThrottlingObjectId = "string",
            Id = "string",
            ThrottlingObjectName = "string",
        },
    },
});

    example, err := flexibleengine.NewApigThrottlingPolicy(ctx, "apigThrottlingPolicyResource", &flexibleengine.ApigThrottlingPolicyArgs{
	Period:         pulumi.Float64(0),
	InstanceId:     pulumi.String("string"),
	MaxApiRequests: pulumi.Float64(0),
	Type:           pulumi.String("string"),
	Description:    pulumi.String("string"),
	MaxAppRequests: pulumi.Float64(0),
	Name:           pulumi.String("string"),
	MaxIpRequests:  pulumi.Float64(0),
	AppThrottles: flexibleengine.ApigThrottlingPolicyAppThrottleArray{
		&flexibleengine.ApigThrottlingPolicyAppThrottleArgs{
			MaxApiRequests:       pulumi.Float64(0),
			ThrottlingObjectId:   pulumi.String("string"),
			Id:                   pulumi.String("string"),
			ThrottlingObjectName: pulumi.String("string"),
		},
	},
	ApigThrottlingPolicyId: pulumi.String("string"),
	PeriodUnit:             pulumi.String("string"),
	Region:                 pulumi.String("string"),
	MaxUserRequests:        pulumi.Float64(0),
	UserThrottles: flexibleengine.ApigThrottlingPolicyUserThrottleArray{
		&flexibleengine.ApigThrottlingPolicyUserThrottleArgs{
			MaxApiRequests:       pulumi.Float64(0),
			ThrottlingObjectId:   pulumi.String("string"),
			Id:                   pulumi.String("string"),
			ThrottlingObjectName: pulumi.String("string"),
		},
	},
})

    var apigThrottlingPolicyResource = new ApigThrottlingPolicy("apigThrottlingPolicyResource", ApigThrottlingPolicyArgs.builder()
    .period(0)
    .instanceId("string")
    .maxApiRequests(0)
    .type("string")
    .description("string")
    .maxAppRequests(0)
    .name("string")
    .maxIpRequests(0)
    .appThrottles(ApigThrottlingPolicyAppThrottleArgs.builder()
        .maxApiRequests(0)
        .throttlingObjectId("string")
        .id("string")
        .throttlingObjectName("string")
        .build())
    .apigThrottlingPolicyId("string")
    .periodUnit("string")
    .region("string")
    .maxUserRequests(0)
    .userThrottles(ApigThrottlingPolicyUserThrottleArgs.builder()
        .maxApiRequests(0)
        .throttlingObjectId("string")
        .id("string")
        .throttlingObjectName("string")
        .build())
    .build());

    apig_throttling_policy_resource = flexibleengine.ApigThrottlingPolicy("apigThrottlingPolicyResource",
    period=0,
    instance_id="string",
    max_api_requests=0,
    type="string",
    description="string",
    max_app_requests=0,
    name="string",
    max_ip_requests=0,
    app_throttles=[{
        "max_api_requests": 0,
        "throttling_object_id": "string",
        "id": "string",
        "throttling_object_name": "string",
    }],
    apig_throttling_policy_id="string",
    period_unit="string",
    region="string",
    max_user_requests=0,
    user_throttles=[{
        "max_api_requests": 0,
        "throttling_object_id": "string",
        "id": "string",
        "throttling_object_name": "string",
    }])

    const apigThrottlingPolicyResource = new flexibleengine.ApigThrottlingPolicy("apigThrottlingPolicyResource", {
    period: 0,
    instanceId: "string",
    maxApiRequests: 0,
    type: "string",
    description: "string",
    maxAppRequests: 0,
    name: "string",
    maxIpRequests: 0,
    appThrottles: [{
        maxApiRequests: 0,
        throttlingObjectId: "string",
        id: "string",
        throttlingObjectName: "string",
    }],
    apigThrottlingPolicyId: "string",
    periodUnit: "string",
    region: "string",
    maxUserRequests: 0,
    userThrottles: [{
        maxApiRequests: 0,
        throttlingObjectId: "string",
        id: "string",
        throttlingObjectName: "string",
    }],
});

    type: flexibleengine:ApigThrottlingPolicy
properties:
    apigThrottlingPolicyId: string
    appThrottles:
        - id: string
          maxApiRequests: 0
          throttlingObjectId: string
          throttlingObjectName: string
    description: string
    instanceId: string
    maxApiRequests: 0
    maxAppRequests: 0
    maxIpRequests: 0
    maxUserRequests: 0
    name: string
    period: 0
    periodUnit: string
    region: string
    type: string
    userThrottles:
        - id: string
          maxApiRequests: 0
          throttlingObjectId: string
          throttlingObjectName: string

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

    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    MaxApiRequests double
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    Period double
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    ApigThrottlingPolicyId string
    ID of the special application throttling policy.
    AppThrottles List<ApigThrottlingPolicyAppThrottle>
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    Description string
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    MaxAppRequests double
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    MaxIpRequests double
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    MaxUserRequests double
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    Name string
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    PeriodUnit string
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    Region string
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    Type string
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    UserThrottles List<ApigThrottlingPolicyUserThrottle>
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    MaxApiRequests float64
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    Period float64
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    ApigThrottlingPolicyId string
    ID of the special application throttling policy.
    AppThrottles []ApigThrottlingPolicyAppThrottleArgs
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    Description string
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    MaxAppRequests float64
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    MaxIpRequests float64
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    MaxUserRequests float64
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    Name string
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    PeriodUnit string
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    Region string
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    Type string
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    UserThrottles []ApigThrottlingPolicyUserThrottleArgs
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    maxApiRequests Double
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    period Double
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    apigThrottlingPolicyId String
    ID of the special application throttling policy.
    appThrottles List<ApigThrottlingPolicyAppThrottle>
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    description String
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    maxAppRequests Double
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    maxIpRequests Double
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    maxUserRequests Double
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    name String
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    periodUnit String
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    region String
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    type String
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    userThrottles List<ApigThrottlingPolicyUserThrottle>
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    instanceId string
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    maxApiRequests number
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    period number
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    apigThrottlingPolicyId string
    ID of the special application throttling policy.
    appThrottles ApigThrottlingPolicyAppThrottle[]
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    description string
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    maxAppRequests number
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    maxIpRequests number
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    maxUserRequests number
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    name string
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    periodUnit string
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    region string
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    type string
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    userThrottles ApigThrottlingPolicyUserThrottle[]
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    instance_id str
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    max_api_requests float
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    period float
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    apig_throttling_policy_id str
    ID of the special application throttling policy.
    app_throttles Sequence[ApigThrottlingPolicyAppThrottleArgs]
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    description str
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    max_app_requests float
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    max_ip_requests float
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    max_user_requests float
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    name str
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    period_unit str
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    region str
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    type str
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    user_throttles Sequence[ApigThrottlingPolicyUserThrottleArgs]
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    maxApiRequests Number
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    period Number
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    apigThrottlingPolicyId String
    ID of the special application throttling policy.
    appThrottles List<Property Map>
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    description String
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    maxAppRequests Number
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    maxIpRequests Number
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    maxUserRequests Number
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    name String
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    periodUnit String
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    region String
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    type String
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    userThrottles List<Property Map>
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApigThrottlingPolicy resource produces the following output properties:

    CreatedAt string
    The creation time of the throttling policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt string
    The creation time of the throttling policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The creation time of the throttling policy.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt string
    The creation time of the throttling policy.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at str
    The creation time of the throttling policy.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The creation time of the throttling policy.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApigThrottlingPolicy Resource

    Get an existing ApigThrottlingPolicy 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?: ApigThrottlingPolicyState, opts?: CustomResourceOptions): ApigThrottlingPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apig_throttling_policy_id: Optional[str] = None,
        app_throttles: Optional[Sequence[ApigThrottlingPolicyAppThrottleArgs]] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        max_api_requests: Optional[float] = None,
        max_app_requests: Optional[float] = None,
        max_ip_requests: Optional[float] = None,
        max_user_requests: Optional[float] = None,
        name: Optional[str] = None,
        period: Optional[float] = None,
        period_unit: Optional[str] = None,
        region: Optional[str] = None,
        type: Optional[str] = None,
        user_throttles: Optional[Sequence[ApigThrottlingPolicyUserThrottleArgs]] = None) -> ApigThrottlingPolicy
    func GetApigThrottlingPolicy(ctx *Context, name string, id IDInput, state *ApigThrottlingPolicyState, opts ...ResourceOption) (*ApigThrottlingPolicy, error)
    public static ApigThrottlingPolicy Get(string name, Input<string> id, ApigThrottlingPolicyState? state, CustomResourceOptions? opts = null)
    public static ApigThrottlingPolicy get(String name, Output<String> id, ApigThrottlingPolicyState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApigThrottlingPolicy    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:
    ApigThrottlingPolicyId string
    ID of the special application throttling policy.
    AppThrottles List<ApigThrottlingPolicyAppThrottle>
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    CreatedAt string
    The creation time of the throttling policy.
    Description string
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    MaxApiRequests double
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    MaxAppRequests double
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    MaxIpRequests double
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    MaxUserRequests double
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    Name string
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Period double
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    PeriodUnit string
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    Region string
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    Type string
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    UserThrottles List<ApigThrottlingPolicyUserThrottle>
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    ApigThrottlingPolicyId string
    ID of the special application throttling policy.
    AppThrottles []ApigThrottlingPolicyAppThrottleArgs
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    CreatedAt string
    The creation time of the throttling policy.
    Description string
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    MaxApiRequests float64
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    MaxAppRequests float64
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    MaxIpRequests float64
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    MaxUserRequests float64
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    Name string
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Period float64
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    PeriodUnit string
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    Region string
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    Type string
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    UserThrottles []ApigThrottlingPolicyUserThrottleArgs
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    apigThrottlingPolicyId String
    ID of the special application throttling policy.
    appThrottles List<ApigThrottlingPolicyAppThrottle>
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    createdAt String
    The creation time of the throttling policy.
    description String
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    maxApiRequests Double
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    maxAppRequests Double
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    maxIpRequests Double
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    maxUserRequests Double
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    name String
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    period Double
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    periodUnit String
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    region String
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    type String
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    userThrottles List<ApigThrottlingPolicyUserThrottle>
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    apigThrottlingPolicyId string
    ID of the special application throttling policy.
    appThrottles ApigThrottlingPolicyAppThrottle[]
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    createdAt string
    The creation time of the throttling policy.
    description string
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    instanceId string
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    maxApiRequests number
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    maxAppRequests number
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    maxIpRequests number
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    maxUserRequests number
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    name string
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    period number
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    periodUnit string
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    region string
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    type string
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    userThrottles ApigThrottlingPolicyUserThrottle[]
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    apig_throttling_policy_id str
    ID of the special application throttling policy.
    app_throttles Sequence[ApigThrottlingPolicyAppThrottleArgs]
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    created_at str
    The creation time of the throttling policy.
    description str
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    instance_id str
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    max_api_requests float
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    max_app_requests float
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    max_ip_requests float
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    max_user_requests float
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    name str
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    period float
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    period_unit str
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    region str
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    type str
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    user_throttles Sequence[ApigThrottlingPolicyUserThrottleArgs]
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.
    apigThrottlingPolicyId String
    ID of the special application throttling policy.
    appThrottles List<Property Map>
    Specifies an array of one or more special throttling policies for APP limit. The throttle object of the app_throttles structure is documented below.
    createdAt String
    The creation time of the throttling policy.
    description String
    Specifies the description about the API throttling policy. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API throttling policy belongs to. Changing this will create a new API throttling policy resource.
    maxApiRequests Number
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    maxAppRequests Number
    Specifies the maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than or equal to the value of max_user_requests.
    maxIpRequests Number
    Specifies the maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    maxUserRequests Number
    Specifies the maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to the value of max_api_requests.
    name String
    Specifies the name of the API throttling policy. The policy name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    period Number
    Specifies the period of time for limiting the number of API calls. This parameter applies with each of the API call limits: max_api_requests, max_app_requests, max_ip_requests and max_user_requests.
    periodUnit String
    Specifies the time unit for limiting the number of API calls. The valid values are SECOND, MINUTE, HOUR and DAY, default to MINUTE.
    region String
    Specifies the region in which to create the API throttling policy resource. If omitted, the provider-level region will be used. Changing this will create a new API throttling policy resource.
    type String
    Specifies the type of the request throttling policy. The valid values are as follows:

    • API-based: limiting the maximum number of times a single API bound to the policy can be called within the specified period.
    • API-shared: limiting the maximum number of times all APIs bound to the policy can be called within the specified period.
    userThrottles List<Property Map>
    Specifies an array of one or more special throttling policies for IAM user limit. The throttle object of the user_throttles structure is documented below.

    Supporting Types

    ApigThrottlingPolicyAppThrottle, ApigThrottlingPolicyAppThrottleArgs

    MaxApiRequests double
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    ThrottlingObjectId string
    The object ID which the special throttling policy belongs.
    Id string
    ID of the special application throttling policy.
    ThrottlingObjectName string
    The object name which the special application throttling policy belongs.
    MaxApiRequests float64
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    ThrottlingObjectId string
    The object ID which the special throttling policy belongs.
    Id string
    ID of the special application throttling policy.
    ThrottlingObjectName string
    The object name which the special application throttling policy belongs.
    maxApiRequests Double
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    throttlingObjectId String
    The object ID which the special throttling policy belongs.
    id String
    ID of the special application throttling policy.
    throttlingObjectName String
    The object name which the special application throttling policy belongs.
    maxApiRequests number
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    throttlingObjectId string
    The object ID which the special throttling policy belongs.
    id string
    ID of the special application throttling policy.
    throttlingObjectName string
    The object name which the special application throttling policy belongs.
    max_api_requests float
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    throttling_object_id str
    The object ID which the special throttling policy belongs.
    id str
    ID of the special application throttling policy.
    throttling_object_name str
    The object name which the special application throttling policy belongs.
    maxApiRequests Number
    Specifies the maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS.
    throttlingObjectId String
    The object ID which the special throttling policy belongs.
    id String
    ID of the special application throttling policy.
    throttlingObjectName String
    The object name which the special application throttling policy belongs.

    ApigThrottlingPolicyUserThrottle, ApigThrottlingPolicyUserThrottleArgs

    MaxApiRequests double
    Specifies the maximum number of times an API can be accessed within a specified period.
    ThrottlingObjectId string
    Specifies the object ID which the special throttling policy belongs.
    Id string
    ID of the special application throttling policy.
    ThrottlingObjectName string
    The object name which the special application throttling policy belongs.
    MaxApiRequests float64
    Specifies the maximum number of times an API can be accessed within a specified period.
    ThrottlingObjectId string
    Specifies the object ID which the special throttling policy belongs.
    Id string
    ID of the special application throttling policy.
    ThrottlingObjectName string
    The object name which the special application throttling policy belongs.
    maxApiRequests Double
    Specifies the maximum number of times an API can be accessed within a specified period.
    throttlingObjectId String
    Specifies the object ID which the special throttling policy belongs.
    id String
    ID of the special application throttling policy.
    throttlingObjectName String
    The object name which the special application throttling policy belongs.
    maxApiRequests number
    Specifies the maximum number of times an API can be accessed within a specified period.
    throttlingObjectId string
    Specifies the object ID which the special throttling policy belongs.
    id string
    ID of the special application throttling policy.
    throttlingObjectName string
    The object name which the special application throttling policy belongs.
    max_api_requests float
    Specifies the maximum number of times an API can be accessed within a specified period.
    throttling_object_id str
    Specifies the object ID which the special throttling policy belongs.
    id str
    ID of the special application throttling policy.
    throttling_object_name str
    The object name which the special application throttling policy belongs.
    maxApiRequests Number
    Specifies the maximum number of times an API can be accessed within a specified period.
    throttlingObjectId String
    Specifies the object ID which the special throttling policy belongs.
    id String
    ID of the special application throttling policy.
    throttlingObjectName String
    The object name which the special application throttling policy belongs.

    Import

    API Throttling Policies of APIG can be imported using the ID of the APIG instances to which the

    environment belongs and name, separated by a slash, e.g.

    $ pulumi import flexibleengine:index/apigThrottlingPolicy:ApigThrottlingPolicy test <instance_id>/<name>

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

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine