Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. alb
  5. Rule
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.alb.Rule

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

Provides a resource to manage alb rule

Example Usage

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",
});
Copy
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")
Copy
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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using 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",
    });

});
Copy
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());

    }
}
Copy
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
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. RuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. RuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 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",
});
Copy
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"),
})
Copy
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());
Copy
rule_resource = volcengine.alb.Rule("ruleResource",
    listener_id="string",
    rule_action="string",
    description="string",
    domain="string",
    redirect_config={
        "redirect_domain": "string",
        "redirect_http_code": "string",
        "redirect_port": "string",
        "redirect_protocol": "string",
        "redirect_uri": "string",
    },
    rewrite_config={
        "rewrite_path": "string",
    },
    rewrite_enabled="string",
    server_group_id="string",
    traffic_limit_enabled="string",
    traffic_limit_qps=0,
    url="string")
Copy
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",
});
Copy
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
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
The ID of listener.
RuleAction This property is required. 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 Changes to this property will trigger replacement. 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 int
When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
Url Changes to this property will trigger replacement. string
The Url of Rule.
ListenerId
This property is required.
Changes to this property will trigger replacement.
string
The ID of listener.
RuleAction This property is required. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The Url of Rule.
listenerId
This property is required.
Changes to this property will trigger replacement.
String
The ID of listener.
ruleAction This property is required. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The Url of Rule.
listenerId
This property is required.
Changes to this property will trigger replacement.
string
The ID of listener.
ruleAction This property is required. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The Url of Rule.
listener_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of listener.
rule_action This property is required. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
The Url of Rule.
listenerId
This property is required.
Changes to this property will trigger replacement.
String
The ID of listener.
ruleAction This property is required. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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)
resources:  _:    type: volcengine:alb:Rule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
The domain of Rule.
ListenerId Changes to this property will trigger replacement. 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 int
When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
Url Changes to this property will trigger replacement. string
The Url of Rule.
Description string
The description of the Rule.
Domain Changes to this property will trigger replacement. string
The domain of Rule.
ListenerId Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The Url of Rule.
description String
The description of the Rule.
domain Changes to this property will trigger replacement. String
The domain of Rule.
listenerId Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The Url of Rule.
description string
The description of the Rule.
domain Changes to this property will trigger replacement. string
The domain of Rule.
listenerId Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
The Url of Rule.
description str
The description of the Rule.
domain Changes to this property will trigger replacement. str
The domain of Rule.
listener_id Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
The Url of Rule.
description String
The description of the Rule.
domain Changes to this property will trigger replacement. String
The domain of Rule.
listenerId Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 This property is required. string
Rewrite path.
RewritePath This property is required. string
Rewrite path.
rewritePath This property is required. String
Rewrite path.
rewritePath This property is required. string
Rewrite path.
rewrite_path This property is required. str
Rewrite path.
rewritePath This property is required. 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-****
Copy

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 v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine