1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. TseCngwRouteRateLimit
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.TseCngwRouteRateLimit

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Provides a resource to create a tse cngw_route_rate_limit

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const config = new pulumi.Config();
    const availabilityZone = config.get("availabilityZone") || "ap-guangzhou-4";
    const vpc = new tencentcloud.Vpc("vpc", {cidrBlock: "10.0.0.0/16"});
    const subnet = new tencentcloud.Subnet("subnet", {
        vpcId: vpc.vpcId,
        availabilityZone: availabilityZone,
        cidrBlock: "10.0.1.0/24",
    });
    const cngwGateway = new tencentcloud.TseCngwGateway("cngwGateway", {
        description: "terraform test1",
        enableCls: true,
        engineRegion: "ap-guangzhou",
        featureVersion: "STANDARD",
        gatewayVersion: "2.5.1",
        ingressClassName: "tse-nginx-ingress",
        internetMaxBandwidthOut: 0,
        tradeType: 0,
        type: "kong",
        nodeConfig: {
            number: 2,
            specification: "1c2g",
        },
        vpcConfig: {
            subnetId: subnet.subnetId,
            vpcId: vpc.vpcId,
        },
        tags: {
            createdBy: "terraform",
        },
    });
    const cngwService = new tencentcloud.TseCngwService("cngwService", {
        gatewayId: cngwGateway.tseCngwGatewayId,
        path: "/test",
        protocol: "http",
        retries: 5,
        timeout: 60000,
        upstreamType: "HostIP",
        upstreamInfo: {
            algorithm: "round-robin",
            autoScalingCvmPort: 0,
            host: "arunma.cn",
            port: 8012,
            slowStart: 0,
        },
    });
    const cngwRoute = new tencentcloud.TseCngwRoute("cngwRoute", {
        destinationPorts: [],
        forceHttps: false,
        gatewayId: cngwGateway.tseCngwGatewayId,
        hosts: ["192.168.0.1:9090"],
        httpsRedirectStatusCode: 426,
        paths: ["/user"],
        headers: [{
            key: "req",
            value: "terraform",
        }],
        preserveHost: false,
        protocols: [
            "http",
            "https",
        ],
        routeName: "terraform-route",
        serviceId: cngwService.serviceId,
        stripPath: true,
    });
    const cngwRouteRateLimit = new tencentcloud.TseCngwRouteRateLimit("cngwRouteRateLimit", {
        gatewayId: cngwGateway.tseCngwGatewayId,
        routeId: cngwRoute.routeId,
        limitDetail: {
            enabled: true,
            header: "req",
            hideClientHeaders: true,
            isDelay: true,
            limitBy: "header",
            lineUpTime: 10,
            policy: "redis",
            responseType: "default",
            qpsThresholds: [{
                max: 10,
                unit: "minute",
            }],
        },
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    config = pulumi.Config()
    availability_zone = config.get("availabilityZone")
    if availability_zone is None:
        availability_zone = "ap-guangzhou-4"
    vpc = tencentcloud.Vpc("vpc", cidr_block="10.0.0.0/16")
    subnet = tencentcloud.Subnet("subnet",
        vpc_id=vpc.vpc_id,
        availability_zone=availability_zone,
        cidr_block="10.0.1.0/24")
    cngw_gateway = tencentcloud.TseCngwGateway("cngwGateway",
        description="terraform test1",
        enable_cls=True,
        engine_region="ap-guangzhou",
        feature_version="STANDARD",
        gateway_version="2.5.1",
        ingress_class_name="tse-nginx-ingress",
        internet_max_bandwidth_out=0,
        trade_type=0,
        type="kong",
        node_config={
            "number": 2,
            "specification": "1c2g",
        },
        vpc_config={
            "subnet_id": subnet.subnet_id,
            "vpc_id": vpc.vpc_id,
        },
        tags={
            "createdBy": "terraform",
        })
    cngw_service = tencentcloud.TseCngwService("cngwService",
        gateway_id=cngw_gateway.tse_cngw_gateway_id,
        path="/test",
        protocol="http",
        retries=5,
        timeout=60000,
        upstream_type="HostIP",
        upstream_info={
            "algorithm": "round-robin",
            "auto_scaling_cvm_port": 0,
            "host": "arunma.cn",
            "port": 8012,
            "slow_start": 0,
        })
    cngw_route = tencentcloud.TseCngwRoute("cngwRoute",
        destination_ports=[],
        force_https=False,
        gateway_id=cngw_gateway.tse_cngw_gateway_id,
        hosts=["192.168.0.1:9090"],
        https_redirect_status_code=426,
        paths=["/user"],
        headers=[{
            "key": "req",
            "value": "terraform",
        }],
        preserve_host=False,
        protocols=[
            "http",
            "https",
        ],
        route_name="terraform-route",
        service_id=cngw_service.service_id,
        strip_path=True)
    cngw_route_rate_limit = tencentcloud.TseCngwRouteRateLimit("cngwRouteRateLimit",
        gateway_id=cngw_gateway.tse_cngw_gateway_id,
        route_id=cngw_route.route_id,
        limit_detail={
            "enabled": True,
            "header": "req",
            "hide_client_headers": True,
            "is_delay": True,
            "limit_by": "header",
            "line_up_time": 10,
            "policy": "redis",
            "response_type": "default",
            "qps_thresholds": [{
                "max": 10,
                "unit": "minute",
            }],
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
    	"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, "")
    		availabilityZone := "ap-guangzhou-4"
    		if param := cfg.Get("availabilityZone"); param != "" {
    			availabilityZone = param
    		}
    		vpc, err := tencentcloud.NewVpc(ctx, "vpc", &tencentcloud.VpcArgs{
    			CidrBlock: pulumi.String("10.0.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		subnet, err := tencentcloud.NewSubnet(ctx, "subnet", &tencentcloud.SubnetArgs{
    			VpcId:            vpc.VpcId,
    			AvailabilityZone: pulumi.String(availabilityZone),
    			CidrBlock:        pulumi.String("10.0.1.0/24"),
    		})
    		if err != nil {
    			return err
    		}
    		cngwGateway, err := tencentcloud.NewTseCngwGateway(ctx, "cngwGateway", &tencentcloud.TseCngwGatewayArgs{
    			Description:             pulumi.String("terraform test1"),
    			EnableCls:               pulumi.Bool(true),
    			EngineRegion:            pulumi.String("ap-guangzhou"),
    			FeatureVersion:          pulumi.String("STANDARD"),
    			GatewayVersion:          pulumi.String("2.5.1"),
    			IngressClassName:        pulumi.String("tse-nginx-ingress"),
    			InternetMaxBandwidthOut: pulumi.Float64(0),
    			TradeType:               pulumi.Float64(0),
    			Type:                    pulumi.String("kong"),
    			NodeConfig: &tencentcloud.TseCngwGatewayNodeConfigArgs{
    				Number:        pulumi.Float64(2),
    				Specification: pulumi.String("1c2g"),
    			},
    			VpcConfig: &tencentcloud.TseCngwGatewayVpcConfigArgs{
    				SubnetId: subnet.SubnetId,
    				VpcId:    vpc.VpcId,
    			},
    			Tags: pulumi.StringMap{
    				"createdBy": pulumi.String("terraform"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		cngwService, err := tencentcloud.NewTseCngwService(ctx, "cngwService", &tencentcloud.TseCngwServiceArgs{
    			GatewayId:    cngwGateway.TseCngwGatewayId,
    			Path:         pulumi.String("/test"),
    			Protocol:     pulumi.String("http"),
    			Retries:      pulumi.Float64(5),
    			Timeout:      pulumi.Float64(60000),
    			UpstreamType: pulumi.String("HostIP"),
    			UpstreamInfo: &tencentcloud.TseCngwServiceUpstreamInfoArgs{
    				Algorithm:          pulumi.String("round-robin"),
    				AutoScalingCvmPort: pulumi.Float64(0),
    				Host:               pulumi.String("arunma.cn"),
    				Port:               pulumi.Float64(8012),
    				SlowStart:          pulumi.Float64(0),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		cngwRoute, err := tencentcloud.NewTseCngwRoute(ctx, "cngwRoute", &tencentcloud.TseCngwRouteArgs{
    			DestinationPorts: pulumi.Float64Array{},
    			ForceHttps:       pulumi.Bool(false),
    			GatewayId:        cngwGateway.TseCngwGatewayId,
    			Hosts: pulumi.StringArray{
    				pulumi.String("192.168.0.1:9090"),
    			},
    			HttpsRedirectStatusCode: pulumi.Float64(426),
    			Paths: pulumi.StringArray{
    				pulumi.String("/user"),
    			},
    			Headers: tencentcloud.TseCngwRouteHeaderArray{
    				&tencentcloud.TseCngwRouteHeaderArgs{
    					Key:   pulumi.String("req"),
    					Value: pulumi.String("terraform"),
    				},
    			},
    			PreserveHost: pulumi.Bool(false),
    			Protocols: pulumi.StringArray{
    				pulumi.String("http"),
    				pulumi.String("https"),
    			},
    			RouteName: pulumi.String("terraform-route"),
    			ServiceId: cngwService.ServiceId,
    			StripPath: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = tencentcloud.NewTseCngwRouteRateLimit(ctx, "cngwRouteRateLimit", &tencentcloud.TseCngwRouteRateLimitArgs{
    			GatewayId: cngwGateway.TseCngwGatewayId,
    			RouteId:   cngwRoute.RouteId,
    			LimitDetail: &tencentcloud.TseCngwRouteRateLimitLimitDetailArgs{
    				Enabled:           pulumi.Bool(true),
    				Header:            pulumi.String("req"),
    				HideClientHeaders: pulumi.Bool(true),
    				IsDelay:           pulumi.Bool(true),
    				LimitBy:           pulumi.String("header"),
    				LineUpTime:        pulumi.Float64(10),
    				Policy:            pulumi.String("redis"),
    				ResponseType:      pulumi.String("default"),
    				QpsThresholds: tencentcloud.TseCngwRouteRateLimitLimitDetailQpsThresholdArray{
    					&tencentcloud.TseCngwRouteRateLimitLimitDetailQpsThresholdArgs{
    						Max:  pulumi.Float64(10),
    						Unit: pulumi.String("minute"),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Tencentcloud = Pulumi.Tencentcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var availabilityZone = config.Get("availabilityZone") ?? "ap-guangzhou-4";
        var vpc = new Tencentcloud.Vpc("vpc", new()
        {
            CidrBlock = "10.0.0.0/16",
        });
    
        var subnet = new Tencentcloud.Subnet("subnet", new()
        {
            VpcId = vpc.VpcId,
            AvailabilityZone = availabilityZone,
            CidrBlock = "10.0.1.0/24",
        });
    
        var cngwGateway = new Tencentcloud.TseCngwGateway("cngwGateway", new()
        {
            Description = "terraform test1",
            EnableCls = true,
            EngineRegion = "ap-guangzhou",
            FeatureVersion = "STANDARD",
            GatewayVersion = "2.5.1",
            IngressClassName = "tse-nginx-ingress",
            InternetMaxBandwidthOut = 0,
            TradeType = 0,
            Type = "kong",
            NodeConfig = new Tencentcloud.Inputs.TseCngwGatewayNodeConfigArgs
            {
                Number = 2,
                Specification = "1c2g",
            },
            VpcConfig = new Tencentcloud.Inputs.TseCngwGatewayVpcConfigArgs
            {
                SubnetId = subnet.SubnetId,
                VpcId = vpc.VpcId,
            },
            Tags = 
            {
                { "createdBy", "terraform" },
            },
        });
    
        var cngwService = new Tencentcloud.TseCngwService("cngwService", new()
        {
            GatewayId = cngwGateway.TseCngwGatewayId,
            Path = "/test",
            Protocol = "http",
            Retries = 5,
            Timeout = 60000,
            UpstreamType = "HostIP",
            UpstreamInfo = new Tencentcloud.Inputs.TseCngwServiceUpstreamInfoArgs
            {
                Algorithm = "round-robin",
                AutoScalingCvmPort = 0,
                Host = "arunma.cn",
                Port = 8012,
                SlowStart = 0,
            },
        });
    
        var cngwRoute = new Tencentcloud.TseCngwRoute("cngwRoute", new()
        {
            DestinationPorts = new[] {},
            ForceHttps = false,
            GatewayId = cngwGateway.TseCngwGatewayId,
            Hosts = new[]
            {
                "192.168.0.1:9090",
            },
            HttpsRedirectStatusCode = 426,
            Paths = new[]
            {
                "/user",
            },
            Headers = new[]
            {
                new Tencentcloud.Inputs.TseCngwRouteHeaderArgs
                {
                    Key = "req",
                    Value = "terraform",
                },
            },
            PreserveHost = false,
            Protocols = new[]
            {
                "http",
                "https",
            },
            RouteName = "terraform-route",
            ServiceId = cngwService.ServiceId,
            StripPath = true,
        });
    
        var cngwRouteRateLimit = new Tencentcloud.TseCngwRouteRateLimit("cngwRouteRateLimit", new()
        {
            GatewayId = cngwGateway.TseCngwGatewayId,
            RouteId = cngwRoute.RouteId,
            LimitDetail = new Tencentcloud.Inputs.TseCngwRouteRateLimitLimitDetailArgs
            {
                Enabled = true,
                Header = "req",
                HideClientHeaders = true,
                IsDelay = true,
                LimitBy = "header",
                LineUpTime = 10,
                Policy = "redis",
                ResponseType = "default",
                QpsThresholds = new[]
                {
                    new Tencentcloud.Inputs.TseCngwRouteRateLimitLimitDetailQpsThresholdArgs
                    {
                        Max = 10,
                        Unit = "minute",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.Vpc;
    import com.pulumi.tencentcloud.VpcArgs;
    import com.pulumi.tencentcloud.Subnet;
    import com.pulumi.tencentcloud.SubnetArgs;
    import com.pulumi.tencentcloud.TseCngwGateway;
    import com.pulumi.tencentcloud.TseCngwGatewayArgs;
    import com.pulumi.tencentcloud.inputs.TseCngwGatewayNodeConfigArgs;
    import com.pulumi.tencentcloud.inputs.TseCngwGatewayVpcConfigArgs;
    import com.pulumi.tencentcloud.TseCngwService;
    import com.pulumi.tencentcloud.TseCngwServiceArgs;
    import com.pulumi.tencentcloud.inputs.TseCngwServiceUpstreamInfoArgs;
    import com.pulumi.tencentcloud.TseCngwRoute;
    import com.pulumi.tencentcloud.TseCngwRouteArgs;
    import com.pulumi.tencentcloud.inputs.TseCngwRouteHeaderArgs;
    import com.pulumi.tencentcloud.TseCngwRouteRateLimit;
    import com.pulumi.tencentcloud.TseCngwRouteRateLimitArgs;
    import com.pulumi.tencentcloud.inputs.TseCngwRouteRateLimitLimitDetailArgs;
    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 availabilityZone = config.get("availabilityZone").orElse("ap-guangzhou-4");
            var vpc = new Vpc("vpc", VpcArgs.builder()
                .cidrBlock("10.0.0.0/16")
                .build());
    
            var subnet = new Subnet("subnet", SubnetArgs.builder()
                .vpcId(vpc.vpcId())
                .availabilityZone(availabilityZone)
                .cidrBlock("10.0.1.0/24")
                .build());
    
            var cngwGateway = new TseCngwGateway("cngwGateway", TseCngwGatewayArgs.builder()
                .description("terraform test1")
                .enableCls(true)
                .engineRegion("ap-guangzhou")
                .featureVersion("STANDARD")
                .gatewayVersion("2.5.1")
                .ingressClassName("tse-nginx-ingress")
                .internetMaxBandwidthOut(0)
                .tradeType(0)
                .type("kong")
                .nodeConfig(TseCngwGatewayNodeConfigArgs.builder()
                    .number(2)
                    .specification("1c2g")
                    .build())
                .vpcConfig(TseCngwGatewayVpcConfigArgs.builder()
                    .subnetId(subnet.subnetId())
                    .vpcId(vpc.vpcId())
                    .build())
                .tags(Map.of("createdBy", "terraform"))
                .build());
    
            var cngwService = new TseCngwService("cngwService", TseCngwServiceArgs.builder()
                .gatewayId(cngwGateway.tseCngwGatewayId())
                .path("/test")
                .protocol("http")
                .retries(5)
                .timeout(60000)
                .upstreamType("HostIP")
                .upstreamInfo(TseCngwServiceUpstreamInfoArgs.builder()
                    .algorithm("round-robin")
                    .autoScalingCvmPort(0)
                    .host("arunma.cn")
                    .port(8012)
                    .slowStart(0)
                    .build())
                .build());
    
            var cngwRoute = new TseCngwRoute("cngwRoute", TseCngwRouteArgs.builder()
                .destinationPorts()
                .forceHttps(false)
                .gatewayId(cngwGateway.tseCngwGatewayId())
                .hosts("192.168.0.1:9090")
                .httpsRedirectStatusCode(426)
                .paths("/user")
                .headers(TseCngwRouteHeaderArgs.builder()
                    .key("req")
                    .value("terraform")
                    .build())
                .preserveHost(false)
                .protocols(            
                    "http",
                    "https")
                .routeName("terraform-route")
                .serviceId(cngwService.serviceId())
                .stripPath(true)
                .build());
    
            var cngwRouteRateLimit = new TseCngwRouteRateLimit("cngwRouteRateLimit", TseCngwRouteRateLimitArgs.builder()
                .gatewayId(cngwGateway.tseCngwGatewayId())
                .routeId(cngwRoute.routeId())
                .limitDetail(TseCngwRouteRateLimitLimitDetailArgs.builder()
                    .enabled(true)
                    .header("req")
                    .hideClientHeaders(true)
                    .isDelay(true)
                    .limitBy("header")
                    .lineUpTime(10)
                    .policy("redis")
                    .responseType("default")
                    .qpsThresholds(TseCngwRouteRateLimitLimitDetailQpsThresholdArgs.builder()
                        .max(10)
                        .unit("minute")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    configuration:
      availabilityZone:
        type: string
        default: ap-guangzhou-4
    resources:
      vpc:
        type: tencentcloud:Vpc
        properties:
          cidrBlock: 10.0.0.0/16
      subnet:
        type: tencentcloud:Subnet
        properties:
          vpcId: ${vpc.vpcId}
          availabilityZone: ${availabilityZone}
          cidrBlock: 10.0.1.0/24
      cngwGateway:
        type: tencentcloud:TseCngwGateway
        properties:
          description: terraform test1
          enableCls: true
          engineRegion: ap-guangzhou
          featureVersion: STANDARD
          gatewayVersion: 2.5.1
          ingressClassName: tse-nginx-ingress
          internetMaxBandwidthOut: 0
          tradeType: 0
          type: kong
          nodeConfig:
            number: 2
            specification: 1c2g
          vpcConfig:
            subnetId: ${subnet.subnetId}
            vpcId: ${vpc.vpcId}
          tags:
            createdBy: terraform
      cngwService:
        type: tencentcloud:TseCngwService
        properties:
          gatewayId: ${cngwGateway.tseCngwGatewayId}
          path: /test
          protocol: http
          retries: 5
          timeout: 60000
          upstreamType: HostIP
          upstreamInfo:
            algorithm: round-robin
            autoScalingCvmPort: 0
            host: arunma.cn
            port: 8012
            slowStart: 0
      cngwRoute:
        type: tencentcloud:TseCngwRoute
        properties:
          destinationPorts: []
          forceHttps: false
          gatewayId: ${cngwGateway.tseCngwGatewayId}
          hosts:
            - 192.168.0.1:9090
          httpsRedirectStatusCode: 426
          paths:
            - /user
          headers:
            - key: req
              value: terraform
          preserveHost: false
          protocols:
            - http
            - https
          routeName: terraform-route
          serviceId: ${cngwService.serviceId}
          stripPath: true
      cngwRouteRateLimit:
        type: tencentcloud:TseCngwRouteRateLimit
        properties:
          gatewayId: ${cngwGateway.tseCngwGatewayId}
          routeId: ${cngwRoute.routeId}
          limitDetail:
            enabled: true
            header: req
            hideClientHeaders: true
            isDelay: true
            limitBy: header
            lineUpTime: 10
            policy: redis
            responseType: default
            qpsThresholds:
              - max: 10
                unit: minute
    

    Create TseCngwRouteRateLimit Resource

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

    Constructor syntax

    new TseCngwRouteRateLimit(name: string, args: TseCngwRouteRateLimitArgs, opts?: CustomResourceOptions);
    @overload
    def TseCngwRouteRateLimit(resource_name: str,
                              args: TseCngwRouteRateLimitArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def TseCngwRouteRateLimit(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              gateway_id: Optional[str] = None,
                              limit_detail: Optional[TseCngwRouteRateLimitLimitDetailArgs] = None,
                              route_id: Optional[str] = None,
                              tse_cngw_route_rate_limit_id: Optional[str] = None)
    func NewTseCngwRouteRateLimit(ctx *Context, name string, args TseCngwRouteRateLimitArgs, opts ...ResourceOption) (*TseCngwRouteRateLimit, error)
    public TseCngwRouteRateLimit(string name, TseCngwRouteRateLimitArgs args, CustomResourceOptions? opts = null)
    public TseCngwRouteRateLimit(String name, TseCngwRouteRateLimitArgs args)
    public TseCngwRouteRateLimit(String name, TseCngwRouteRateLimitArgs args, CustomResourceOptions options)
    
    type: tencentcloud:TseCngwRouteRateLimit
    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 TseCngwRouteRateLimitArgs
    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 TseCngwRouteRateLimitArgs
    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 TseCngwRouteRateLimitArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TseCngwRouteRateLimitArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TseCngwRouteRateLimitArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    GatewayId string
    gateway ID.
    LimitDetail TseCngwRouteRateLimitLimitDetail
    rate limit configuration.
    RouteId string
    Route id, or route name.
    TseCngwRouteRateLimitId string
    ID of the resource.
    GatewayId string
    gateway ID.
    LimitDetail TseCngwRouteRateLimitLimitDetailArgs
    rate limit configuration.
    RouteId string
    Route id, or route name.
    TseCngwRouteRateLimitId string
    ID of the resource.
    gatewayId String
    gateway ID.
    limitDetail TseCngwRouteRateLimitLimitDetail
    rate limit configuration.
    routeId String
    Route id, or route name.
    tseCngwRouteRateLimitId String
    ID of the resource.
    gatewayId string
    gateway ID.
    limitDetail TseCngwRouteRateLimitLimitDetail
    rate limit configuration.
    routeId string
    Route id, or route name.
    tseCngwRouteRateLimitId string
    ID of the resource.
    gateway_id str
    gateway ID.
    limit_detail TseCngwRouteRateLimitLimitDetailArgs
    rate limit configuration.
    route_id str
    Route id, or route name.
    tse_cngw_route_rate_limit_id str
    ID of the resource.
    gatewayId String
    gateway ID.
    limitDetail Property Map
    rate limit configuration.
    routeId String
    Route id, or route name.
    tseCngwRouteRateLimitId String
    ID of the resource.

    Outputs

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

    Get an existing TseCngwRouteRateLimit 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?: TseCngwRouteRateLimitState, opts?: CustomResourceOptions): TseCngwRouteRateLimit
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            gateway_id: Optional[str] = None,
            limit_detail: Optional[TseCngwRouteRateLimitLimitDetailArgs] = None,
            route_id: Optional[str] = None,
            tse_cngw_route_rate_limit_id: Optional[str] = None) -> TseCngwRouteRateLimit
    func GetTseCngwRouteRateLimit(ctx *Context, name string, id IDInput, state *TseCngwRouteRateLimitState, opts ...ResourceOption) (*TseCngwRouteRateLimit, error)
    public static TseCngwRouteRateLimit Get(string name, Input<string> id, TseCngwRouteRateLimitState? state, CustomResourceOptions? opts = null)
    public static TseCngwRouteRateLimit get(String name, Output<String> id, TseCngwRouteRateLimitState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:TseCngwRouteRateLimit    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:
    GatewayId string
    gateway ID.
    LimitDetail TseCngwRouteRateLimitLimitDetail
    rate limit configuration.
    RouteId string
    Route id, or route name.
    TseCngwRouteRateLimitId string
    ID of the resource.
    GatewayId string
    gateway ID.
    LimitDetail TseCngwRouteRateLimitLimitDetailArgs
    rate limit configuration.
    RouteId string
    Route id, or route name.
    TseCngwRouteRateLimitId string
    ID of the resource.
    gatewayId String
    gateway ID.
    limitDetail TseCngwRouteRateLimitLimitDetail
    rate limit configuration.
    routeId String
    Route id, or route name.
    tseCngwRouteRateLimitId String
    ID of the resource.
    gatewayId string
    gateway ID.
    limitDetail TseCngwRouteRateLimitLimitDetail
    rate limit configuration.
    routeId string
    Route id, or route name.
    tseCngwRouteRateLimitId string
    ID of the resource.
    gateway_id str
    gateway ID.
    limit_detail TseCngwRouteRateLimitLimitDetailArgs
    rate limit configuration.
    route_id str
    Route id, or route name.
    tse_cngw_route_rate_limit_id str
    ID of the resource.
    gatewayId String
    gateway ID.
    limitDetail Property Map
    rate limit configuration.
    routeId String
    Route id, or route name.
    tseCngwRouteRateLimitId String
    ID of the resource.

    Supporting Types

    TseCngwRouteRateLimitLimitDetail, TseCngwRouteRateLimitLimitDetailArgs

    Enabled bool
    status of service rate limit.
    HideClientHeaders bool
    whether to hide the headers of client.
    IsDelay bool
    whether to enable request queuing.
    LimitBy string
    basis for service rate limit.Reference value:ip,service,consumer,credential,path,header.
    QpsThresholds List<TseCngwRouteRateLimitLimitDetailQpsThreshold>
    qps threshold.
    ResponseType string
    response strategy.Reference value:url: forward request according to url,text: response configuration,default: return directly.
    ExternalRedis TseCngwRouteRateLimitLimitDetailExternalRedis
    external redis information, maybe null.
    Header string
    request headers that require rate limit.
    LineUpTime double
    queue time.
    Path string
    request paths that require rate limit.
    Policy string
    counter policy.Reference value:local,redis,external_redis.
    RateLimitResponse TseCngwRouteRateLimitLimitDetailRateLimitResponse
    response configuration, the response strategy is text, maybe null.
    RateLimitResponseUrl string
    request forwarding address, maybe null.
    Enabled bool
    status of service rate limit.
    HideClientHeaders bool
    whether to hide the headers of client.
    IsDelay bool
    whether to enable request queuing.
    LimitBy string
    basis for service rate limit.Reference value:ip,service,consumer,credential,path,header.
    QpsThresholds []TseCngwRouteRateLimitLimitDetailQpsThreshold
    qps threshold.
    ResponseType string
    response strategy.Reference value:url: forward request according to url,text: response configuration,default: return directly.
    ExternalRedis TseCngwRouteRateLimitLimitDetailExternalRedis
    external redis information, maybe null.
    Header string
    request headers that require rate limit.
    LineUpTime float64
    queue time.
    Path string
    request paths that require rate limit.
    Policy string
    counter policy.Reference value:local,redis,external_redis.
    RateLimitResponse TseCngwRouteRateLimitLimitDetailRateLimitResponse
    response configuration, the response strategy is text, maybe null.
    RateLimitResponseUrl string
    request forwarding address, maybe null.
    enabled Boolean
    status of service rate limit.
    hideClientHeaders Boolean
    whether to hide the headers of client.
    isDelay Boolean
    whether to enable request queuing.
    limitBy String
    basis for service rate limit.Reference value:ip,service,consumer,credential,path,header.
    qpsThresholds List<TseCngwRouteRateLimitLimitDetailQpsThreshold>
    qps threshold.
    responseType String
    response strategy.Reference value:url: forward request according to url,text: response configuration,default: return directly.
    externalRedis TseCngwRouteRateLimitLimitDetailExternalRedis
    external redis information, maybe null.
    header String
    request headers that require rate limit.
    lineUpTime Double
    queue time.
    path String
    request paths that require rate limit.
    policy String
    counter policy.Reference value:local,redis,external_redis.
    rateLimitResponse TseCngwRouteRateLimitLimitDetailRateLimitResponse
    response configuration, the response strategy is text, maybe null.
    rateLimitResponseUrl String
    request forwarding address, maybe null.
    enabled boolean
    status of service rate limit.
    hideClientHeaders boolean
    whether to hide the headers of client.
    isDelay boolean
    whether to enable request queuing.
    limitBy string
    basis for service rate limit.Reference value:ip,service,consumer,credential,path,header.
    qpsThresholds TseCngwRouteRateLimitLimitDetailQpsThreshold[]
    qps threshold.
    responseType string
    response strategy.Reference value:url: forward request according to url,text: response configuration,default: return directly.
    externalRedis TseCngwRouteRateLimitLimitDetailExternalRedis
    external redis information, maybe null.
    header string
    request headers that require rate limit.
    lineUpTime number
    queue time.
    path string
    request paths that require rate limit.
    policy string
    counter policy.Reference value:local,redis,external_redis.
    rateLimitResponse TseCngwRouteRateLimitLimitDetailRateLimitResponse
    response configuration, the response strategy is text, maybe null.
    rateLimitResponseUrl string
    request forwarding address, maybe null.
    enabled bool
    status of service rate limit.
    hide_client_headers bool
    whether to hide the headers of client.
    is_delay bool
    whether to enable request queuing.
    limit_by str
    basis for service rate limit.Reference value:ip,service,consumer,credential,path,header.
    qps_thresholds Sequence[TseCngwRouteRateLimitLimitDetailQpsThreshold]
    qps threshold.
    response_type str
    response strategy.Reference value:url: forward request according to url,text: response configuration,default: return directly.
    external_redis TseCngwRouteRateLimitLimitDetailExternalRedis
    external redis information, maybe null.
    header str
    request headers that require rate limit.
    line_up_time float
    queue time.
    path str
    request paths that require rate limit.
    policy str
    counter policy.Reference value:local,redis,external_redis.
    rate_limit_response TseCngwRouteRateLimitLimitDetailRateLimitResponse
    response configuration, the response strategy is text, maybe null.
    rate_limit_response_url str
    request forwarding address, maybe null.
    enabled Boolean
    status of service rate limit.
    hideClientHeaders Boolean
    whether to hide the headers of client.
    isDelay Boolean
    whether to enable request queuing.
    limitBy String
    basis for service rate limit.Reference value:ip,service,consumer,credential,path,header.
    qpsThresholds List<Property Map>
    qps threshold.
    responseType String
    response strategy.Reference value:url: forward request according to url,text: response configuration,default: return directly.
    externalRedis Property Map
    external redis information, maybe null.
    header String
    request headers that require rate limit.
    lineUpTime Number
    queue time.
    path String
    request paths that require rate limit.
    policy String
    counter policy.Reference value:local,redis,external_redis.
    rateLimitResponse Property Map
    response configuration, the response strategy is text, maybe null.
    rateLimitResponseUrl String
    request forwarding address, maybe null.

    TseCngwRouteRateLimitLimitDetailExternalRedis, TseCngwRouteRateLimitLimitDetailExternalRedisArgs

    RedisHost string
    redis ip, maybe null.
    RedisPassword string
    redis password, maybe null.
    RedisPort double
    redis port, maybe null.
    RedisTimeout double
    redis timeout, unit: ms, maybe null.
    RedisHost string
    redis ip, maybe null.
    RedisPassword string
    redis password, maybe null.
    RedisPort float64
    redis port, maybe null.
    RedisTimeout float64
    redis timeout, unit: ms, maybe null.
    redisHost String
    redis ip, maybe null.
    redisPassword String
    redis password, maybe null.
    redisPort Double
    redis port, maybe null.
    redisTimeout Double
    redis timeout, unit: ms, maybe null.
    redisHost string
    redis ip, maybe null.
    redisPassword string
    redis password, maybe null.
    redisPort number
    redis port, maybe null.
    redisTimeout number
    redis timeout, unit: ms, maybe null.
    redis_host str
    redis ip, maybe null.
    redis_password str
    redis password, maybe null.
    redis_port float
    redis port, maybe null.
    redis_timeout float
    redis timeout, unit: ms, maybe null.
    redisHost String
    redis ip, maybe null.
    redisPassword String
    redis password, maybe null.
    redisPort Number
    redis port, maybe null.
    redisTimeout Number
    redis timeout, unit: ms, maybe null.

    TseCngwRouteRateLimitLimitDetailQpsThreshold, TseCngwRouteRateLimitLimitDetailQpsThresholdArgs

    Max double
    the max threshold.
    Unit string
    qps threshold unit.Reference value:second,minute,hour,day,month,year.
    Max float64
    the max threshold.
    Unit string
    qps threshold unit.Reference value:second,minute,hour,day,month,year.
    max Double
    the max threshold.
    unit String
    qps threshold unit.Reference value:second,minute,hour,day,month,year.
    max number
    the max threshold.
    unit string
    qps threshold unit.Reference value:second,minute,hour,day,month,year.
    max float
    the max threshold.
    unit str
    qps threshold unit.Reference value:second,minute,hour,day,month,year.
    max Number
    the max threshold.
    unit String
    qps threshold unit.Reference value:second,minute,hour,day,month,year.

    TseCngwRouteRateLimitLimitDetailRateLimitResponse, TseCngwRouteRateLimitLimitDetailRateLimitResponseArgs

    Body string
    custom response body, maybe bull.
    Headers List<TseCngwRouteRateLimitLimitDetailRateLimitResponseHeader>
    headrs.
    HttpStatus double
    http status code.
    Body string
    custom response body, maybe bull.
    Headers []TseCngwRouteRateLimitLimitDetailRateLimitResponseHeader
    headrs.
    HttpStatus float64
    http status code.
    body String
    custom response body, maybe bull.
    headers List<TseCngwRouteRateLimitLimitDetailRateLimitResponseHeader>
    headrs.
    httpStatus Double
    http status code.
    body string
    custom response body, maybe bull.
    headers TseCngwRouteRateLimitLimitDetailRateLimitResponseHeader[]
    headrs.
    httpStatus number
    http status code.
    body str
    custom response body, maybe bull.
    headers Sequence[TseCngwRouteRateLimitLimitDetailRateLimitResponseHeader]
    headrs.
    http_status float
    http status code.
    body String
    custom response body, maybe bull.
    headers List<Property Map>
    headrs.
    httpStatus Number
    http status code.

    TseCngwRouteRateLimitLimitDetailRateLimitResponseHeader, TseCngwRouteRateLimitLimitDetailRateLimitResponseHeaderArgs

    Key string
    key of header.
    Value string
    value of header.
    Key string
    key of header.
    Value string
    value of header.
    key String
    key of header.
    value String
    value of header.
    key string
    key of header.
    value string
    value of header.
    key str
    key of header.
    value str
    value of header.
    key String
    key of header.
    value String
    value of header.

    Import

    tse cngw_route_rate_limit can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/tseCngwRouteRateLimit:TseCngwRouteRateLimit cngw_route_rate_limit gatewayId#routeId
    

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

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack