1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. clb
  6. Rule
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    The forwarding rule directs requests for specified domain names and URLs to the designated backend server group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const ruleDemo = new volcenginecc.clb.Rule("RuleDemo", {
        listenerId: "lsn-13****",
        description: "RuleDemo Example",
        domain: "www.***.com",
        actionType: "Forward",
        serverGroupId: "rsp-mj***",
        url: "/co3cee",
        tags: [{
            key: "env",
            value: "test",
        }],
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    rule_demo = volcenginecc.clb.Rule("RuleDemo",
        listener_id="lsn-13****",
        description="RuleDemo Example",
        domain="www.***.com",
        action_type="Forward",
        server_group_id="rsp-mj***",
        url="/co3cee",
        tags=[{
            "key": "env",
            "value": "test",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/clb"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := clb.NewRule(ctx, "RuleDemo", &clb.RuleArgs{
    			ListenerId:    pulumi.String("lsn-13****"),
    			Description:   pulumi.String("RuleDemo Example"),
    			Domain:        pulumi.String("www.***.com"),
    			ActionType:    pulumi.String("Forward"),
    			ServerGroupId: pulumi.String("rsp-mj***"),
    			Url:           pulumi.String("/co3cee"),
    			Tags: clb.RuleTagArray{
    				&clb.RuleTagArgs{
    					Key:   pulumi.String("env"),
    					Value: pulumi.String("test"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var ruleDemo = new Volcenginecc.Clb.Rule("RuleDemo", new()
        {
            ListenerId = "lsn-13****",
            Description = "RuleDemo Example",
            Domain = "www.***.com",
            ActionType = "Forward",
            ServerGroupId = "rsp-mj***",
            Url = "/co3cee",
            Tags = new[]
            {
                new Volcenginecc.Clb.Inputs.RuleTagArgs
                {
                    Key = "env",
                    Value = "test",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.clb.Rule;
    import com.volcengine.volcenginecc.clb.RuleArgs;
    import com.pulumi.volcenginecc.clb.inputs.RuleTagArgs;
    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 ruleDemo = new Rule("ruleDemo", RuleArgs.builder()
                .listenerId("lsn-13****")
                .description("RuleDemo Example")
                .domain("www.***.com")
                .actionType("Forward")
                .serverGroupId("rsp-mj***")
                .url("/co3cee")
                .tags(RuleTagArgs.builder()
                    .key("env")
                    .value("test")
                    .build())
                .build());
    
        }
    }
    
    resources:
      ruleDemo:
        type: volcenginecc:clb:Rule
        name: RuleDemo
        properties:
          listenerId: lsn-13****
          description: RuleDemo Example
          domain: www.***.com
          actionType: Forward
          serverGroupId: rsp-mj***
          url: /co3cee
          tags:
            - key: env
              value: 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,
             action_type: Optional[str] = None,
             description: Optional[str] = None,
             domain: Optional[str] = None,
             redirect_config: Optional[RuleRedirectConfigArgs] = None,
             server_group_id: Optional[str] = None,
             tags: Optional[Sequence[RuleTagArgs]] = 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: volcenginecc:clb: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.

    Constructor example

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

    var volcengineccRuleResource = new Volcenginecc.Clb.Rule("volcengineccRuleResource", new()
    {
        ListenerId = "string",
        ActionType = "string",
        Description = "string",
        Domain = "string",
        RedirectConfig = new Volcenginecc.Clb.Inputs.RuleRedirectConfigArgs
        {
            Host = "string",
            Path = "string",
            Port = "string",
            Protocol = "string",
            StatusCode = "string",
        },
        ServerGroupId = "string",
        Tags = new[]
        {
            new Volcenginecc.Clb.Inputs.RuleTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        Url = "string",
    });
    
    example, err := clb.NewRule(ctx, "volcengineccRuleResource", &clb.RuleArgs{
    	ListenerId:  pulumi.String("string"),
    	ActionType:  pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Domain:      pulumi.String("string"),
    	RedirectConfig: &clb.RuleRedirectConfigArgs{
    		Host:       pulumi.String("string"),
    		Path:       pulumi.String("string"),
    		Port:       pulumi.String("string"),
    		Protocol:   pulumi.String("string"),
    		StatusCode: pulumi.String("string"),
    	},
    	ServerGroupId: pulumi.String("string"),
    	Tags: clb.RuleTagArray{
    		&clb.RuleTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	Url: pulumi.String("string"),
    })
    
    var volcengineccRuleResource = new com.volcengine.volcenginecc.clb.Rule("volcengineccRuleResource", com.volcengine.volcenginecc.clb.RuleArgs.builder()
        .listenerId("string")
        .actionType("string")
        .description("string")
        .domain("string")
        .redirectConfig(RuleRedirectConfigArgs.builder()
            .host("string")
            .path("string")
            .port("string")
            .protocol("string")
            .statusCode("string")
            .build())
        .serverGroupId("string")
        .tags(RuleTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .url("string")
        .build());
    
    volcenginecc_rule_resource = volcenginecc.clb.Rule("volcengineccRuleResource",
        listener_id="string",
        action_type="string",
        description="string",
        domain="string",
        redirect_config={
            "host": "string",
            "path": "string",
            "port": "string",
            "protocol": "string",
            "status_code": "string",
        },
        server_group_id="string",
        tags=[{
            "key": "string",
            "value": "string",
        }],
        url="string")
    
    const volcengineccRuleResource = new volcenginecc.clb.Rule("volcengineccRuleResource", {
        listenerId: "string",
        actionType: "string",
        description: "string",
        domain: "string",
        redirectConfig: {
            host: "string",
            path: "string",
            port: "string",
            protocol: "string",
            statusCode: "string",
        },
        serverGroupId: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        url: "string",
    });
    
    type: volcenginecc:clb:Rule
    properties:
        actionType: string
        description: string
        domain: string
        listenerId: string
        redirectConfig:
            host: string
            path: string
            port: string
            protocol: string
            statusCode: string
        serverGroupId: string
        tags:
            - key: string
              value: string
        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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Rule resource accepts the following input properties:

    ListenerId string
    Listener ID.
    ActionType string
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    Description string
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    Domain string
    Domain name of the forwarding rule.
    RedirectConfig Volcengine.RuleRedirectConfig
    Redirection-related configuration information.
    ServerGroupId string
    ID of the backend server group associated with the forwarding rule.
    Tags List<Volcengine.RuleTag>
    Url string
    URL of the forwarding rule.
    ListenerId string
    Listener ID.
    ActionType string
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    Description string
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    Domain string
    Domain name of the forwarding rule.
    RedirectConfig RuleRedirectConfigArgs
    Redirection-related configuration information.
    ServerGroupId string
    ID of the backend server group associated with the forwarding rule.
    Tags []RuleTagArgs
    Url string
    URL of the forwarding rule.
    listenerId String
    Listener ID.
    actionType String
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description String
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    domain String
    Domain name of the forwarding rule.
    redirectConfig RuleRedirectConfig
    Redirection-related configuration information.
    serverGroupId String
    ID of the backend server group associated with the forwarding rule.
    tags List<RuleTag>
    url String
    URL of the forwarding rule.
    listenerId string
    Listener ID.
    actionType string
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description string
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    domain string
    Domain name of the forwarding rule.
    redirectConfig RuleRedirectConfig
    Redirection-related configuration information.
    serverGroupId string
    ID of the backend server group associated with the forwarding rule.
    tags RuleTag[]
    url string
    URL of the forwarding rule.
    listener_id str
    Listener ID.
    action_type str
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description str
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    domain str
    Domain name of the forwarding rule.
    redirect_config RuleRedirectConfigArgs
    Redirection-related configuration information.
    server_group_id str
    ID of the backend server group associated with the forwarding rule.
    tags Sequence[RuleTagArgs]
    url str
    URL of the forwarding rule.
    listenerId String
    Listener ID.
    actionType String
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description String
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    domain String
    Domain name of the forwarding rule.
    redirectConfig Property Map
    Redirection-related configuration information.
    serverGroupId String
    ID of the backend server group associated with the forwarding rule.
    tags List<Property Map>
    url String
    URL of the forwarding 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
    Forwarding rule ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    Forwarding rule ID.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    Forwarding rule ID.
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId string
    Forwarding rule ID.
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id str
    Forwarding rule ID.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    Forwarding rule ID.

    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,
            action_type: Optional[str] = None,
            description: Optional[str] = None,
            domain: Optional[str] = None,
            listener_id: Optional[str] = None,
            redirect_config: Optional[RuleRedirectConfigArgs] = None,
            rule_id: Optional[str] = None,
            server_group_id: Optional[str] = None,
            tags: Optional[Sequence[RuleTagArgs]] = 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)
    resources:  _:    type: volcenginecc:clb:Rule    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:
    ActionType string
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    Description string
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    Domain string
    Domain name of the forwarding rule.
    ListenerId string
    Listener ID.
    RedirectConfig Volcengine.RuleRedirectConfig
    Redirection-related configuration information.
    RuleId string
    Forwarding rule ID.
    ServerGroupId string
    ID of the backend server group associated with the forwarding rule.
    Tags List<Volcengine.RuleTag>
    Url string
    URL of the forwarding rule.
    ActionType string
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    Description string
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    Domain string
    Domain name of the forwarding rule.
    ListenerId string
    Listener ID.
    RedirectConfig RuleRedirectConfigArgs
    Redirection-related configuration information.
    RuleId string
    Forwarding rule ID.
    ServerGroupId string
    ID of the backend server group associated with the forwarding rule.
    Tags []RuleTagArgs
    Url string
    URL of the forwarding rule.
    actionType String
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description String
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    domain String
    Domain name of the forwarding rule.
    listenerId String
    Listener ID.
    redirectConfig RuleRedirectConfig
    Redirection-related configuration information.
    ruleId String
    Forwarding rule ID.
    serverGroupId String
    ID of the backend server group associated with the forwarding rule.
    tags List<RuleTag>
    url String
    URL of the forwarding rule.
    actionType string
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description string
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    domain string
    Domain name of the forwarding rule.
    listenerId string
    Listener ID.
    redirectConfig RuleRedirectConfig
    Redirection-related configuration information.
    ruleId string
    Forwarding rule ID.
    serverGroupId string
    ID of the backend server group associated with the forwarding rule.
    tags RuleTag[]
    url string
    URL of the forwarding rule.
    action_type str
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description str
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    domain str
    Domain name of the forwarding rule.
    listener_id str
    Listener ID.
    redirect_config RuleRedirectConfigArgs
    Redirection-related configuration information.
    rule_id str
    Forwarding rule ID.
    server_group_id str
    ID of the backend server group associated with the forwarding rule.
    tags Sequence[RuleTagArgs]
    url str
    URL of the forwarding rule.
    actionType String
    Forwarding rule action. Options: Forward: Forward to. Redirect: Redirect to.
    description String
    Description of the forwarding rule. Default value is an empty string. Specifications: Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length must be between 0 and 255 characters.
    domain String
    Domain name of the forwarding rule.
    listenerId String
    Listener ID.
    redirectConfig Property Map
    Redirection-related configuration information.
    ruleId String
    Forwarding rule ID.
    serverGroupId String
    ID of the backend server group associated with the forwarding rule.
    tags List<Property Map>
    url String
    URL of the forwarding rule.

    Supporting Types

    RuleRedirectConfig, RuleRedirectConfigArgs

    Host string
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    Path string
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    Port string
    Port for forwarding rule redirection. Value range: 1~65535.
    Protocol string
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    StatusCode string
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    Host string
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    Path string
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    Port string
    Port for forwarding rule redirection. Value range: 1~65535.
    Protocol string
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    StatusCode string
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    host String
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    path String
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    port String
    Port for forwarding rule redirection. Value range: 1~65535.
    protocol String
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    statusCode String
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    host string
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    path string
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    port string
    Port for forwarding rule redirection. Value range: 1~65535.
    protocol string
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    statusCode string
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    host str
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    path str
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    port str
    Port for forwarding rule redirection. Value range: 1~65535.
    protocol str
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    status_code str
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.
    host String
    The domain name for forwarding rule redirection currently supports only exact domain names. Specifications: Must contain at least one '.', and cannot start or end with '.'. Only letters, numbers, '.', and '-' are allowed. Length must be between 1 and 128 characters. Example of a valid exact domain name: www.test.com.
    path String
    Path for forwarding rule redirection. Specifications: Must start with a forward slash '/'. Consecutive '/' characters are not allowed. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=', and other specified characters are allowed. Length must be between 1 and 128 characters.
    port String
    Port for forwarding rule redirection. Value range: 1~65535.
    protocol String
    Protocol for forwarding rule redirection. Options: HTTP. HTTPS (default).
    statusCode String
    Status code for forwarding rule redirection. Options: 301 (default): Indicates the requested resource has been permanently moved to a new URL. The client should use the new URL for subsequent requests. 302: Indicates the requested resource has been temporarily moved to a new URL and may change again in the future. The client should use the new URL for subsequent requests. 307: Similar to 302, but requires the client to keep the request method unchanged during redirection. For example, if the original request is GET, the redirected request remains GET. 308: Similar to 301, but requires the client to keep the request method unchanged during redirection.

    RuleTag, RuleTagArgs

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Import

    $ pulumi import volcenginecc:clb/rule:Rule example "listener_id|rule_id"
    

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.