volcenginecc.alb.Rule

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

ALB distributes incoming traffic based on the forwarding rules you set. You can configure multiple forwarding rules for a single listener. Basic edition ALB instances support forwarding rules based on domain and path. Standard edition ALB instances support forwarding rules based on domain, path, and HTTP headers, and support composite forwarding conditions.

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  albRuleDemo:
    type: volcenginecc:alb:Rule
    name: AlbRuleDemo
    properties:
      description: test-rewrite
      domain: www.xxxx.test.com
      listenerId: lsn-bdwhrmgvcyyo8dv4xxxxxx
      rewriteConfig:
        rewrite_path: /test
      rewriteEnabled: on
      ruleAction: ""
      trafficLimitEnabled: off
      trafficLimitQps: 0
      url: /
      forwardGroupConfig:
        server_group_tuples:
          - serverGroupId: rsp-1pf4pgyq8zitc845wfxxxxxx
            weight: 100
          - serverGroupId: rsp-1pf4pgyq8zitc845wfxxxxxx
            weight: 100
        sticky_session_enabled: on
        sticky_session_timeout: 2000

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,
         rewrite_config: Optional[RuleRewriteConfigArgs] = None,
         rule_action: Optional[str] = None,
         domain: Optional[str] = None,
         priority: Optional[int] = None,
         redirect_config: Optional[RuleRedirectConfigArgs] = None,
         description: Optional[str] = None,
         rewrite_enabled: Optional[str] = None,
         forward_group_config: Optional[RuleForwardGroupConfigArgs] = None,
         rule_actions: Optional[Sequence[RuleRuleActionArgs]] = None,
         rule_conditions: Optional[Sequence[RuleRuleConditionArgs]] = 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: volcenginecc: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.

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.
Description string: Forwarding rule description.
Domain string: Domain name of the forwarding rule.
ForwardGroupConfig Volcengine.RuleForwardGroupConfig: Forwarding rule server group configuration.
Priority int: Standard edition forwarding rule priority.
RedirectConfig Volcengine.RuleRedirectConfig: Redirect-related configuration information.
RewriteConfig Volcengine.RuleRewriteConfig: Redirect-related configuration information.
RewriteEnabled string: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
RuleAction string: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
RuleActions List<Volcengine.RuleRuleAction>
RuleConditions List<Volcengine.RuleRuleCondition>
ServerGroupId string: Backend server group ID associated with the forwarding rule.
TrafficLimitEnabled string: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
TrafficLimitQps int: Requests per second. Range: 100–100000.
Url string: Forwarding rule URL.

ListenerId string: Listener ID.
Description string: Forwarding rule description.
Domain string: Domain name of the forwarding rule.
ForwardGroupConfig RuleForwardGroupConfigArgs: Forwarding rule server group configuration.
Priority int: Standard edition forwarding rule priority.
RedirectConfig RuleRedirectConfigArgs: Redirect-related configuration information.
RewriteConfig RuleRewriteConfigArgs: Redirect-related configuration information.
RewriteEnabled string: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
RuleAction string: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
RuleActions []RuleRuleActionArgs
RuleConditions []RuleRuleConditionArgs
ServerGroupId string: Backend server group ID associated with the forwarding rule.
TrafficLimitEnabled string: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
TrafficLimitQps int: Requests per second. Range: 100–100000.
Url string: Forwarding rule URL.

listenerId String: Listener ID.
description String: Forwarding rule description.
domain String: Domain name of the forwarding rule.
forwardGroupConfig RuleForwardGroupConfig: Forwarding rule server group configuration.
priority Integer: Standard edition forwarding rule priority.
redirectConfig RuleRedirectConfig: Redirect-related configuration information.
rewriteConfig RuleRewriteConfig: Redirect-related configuration information.
rewriteEnabled String: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
ruleAction String: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
ruleActions List<RuleRuleAction>
ruleConditions List<RuleRuleCondition>
serverGroupId String: Backend server group ID associated with the forwarding rule.
trafficLimitEnabled String: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
trafficLimitQps Integer: Requests per second. Range: 100–100000.
url String: Forwarding rule URL.

listenerId string: Listener ID.
description string: Forwarding rule description.
domain string: Domain name of the forwarding rule.
forwardGroupConfig RuleForwardGroupConfig: Forwarding rule server group configuration.
priority number: Standard edition forwarding rule priority.
redirectConfig RuleRedirectConfig: Redirect-related configuration information.
rewriteConfig RuleRewriteConfig: Redirect-related configuration information.
rewriteEnabled string: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
ruleAction string: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
ruleActions RuleRuleAction[]
ruleConditions RuleRuleCondition[]
serverGroupId string: Backend server group ID associated with the forwarding rule.
trafficLimitEnabled string: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
trafficLimitQps number: Requests per second. Range: 100–100000.
url string: Forwarding rule URL.

listener_id str: Listener ID.
description str: Forwarding rule description.
domain str: Domain name of the forwarding rule.
forward_group_config RuleForwardGroupConfigArgs: Forwarding rule server group configuration.
priority int: Standard edition forwarding rule priority.
redirect_config RuleRedirectConfigArgs: Redirect-related configuration information.
rewrite_config RuleRewriteConfigArgs: Redirect-related configuration information.
rewrite_enabled str: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
rule_action str: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
rule_actions Sequence[RuleRuleActionArgs]
rule_conditions Sequence[RuleRuleConditionArgs]
server_group_id str: Backend server group ID associated with the forwarding rule.
traffic_limit_enabled str: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
traffic_limit_qps int: Requests per second. Range: 100–100000.
url str: Forwarding rule URL.

listenerId String: Listener ID.
description String: Forwarding rule description.
domain String: Domain name of the forwarding rule.
forwardGroupConfig Property Map: Forwarding rule server group configuration.
priority Number: Standard edition forwarding rule priority.
redirectConfig Property Map: Redirect-related configuration information.
rewriteConfig Property Map: Redirect-related configuration information.
rewriteEnabled String: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
ruleAction String: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
ruleActions List<Property Map>
ruleConditions List<Property Map>
serverGroupId String: Backend server group ID associated with the forwarding rule.
trafficLimitEnabled String: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
trafficLimitQps Number: Requests per second. Range: 100–100000.
url String: Forwarding rule URL.

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,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        forward_group_config: Optional[RuleForwardGroupConfigArgs] = None,
        listener_id: Optional[str] = None,
        priority: Optional[int] = None,
        redirect_config: Optional[RuleRedirectConfigArgs] = None,
        rewrite_config: Optional[RuleRewriteConfigArgs] = None,
        rewrite_enabled: Optional[str] = None,
        rule_action: Optional[str] = None,
        rule_actions: Optional[Sequence[RuleRuleActionArgs]] = None,
        rule_conditions: Optional[Sequence[RuleRuleConditionArgs]] = 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: volcenginecc:alb: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:

Description string: Forwarding rule description.
Domain string: Domain name of the forwarding rule.
ForwardGroupConfig Volcengine.RuleForwardGroupConfig: Forwarding rule server group configuration.
ListenerId string: Listener ID.
Priority int: Standard edition forwarding rule priority.
RedirectConfig Volcengine.RuleRedirectConfig: Redirect-related configuration information.
RewriteConfig Volcengine.RuleRewriteConfig: Redirect-related configuration information.
RewriteEnabled string: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
RuleAction string: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
RuleActions List<Volcengine.RuleRuleAction>
RuleConditions List<Volcengine.RuleRuleCondition>
RuleId string: Forwarding rule ID.
ServerGroupId string: Backend server group ID associated with the forwarding rule.
TrafficLimitEnabled string: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
TrafficLimitQps int: Requests per second. Range: 100–100000.
Url string: Forwarding rule URL.

Description string: Forwarding rule description.
Domain string: Domain name of the forwarding rule.
ForwardGroupConfig RuleForwardGroupConfigArgs: Forwarding rule server group configuration.
ListenerId string: Listener ID.
Priority int: Standard edition forwarding rule priority.
RedirectConfig RuleRedirectConfigArgs: Redirect-related configuration information.
RewriteConfig RuleRewriteConfigArgs: Redirect-related configuration information.
RewriteEnabled string: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
RuleAction string: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
RuleActions []RuleRuleActionArgs
RuleConditions []RuleRuleConditionArgs
RuleId string: Forwarding rule ID.
ServerGroupId string: Backend server group ID associated with the forwarding rule.
TrafficLimitEnabled string: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
TrafficLimitQps int: Requests per second. Range: 100–100000.
Url string: Forwarding rule URL.

description String: Forwarding rule description.
domain String: Domain name of the forwarding rule.
forwardGroupConfig RuleForwardGroupConfig: Forwarding rule server group configuration.
listenerId String: Listener ID.
priority Integer: Standard edition forwarding rule priority.
redirectConfig RuleRedirectConfig: Redirect-related configuration information.
rewriteConfig RuleRewriteConfig: Redirect-related configuration information.
rewriteEnabled String: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
ruleAction String: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
ruleActions List<RuleRuleAction>
ruleConditions List<RuleRuleCondition>
ruleId String: Forwarding rule ID.
serverGroupId String: Backend server group ID associated with the forwarding rule.
trafficLimitEnabled String: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
trafficLimitQps Integer: Requests per second. Range: 100–100000.
url String: Forwarding rule URL.

description string: Forwarding rule description.
domain string: Domain name of the forwarding rule.
forwardGroupConfig RuleForwardGroupConfig: Forwarding rule server group configuration.
listenerId string: Listener ID.
priority number: Standard edition forwarding rule priority.
redirectConfig RuleRedirectConfig: Redirect-related configuration information.
rewriteConfig RuleRewriteConfig: Redirect-related configuration information.
rewriteEnabled string: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
ruleAction string: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
ruleActions RuleRuleAction[]
ruleConditions RuleRuleCondition[]
ruleId string: Forwarding rule ID.
serverGroupId string: Backend server group ID associated with the forwarding rule.
trafficLimitEnabled string: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
trafficLimitQps number: Requests per second. Range: 100–100000.
url string: Forwarding rule URL.

description str: Forwarding rule description.
domain str: Domain name of the forwarding rule.
forward_group_config RuleForwardGroupConfigArgs: Forwarding rule server group configuration.
listener_id str: Listener ID.
priority int: Standard edition forwarding rule priority.
redirect_config RuleRedirectConfigArgs: Redirect-related configuration information.
rewrite_config RuleRewriteConfigArgs: Redirect-related configuration information.
rewrite_enabled str: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
rule_action str: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
rule_actions Sequence[RuleRuleActionArgs]
rule_conditions Sequence[RuleRuleConditionArgs]
rule_id str: Forwarding rule ID.
server_group_id str: Backend server group ID associated with the forwarding rule.
traffic_limit_enabled str: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
traffic_limit_qps int: Requests per second. Range: 100–100000.
url str: Forwarding rule URL.

description String: Forwarding rule description.
domain String: Domain name of the forwarding rule.
forwardGroupConfig Property Map: Forwarding rule server group configuration.
listenerId String: Listener ID.
priority Number: Standard edition forwarding rule priority.
redirectConfig Property Map: Redirect-related configuration information.
rewriteConfig Property Map: Redirect-related configuration information.
rewriteEnabled String: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
ruleAction String: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
ruleActions List<Property Map>
ruleConditions List<Property Map>
ruleId String: Forwarding rule ID.
serverGroupId String: Backend server group ID associated with the forwarding rule.
trafficLimitEnabled String: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
trafficLimitQps Number: Requests per second. Range: 100–100000.
url String: Forwarding rule URL.

Supporting Types

RuleForwardGroupConfig, RuleForwardGroupConfigArgs

ServerGroupTuples List<Volcengine.RuleForwardGroupConfigServerGroupTuple>
StickySessionEnabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
StickySessionTimeout int: Component session stickiness timeout. Unit: seconds.

ServerGroupTuples []RuleForwardGroupConfigServerGroupTuple
StickySessionEnabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
StickySessionTimeout int: Component session stickiness timeout. Unit: seconds.

serverGroupTuples List<RuleForwardGroupConfigServerGroupTuple>
stickySessionEnabled String: Whether to enable inter-group session persistence. on: enabled. off: disabled.
stickySessionTimeout Integer: Component session stickiness timeout. Unit: seconds.

serverGroupTuples RuleForwardGroupConfigServerGroupTuple[]
stickySessionEnabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
stickySessionTimeout number: Component session stickiness timeout. Unit: seconds.

server_group_tuples Sequence[RuleForwardGroupConfigServerGroupTuple]
sticky_session_enabled str: Whether to enable inter-group session persistence. on: enabled. off: disabled.
sticky_session_timeout int: Component session stickiness timeout. Unit: seconds.

serverGroupTuples List<Property Map>
stickySessionEnabled String: Whether to enable inter-group session persistence. on: enabled. off: disabled.
stickySessionTimeout Number: Component session stickiness timeout. Unit: seconds.

RuleForwardGroupConfigServerGroupTuple, RuleForwardGroupConfigServerGroupTupleArgs

ServerGroupId string: Destination server group ID.
Weight int: Server group weight.

ServerGroupId string: Destination server group ID.
Weight int: Server group weight.

serverGroupId String: Destination server group ID.
weight Integer: Server group weight.

serverGroupId string: Destination server group ID.
weight number: Server group weight.

server_group_id str: Destination server group ID.
weight int: Server group weight.

serverGroupId String: Destination server group ID.
weight Number: Server group weight.

RuleRedirectConfig, RuleRedirectConfigArgs

RedirectDomain string: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
RedirectHttpCode string: Redirect status codes: 301, 302, 307, 308.
RedirectPort string: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
RedirectProtocol string: Protocol used for redirect. HTTP, HTTPS.
RedirectUri string: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

RedirectDomain string: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
RedirectHttpCode string: Redirect status codes: 301, 302, 307, 308.
RedirectPort string: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
RedirectProtocol string: Protocol used for redirect. HTTP, HTTPS.
RedirectUri string: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

redirectDomain String: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
redirectHttpCode String: Redirect status codes: 301, 302, 307, 308.
redirectPort String: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
redirectProtocol String: Protocol used for redirect. HTTP, HTTPS.
redirectUri String: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

redirectDomain string: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
redirectHttpCode string: Redirect status codes: 301, 302, 307, 308.
redirectPort string: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
redirectProtocol string: Protocol used for redirect. HTTP, HTTPS.
redirectUri string: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

redirect_domain str: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
redirect_http_code str: Redirect status codes: 301, 302, 307, 308.
redirect_port str: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
redirect_protocol str: Protocol used for redirect. HTTP, HTTPS.
redirect_uri str: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

redirectDomain String: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
redirectHttpCode String: Redirect status codes: 301, 302, 307, 308.
redirectPort String: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
redirectProtocol String: Protocol used for redirect. HTTP, HTTPS.
redirectUri String: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

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.

RuleRuleAction, RuleRuleActionArgs

FixedResponseConfig Volcengine.RuleRuleActionFixedResponseConfig: FixedResponseConfig
ForwardGroupConfig Volcengine.RuleRuleActionForwardGroupConfig: ForwardGroupConfig
RedirectConfig Volcengine.RuleRuleActionRedirectConfig: RedirectConfig
RewriteConfig Volcengine.RuleRuleActionRewriteConfig: RewriteConfig
TrafficLimitConfig Volcengine.RuleRuleActionTrafficLimitConfig: TrafficLimitConfig
Type string: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

FixedResponseConfig RuleRuleActionFixedResponseConfig: FixedResponseConfig
ForwardGroupConfig RuleRuleActionForwardGroupConfig: ForwardGroupConfig
RedirectConfig RuleRuleActionRedirectConfig: RedirectConfig
RewriteConfig RuleRuleActionRewriteConfig: RewriteConfig
TrafficLimitConfig RuleRuleActionTrafficLimitConfig: TrafficLimitConfig
Type string: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

fixedResponseConfig RuleRuleActionFixedResponseConfig: FixedResponseConfig
forwardGroupConfig RuleRuleActionForwardGroupConfig: ForwardGroupConfig
redirectConfig RuleRuleActionRedirectConfig: RedirectConfig
rewriteConfig RuleRuleActionRewriteConfig: RewriteConfig
trafficLimitConfig RuleRuleActionTrafficLimitConfig: TrafficLimitConfig
type String: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

fixedResponseConfig RuleRuleActionFixedResponseConfig: FixedResponseConfig
forwardGroupConfig RuleRuleActionForwardGroupConfig: ForwardGroupConfig
redirectConfig RuleRuleActionRedirectConfig: RedirectConfig
rewriteConfig RuleRuleActionRewriteConfig: RewriteConfig
trafficLimitConfig RuleRuleActionTrafficLimitConfig: TrafficLimitConfig
type string: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

fixed_response_config RuleRuleActionFixedResponseConfig: FixedResponseConfig
forward_group_config RuleRuleActionForwardGroupConfig: ForwardGroupConfig
redirect_config RuleRuleActionRedirectConfig: RedirectConfig
rewrite_config RuleRuleActionRewriteConfig: RewriteConfig
traffic_limit_config RuleRuleActionTrafficLimitConfig: TrafficLimitConfig
type str: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

fixedResponseConfig Property Map: FixedResponseConfig
forwardGroupConfig Property Map: ForwardGroupConfig
redirectConfig Property Map: RedirectConfig
rewriteConfig Property Map: RewriteConfig
trafficLimitConfig Property Map: TrafficLimitConfig
type String: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

RuleRuleActionFixedResponseConfig, RuleRuleActionFixedResponseConfigArgs

Content string: Fixed response content.
ContentType string: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
HttpCode string: Returned HTTP status code.

Content string: Fixed response content.
ContentType string: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
HttpCode string: Returned HTTP status code.

content String: Fixed response content.
contentType String: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
httpCode String: Returned HTTP status code.

content string: Fixed response content.
contentType string: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
httpCode string: Returned HTTP status code.

content str: Fixed response content.
content_type str: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
http_code str: Returned HTTP status code.

content String: Fixed response content.
contentType String: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
httpCode String: Returned HTTP status code.

RuleRuleActionForwardGroupConfig, RuleRuleActionForwardGroupConfigArgs

ServerGroupStickySession Volcengine.RuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
ServerGroupTuples List<Volcengine.RuleRuleActionForwardGroupConfigServerGroupTuple>

ServerGroupStickySession RuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
ServerGroupTuples []RuleRuleActionForwardGroupConfigServerGroupTuple

serverGroupStickySession RuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
serverGroupTuples List<RuleRuleActionForwardGroupConfigServerGroupTuple>

serverGroupStickySession RuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
serverGroupTuples RuleRuleActionForwardGroupConfigServerGroupTuple[]

server_group_sticky_session RuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
server_group_tuples Sequence[RuleRuleActionForwardGroupConfigServerGroupTuple]

serverGroupStickySession Property Map: ServerGroupStickySession
serverGroupTuples List<Property Map>

RuleRuleActionForwardGroupConfigServerGroupStickySession, RuleRuleActionForwardGroupConfigServerGroupStickySessionArgs

Enabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
Timeout int: Component session stickiness timeout. Unit: seconds.

Enabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
Timeout int: Component session stickiness timeout. Unit: seconds.

enabled String: Whether to enable inter-group session persistence. on: enabled. off: disabled.
timeout Integer: Component session stickiness timeout. Unit: seconds.

enabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
timeout number: Component session stickiness timeout. Unit: seconds.

enabled str: Whether to enable inter-group session persistence. on: enabled. off: disabled.
timeout int: Component session stickiness timeout. Unit: seconds.

enabled String: Whether to enable inter-group session persistence. on: enabled. off: disabled.
timeout Number: Component session stickiness timeout. Unit: seconds.

RuleRuleActionForwardGroupConfigServerGroupTuple, RuleRuleActionForwardGroupConfigServerGroupTupleArgs

ServerGroupId string: Destination server group ID.
Weight int: Server group weight.

ServerGroupId string: Destination server group ID.
Weight int: Server group weight.

serverGroupId String: Destination server group ID.
weight Integer: Server group weight.

serverGroupId string: Destination server group ID.
weight number: Server group weight.

server_group_id str: Destination server group ID.
weight int: Server group weight.

serverGroupId String: Destination server group ID.
weight Number: Server group weight.

RuleRuleActionRedirectConfig, RuleRuleActionRedirectConfigArgs

Host string: Redirect domain. Only exact domains are supported.
HttpCode string: Redirect status codes supported: 301, 302, 307, 308.
Path string: Redirect URI..
Port string: Redirect port.
Protocol string: Protocol used for redirect. Supports HTTP and HTTPS.

Host string: Redirect domain. Only exact domains are supported.
HttpCode string: Redirect status codes supported: 301, 302, 307, 308.
Path string: Redirect URI..
Port string: Redirect port.
Protocol string: Protocol used for redirect. Supports HTTP and HTTPS.

host String: Redirect domain. Only exact domains are supported.
httpCode String: Redirect status codes supported: 301, 302, 307, 308.
path String: Redirect URI..
port String: Redirect port.
protocol String: Protocol used for redirect. Supports HTTP and HTTPS.

host string: Redirect domain. Only exact domains are supported.
httpCode string: Redirect status codes supported: 301, 302, 307, 308.
path string: Redirect URI..
port string: Redirect port.
protocol string: Protocol used for redirect. Supports HTTP and HTTPS.

host str: Redirect domain. Only exact domains are supported.
http_code str: Redirect status codes supported: 301, 302, 307, 308.
path str: Redirect URI..
port str: Redirect port.
protocol str: Protocol used for redirect. Supports HTTP and HTTPS.

host String: Redirect domain. Only exact domains are supported.
httpCode String: Redirect status codes supported: 301, 302, 307, 308.
path String: Redirect URI..
port String: Redirect port.
protocol String: Protocol used for redirect. Supports HTTP and HTTPS.

RuleRuleActionRewriteConfig, RuleRuleActionRewriteConfigArgs

Path string: Rewrite path.

Path string: Rewrite path.

path String: Rewrite path.

path string: Rewrite path.

path str: Rewrite path.

path String: Rewrite path.

RuleRuleActionTrafficLimitConfig, RuleRuleActionTrafficLimitConfigArgs

Qps int: Requests per second.

Qps int: Requests per second.

qps Integer: Requests per second.

qps number: Requests per second.

qps int: Requests per second.

qps Number: Requests per second.

RuleRuleCondition, RuleRuleConditionArgs

HeaderConfig Volcengine.RuleRuleConditionHeaderConfig: HeaderConfig。
HostConfig Volcengine.RuleRuleConditionHostConfig: HostConfig。
MethodConfig Volcengine.RuleRuleConditionMethodConfig: MethodConfig。
PathConfig Volcengine.RuleRuleConditionPathConfig: PathConfig。
QueryStringConfig Volcengine.RuleRuleConditionQueryStringConfig: QueryStringConfig。
Type string: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

HeaderConfig RuleRuleConditionHeaderConfig: HeaderConfig。
HostConfig RuleRuleConditionHostConfig: HostConfig。
MethodConfig RuleRuleConditionMethodConfig: MethodConfig。
PathConfig RuleRuleConditionPathConfig: PathConfig。
QueryStringConfig RuleRuleConditionQueryStringConfig: QueryStringConfig。
Type string: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

headerConfig RuleRuleConditionHeaderConfig: HeaderConfig。
hostConfig RuleRuleConditionHostConfig: HostConfig。
methodConfig RuleRuleConditionMethodConfig: MethodConfig。
pathConfig RuleRuleConditionPathConfig: PathConfig。
queryStringConfig RuleRuleConditionQueryStringConfig: QueryStringConfig。
type String: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

headerConfig RuleRuleConditionHeaderConfig: HeaderConfig。
hostConfig RuleRuleConditionHostConfig: HostConfig。
methodConfig RuleRuleConditionMethodConfig: MethodConfig。
pathConfig RuleRuleConditionPathConfig: PathConfig。
queryStringConfig RuleRuleConditionQueryStringConfig: QueryStringConfig。
type string: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

header_config RuleRuleConditionHeaderConfig: HeaderConfig。
host_config RuleRuleConditionHostConfig: HostConfig。
method_config RuleRuleConditionMethodConfig: MethodConfig。
path_config RuleRuleConditionPathConfig: PathConfig。
query_string_config RuleRuleConditionQueryStringConfig: QueryStringConfig。
type str: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

headerConfig Property Map: HeaderConfig。
hostConfig Property Map: HostConfig。
methodConfig Property Map: MethodConfig。
pathConfig Property Map: PathConfig。
queryStringConfig Property Map: QueryStringConfig。
type String: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

RuleRuleConditionHeaderConfig, RuleRuleConditionHeaderConfigArgs

Key string: Header field key.
Values List<string>: Header field value.

Key string: Header field key.
Values []string: Header field value.

key String: Header field key.
values List<String>: Header field value.

key string: Header field key.
values string[]: Header field value.

key str: Header field key.
values Sequence[str]: Header field value.

key String: Header field key.
values List<String>: Header field value.

RuleRuleConditionHostConfig, RuleRuleConditionHostConfigArgs

Values List<string>: Domain name of the forwarding rule. Supports wildcard and exact domains.

Values []string: Domain name of the forwarding rule. Supports wildcard and exact domains.

values List<String>: Domain name of the forwarding rule. Supports wildcard and exact domains.

values string[]: Domain name of the forwarding rule. Supports wildcard and exact domains.

values Sequence[str]: Domain name of the forwarding rule. Supports wildcard and exact domains.

values List<String>: Domain name of the forwarding rule. Supports wildcard and exact domains.

RuleRuleConditionMethodConfig, RuleRuleConditionMethodConfigArgs

Values List<string>: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

Values []string: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

values List<String>: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

values string[]: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

values Sequence[str]: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

values List<String>: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

RuleRuleConditionPathConfig, RuleRuleConditionPathConfigArgs

Values List<string>: Forwarding rule URL. Only absolute paths are supported.

Values []string: Forwarding rule URL. Only absolute paths are supported.

values List<String>: Forwarding rule URL. Only absolute paths are supported.

values string[]: Forwarding rule URL. Only absolute paths are supported.

values Sequence[str]: Forwarding rule URL. Only absolute paths are supported.

values List<String>: Forwarding rule URL. Only absolute paths are supported.

RuleRuleConditionQueryStringConfig, RuleRuleConditionQueryStringConfigArgs

Values List<Volcengine.RuleRuleConditionQueryStringConfigValue>

Values []RuleRuleConditionQueryStringConfigValue

values List<RuleRuleConditionQueryStringConfigValue>

values RuleRuleConditionQueryStringConfigValue[]

values Sequence[RuleRuleConditionQueryStringConfigValue]

values List<Property Map>

RuleRuleConditionQueryStringConfigValue, RuleRuleConditionQueryStringConfigValueArgs

Key string: Query string key.
Value string: Query string value.

Key string: Query string key.
Value string: Query string value.

key String: Query string key.
value String: Query string value.

key string: Query string key.
value string: Query string value.

key str: Query string key.
value str: Query string value.

key String: Query string key.
value String: Query string value.

Import

$ pulumi import volcenginecc:alb/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.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

On this page

On this page

Example Usage

Create Rule Resource

Constructor syntax

Parameters

Rule Resource Properties

Inputs

Outputs

Look up Existing Rule Resource

Supporting Types

RuleForwardGroupConfig, RuleForwardGroupConfigArgs

RuleForwardGroupConfigServerGroupTuple, RuleForwardGroupConfigServerGroupTupleArgs

RuleRedirectConfig, RuleRedirectConfigArgs

RuleRewriteConfig, RuleRewriteConfigArgs

RuleRuleAction, RuleRuleActionArgs

RuleRuleActionFixedResponseConfig, RuleRuleActionFixedResponseConfigArgs

RuleRuleActionForwardGroupConfig, RuleRuleActionForwardGroupConfigArgs

RuleRuleActionForwardGroupConfigServerGroupStickySession, RuleRuleActionForwardGroupConfigServerGroupStickySessionArgs

RuleRuleActionForwardGroupConfigServerGroupTuple, RuleRuleActionForwardGroupConfigServerGroupTupleArgs

RuleRuleActionRedirectConfig, RuleRuleActionRedirectConfigArgs

RuleRuleActionRewriteConfig, RuleRuleActionRewriteConfigArgs

RuleRuleActionTrafficLimitConfig, RuleRuleActionTrafficLimitConfigArgs

RuleRuleCondition, RuleRuleConditionArgs

RuleRuleConditionHeaderConfig, RuleRuleConditionHeaderConfigArgs

RuleRuleConditionHostConfig, RuleRuleConditionHostConfigArgs

RuleRuleConditionMethodConfig, RuleRuleConditionMethodConfigArgs

RuleRuleConditionPathConfig, RuleRuleConditionPathConfigArgs

RuleRuleConditionQueryStringConfig, RuleRuleConditionQueryStringConfigArgs

RuleRuleConditionQueryStringConfigValue, RuleRuleConditionQueryStringConfigValueArgs

Import

Package Details

On this page

On this page