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

    Data Source schema for Volcengine::VPC::TrafficMirrorFilterRule

    Using getTrafficMirrorFilterRule

    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 getTrafficMirrorFilterRule(args: GetTrafficMirrorFilterRuleArgs, opts?: InvokeOptions): Promise<GetTrafficMirrorFilterRuleResult>
    function getTrafficMirrorFilterRuleOutput(args: GetTrafficMirrorFilterRuleOutputArgs, opts?: InvokeOptions): Output<GetTrafficMirrorFilterRuleResult>
    def get_traffic_mirror_filter_rule(id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetTrafficMirrorFilterRuleResult
    def get_traffic_mirror_filter_rule_output(id: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetTrafficMirrorFilterRuleResult]
    func LookupTrafficMirrorFilterRule(ctx *Context, args *LookupTrafficMirrorFilterRuleArgs, opts ...InvokeOption) (*LookupTrafficMirrorFilterRuleResult, error)
    func LookupTrafficMirrorFilterRuleOutput(ctx *Context, args *LookupTrafficMirrorFilterRuleOutputArgs, opts ...InvokeOption) LookupTrafficMirrorFilterRuleResultOutput

    > Note: This function is named LookupTrafficMirrorFilterRule in the Go SDK.

    public static class GetTrafficMirrorFilterRule 
    {
        public static Task<GetTrafficMirrorFilterRuleResult> InvokeAsync(GetTrafficMirrorFilterRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetTrafficMirrorFilterRuleResult> Invoke(GetTrafficMirrorFilterRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTrafficMirrorFilterRuleResult> getTrafficMirrorFilterRule(GetTrafficMirrorFilterRuleArgs args, InvokeOptions options)
    public static Output<GetTrafficMirrorFilterRuleResult> getTrafficMirrorFilterRule(GetTrafficMirrorFilterRuleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:vpc/getTrafficMirrorFilterRule:getTrafficMirrorFilterRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getTrafficMirrorFilterRule Result

    The following output properties are available:

    Description string
    Description of the filtering rule.
    DestinationCidrBlock string
    Destination network segment.
    DestinationPortRange string
    Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    Id string
    Uniquely identifies the resource.
    Policy string
    Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.
    Priority int
    Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.
    Protocol string
    Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.
    SourceCidrBlock string
    Source network segment.
    SourcePortRange string
    Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    Status string
    Status of the filtering rule. Available: available. Deleting: deleting. Creating: creating. Pending: modifying.
    TrafficDirection string
    Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.
    TrafficMirrorFilterId string
    Filtering condition ID.
    TrafficMirrorFilterRuleId string
    Filtering rule ID.
    Description string
    Description of the filtering rule.
    DestinationCidrBlock string
    Destination network segment.
    DestinationPortRange string
    Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    Id string
    Uniquely identifies the resource.
    Policy string
    Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.
    Priority int
    Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.
    Protocol string
    Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.
    SourceCidrBlock string
    Source network segment.
    SourcePortRange string
    Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    Status string
    Status of the filtering rule. Available: available. Deleting: deleting. Creating: creating. Pending: modifying.
    TrafficDirection string
    Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.
    TrafficMirrorFilterId string
    Filtering condition ID.
    TrafficMirrorFilterRuleId string
    Filtering rule ID.
    description String
    Description of the filtering rule.
    destinationCidrBlock String
    Destination network segment.
    destinationPortRange String
    Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    id String
    Uniquely identifies the resource.
    policy String
    Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.
    priority Integer
    Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.
    protocol String
    Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.
    sourceCidrBlock String
    Source network segment.
    sourcePortRange String
    Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    status String
    Status of the filtering rule. Available: available. Deleting: deleting. Creating: creating. Pending: modifying.
    trafficDirection String
    Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.
    trafficMirrorFilterId String
    Filtering condition ID.
    trafficMirrorFilterRuleId String
    Filtering rule ID.
    description string
    Description of the filtering rule.
    destinationCidrBlock string
    Destination network segment.
    destinationPortRange string
    Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    id string
    Uniquely identifies the resource.
    policy string
    Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.
    priority number
    Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.
    protocol string
    Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.
    sourceCidrBlock string
    Source network segment.
    sourcePortRange string
    Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    status string
    Status of the filtering rule. Available: available. Deleting: deleting. Creating: creating. Pending: modifying.
    trafficDirection string
    Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.
    trafficMirrorFilterId string
    Filtering condition ID.
    trafficMirrorFilterRuleId string
    Filtering rule ID.
    description str
    Description of the filtering rule.
    destination_cidr_block str
    Destination network segment.
    destination_port_range str
    Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    id str
    Uniquely identifies the resource.
    policy str
    Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.
    priority int
    Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.
    protocol str
    Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.
    source_cidr_block str
    Source network segment.
    source_port_range str
    Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    status str
    Status of the filtering rule. Available: available. Deleting: deleting. Creating: creating. Pending: modifying.
    traffic_direction str
    Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.
    traffic_mirror_filter_id str
    Filtering condition ID.
    traffic_mirror_filter_rule_id str
    Filtering rule ID.
    description String
    Description of the filtering rule.
    destinationCidrBlock String
    Destination network segment.
    destinationPortRange String
    Destination port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    id String
    Uniquely identifies the resource.
    policy String
    Traffic capture policy. accept: allow. When traffic from the mirror source matches this rule, the traffic is copied to the mirror target for monitoring and analysis. reject: reject. When traffic from the mirror source matches this rule, the traffic is not copied and monitoring and analysis are not performed.
    priority Number
    Priority of the filtering rule, ranging from 1 to 1000. The smaller the value, the higher the priority. Default is 1, which is the highest priority. For the same filtering condition and direction, the priority must be unique.
    protocol String
    Traffic protocol. Valid values: all: includes TCP, UDP, and ICMP protocols. tcp: TCP protocol. udp: UDP protocol. icmp: ICMP protocol.
    sourceCidrBlock String
    Source network segment.
    sourcePortRange String
    Source port range for traffic. When Protocol is all or icmp, this parameter is not required. The default value is -1/-1, which means no port restriction. When Protocol is tcp or udp, this parameter is required. Valid range is 1–65535. Use a forward slash (/) to separate the start and end ports, such as 1/50, 80/80.
    status String
    Status of the filtering rule. Available: available. Deleting: deleting. Creating: creating. Pending: modifying.
    trafficDirection String
    Traffic direction. Valid values: ingress: inbound rule. egress: outbound rule.
    trafficMirrorFilterId String
    Filtering condition ID.
    trafficMirrorFilterRuleId String
    Filtering rule ID.

    Package Details

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