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

volcengine.alb.Rules

Explore with Pulumi AI

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

    Use this data source to query detailed information of alb rules

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Volcengine.Alb.Rules.Invoke(new()
        {
            ListenerId = "lsn-1iidd19u4oni874adhezjkyj3",
        });
    
    });
    
    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.Rules(ctx, &alb.RulesArgs{
    			ListenerId: "lsn-1iidd19u4oni874adhezjkyj3",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.alb.AlbFunctions;
    import com.pulumi.volcengine.alb.inputs.RulesArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var foo = AlbFunctions.Rules(RulesArgs.builder()
                .listenerId("lsn-1iidd19u4oni874adhezjkyj3")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.alb.rules(listener_id="lsn-1iidd19u4oni874adhezjkyj3")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    
    const foo = volcengine.alb.Rules({
        listenerId: "lsn-1iidd19u4oni874adhezjkyj3",
    });
    
    variables:
      foo:
        fn::invoke:
          Function: volcengine:alb:Rules
          Arguments:
            listenerId: lsn-1iidd19u4oni874adhezjkyj3
    

    Using Rules

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function rules(args: RulesArgs, opts?: InvokeOptions): Promise<RulesResult>
    function rulesOutput(args: RulesOutputArgs, opts?: InvokeOptions): Output<RulesResult>
    def rules(listener_id: Optional[str] = None,
              output_file: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> RulesResult
    def rules_output(listener_id: Optional[pulumi.Input[str]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[RulesResult]
    func Rules(ctx *Context, args *RulesArgs, opts ...InvokeOption) (*RulesResult, error)
    func RulesOutput(ctx *Context, args *RulesOutputArgs, opts ...InvokeOption) RulesResultOutput
    public static class Rules 
    {
        public static Task<RulesResult> InvokeAsync(RulesArgs args, InvokeOptions? opts = null)
        public static Output<RulesResult> Invoke(RulesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<RulesResult> rules(RulesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: volcengine:alb:Rules
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ListenerId string
    The Id of listener.
    OutputFile string
    File name where to save data source results.
    ListenerId string
    The Id of listener.
    OutputFile string
    File name where to save data source results.
    listenerId String
    The Id of listener.
    outputFile String
    File name where to save data source results.
    listenerId string
    The Id of listener.
    outputFile string
    File name where to save data source results.
    listener_id str
    The Id of listener.
    output_file str
    File name where to save data source results.
    listenerId String
    The Id of listener.
    outputFile String
    File name where to save data source results.

    Rules Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    Rules List<Volcengine.RulesRule>
    The collection of Rule query.
    TotalCount int
    The total count of Rule query.
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    Rules []RulesRule
    The collection of Rule query.
    TotalCount int
    The total count of Rule query.
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    rules List<RulesRule>
    The collection of Rule query.
    totalCount Integer
    The total count of Rule query.
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    listenerId string
    rules RulesRule[]
    The collection of Rule query.
    totalCount number
    The total count of Rule query.
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    listener_id str
    rules Sequence[RulesRule]
    The collection of Rule query.
    total_count int
    The total count of Rule query.
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    rules List<Property Map>
    The collection of Rule query.
    totalCount Number
    The total count of Rule query.
    outputFile String

    Supporting Types

    RulesRule

    Description string
    The Description of Rule.
    Domain string
    The Domain of Rule.
    Id string
    The Id of Rule.
    RedirectConfigs List<Volcengine.RulesRuleRedirectConfig>
    Redirect related configuration.
    RewriteConfigs List<Volcengine.RulesRuleRewriteConfig>
    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
    The Id of Server Group.
    TrafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    TrafficLimitQps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    Url string
    The Url of Rule.
    Description string
    The Description of Rule.
    Domain string
    The Domain of Rule.
    Id string
    The Id of Rule.
    RedirectConfigs []RulesRuleRedirectConfig
    Redirect related configuration.
    RewriteConfigs []RulesRuleRewriteConfig
    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
    The Id of Server Group.
    TrafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    TrafficLimitQps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    Url string
    The Url of Rule.
    description String
    The Description of Rule.
    domain String
    The Domain of Rule.
    id String
    The Id of Rule.
    redirectConfigs List<RulesRuleRedirectConfig>
    Redirect related configuration.
    rewriteConfigs List<RulesRuleRewriteConfig>
    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
    The Id of Server Group.
    trafficLimitEnabled String
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps Integer
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url String
    The Url of Rule.
    description string
    The Description of Rule.
    domain string
    The Domain of Rule.
    id string
    The Id of Rule.
    redirectConfigs RulesRuleRedirectConfig[]
    Redirect related configuration.
    rewriteConfigs RulesRuleRewriteConfig[]
    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
    The Id of Server Group.
    trafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps number
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url string
    The Url of Rule.
    description str
    The Description of Rule.
    domain str
    The Domain of Rule.
    id str
    The Id of Rule.
    redirect_configs Sequence[RulesRuleRedirectConfig]
    Redirect related configuration.
    rewrite_configs Sequence[RulesRuleRewriteConfig]
    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
    The Id of Server Group.
    traffic_limit_enabled str
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    traffic_limit_qps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url str
    The Url of Rule.
    description String
    The Description of Rule.
    domain String
    The Domain of Rule.
    id String
    The Id of Rule.
    redirectConfigs List<Property Map>
    Redirect related configuration.
    rewriteConfigs List<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
    The Id of Server Group.
    trafficLimitEnabled String
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps Number
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url String
    The Url of Rule.

    RulesRuleRedirectConfig

    RedirectDomain string
    The redirect domain.
    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.
    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.
    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.
    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.
    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.
    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.

    RulesRuleRewriteConfig

    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.

    Package Details

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