Docs Packages
  1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. Rules
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.tls.Rules

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
volcengine/pulumi-volcengine

    Use this data source to query detailed information of tls rules

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Tls.Rules.Invoke(new()
    {
        ProjectId = "cc44f8b6-0328-4622-b043-023fca735cd4",
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tls"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.Rules(ctx, &tls.RulesArgs{
			ProjectId: "cc44f8b6-0328-4622-b043-023fca735cd4",
		}, 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.tls.TlsFunctions;
import com.pulumi.volcengine.tls.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 default = TlsFunctions.Rules(RulesArgs.builder()
            .projectId("cc44f8b6-0328-4622-b043-023fca735cd4")
            .build());

    }
}

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tls.rules(project_id="cc44f8b6-0328-4622-b043-023fca735cd4")

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const default = volcengine.tls.Rules({
    projectId: "cc44f8b6-0328-4622-b043-023fca735cd4",
});

    variables:
  default:
    fn::invoke:
      Function: volcengine:tls:Rules
      Arguments:
        projectId: cc44f8b6-0328-4622-b043-023fca735cd4

    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(output_file: Optional[str] = None,
          project_id: Optional[str] = None,
          rule_id: Optional[str] = None,
          rule_name: Optional[str] = None,
          topic_id: Optional[str] = None,
          topic_name: Optional[str] = None,
          opts: Optional[InvokeOptions] = None) -> RulesResult
def rules_output(output_file: Optional[pulumi.Input[str]] = None,
          project_id: Optional[pulumi.Input[str]] = None,
          rule_id: Optional[pulumi.Input[str]] = None,
          rule_name: Optional[pulumi.Input[str]] = None,
          topic_id: Optional[pulumi.Input[str]] = None,
          topic_name: 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:tls:Rules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ProjectId string
    The project id.
    OutputFile string
    File name where to save data source results.
    RuleId string
    The rule id.
    RuleName string
    The rule name.
    TopicId string
    The topic id.
    TopicName string
    The topic name.
    ProjectId string
    The project id.
    OutputFile string
    File name where to save data source results.
    RuleId string
    The rule id.
    RuleName string
    The rule name.
    TopicId string
    The topic id.
    TopicName string
    The topic name.
    projectId String
    The project id.
    outputFile String
    File name where to save data source results.
    ruleId String
    The rule id.
    ruleName String
    The rule name.
    topicId String
    The topic id.
    topicName String
    The topic name.
    projectId string
    The project id.
    outputFile string
    File name where to save data source results.
    ruleId string
    The rule id.
    ruleName string
    The rule name.
    topicId string
    The topic id.
    topicName string
    The topic name.
    project_id str
    The project id.
    output_file str
    File name where to save data source results.
    rule_id str
    The rule id.
    rule_name str
    The rule name.
    topic_id str
    The topic id.
    topic_name str
    The topic name.
    projectId String
    The project id.
    outputFile String
    File name where to save data source results.
    ruleId String
    The rule id.
    ruleName String
    The rule name.
    topicId String
    The topic id.
    topicName String
    The topic name.

    Rules Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Rules List<RulesRule>
    The rules list.
    TotalCount int
    The total count of query.
    OutputFile string
    RuleId string
    The rule id.
    RuleName string
    The rule name.
    TopicId string
    The topic id.
    TopicName string
    The topic name.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Rules []RulesRule
    The rules list.
    TotalCount int
    The total count of query.
    OutputFile string
    RuleId string
    The rule id.
    RuleName string
    The rule name.
    TopicId string
    The topic id.
    TopicName string
    The topic name.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    rules List<RulesRule>
    The rules list.
    totalCount Integer
    The total count of query.
    outputFile String
    ruleId String
    The rule id.
    ruleName String
    The rule name.
    topicId String
    The topic id.
    topicName String
    The topic name.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    rules RulesRule[]
    The rules list.
    totalCount number
    The total count of query.
    outputFile string
    ruleId string
    The rule id.
    ruleName string
    The rule name.
    topicId string
    The topic id.
    topicName string
    The topic name.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    rules Sequence[RulesRule]
    The rules list.
    total_count int
    The total count of query.
    output_file str
    rule_id str
    The rule id.
    rule_name str
    The rule name.
    topic_id str
    The topic id.
    topic_name str
    The topic name.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    rules List<Property Map>
    The rules list.
    totalCount Number
    The total count of query.
    outputFile String
    ruleId String
    The rule id.
    ruleName String
    The rule name.
    topicId String
    The topic id.
    topicName String
    The topic name.

    Supporting Types

    RulesRule

    ContainerRules List<RulesRuleContainerRule>
    Container collection rules.
    CreateTime string
    The creation time.
    ExcludePaths List<RulesRuleExcludePath>
    Collect the blacklist list.
    ExtractRules List<RulesRuleExtractRule>
    The extract rule.
    InputType int
    The collection type.
    LogSample string
    Log sample.
    LogType string
    The log type.
    ModifyTime string
    The modification time.
    Paths List<string>
    Collection path list.
    RuleId string
    The rule id.
    RuleName string
    The rule name.
    TopicId string
    The topic id.
    TopicName string
    The topic name.
    UserDefineRules List<RulesRuleUserDefineRule>
    User-defined collection rules.
    ContainerRules []RulesRuleContainerRule
    Container collection rules.
    CreateTime string
    The creation time.
    ExcludePaths []RulesRuleExcludePath
    Collect the blacklist list.
    ExtractRules []RulesRuleExtractRule
    The extract rule.
    InputType int
    The collection type.
    LogSample string
    Log sample.
    LogType string
    The log type.
    ModifyTime string
    The modification time.
    Paths []string
    Collection path list.
    RuleId string
    The rule id.
    RuleName string
    The rule name.
    TopicId string
    The topic id.
    TopicName string
    The topic name.
    UserDefineRules []RulesRuleUserDefineRule
    User-defined collection rules.
    containerRules List<RulesRuleContainerRule>
    Container collection rules.
    createTime String
    The creation time.
    excludePaths List<RulesRuleExcludePath>
    Collect the blacklist list.
    extractRules List<RulesRuleExtractRule>
    The extract rule.
    inputType Integer
    The collection type.
    logSample String
    Log sample.
    logType String
    The log type.
    modifyTime String
    The modification time.
    paths List<String>
    Collection path list.
    ruleId String
    The rule id.
    ruleName String
    The rule name.
    topicId String
    The topic id.
    topicName String
    The topic name.
    userDefineRules List<RulesRuleUserDefineRule>
    User-defined collection rules.
    containerRules RulesRuleContainerRule[]
    Container collection rules.
    createTime string
    The creation time.
    excludePaths RulesRuleExcludePath[]
    Collect the blacklist list.
    extractRules RulesRuleExtractRule[]
    The extract rule.
    inputType number
    The collection type.
    logSample string
    Log sample.
    logType string
    The log type.
    modifyTime string
    The modification time.
    paths string[]
    Collection path list.
    ruleId string
    The rule id.
    ruleName string
    The rule name.
    topicId string
    The topic id.
    topicName string
    The topic name.
    userDefineRules RulesRuleUserDefineRule[]
    User-defined collection rules.
    container_rules Sequence[RulesRuleContainerRule]
    Container collection rules.
    create_time str
    The creation time.
    exclude_paths Sequence[RulesRuleExcludePath]
    Collect the blacklist list.
    extract_rules Sequence[RulesRuleExtractRule]
    The extract rule.
    input_type int
    The collection type.
    log_sample str
    Log sample.
    log_type str
    The log type.
    modify_time str
    The modification time.
    paths Sequence[str]
    Collection path list.
    rule_id str
    The rule id.
    rule_name str
    The rule name.
    topic_id str
    The topic id.
    topic_name str
    The topic name.
    user_define_rules Sequence[RulesRuleUserDefineRule]
    User-defined collection rules.
    containerRules List<Property Map>
    Container collection rules.
    createTime String
    The creation time.
    excludePaths List<Property Map>
    Collect the blacklist list.
    extractRules List<Property Map>
    The extract rule.
    inputType Number
    The collection type.
    logSample String
    Log sample.
    logType String
    The log type.
    modifyTime String
    The modification time.
    paths List<String>
    Collection path list.
    ruleId String
    The rule id.
    ruleName String
    The rule name.
    topicId String
    The topic id.
    topicName String
    The topic name.
    userDefineRules List<Property Map>
    User-defined collection rules.

    RulesRuleContainerRule

    ContainerNameRegex string
    The name of the container to be collected.
    EnvTag Dictionary<string, object>
    Whether to add environment variables as log tags to raw log data.
    ExcludeContainerEnvRegex Dictionary<string, object>
    The container environment variable blacklist is used to specify the range of containers not to be collected.
    ExcludeContainerLabelRegex Dictionary<string, object>
    The container Label blacklist is used to specify the range of containers not to be collected.
    IncludeContainerEnvRegex Dictionary<string, object>
    The container environment variable whitelist specifies the container to be collected through the container environment variable. If the whitelist is not enabled, it means that all containers are specified to be collected.
    IncludeContainerLabelRegex Dictionary<string, object>
    The container label whitelist specifies the containers to be collected through the container label. If the whitelist is not enabled, all containers are specified to be collected.
    KubernetesRules List<RulesRuleContainerRuleKubernetesRule>
    Collection rules for Kubernetes containers.
    Stream string
    The collection mode.
    ContainerNameRegex string
    The name of the container to be collected.
    EnvTag map[string]interface{}
    Whether to add environment variables as log tags to raw log data.
    ExcludeContainerEnvRegex map[string]interface{}
    The container environment variable blacklist is used to specify the range of containers not to be collected.
    ExcludeContainerLabelRegex map[string]interface{}
    The container Label blacklist is used to specify the range of containers not to be collected.
    IncludeContainerEnvRegex map[string]interface{}
    The container environment variable whitelist specifies the container to be collected through the container environment variable. If the whitelist is not enabled, it means that all containers are specified to be collected.
    IncludeContainerLabelRegex map[string]interface{}
    The container label whitelist specifies the containers to be collected through the container label. If the whitelist is not enabled, all containers are specified to be collected.
    KubernetesRules []RulesRuleContainerRuleKubernetesRule
    Collection rules for Kubernetes containers.
    Stream string
    The collection mode.
    containerNameRegex String
    The name of the container to be collected.
    envTag Map<String,Object>
    Whether to add environment variables as log tags to raw log data.
    excludeContainerEnvRegex Map<String,Object>
    The container environment variable blacklist is used to specify the range of containers not to be collected.
    excludeContainerLabelRegex Map<String,Object>
    The container Label blacklist is used to specify the range of containers not to be collected.
    includeContainerEnvRegex Map<String,Object>
    The container environment variable whitelist specifies the container to be collected through the container environment variable. If the whitelist is not enabled, it means that all containers are specified to be collected.
    includeContainerLabelRegex Map<String,Object>
    The container label whitelist specifies the containers to be collected through the container label. If the whitelist is not enabled, all containers are specified to be collected.
    kubernetesRules List<RulesRuleContainerRuleKubernetesRule>
    Collection rules for Kubernetes containers.
    stream String
    The collection mode.
    containerNameRegex string
    The name of the container to be collected.
    envTag {[key: string]: any}
    Whether to add environment variables as log tags to raw log data.
    excludeContainerEnvRegex {[key: string]: any}
    The container environment variable blacklist is used to specify the range of containers not to be collected.
    excludeContainerLabelRegex {[key: string]: any}
    The container Label blacklist is used to specify the range of containers not to be collected.
    includeContainerEnvRegex {[key: string]: any}
    The container environment variable whitelist specifies the container to be collected through the container environment variable. If the whitelist is not enabled, it means that all containers are specified to be collected.
    includeContainerLabelRegex {[key: string]: any}
    The container label whitelist specifies the containers to be collected through the container label. If the whitelist is not enabled, all containers are specified to be collected.
    kubernetesRules RulesRuleContainerRuleKubernetesRule[]
    Collection rules for Kubernetes containers.
    stream string
    The collection mode.
    container_name_regex str
    The name of the container to be collected.
    env_tag Mapping[str, Any]
    Whether to add environment variables as log tags to raw log data.
    exclude_container_env_regex Mapping[str, Any]
    The container environment variable blacklist is used to specify the range of containers not to be collected.
    exclude_container_label_regex Mapping[str, Any]
    The container Label blacklist is used to specify the range of containers not to be collected.
    include_container_env_regex Mapping[str, Any]
    The container environment variable whitelist specifies the container to be collected through the container environment variable. If the whitelist is not enabled, it means that all containers are specified to be collected.
    include_container_label_regex Mapping[str, Any]
    The container label whitelist specifies the containers to be collected through the container label. If the whitelist is not enabled, all containers are specified to be collected.
    kubernetes_rules Sequence[RulesRuleContainerRuleKubernetesRule]
    Collection rules for Kubernetes containers.
    stream str
    The collection mode.
    containerNameRegex String
    The name of the container to be collected.
    envTag Map<Any>
    Whether to add environment variables as log tags to raw log data.
    excludeContainerEnvRegex Map<Any>
    The container environment variable blacklist is used to specify the range of containers not to be collected.
    excludeContainerLabelRegex Map<Any>
    The container Label blacklist is used to specify the range of containers not to be collected.
    includeContainerEnvRegex Map<Any>
    The container environment variable whitelist specifies the container to be collected through the container environment variable. If the whitelist is not enabled, it means that all containers are specified to be collected.
    includeContainerLabelRegex Map<Any>
    The container label whitelist specifies the containers to be collected through the container label. If the whitelist is not enabled, all containers are specified to be collected.
    kubernetesRules List<Property Map>
    Collection rules for Kubernetes containers.
    stream String
    The collection mode.

    RulesRuleContainerRuleKubernetesRule

    AnnotationTag Dictionary<string, object>
    Whether to add Kubernetes Annotation as a log tag to the raw log data.
    ExcludePodLabelRegex Dictionary<string, object>
    Specify the containers not to be collected through the Pod Label blacklist, and not enable means to collect all containers.
    IncludePodLabelRegex Dictionary<string, object>
    The Pod Label whitelist is used to specify containers to be collected. When the Pod Label whitelist is not enabled, it means that all containers are collected.
    LabelTag Dictionary<string, object>
    Whether to add Kubernetes Label as a log label to the original log data.
    NamespaceNameRegex string
    The name of the Kubernetes Namespace to be collected. If no Namespace name is specified, all containers will be collected. Namespace names support regular matching.
    PodNameRegex string
    The Pod name is used to specify the container to be collected. When no Pod name is specified, it means to collect all containers.
    WorkloadNameRegex string
    Specify the container to be collected by the name of the workload. When no workload name is specified, all containers are collected. The workload name supports regular matching.
    WorkloadType string
    Specify the container to be collected by the type of workload. Only one type can be selected. When no type is specified, it means to collect all types of containers.
    AnnotationTag map[string]interface{}
    Whether to add Kubernetes Annotation as a log tag to the raw log data.
    ExcludePodLabelRegex map[string]interface{}
    Specify the containers not to be collected through the Pod Label blacklist, and not enable means to collect all containers.
    IncludePodLabelRegex map[string]interface{}
    The Pod Label whitelist is used to specify containers to be collected. When the Pod Label whitelist is not enabled, it means that all containers are collected.
    LabelTag map[string]interface{}
    Whether to add Kubernetes Label as a log label to the original log data.
    NamespaceNameRegex string
    The name of the Kubernetes Namespace to be collected. If no Namespace name is specified, all containers will be collected. Namespace names support regular matching.
    PodNameRegex string
    The Pod name is used to specify the container to be collected. When no Pod name is specified, it means to collect all containers.
    WorkloadNameRegex string
    Specify the container to be collected by the name of the workload. When no workload name is specified, all containers are collected. The workload name supports regular matching.
    WorkloadType string
    Specify the container to be collected by the type of workload. Only one type can be selected. When no type is specified, it means to collect all types of containers.
    annotationTag Map<String,Object>
    Whether to add Kubernetes Annotation as a log tag to the raw log data.
    excludePodLabelRegex Map<String,Object>
    Specify the containers not to be collected through the Pod Label blacklist, and not enable means to collect all containers.
    includePodLabelRegex Map<String,Object>
    The Pod Label whitelist is used to specify containers to be collected. When the Pod Label whitelist is not enabled, it means that all containers are collected.
    labelTag Map<String,Object>
    Whether to add Kubernetes Label as a log label to the original log data.
    namespaceNameRegex String
    The name of the Kubernetes Namespace to be collected. If no Namespace name is specified, all containers will be collected. Namespace names support regular matching.
    podNameRegex String
    The Pod name is used to specify the container to be collected. When no Pod name is specified, it means to collect all containers.
    workloadNameRegex String
    Specify the container to be collected by the name of the workload. When no workload name is specified, all containers are collected. The workload name supports regular matching.
    workloadType String
    Specify the container to be collected by the type of workload. Only one type can be selected. When no type is specified, it means to collect all types of containers.
    annotationTag {[key: string]: any}
    Whether to add Kubernetes Annotation as a log tag to the raw log data.
    excludePodLabelRegex {[key: string]: any}
    Specify the containers not to be collected through the Pod Label blacklist, and not enable means to collect all containers.
    includePodLabelRegex {[key: string]: any}
    The Pod Label whitelist is used to specify containers to be collected. When the Pod Label whitelist is not enabled, it means that all containers are collected.
    labelTag {[key: string]: any}
    Whether to add Kubernetes Label as a log label to the original log data.
    namespaceNameRegex string
    The name of the Kubernetes Namespace to be collected. If no Namespace name is specified, all containers will be collected. Namespace names support regular matching.
    podNameRegex string
    The Pod name is used to specify the container to be collected. When no Pod name is specified, it means to collect all containers.
    workloadNameRegex string
    Specify the container to be collected by the name of the workload. When no workload name is specified, all containers are collected. The workload name supports regular matching.
    workloadType string
    Specify the container to be collected by the type of workload. Only one type can be selected. When no type is specified, it means to collect all types of containers.
    annotation_tag Mapping[str, Any]
    Whether to add Kubernetes Annotation as a log tag to the raw log data.
    exclude_pod_label_regex Mapping[str, Any]
    Specify the containers not to be collected through the Pod Label blacklist, and not enable means to collect all containers.
    include_pod_label_regex Mapping[str, Any]
    The Pod Label whitelist is used to specify containers to be collected. When the Pod Label whitelist is not enabled, it means that all containers are collected.
    label_tag Mapping[str, Any]
    Whether to add Kubernetes Label as a log label to the original log data.
    namespace_name_regex str
    The name of the Kubernetes Namespace to be collected. If no Namespace name is specified, all containers will be collected. Namespace names support regular matching.
    pod_name_regex str
    The Pod name is used to specify the container to be collected. When no Pod name is specified, it means to collect all containers.
    workload_name_regex str
    Specify the container to be collected by the name of the workload. When no workload name is specified, all containers are collected. The workload name supports regular matching.
    workload_type str
    Specify the container to be collected by the type of workload. Only one type can be selected. When no type is specified, it means to collect all types of containers.
    annotationTag Map<Any>
    Whether to add Kubernetes Annotation as a log tag to the raw log data.
    excludePodLabelRegex Map<Any>
    Specify the containers not to be collected through the Pod Label blacklist, and not enable means to collect all containers.
    includePodLabelRegex Map<Any>
    The Pod Label whitelist is used to specify containers to be collected. When the Pod Label whitelist is not enabled, it means that all containers are collected.
    labelTag Map<Any>
    Whether to add Kubernetes Label as a log label to the original log data.
    namespaceNameRegex String
    The name of the Kubernetes Namespace to be collected. If no Namespace name is specified, all containers will be collected. Namespace names support regular matching.
    podNameRegex String
    The Pod name is used to specify the container to be collected. When no Pod name is specified, it means to collect all containers.
    workloadNameRegex String
    Specify the container to be collected by the name of the workload. When no workload name is specified, all containers are collected. The workload name supports regular matching.
    workloadType String
    Specify the container to be collected by the type of workload. Only one type can be selected. When no type is specified, it means to collect all types of containers.

    RulesRuleExcludePath

    Type string
    The type of the log template.
    Value string
    Collection path.
    Type string
    The type of the log template.
    Value string
    Collection path.
    type String
    The type of the log template.
    value String
    Collection path.
    type string
    The type of the log template.
    value string
    Collection path.
    type str
    The type of the log template.
    value str
    Collection path.
    type String
    The type of the log template.
    value String
    Collection path.

    RulesRuleExtractRule

    BeginRegex string
    The first log line needs to match the regular expression.
    Delimiter string
    The delimiter of the log.
    FilterKeyRegexes List<RulesRuleExtractRuleFilterKeyRegex>
    The filter key list.
    Keys List<string>
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    LogRegex string
    The entire log needs to match the regular expression.
    LogTemplates List<RulesRuleExtractRuleLogTemplate>
    Automatically extract log fields according to the specified log template.
    TimeFormat string
    Parsing format of the time field.
    TimeKey string
    The field name of the log time field.
    UnMatchLogKey string
    When uploading the failed log, the key name of the failed log.
    UnMatchUpLoadSwitch bool
    Whether to upload the log of parsing failure.
    BeginRegex string
    The first log line needs to match the regular expression.
    Delimiter string
    The delimiter of the log.
    FilterKeyRegexes []RulesRuleExtractRuleFilterKeyRegex
    The filter key list.
    Keys []string
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    LogRegex string
    The entire log needs to match the regular expression.
    LogTemplates []RulesRuleExtractRuleLogTemplate
    Automatically extract log fields according to the specified log template.
    TimeFormat string
    Parsing format of the time field.
    TimeKey string
    The field name of the log time field.
    UnMatchLogKey string
    When uploading the failed log, the key name of the failed log.
    UnMatchUpLoadSwitch bool
    Whether to upload the log of parsing failure.
    beginRegex String
    The first log line needs to match the regular expression.
    delimiter String
    The delimiter of the log.
    filterKeyRegexes List<RulesRuleExtractRuleFilterKeyRegex>
    The filter key list.
    keys List<String>
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    logRegex String
    The entire log needs to match the regular expression.
    logTemplates List<RulesRuleExtractRuleLogTemplate>
    Automatically extract log fields according to the specified log template.
    timeFormat String
    Parsing format of the time field.
    timeKey String
    The field name of the log time field.
    unMatchLogKey String
    When uploading the failed log, the key name of the failed log.
    unMatchUpLoadSwitch Boolean
    Whether to upload the log of parsing failure.
    beginRegex string
    The first log line needs to match the regular expression.
    delimiter string
    The delimiter of the log.
    filterKeyRegexes RulesRuleExtractRuleFilterKeyRegex[]
    The filter key list.
    keys string[]
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    logRegex string
    The entire log needs to match the regular expression.
    logTemplates RulesRuleExtractRuleLogTemplate[]
    Automatically extract log fields according to the specified log template.
    timeFormat string
    Parsing format of the time field.
    timeKey string
    The field name of the log time field.
    unMatchLogKey string
    When uploading the failed log, the key name of the failed log.
    unMatchUpLoadSwitch boolean
    Whether to upload the log of parsing failure.
    begin_regex str
    The first log line needs to match the regular expression.
    delimiter str
    The delimiter of the log.
    filter_key_regexes Sequence[RulesRuleExtractRuleFilterKeyRegex]
    The filter key list.
    keys Sequence[str]
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    log_regex str
    The entire log needs to match the regular expression.
    log_templates Sequence[RulesRuleExtractRuleLogTemplate]
    Automatically extract log fields according to the specified log template.
    time_format str
    Parsing format of the time field.
    time_key str
    The field name of the log time field.
    un_match_log_key str
    When uploading the failed log, the key name of the failed log.
    un_match_up_load_switch bool
    Whether to upload the log of parsing failure.
    beginRegex String
    The first log line needs to match the regular expression.
    delimiter String
    The delimiter of the log.
    filterKeyRegexes List<Property Map>
    The filter key list.
    keys List<String>
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    logRegex String
    The entire log needs to match the regular expression.
    logTemplates List<Property Map>
    Automatically extract log fields according to the specified log template.
    timeFormat String
    Parsing format of the time field.
    timeKey String
    The field name of the log time field.
    unMatchLogKey String
    When uploading the failed log, the key name of the failed log.
    unMatchUpLoadSwitch Boolean
    Whether to upload the log of parsing failure.

    RulesRuleExtractRuleFilterKeyRegex

    Key string
    The name of the filter key.
    Regex string
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    Key string
    The name of the filter key.
    Regex string
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    key String
    The name of the filter key.
    regex String
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    key string
    The name of the filter key.
    regex string
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    key str
    The name of the filter key.
    regex str
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    key String
    The name of the filter key.
    regex String
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.

    RulesRuleExtractRuleLogTemplate

    Format string
    Log template content.
    Type string
    The type of the log template.
    Format string
    Log template content.
    Type string
    The type of the log template.
    format String
    Log template content.
    type String
    The type of the log template.
    format string
    Log template content.
    type string
    The type of the log template.
    format str
    Log template content.
    type str
    The type of the log template.
    format String
    Log template content.
    type String
    The type of the log template.

    RulesRuleUserDefineRule

    Advanceds List<RulesRuleUserDefineRuleAdvanced>
    LogCollector extension configuration.
    EnableRawLog bool
    Whether to upload raw logs.
    Fields Dictionary<string, object>
    Add constant fields to logs.
    ParsePathRules List<RulesRuleUserDefineRuleParsePathRule>
    Rules for parsing collection paths. After the rules are set, the fields in the collection path will be extracted through the regular expressions specified in the rules, and added to the log data as metadata.
    Plugins List<RulesRuleUserDefineRulePlugin>
    Plugin configuration. After the plugin configuration is enabled, one or more LogCollector processor plugins can be added to parse logs with complex or variable structures.
    ShardHashKeys List<RulesRuleUserDefineRuleShardHashKey>
    Rules for routing log partitions. Setting this parameter indicates that the HashKey routing shard mode is used when collecting logs, and Log Service will write the data to the shard containing the specified Key value.
    TailFiles bool
    LogCollector collection strategy, which specifies whether LogCollector collects incremental logs or full logs. The default is false, which means to collect all logs.
    Advanceds []RulesRuleUserDefineRuleAdvanced
    LogCollector extension configuration.
    EnableRawLog bool
    Whether to upload raw logs.
    Fields map[string]interface{}
    Add constant fields to logs.
    ParsePathRules []RulesRuleUserDefineRuleParsePathRule
    Rules for parsing collection paths. After the rules are set, the fields in the collection path will be extracted through the regular expressions specified in the rules, and added to the log data as metadata.
    Plugins []RulesRuleUserDefineRulePlugin
    Plugin configuration. After the plugin configuration is enabled, one or more LogCollector processor plugins can be added to parse logs with complex or variable structures.
    ShardHashKeys []RulesRuleUserDefineRuleShardHashKey
    Rules for routing log partitions. Setting this parameter indicates that the HashKey routing shard mode is used when collecting logs, and Log Service will write the data to the shard containing the specified Key value.
    TailFiles bool
    LogCollector collection strategy, which specifies whether LogCollector collects incremental logs or full logs. The default is false, which means to collect all logs.
    advanceds List<RulesRuleUserDefineRuleAdvanced>
    LogCollector extension configuration.
    enableRawLog Boolean
    Whether to upload raw logs.
    fields Map<String,Object>
    Add constant fields to logs.
    parsePathRules List<RulesRuleUserDefineRuleParsePathRule>
    Rules for parsing collection paths. After the rules are set, the fields in the collection path will be extracted through the regular expressions specified in the rules, and added to the log data as metadata.
    plugins List<RulesRuleUserDefineRulePlugin>
    Plugin configuration. After the plugin configuration is enabled, one or more LogCollector processor plugins can be added to parse logs with complex or variable structures.
    shardHashKeys List<RulesRuleUserDefineRuleShardHashKey>
    Rules for routing log partitions. Setting this parameter indicates that the HashKey routing shard mode is used when collecting logs, and Log Service will write the data to the shard containing the specified Key value.
    tailFiles Boolean
    LogCollector collection strategy, which specifies whether LogCollector collects incremental logs or full logs. The default is false, which means to collect all logs.
    advanceds RulesRuleUserDefineRuleAdvanced[]
    LogCollector extension configuration.
    enableRawLog boolean
    Whether to upload raw logs.
    fields {[key: string]: any}
    Add constant fields to logs.
    parsePathRules RulesRuleUserDefineRuleParsePathRule[]
    Rules for parsing collection paths. After the rules are set, the fields in the collection path will be extracted through the regular expressions specified in the rules, and added to the log data as metadata.
    plugins RulesRuleUserDefineRulePlugin[]
    Plugin configuration. After the plugin configuration is enabled, one or more LogCollector processor plugins can be added to parse logs with complex or variable structures.
    shardHashKeys RulesRuleUserDefineRuleShardHashKey[]
    Rules for routing log partitions. Setting this parameter indicates that the HashKey routing shard mode is used when collecting logs, and Log Service will write the data to the shard containing the specified Key value.
    tailFiles boolean
    LogCollector collection strategy, which specifies whether LogCollector collects incremental logs or full logs. The default is false, which means to collect all logs.
    advanceds Sequence[RulesRuleUserDefineRuleAdvanced]
    LogCollector extension configuration.
    enable_raw_log bool
    Whether to upload raw logs.
    fields Mapping[str, Any]
    Add constant fields to logs.
    parse_path_rules Sequence[RulesRuleUserDefineRuleParsePathRule]
    Rules for parsing collection paths. After the rules are set, the fields in the collection path will be extracted through the regular expressions specified in the rules, and added to the log data as metadata.
    plugins Sequence[RulesRuleUserDefineRulePlugin]
    Plugin configuration. After the plugin configuration is enabled, one or more LogCollector processor plugins can be added to parse logs with complex or variable structures.
    shard_hash_keys Sequence[RulesRuleUserDefineRuleShardHashKey]
    Rules for routing log partitions. Setting this parameter indicates that the HashKey routing shard mode is used when collecting logs, and Log Service will write the data to the shard containing the specified Key value.
    tail_files bool
    LogCollector collection strategy, which specifies whether LogCollector collects incremental logs or full logs. The default is false, which means to collect all logs.
    advanceds List<Property Map>
    LogCollector extension configuration.
    enableRawLog Boolean
    Whether to upload raw logs.
    fields Map<Any>
    Add constant fields to logs.
    parsePathRules List<Property Map>
    Rules for parsing collection paths. After the rules are set, the fields in the collection path will be extracted through the regular expressions specified in the rules, and added to the log data as metadata.
    plugins List<Property Map>
    Plugin configuration. After the plugin configuration is enabled, one or more LogCollector processor plugins can be added to parse logs with complex or variable structures.
    shardHashKeys List<Property Map>
    Rules for routing log partitions. Setting this parameter indicates that the HashKey routing shard mode is used when collecting logs, and Log Service will write the data to the shard containing the specified Key value.
    tailFiles Boolean
    LogCollector collection strategy, which specifies whether LogCollector collects incremental logs or full logs. The default is false, which means to collect all logs.

    RulesRuleUserDefineRuleAdvanced

    CloseEof bool
    Whether to release the log file handle after reading to the end of the log file. The default is false.
    CloseInactive int
    The wait time to release the log file handle. When the log file has not written a new log for more than the specified time, release the handle of the log file.
    CloseRemoved bool
    After the log file is removed, whether to release the handle of the log file. The default is false.
    CloseRenamed bool
    After the log file is renamed, whether to release the handle of the log file. The default is false.
    CloseTimeout int
    The maximum length of time that LogCollector monitors log files. The unit is seconds, and the default is 0 seconds, which means that there is no limit to the length of time LogCollector monitors log files.
    CloseEof bool
    Whether to release the log file handle after reading to the end of the log file. The default is false.
    CloseInactive int
    The wait time to release the log file handle. When the log file has not written a new log for more than the specified time, release the handle of the log file.
    CloseRemoved bool
    After the log file is removed, whether to release the handle of the log file. The default is false.
    CloseRenamed bool
    After the log file is renamed, whether to release the handle of the log file. The default is false.
    CloseTimeout int
    The maximum length of time that LogCollector monitors log files. The unit is seconds, and the default is 0 seconds, which means that there is no limit to the length of time LogCollector monitors log files.
    closeEof Boolean
    Whether to release the log file handle after reading to the end of the log file. The default is false.
    closeInactive Integer
    The wait time to release the log file handle. When the log file has not written a new log for more than the specified time, release the handle of the log file.
    closeRemoved Boolean
    After the log file is removed, whether to release the handle of the log file. The default is false.
    closeRenamed Boolean
    After the log file is renamed, whether to release the handle of the log file. The default is false.
    closeTimeout Integer
    The maximum length of time that LogCollector monitors log files. The unit is seconds, and the default is 0 seconds, which means that there is no limit to the length of time LogCollector monitors log files.
    closeEof boolean
    Whether to release the log file handle after reading to the end of the log file. The default is false.
    closeInactive number
    The wait time to release the log file handle. When the log file has not written a new log for more than the specified time, release the handle of the log file.
    closeRemoved boolean
    After the log file is removed, whether to release the handle of the log file. The default is false.
    closeRenamed boolean
    After the log file is renamed, whether to release the handle of the log file. The default is false.
    closeTimeout number
    The maximum length of time that LogCollector monitors log files. The unit is seconds, and the default is 0 seconds, which means that there is no limit to the length of time LogCollector monitors log files.
    close_eof bool
    Whether to release the log file handle after reading to the end of the log file. The default is false.
    close_inactive int
    The wait time to release the log file handle. When the log file has not written a new log for more than the specified time, release the handle of the log file.
    close_removed bool
    After the log file is removed, whether to release the handle of the log file. The default is false.
    close_renamed bool
    After the log file is renamed, whether to release the handle of the log file. The default is false.
    close_timeout int
    The maximum length of time that LogCollector monitors log files. The unit is seconds, and the default is 0 seconds, which means that there is no limit to the length of time LogCollector monitors log files.
    closeEof Boolean
    Whether to release the log file handle after reading to the end of the log file. The default is false.
    closeInactive Number
    The wait time to release the log file handle. When the log file has not written a new log for more than the specified time, release the handle of the log file.
    closeRemoved Boolean
    After the log file is removed, whether to release the handle of the log file. The default is false.
    closeRenamed Boolean
    After the log file is renamed, whether to release the handle of the log file. The default is false.
    closeTimeout Number
    The maximum length of time that LogCollector monitors log files. The unit is seconds, and the default is 0 seconds, which means that there is no limit to the length of time LogCollector monitors log files.

    RulesRuleUserDefineRuleParsePathRule

    Keys List<string>
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    PathSample string
    Sample capture path for a real scene.
    Regex string
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    Keys []string
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    PathSample string
    Sample capture path for a real scene.
    Regex string
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    keys List<String>
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    pathSample String
    Sample capture path for a real scene.
    regex String
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    keys string[]
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    pathSample string
    Sample capture path for a real scene.
    regex string
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    keys Sequence[str]
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    path_sample str
    Sample capture path for a real scene.
    regex str
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.
    keys List<String>
    A list of field names. Log Service will parse the path sample (PathSample) into multiple fields according to the regular expression (Regex), and Keys is used to specify the field name of each field.
    pathSample String
    Sample capture path for a real scene.
    regex String
    Regular expression for extracting path fields. It must match the collection path sample, otherwise it cannot be extracted successfully.

    RulesRuleUserDefineRulePlugin

    Processors List<string>
    LogCollector plugin.
    Processors []string
    LogCollector plugin.
    processors List<String>
    LogCollector plugin.
    processors string[]
    LogCollector plugin.
    processors Sequence[str]
    LogCollector plugin.
    processors List<String>
    LogCollector plugin.

    RulesRuleUserDefineRuleShardHashKey

    HashKey string
    The HashKey of the log group is used to specify the partition (shard) to be written to by the current log group.
    HashKey string
    The HashKey of the log group is used to specify the partition (shard) to be written to by the current log group.
    hashKey String
    The HashKey of the log group is used to specify the partition (shard) to be written to by the current log group.
    hashKey string
    The HashKey of the log group is used to specify the partition (shard) to be written to by the current log group.
    hash_key str
    The HashKey of the log group is used to specify the partition (shard) to be written to by the current log group.
    hashKey String
    The HashKey of the log group is used to specify the partition (shard) to be written to by the current log group.

    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.24 published on Tuesday, Jun 25, 2024 by Volcengine
    volcengine/pulumi-volcengine