1. Packages
  2. Volcengine
  3. API Docs
  4. alb
  5. Rule
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

volcengine.alb.Rule

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

    Provides a resource to manage alb rule

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Volcengine.Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Alb.Rule("foo", new()
        {
            Description = "test",
            Domain = "www.test.com",
            ListenerId = "lsn-1iidd19u4oni874adhezjkyj3",
            RedirectConfig = new Volcengine.Alb.Inputs.RuleRedirectConfigArgs
            {
                RedirectDomain = "www.testtest.com",
                RedirectHttpCode = "302",
                RedirectPort = "555",
                RedirectUri = "/testtest",
            },
            RewriteConfig = new Volcengine.Alb.Inputs.RuleRewriteConfigArgs
            {
                RewritePath = "/test",
            },
            RewriteEnabled = "off",
            RuleAction = "Redirect",
            ServerGroupId = "rsp-1g72w74y4umf42zbhq4k4hnln",
            TrafficLimitEnabled = "off",
            TrafficLimitQps = 100,
            Url = "/test",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/alb"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := alb.NewRule(ctx, "foo", &alb.RuleArgs{
    			Description: pulumi.String("test"),
    			Domain:      pulumi.String("www.test.com"),
    			ListenerId:  pulumi.String("lsn-1iidd19u4oni874adhezjkyj3"),
    			RedirectConfig: &alb.RuleRedirectConfigArgs{
    				RedirectDomain:   pulumi.String("www.testtest.com"),
    				RedirectHttpCode: pulumi.String("302"),
    				RedirectPort:     pulumi.String("555"),
    				RedirectUri:      pulumi.String("/testtest"),
    			},
    			RewriteConfig: &alb.RuleRewriteConfigArgs{
    				RewritePath: pulumi.String("/test"),
    			},
    			RewriteEnabled:      pulumi.String("off"),
    			RuleAction:          pulumi.String("Redirect"),
    			ServerGroupId:       pulumi.String("rsp-1g72w74y4umf42zbhq4k4hnln"),
    			TrafficLimitEnabled: pulumi.String("off"),
    			TrafficLimitQps:     pulumi.Int(100),
    			Url:                 pulumi.String("/test"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.alb.Rule;
    import com.pulumi.volcengine.alb.RuleArgs;
    import com.pulumi.volcengine.alb.inputs.RuleRedirectConfigArgs;
    import com.pulumi.volcengine.alb.inputs.RuleRewriteConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var foo = new Rule("foo", RuleArgs.builder()        
                .description("test")
                .domain("www.test.com")
                .listenerId("lsn-1iidd19u4oni874adhezjkyj3")
                .redirectConfig(RuleRedirectConfigArgs.builder()
                    .redirectDomain("www.testtest.com")
                    .redirectHttpCode("302")
                    .redirectPort("555")
                    .redirectUri("/testtest")
                    .build())
                .rewriteConfig(RuleRewriteConfigArgs.builder()
                    .rewritePath("/test")
                    .build())
                .rewriteEnabled("off")
                .ruleAction("Redirect")
                .serverGroupId("rsp-1g72w74y4umf42zbhq4k4hnln")
                .trafficLimitEnabled("off")
                .trafficLimitQps(100)
                .url("/test")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.alb.Rule("foo",
        description="test",
        domain="www.test.com",
        listener_id="lsn-1iidd19u4oni874adhezjkyj3",
        redirect_config=volcengine.alb.RuleRedirectConfigArgs(
            redirect_domain="www.testtest.com",
            redirect_http_code="302",
            redirect_port="555",
            redirect_uri="/testtest",
        ),
        rewrite_config=volcengine.alb.RuleRewriteConfigArgs(
            rewrite_path="/test",
        ),
        rewrite_enabled="off",
        rule_action="Redirect",
        server_group_id="rsp-1g72w74y4umf42zbhq4k4hnln",
        traffic_limit_enabled="off",
        traffic_limit_qps=100,
        url="/test")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.alb.Rule("foo", {
        description: "test",
        domain: "www.test.com",
        listenerId: "lsn-1iidd19u4oni874adhezjkyj3",
        redirectConfig: {
            redirectDomain: "www.testtest.com",
            redirectHttpCode: "302",
            redirectPort: "555",
            redirectUri: "/testtest",
        },
        rewriteConfig: {
            rewritePath: "/test",
        },
        rewriteEnabled: "off",
        ruleAction: "Redirect",
        serverGroupId: "rsp-1g72w74y4umf42zbhq4k4hnln",
        trafficLimitEnabled: "off",
        trafficLimitQps: 100,
        url: "/test",
    });
    
    resources:
      foo:
        type: volcengine:alb:Rule
        properties:
          description: test
          domain: www.test.com
          listenerId: lsn-1iidd19u4oni874adhezjkyj3
          redirectConfig:
            redirectDomain: www.testtest.com
            redirectHttpCode: '302'
            redirectPort: '555'
            redirectUri: /testtest
          rewriteConfig:
            rewritePath: /test
          rewriteEnabled: off
          ruleAction: Redirect
          serverGroupId: rsp-1g72w74y4umf42zbhq4k4hnln
          trafficLimitEnabled: off
          trafficLimitQps: 100
          url: /test
    

    Create Rule Resource

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

    Constructor syntax

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
    def Rule(resource_name: str,
             args: RuleArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Rule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             listener_id: Optional[str] = None,
             rule_action: Optional[str] = None,
             description: Optional[str] = None,
             domain: Optional[str] = None,
             redirect_config: Optional[RuleRedirectConfigArgs] = None,
             rewrite_config: Optional[RuleRewriteConfigArgs] = None,
             rewrite_enabled: Optional[str] = None,
             server_group_id: Optional[str] = None,
             traffic_limit_enabled: Optional[str] = None,
             traffic_limit_qps: Optional[int] = None,
             url: Optional[str] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
    public Rule(String name, RuleArgs args, CustomResourceOptions options)
    
    type: volcengine:alb:Rule
    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 RuleArgs
    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 RuleArgs
    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 RuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var ruleResource = new Volcengine.Alb.Rule("ruleResource", new()
    {
        ListenerId = "string",
        RuleAction = "string",
        Description = "string",
        Domain = "string",
        RedirectConfig = new Volcengine.Alb.Inputs.RuleRedirectConfigArgs
        {
            RedirectDomain = "string",
            RedirectHttpCode = "string",
            RedirectPort = "string",
            RedirectProtocol = "string",
            RedirectUri = "string",
        },
        RewriteConfig = new Volcengine.Alb.Inputs.RuleRewriteConfigArgs
        {
            RewritePath = "string",
        },
        RewriteEnabled = "string",
        ServerGroupId = "string",
        TrafficLimitEnabled = "string",
        TrafficLimitQps = 0,
        Url = "string",
    });
    
    example, err := alb.NewRule(ctx, "ruleResource", &alb.RuleArgs{
    	ListenerId:  pulumi.String("string"),
    	RuleAction:  pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Domain:      pulumi.String("string"),
    	RedirectConfig: &alb.RuleRedirectConfigArgs{
    		RedirectDomain:   pulumi.String("string"),
    		RedirectHttpCode: pulumi.String("string"),
    		RedirectPort:     pulumi.String("string"),
    		RedirectProtocol: pulumi.String("string"),
    		RedirectUri:      pulumi.String("string"),
    	},
    	RewriteConfig: &alb.RuleRewriteConfigArgs{
    		RewritePath: pulumi.String("string"),
    	},
    	RewriteEnabled:      pulumi.String("string"),
    	ServerGroupId:       pulumi.String("string"),
    	TrafficLimitEnabled: pulumi.String("string"),
    	TrafficLimitQps:     pulumi.Int(0),
    	Url:                 pulumi.String("string"),
    })
    
    var ruleResource = new Rule("ruleResource", RuleArgs.builder()        
        .listenerId("string")
        .ruleAction("string")
        .description("string")
        .domain("string")
        .redirectConfig(RuleRedirectConfigArgs.builder()
            .redirectDomain("string")
            .redirectHttpCode("string")
            .redirectPort("string")
            .redirectProtocol("string")
            .redirectUri("string")
            .build())
        .rewriteConfig(RuleRewriteConfigArgs.builder()
            .rewritePath("string")
            .build())
        .rewriteEnabled("string")
        .serverGroupId("string")
        .trafficLimitEnabled("string")
        .trafficLimitQps(0)
        .url("string")
        .build());
    
    rule_resource = volcengine.alb.Rule("ruleResource",
        listener_id="string",
        rule_action="string",
        description="string",
        domain="string",
        redirect_config=volcengine.alb.RuleRedirectConfigArgs(
            redirect_domain="string",
            redirect_http_code="string",
            redirect_port="string",
            redirect_protocol="string",
            redirect_uri="string",
        ),
        rewrite_config=volcengine.alb.RuleRewriteConfigArgs(
            rewrite_path="string",
        ),
        rewrite_enabled="string",
        server_group_id="string",
        traffic_limit_enabled="string",
        traffic_limit_qps=0,
        url="string")
    
    const ruleResource = new volcengine.alb.Rule("ruleResource", {
        listenerId: "string",
        ruleAction: "string",
        description: "string",
        domain: "string",
        redirectConfig: {
            redirectDomain: "string",
            redirectHttpCode: "string",
            redirectPort: "string",
            redirectProtocol: "string",
            redirectUri: "string",
        },
        rewriteConfig: {
            rewritePath: "string",
        },
        rewriteEnabled: "string",
        serverGroupId: "string",
        trafficLimitEnabled: "string",
        trafficLimitQps: 0,
        url: "string",
    });
    
    type: volcengine:alb:Rule
    properties:
        description: string
        domain: string
        listenerId: string
        redirectConfig:
            redirectDomain: string
            redirectHttpCode: string
            redirectPort: string
            redirectProtocol: string
            redirectUri: string
        rewriteConfig:
            rewritePath: string
        rewriteEnabled: string
        ruleAction: string
        serverGroupId: string
        trafficLimitEnabled: string
        trafficLimitQps: 0
        url: string
    

    Rule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Rule resource accepts the following input properties:

    ListenerId string
    The ID of listener.
    RuleAction string
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    Description string
    The description of the Rule.
    Domain string
    The domain of Rule.
    RedirectConfig Volcengine.RuleRedirectConfig
    The redirect related configuration.
    RewriteConfig Volcengine.RuleRewriteConfig
    The list of rewrite configurations.
    RewriteEnabled string
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    ServerGroupId string
    Server group ID, this parameter is required if rule_action is empty.
    TrafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    TrafficLimitQps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    Url string
    The Url of Rule.
    ListenerId string
    The ID of listener.
    RuleAction string
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    Description string
    The description of the Rule.
    Domain string
    The domain of Rule.
    RedirectConfig RuleRedirectConfigArgs
    The redirect related configuration.
    RewriteConfig RuleRewriteConfigArgs
    The list of rewrite configurations.
    RewriteEnabled string
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    ServerGroupId string
    Server group ID, this parameter is required if rule_action is empty.
    TrafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    TrafficLimitQps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    Url string
    The Url of Rule.
    listenerId String
    The ID of listener.
    ruleAction String
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    description String
    The description of the Rule.
    domain String
    The domain of Rule.
    redirectConfig RuleRedirectConfig
    The redirect related configuration.
    rewriteConfig RuleRewriteConfig
    The list of rewrite configurations.
    rewriteEnabled String
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    serverGroupId String
    Server group ID, this parameter is required if rule_action is empty.
    trafficLimitEnabled String
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps Integer
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url String
    The Url of Rule.
    listenerId string
    The ID of listener.
    ruleAction string
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    description string
    The description of the Rule.
    domain string
    The domain of Rule.
    redirectConfig RuleRedirectConfig
    The redirect related configuration.
    rewriteConfig RuleRewriteConfig
    The list of rewrite configurations.
    rewriteEnabled string
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    serverGroupId string
    Server group ID, this parameter is required if rule_action is empty.
    trafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps number
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url string
    The Url of Rule.
    listener_id str
    The ID of listener.
    rule_action str
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    description str
    The description of the Rule.
    domain str
    The domain of Rule.
    redirect_config RuleRedirectConfigArgs
    The redirect related configuration.
    rewrite_config RuleRewriteConfigArgs
    The list of rewrite configurations.
    rewrite_enabled str
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    server_group_id str
    Server group ID, this parameter is required if rule_action is empty.
    traffic_limit_enabled str
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    traffic_limit_qps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url str
    The Url of Rule.
    listenerId String
    The ID of listener.
    ruleAction String
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    description String
    The description of the Rule.
    domain String
    The domain of Rule.
    redirectConfig Property Map
    The redirect related configuration.
    rewriteConfig Property Map
    The list of rewrite configurations.
    rewriteEnabled String
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    serverGroupId String
    Server group ID, this parameter is required if rule_action is empty.
    trafficLimitEnabled String
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps Number
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url String
    The Url of Rule.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    The ID of rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    The ID of rule.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    The ID of rule.
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId string
    The ID of rule.
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id str
    The ID of rule.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    The ID of rule.

    Look up Existing Rule Resource

    Get an existing Rule 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?: RuleState, opts?: CustomResourceOptions): Rule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            domain: Optional[str] = None,
            listener_id: Optional[str] = None,
            redirect_config: Optional[RuleRedirectConfigArgs] = None,
            rewrite_config: Optional[RuleRewriteConfigArgs] = None,
            rewrite_enabled: Optional[str] = None,
            rule_action: Optional[str] = None,
            rule_id: Optional[str] = None,
            server_group_id: Optional[str] = None,
            traffic_limit_enabled: Optional[str] = None,
            traffic_limit_qps: Optional[int] = None,
            url: Optional[str] = None) -> Rule
    func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)
    public static Rule Get(string name, Input<string> id, RuleState? state, CustomResourceOptions? opts = null)
    public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Description string
    The description of the Rule.
    Domain string
    The domain of Rule.
    ListenerId string
    The ID of listener.
    RedirectConfig Volcengine.RuleRedirectConfig
    The redirect related configuration.
    RewriteConfig Volcengine.RuleRewriteConfig
    The list of rewrite configurations.
    RewriteEnabled string
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    RuleAction string
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    RuleId string
    The ID of rule.
    ServerGroupId string
    Server group ID, this parameter is required if rule_action is empty.
    TrafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    TrafficLimitQps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    Url string
    The Url of Rule.
    Description string
    The description of the Rule.
    Domain string
    The domain of Rule.
    ListenerId string
    The ID of listener.
    RedirectConfig RuleRedirectConfigArgs
    The redirect related configuration.
    RewriteConfig RuleRewriteConfigArgs
    The list of rewrite configurations.
    RewriteEnabled string
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    RuleAction string
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    RuleId string
    The ID of rule.
    ServerGroupId string
    Server group ID, this parameter is required if rule_action is empty.
    TrafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    TrafficLimitQps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    Url string
    The Url of Rule.
    description String
    The description of the Rule.
    domain String
    The domain of Rule.
    listenerId String
    The ID of listener.
    redirectConfig RuleRedirectConfig
    The redirect related configuration.
    rewriteConfig RuleRewriteConfig
    The list of rewrite configurations.
    rewriteEnabled String
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    ruleAction String
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    ruleId String
    The ID of rule.
    serverGroupId String
    Server group ID, this parameter is required if rule_action is empty.
    trafficLimitEnabled String
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps Integer
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url String
    The Url of Rule.
    description string
    The description of the Rule.
    domain string
    The domain of Rule.
    listenerId string
    The ID of listener.
    redirectConfig RuleRedirectConfig
    The redirect related configuration.
    rewriteConfig RuleRewriteConfig
    The list of rewrite configurations.
    rewriteEnabled string
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    ruleAction string
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    ruleId string
    The ID of rule.
    serverGroupId string
    Server group ID, this parameter is required if rule_action is empty.
    trafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps number
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url string
    The Url of Rule.
    description str
    The description of the Rule.
    domain str
    The domain of Rule.
    listener_id str
    The ID of listener.
    redirect_config RuleRedirectConfigArgs
    The redirect related configuration.
    rewrite_config RuleRewriteConfigArgs
    The list of rewrite configurations.
    rewrite_enabled str
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    rule_action str
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    rule_id str
    The ID of rule.
    server_group_id str
    Server group ID, this parameter is required if rule_action is empty.
    traffic_limit_enabled str
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    traffic_limit_qps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url str
    The Url of Rule.
    description String
    The description of the Rule.
    domain String
    The domain of Rule.
    listenerId String
    The ID of listener.
    redirectConfig Property Map
    The redirect related configuration.
    rewriteConfig Property Map
    The list of rewrite configurations.
    rewriteEnabled String
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    ruleAction String
    The forwarding rule action, if this parameter is empty(""), forward to server group, if value is Redirect, will redirect.
    ruleId String
    The ID of rule.
    serverGroupId String
    Server group ID, this parameter is required if rule_action is empty.
    trafficLimitEnabled String
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps Number
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url String
    The Url of Rule.

    Supporting Types

    RuleRedirectConfig, RuleRedirectConfigArgs

    RedirectDomain string
    The redirect domain, only support exact domain name.
    RedirectHttpCode string
    The redirect http code, support 301(default), 302, 307, 308.
    RedirectPort string
    The redirect port.
    RedirectProtocol string
    The redirect protocol, support HTTP, HTTPS(default).
    RedirectUri string
    The redirect URI.
    RedirectDomain string
    The redirect domain, only support exact domain name.
    RedirectHttpCode string
    The redirect http code, support 301(default), 302, 307, 308.
    RedirectPort string
    The redirect port.
    RedirectProtocol string
    The redirect protocol, support HTTP, HTTPS(default).
    RedirectUri string
    The redirect URI.
    redirectDomain String
    The redirect domain, only support exact domain name.
    redirectHttpCode String
    The redirect http code, support 301(default), 302, 307, 308.
    redirectPort String
    The redirect port.
    redirectProtocol String
    The redirect protocol, support HTTP, HTTPS(default).
    redirectUri String
    The redirect URI.
    redirectDomain string
    The redirect domain, only support exact domain name.
    redirectHttpCode string
    The redirect http code, support 301(default), 302, 307, 308.
    redirectPort string
    The redirect port.
    redirectProtocol string
    The redirect protocol, support HTTP, HTTPS(default).
    redirectUri string
    The redirect URI.
    redirect_domain str
    The redirect domain, only support exact domain name.
    redirect_http_code str
    The redirect http code, support 301(default), 302, 307, 308.
    redirect_port str
    The redirect port.
    redirect_protocol str
    The redirect protocol, support HTTP, HTTPS(default).
    redirect_uri str
    The redirect URI.
    redirectDomain String
    The redirect domain, only support exact domain name.
    redirectHttpCode String
    The redirect http code, support 301(default), 302, 307, 308.
    redirectPort String
    The redirect port.
    redirectProtocol String
    The redirect protocol, support HTTP, HTTPS(default).
    redirectUri String
    The redirect URI.

    RuleRewriteConfig, RuleRewriteConfigArgs

    RewritePath string
    Rewrite path.
    RewritePath string
    Rewrite path.
    rewritePath String
    Rewrite path.
    rewritePath string
    Rewrite path.
    rewrite_path str
    Rewrite path.
    rewritePath String
    Rewrite path.

    Import

    AlbRule can be imported using the listener id and rule id, e.g.

     $ pulumi import volcengine:alb/rule:Rule default lsn-273yv0mhs5xj47fap8sehiiso:rule-****
    

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine