1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. networksecurity
  6. UllMirroringCollectorRule
Viewing docs for Google Cloud v9.23.0
published on Thursday, May 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.networksecurity.UllMirroringCollectorRule

gcp logo
Viewing docs for Google Cloud v9.23.0
published on Thursday, May 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    UllMirroringCollectorRule is a resource that defines what traffic should be mirrored.

    Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

    Example Usage

    Network Security Ull Mirroring Collector Rule Basic

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

const network = new gcp.compute.Network("network", {
    name: "example-network",
    autoCreateSubnetworks: false,
});
const subnetwork = new gcp.compute.Subnetwork("subnetwork", {
    name: "example-subnet",
    region: "us-south1",
    ipCidrRange: "10.1.0.0/16",
    network: network.name,
});
const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
    name: "example-hc",
    region: "us-south1",
    httpHealthCheck: {
        port: 80,
    },
});
const backendService = new gcp.compute.RegionBackendService("backend_service", {
    name: "example-bs",
    region: "us-south1",
    healthChecks: healthCheck.id,
    protocol: "UDP",
    loadBalancingScheme: "INTERNAL",
});
const forwardingRule = new gcp.compute.ForwardingRule("forwarding_rule", {
    name: "example-fwr",
    region: "us-south1",
    network: network.name,
    subnetwork: subnetwork.name,
    backendService: backendService.id,
    loadBalancingScheme: "INTERNAL",
    ports: ["6081"],
    ipProtocol: "UDP",
    isMirroringCollector: true,
});
const ullMirroringEngine = new gcp.networksecurity.UllMirroringEngine("ull_mirroring_engine", {
    ullMirroringEngineId: "example-ull-eng",
    location: "us-south1-d",
});
const collector = new gcp.networksecurity.UllMirroringCollector("collector", {
    ullMirroringCollectorId: "example-ull-col",
    location: "us-south1-d",
    forwardingRule: forwardingRule.id,
    engine: ullMirroringEngine.id,
    labels: {
        foo: "bar",
    },
});
const _default = new gcp.networksecurity.UllMirroringCollectorRule("default", {
    ullMirroringCollectorRuleId: "example-ull-rule",
    location: "us-south1-d",
    ullMirroringCollector: collector.ullMirroringCollectorId,
    match: {
        direction: "INGRESS",
        ipProtocols: ["tcp"],
        srcIpRanges: ["10.0.0.0/8"],
        dstIpRanges: ["192.168.0.0/16"],
    },
});

    import pulumi
import pulumi_gcp as gcp

network = gcp.compute.Network("network",
    name="example-network",
    auto_create_subnetworks=False)
subnetwork = gcp.compute.Subnetwork("subnetwork",
    name="example-subnet",
    region="us-south1",
    ip_cidr_range="10.1.0.0/16",
    network=network.name)
health_check = gcp.compute.RegionHealthCheck("health_check",
    name="example-hc",
    region="us-south1",
    http_health_check={
        "port": 80,
    })
backend_service = gcp.compute.RegionBackendService("backend_service",
    name="example-bs",
    region="us-south1",
    health_checks=health_check.id,
    protocol="UDP",
    load_balancing_scheme="INTERNAL")
forwarding_rule = gcp.compute.ForwardingRule("forwarding_rule",
    name="example-fwr",
    region="us-south1",
    network=network.name,
    subnetwork=subnetwork.name,
    backend_service=backend_service.id,
    load_balancing_scheme="INTERNAL",
    ports=["6081"],
    ip_protocol="UDP",
    is_mirroring_collector=True)
ull_mirroring_engine = gcp.networksecurity.UllMirroringEngine("ull_mirroring_engine",
    ull_mirroring_engine_id="example-ull-eng",
    location="us-south1-d")
collector = gcp.networksecurity.UllMirroringCollector("collector",
    ull_mirroring_collector_id="example-ull-col",
    location="us-south1-d",
    forwarding_rule=forwarding_rule.id,
    engine=ull_mirroring_engine.id,
    labels={
        "foo": "bar",
    })
default = gcp.networksecurity.UllMirroringCollectorRule("default",
    ull_mirroring_collector_rule_id="example-ull-rule",
    location="us-south1-d",
    ull_mirroring_collector=collector.ull_mirroring_collector_id,
    match={
        "direction": "INGRESS",
        "ip_protocols": ["tcp"],
        "src_ip_ranges": ["10.0.0.0/8"],
        "dst_ip_ranges": ["192.168.0.0/16"],
    })

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network, err := compute.NewNetwork(ctx, "network", &compute.NetworkArgs{
			Name:                  pulumi.String("example-network"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		subnetwork, err := compute.NewSubnetwork(ctx, "subnetwork", &compute.SubnetworkArgs{
			Name:        pulumi.String("example-subnet"),
			Region:      pulumi.String("us-south1"),
			IpCidrRange: pulumi.String("10.1.0.0/16"),
			Network:     network.Name,
		})
		if err != nil {
			return err
		}
		healthCheck, err := compute.NewRegionHealthCheck(ctx, "health_check", &compute.RegionHealthCheckArgs{
			Name:   pulumi.String("example-hc"),
			Region: pulumi.String("us-south1"),
			HttpHealthCheck: &compute.RegionHealthCheckHttpHealthCheckArgs{
				Port: pulumi.Int(80),
			},
		})
		if err != nil {
			return err
		}
		backendService, err := compute.NewRegionBackendService(ctx, "backend_service", &compute.RegionBackendServiceArgs{
			Name:                pulumi.String("example-bs"),
			Region:              pulumi.String("us-south1"),
			HealthChecks:        healthCheck.ID(),
			Protocol:            pulumi.String("UDP"),
			LoadBalancingScheme: pulumi.String("INTERNAL"),
		})
		if err != nil {
			return err
		}
		forwardingRule, err := compute.NewForwardingRule(ctx, "forwarding_rule", &compute.ForwardingRuleArgs{
			Name:                pulumi.String("example-fwr"),
			Region:              pulumi.String("us-south1"),
			Network:             network.Name,
			Subnetwork:          subnetwork.Name,
			BackendService:      backendService.ID(),
			LoadBalancingScheme: pulumi.String("INTERNAL"),
			Ports: pulumi.StringArray{
				pulumi.String("6081"),
			},
			IpProtocol:           pulumi.String("UDP"),
			IsMirroringCollector: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		ullMirroringEngine, err := networksecurity.NewUllMirroringEngine(ctx, "ull_mirroring_engine", &networksecurity.UllMirroringEngineArgs{
			UllMirroringEngineId: pulumi.String("example-ull-eng"),
			Location:             pulumi.String("us-south1-d"),
		})
		if err != nil {
			return err
		}
		collector, err := networksecurity.NewUllMirroringCollector(ctx, "collector", &networksecurity.UllMirroringCollectorArgs{
			UllMirroringCollectorId: pulumi.String("example-ull-col"),
			Location:                pulumi.String("us-south1-d"),
			ForwardingRule:          forwardingRule.ID(),
			Engine:                  ullMirroringEngine.ID(),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		_, err = networksecurity.NewUllMirroringCollectorRule(ctx, "default", &networksecurity.UllMirroringCollectorRuleArgs{
			UllMirroringCollectorRuleId: pulumi.String("example-ull-rule"),
			Location:                    pulumi.String("us-south1-d"),
			UllMirroringCollector:       collector.UllMirroringCollectorId,
			Match: &networksecurity.UllMirroringCollectorRuleMatchArgs{
				Direction: pulumi.String("INGRESS"),
				IpProtocols: pulumi.StringArray{
					pulumi.String("tcp"),
				},
				SrcIpRanges: pulumi.StringArray{
					pulumi.String("10.0.0.0/8"),
				},
				DstIpRanges: pulumi.StringArray{
					pulumi.String("192.168.0.0/16"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var network = new Gcp.Compute.Network("network", new()
    {
        Name = "example-network",
        AutoCreateSubnetworks = false,
    });

    var subnetwork = new Gcp.Compute.Subnetwork("subnetwork", new()
    {
        Name = "example-subnet",
        Region = "us-south1",
        IpCidrRange = "10.1.0.0/16",
        Network = network.Name,
    });

    var healthCheck = new Gcp.Compute.RegionHealthCheck("health_check", new()
    {
        Name = "example-hc",
        Region = "us-south1",
        HttpHealthCheck = new Gcp.Compute.Inputs.RegionHealthCheckHttpHealthCheckArgs
        {
            Port = 80,
        },
    });

    var backendService = new Gcp.Compute.RegionBackendService("backend_service", new()
    {
        Name = "example-bs",
        Region = "us-south1",
        HealthChecks = healthCheck.Id,
        Protocol = "UDP",
        LoadBalancingScheme = "INTERNAL",
    });

    var forwardingRule = new Gcp.Compute.ForwardingRule("forwarding_rule", new()
    {
        Name = "example-fwr",
        Region = "us-south1",
        Network = network.Name,
        Subnetwork = subnetwork.Name,
        BackendService = backendService.Id,
        LoadBalancingScheme = "INTERNAL",
        Ports = new[]
        {
            "6081",
        },
        IpProtocol = "UDP",
        IsMirroringCollector = true,
    });

    var ullMirroringEngine = new Gcp.NetworkSecurity.UllMirroringEngine("ull_mirroring_engine", new()
    {
        UllMirroringEngineId = "example-ull-eng",
        Location = "us-south1-d",
    });

    var collector = new Gcp.NetworkSecurity.UllMirroringCollector("collector", new()
    {
        UllMirroringCollectorId = "example-ull-col",
        Location = "us-south1-d",
        ForwardingRule = forwardingRule.Id,
        Engine = ullMirroringEngine.Id,
        Labels = 
        {
            { "foo", "bar" },
        },
    });

    var @default = new Gcp.NetworkSecurity.UllMirroringCollectorRule("default", new()
    {
        UllMirroringCollectorRuleId = "example-ull-rule",
        Location = "us-south1-d",
        UllMirroringCollector = collector.UllMirroringCollectorId,
        Match = new Gcp.NetworkSecurity.Inputs.UllMirroringCollectorRuleMatchArgs
        {
            Direction = "INGRESS",
            IpProtocols = new[]
            {
                "tcp",
            },
            SrcIpRanges = new[]
            {
                "10.0.0.0/8",
            },
            DstIpRanges = new[]
            {
                "192.168.0.0/16",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.compute.RegionHealthCheck;
import com.pulumi.gcp.compute.RegionHealthCheckArgs;
import com.pulumi.gcp.compute.inputs.RegionHealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.compute.ForwardingRule;
import com.pulumi.gcp.compute.ForwardingRuleArgs;
import com.pulumi.gcp.networksecurity.UllMirroringEngine;
import com.pulumi.gcp.networksecurity.UllMirroringEngineArgs;
import com.pulumi.gcp.networksecurity.UllMirroringCollector;
import com.pulumi.gcp.networksecurity.UllMirroringCollectorArgs;
import com.pulumi.gcp.networksecurity.UllMirroringCollectorRule;
import com.pulumi.gcp.networksecurity.UllMirroringCollectorRuleArgs;
import com.pulumi.gcp.networksecurity.inputs.UllMirroringCollectorRuleMatchArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var network = new Network("network", NetworkArgs.builder()
            .name("example-network")
            .autoCreateSubnetworks(false)
            .build());

        var subnetwork = new Subnetwork("subnetwork", SubnetworkArgs.builder()
            .name("example-subnet")
            .region("us-south1")
            .ipCidrRange("10.1.0.0/16")
            .network(network.name())
            .build());

        var healthCheck = new RegionHealthCheck("healthCheck", RegionHealthCheckArgs.builder()
            .name("example-hc")
            .region("us-south1")
            .httpHealthCheck(RegionHealthCheckHttpHealthCheckArgs.builder()
                .port(80)
                .build())
            .build());

        var backendService = new RegionBackendService("backendService", RegionBackendServiceArgs.builder()
            .name("example-bs")
            .region("us-south1")
            .healthChecks(healthCheck.id())
            .protocol("UDP")
            .loadBalancingScheme("INTERNAL")
            .build());

        var forwardingRule = new ForwardingRule("forwardingRule", ForwardingRuleArgs.builder()
            .name("example-fwr")
            .region("us-south1")
            .network(network.name())
            .subnetwork(subnetwork.name())
            .backendService(backendService.id())
            .loadBalancingScheme("INTERNAL")
            .ports("6081")
            .ipProtocol("UDP")
            .isMirroringCollector(true)
            .build());

        var ullMirroringEngine = new UllMirroringEngine("ullMirroringEngine", UllMirroringEngineArgs.builder()
            .ullMirroringEngineId("example-ull-eng")
            .location("us-south1-d")
            .build());

        var collector = new UllMirroringCollector("collector", UllMirroringCollectorArgs.builder()
            .ullMirroringCollectorId("example-ull-col")
            .location("us-south1-d")
            .forwardingRule(forwardingRule.id())
            .engine(ullMirroringEngine.id())
            .labels(Map.of("foo", "bar"))
            .build());

        var default_ = new UllMirroringCollectorRule("default", UllMirroringCollectorRuleArgs.builder()
            .ullMirroringCollectorRuleId("example-ull-rule")
            .location("us-south1-d")
            .ullMirroringCollector(collector.ullMirroringCollectorId())
            .match(UllMirroringCollectorRuleMatchArgs.builder()
                .direction("INGRESS")
                .ipProtocols("tcp")
                .srcIpRanges("10.0.0.0/8")
                .dstIpRanges("192.168.0.0/16")
                .build())
            .build());

    }
}

    resources:
  network:
    type: gcp:compute:Network
    properties:
      name: example-network
      autoCreateSubnetworks: false
  subnetwork:
    type: gcp:compute:Subnetwork
    properties:
      name: example-subnet
      region: us-south1
      ipCidrRange: 10.1.0.0/16
      network: ${network.name}
  healthCheck:
    type: gcp:compute:RegionHealthCheck
    name: health_check
    properties:
      name: example-hc
      region: us-south1
      httpHealthCheck:
        port: 80
  backendService:
    type: gcp:compute:RegionBackendService
    name: backend_service
    properties:
      name: example-bs
      region: us-south1
      healthChecks: ${healthCheck.id}
      protocol: UDP
      loadBalancingScheme: INTERNAL
  forwardingRule:
    type: gcp:compute:ForwardingRule
    name: forwarding_rule
    properties:
      name: example-fwr
      region: us-south1
      network: ${network.name}
      subnetwork: ${subnetwork.name}
      backendService: ${backendService.id}
      loadBalancingScheme: INTERNAL
      ports:
        - 6081
      ipProtocol: UDP
      isMirroringCollector: true
  ullMirroringEngine:
    type: gcp:networksecurity:UllMirroringEngine
    name: ull_mirroring_engine
    properties:
      ullMirroringEngineId: example-ull-eng
      location: us-south1-d
  collector:
    type: gcp:networksecurity:UllMirroringCollector
    properties:
      ullMirroringCollectorId: example-ull-col
      location: us-south1-d
      forwardingRule: ${forwardingRule.id}
      engine: ${ullMirroringEngine.id}
      labels:
        foo: bar
  default:
    type: gcp:networksecurity:UllMirroringCollectorRule
    properties:
      ullMirroringCollectorRuleId: example-ull-rule
      location: us-south1-d
      ullMirroringCollector: ${collector.ullMirroringCollectorId}
      match:
        direction: INGRESS
        ipProtocols:
          - tcp
        srcIpRanges:
          - 10.0.0.0/8
        dstIpRanges:
          - 192.168.0.0/16

    Create UllMirroringCollectorRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UllMirroringCollectorRule(name: string, args: UllMirroringCollectorRuleArgs, opts?: CustomResourceOptions);
    @overload
def UllMirroringCollectorRule(resource_name: str,
                              args: UllMirroringCollectorRuleArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def UllMirroringCollectorRule(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              location: Optional[str] = None,
                              match: Optional[UllMirroringCollectorRuleMatchArgs] = None,
                              ull_mirroring_collector: Optional[str] = None,
                              ull_mirroring_collector_rule_id: Optional[str] = None,
                              labels: Optional[Mapping[str, str]] = None,
                              project: Optional[str] = None)
    func NewUllMirroringCollectorRule(ctx *Context, name string, args UllMirroringCollectorRuleArgs, opts ...ResourceOption) (*UllMirroringCollectorRule, error)
    public UllMirroringCollectorRule(string name, UllMirroringCollectorRuleArgs args, CustomResourceOptions? opts = null)
    public UllMirroringCollectorRule(String name, UllMirroringCollectorRuleArgs args)
public UllMirroringCollectorRule(String name, UllMirroringCollectorRuleArgs args, CustomResourceOptions options)

    type: gcp:networksecurity:UllMirroringCollectorRule
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 UllMirroringCollectorRuleArgs
    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 UllMirroringCollectorRuleArgs
    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 UllMirroringCollectorRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UllMirroringCollectorRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UllMirroringCollectorRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ullMirroringCollectorRuleResource = new Gcp.NetworkSecurity.UllMirroringCollectorRule("ullMirroringCollectorRuleResource", new()
{
    Location = "string",
    Match = new Gcp.NetworkSecurity.Inputs.UllMirroringCollectorRuleMatchArgs
    {
        Direction = "string",
        DstIpRanges = new[]
        {
            "string",
        },
        IpProtocols = new[]
        {
            "string",
        },
        SrcIpRanges = new[]
        {
            "string",
        },
    },
    UllMirroringCollector = "string",
    UllMirroringCollectorRuleId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});

    example, err := networksecurity.NewUllMirroringCollectorRule(ctx, "ullMirroringCollectorRuleResource", &networksecurity.UllMirroringCollectorRuleArgs{
	Location: pulumi.String("string"),
	Match: &networksecurity.UllMirroringCollectorRuleMatchArgs{
		Direction: pulumi.String("string"),
		DstIpRanges: pulumi.StringArray{
			pulumi.String("string"),
		},
		IpProtocols: pulumi.StringArray{
			pulumi.String("string"),
		},
		SrcIpRanges: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	UllMirroringCollector:       pulumi.String("string"),
	UllMirroringCollectorRuleId: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var ullMirroringCollectorRuleResource = new UllMirroringCollectorRule("ullMirroringCollectorRuleResource", UllMirroringCollectorRuleArgs.builder()
    .location("string")
    .match(UllMirroringCollectorRuleMatchArgs.builder()
        .direction("string")
        .dstIpRanges("string")
        .ipProtocols("string")
        .srcIpRanges("string")
        .build())
    .ullMirroringCollector("string")
    .ullMirroringCollectorRuleId("string")
    .labels(Map.of("string", "string"))
    .project("string")
    .build());

    ull_mirroring_collector_rule_resource = gcp.networksecurity.UllMirroringCollectorRule("ullMirroringCollectorRuleResource",
    location="string",
    match={
        "direction": "string",
        "dst_ip_ranges": ["string"],
        "ip_protocols": ["string"],
        "src_ip_ranges": ["string"],
    },
    ull_mirroring_collector="string",
    ull_mirroring_collector_rule_id="string",
    labels={
        "string": "string",
    },
    project="string")

    const ullMirroringCollectorRuleResource = new gcp.networksecurity.UllMirroringCollectorRule("ullMirroringCollectorRuleResource", {
    location: "string",
    match: {
        direction: "string",
        dstIpRanges: ["string"],
        ipProtocols: ["string"],
        srcIpRanges: ["string"],
    },
    ullMirroringCollector: "string",
    ullMirroringCollectorRuleId: "string",
    labels: {
        string: "string",
    },
    project: "string",
});

    type: gcp:networksecurity:UllMirroringCollectorRule
properties:
    labels:
        string: string
    location: string
    match:
        direction: string
        dstIpRanges:
            - string
        ipProtocols:
            - string
        srcIpRanges:
            - string
    project: string
    ullMirroringCollector: string
    ullMirroringCollectorRuleId: string

    UllMirroringCollectorRule 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 UllMirroringCollectorRule resource accepts the following input properties:

    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Match UllMirroringCollectorRuleMatch
    Match defines what traffic to mirror. Structure is documented below.
    UllMirroringCollector string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    UllMirroringCollectorRuleId string
    ID for the new UllMirroringCollectorRule.
    Labels Dictionary<string, string>
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Match UllMirroringCollectorRuleMatchArgs
    Match defines what traffic to mirror. Structure is documented below.
    UllMirroringCollector string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    UllMirroringCollectorRuleId string
    ID for the new UllMirroringCollectorRule.
    Labels map[string]string
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    match UllMirroringCollectorRuleMatch
    Match defines what traffic to mirror. Structure is documented below.
    ullMirroringCollector String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    ullMirroringCollectorRuleId String
    ID for the new UllMirroringCollectorRule.
    labels Map<String,String>
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    match UllMirroringCollectorRuleMatch
    Match defines what traffic to mirror. Structure is documented below.
    ullMirroringCollector string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    ullMirroringCollectorRuleId string
    ID for the new UllMirroringCollectorRule.
    labels {[key: string]: string}
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    match UllMirroringCollectorRuleMatchArgs
    Match defines what traffic to mirror. Structure is documented below.
    ull_mirroring_collector str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    ull_mirroring_collector_rule_id str
    ID for the new UllMirroringCollectorRule.
    labels Mapping[str, str]
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    match Property Map
    Match defines what traffic to mirror. Structure is documented below.
    ullMirroringCollector String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    ullMirroringCollectorRuleId String
    ID for the new UllMirroringCollectorRule.
    labels Map<String>
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UllMirroringCollectorRule resource produces the following output properties:

    CreateTime string
    [Output only] Create time stamp
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The name of the UllMirroringCollectorRule.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Reconciling bool
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    UpdateTime string
    [Output only] Update time stamp
    CreateTime string
    [Output only] Create time stamp
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The name of the UllMirroringCollectorRule.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Reconciling bool
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    UpdateTime string
    [Output only] Update time stamp
    createTime String
    [Output only] Create time stamp
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The name of the UllMirroringCollectorRule.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling Boolean
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    updateTime String
    [Output only] Update time stamp
    createTime string
    [Output only] Create time stamp
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. The name of the UllMirroringCollectorRule.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling boolean
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    updateTime string
    [Output only] Update time stamp
    create_time str
    [Output only] Create time stamp
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Identifier. The name of the UllMirroringCollectorRule.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling bool
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    update_time str
    [Output only] Update time stamp
    createTime String
    [Output only] Create time stamp
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The name of the UllMirroringCollectorRule.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling Boolean
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    updateTime String
    [Output only] Update time stamp

    Look up Existing UllMirroringCollectorRule Resource

    Get an existing UllMirroringCollectorRule 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?: UllMirroringCollectorRuleState, opts?: CustomResourceOptions): UllMirroringCollectorRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        match: Optional[UllMirroringCollectorRuleMatchArgs] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        reconciling: Optional[bool] = None,
        ull_mirroring_collector: Optional[str] = None,
        ull_mirroring_collector_rule_id: Optional[str] = None,
        update_time: Optional[str] = None) -> UllMirroringCollectorRule
    func GetUllMirroringCollectorRule(ctx *Context, name string, id IDInput, state *UllMirroringCollectorRuleState, opts ...ResourceOption) (*UllMirroringCollectorRule, error)
    public static UllMirroringCollectorRule Get(string name, Input<string> id, UllMirroringCollectorRuleState? state, CustomResourceOptions? opts = null)
    public static UllMirroringCollectorRule get(String name, Output<String> id, UllMirroringCollectorRuleState state, CustomResourceOptions options)
    resources:  _:    type: gcp:networksecurity:UllMirroringCollectorRule    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:
    CreateTime string
    [Output only] Create time stamp
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels Dictionary<string, string>
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Match UllMirroringCollectorRuleMatch
    Match defines what traffic to mirror. Structure is documented below.
    Name string
    Identifier. The name of the UllMirroringCollectorRule.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Reconciling bool
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    UllMirroringCollector string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    UllMirroringCollectorRuleId string
    ID for the new UllMirroringCollectorRule.
    UpdateTime string
    [Output only] Update time stamp
    CreateTime string
    [Output only] Create time stamp
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels map[string]string
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Match UllMirroringCollectorRuleMatchArgs
    Match defines what traffic to mirror. Structure is documented below.
    Name string
    Identifier. The name of the UllMirroringCollectorRule.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Reconciling bool
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    UllMirroringCollector string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    UllMirroringCollectorRuleId string
    ID for the new UllMirroringCollectorRule.
    UpdateTime string
    [Output only] Update time stamp
    createTime String
    [Output only] Create time stamp
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String,String>
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    match UllMirroringCollectorRuleMatch
    Match defines what traffic to mirror. Structure is documented below.
    name String
    Identifier. The name of the UllMirroringCollectorRule.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling Boolean
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    ullMirroringCollector String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    ullMirroringCollectorRuleId String
    ID for the new UllMirroringCollectorRule.
    updateTime String
    [Output only] Update time stamp
    createTime string
    [Output only] Create time stamp
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels {[key: string]: string}
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    match UllMirroringCollectorRuleMatch
    Match defines what traffic to mirror. Structure is documented below.
    name string
    Identifier. The name of the UllMirroringCollectorRule.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling boolean
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    ullMirroringCollector string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    ullMirroringCollectorRuleId string
    ID for the new UllMirroringCollectorRule.
    updateTime string
    [Output only] Update time stamp
    create_time str
    [Output only] Create time stamp
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Mapping[str, str]
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    match UllMirroringCollectorRuleMatchArgs
    Match defines what traffic to mirror. Structure is documented below.
    name str
    Identifier. The name of the UllMirroringCollectorRule.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling bool
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    ull_mirroring_collector str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    ull_mirroring_collector_rule_id str
    ID for the new UllMirroringCollectorRule.
    update_time str
    [Output only] Update time stamp
    createTime String
    [Output only] Create time stamp
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String>
    Labels as key value pairs Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    match Property Map
    Match defines what traffic to mirror. Structure is documented below.
    name String
    Identifier. The name of the UllMirroringCollectorRule.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling Boolean
    Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    ullMirroringCollector String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    ullMirroringCollectorRuleId String
    ID for the new UllMirroringCollectorRule.
    updateTime String
    [Output only] Update time stamp

    Supporting Types

    UllMirroringCollectorRuleMatch, UllMirroringCollectorRuleMatchArgs

    Direction string
    Direction of traffic to match. When unset, matches any direction. Possible values: INGRESS: Traffic inbound to the capture point. EGRESS: Traffic outbound from the capture point.
    DstIpRanges List<string>
    Destination IP ranges to match. When unset, matches any destination IP range.
    IpProtocols List<string>
    IP protocols to match. When unset, matches any IP protocol. Examples: "tcp", "udp", "icmp". If unset, matches any IP protocol.
    SrcIpRanges List<string>
    Source IP ranges to match. When unset, matches any source IP range.
    Direction string
    Direction of traffic to match. When unset, matches any direction. Possible values: INGRESS: Traffic inbound to the capture point. EGRESS: Traffic outbound from the capture point.
    DstIpRanges []string
    Destination IP ranges to match. When unset, matches any destination IP range.
    IpProtocols []string
    IP protocols to match. When unset, matches any IP protocol. Examples: "tcp", "udp", "icmp". If unset, matches any IP protocol.
    SrcIpRanges []string
    Source IP ranges to match. When unset, matches any source IP range.
    direction String
    Direction of traffic to match. When unset, matches any direction. Possible values: INGRESS: Traffic inbound to the capture point. EGRESS: Traffic outbound from the capture point.
    dstIpRanges List<String>
    Destination IP ranges to match. When unset, matches any destination IP range.
    ipProtocols List<String>
    IP protocols to match. When unset, matches any IP protocol. Examples: "tcp", "udp", "icmp". If unset, matches any IP protocol.
    srcIpRanges List<String>
    Source IP ranges to match. When unset, matches any source IP range.
    direction string
    Direction of traffic to match. When unset, matches any direction. Possible values: INGRESS: Traffic inbound to the capture point. EGRESS: Traffic outbound from the capture point.
    dstIpRanges string[]
    Destination IP ranges to match. When unset, matches any destination IP range.
    ipProtocols string[]
    IP protocols to match. When unset, matches any IP protocol. Examples: "tcp", "udp", "icmp". If unset, matches any IP protocol.
    srcIpRanges string[]
    Source IP ranges to match. When unset, matches any source IP range.
    direction str
    Direction of traffic to match. When unset, matches any direction. Possible values: INGRESS: Traffic inbound to the capture point. EGRESS: Traffic outbound from the capture point.
    dst_ip_ranges Sequence[str]
    Destination IP ranges to match. When unset, matches any destination IP range.
    ip_protocols Sequence[str]
    IP protocols to match. When unset, matches any IP protocol. Examples: "tcp", "udp", "icmp". If unset, matches any IP protocol.
    src_ip_ranges Sequence[str]
    Source IP ranges to match. When unset, matches any source IP range.
    direction String
    Direction of traffic to match. When unset, matches any direction. Possible values: INGRESS: Traffic inbound to the capture point. EGRESS: Traffic outbound from the capture point.
    dstIpRanges List<String>
    Destination IP ranges to match. When unset, matches any destination IP range.
    ipProtocols List<String>
    IP protocols to match. When unset, matches any IP protocol. Examples: "tcp", "udp", "icmp". If unset, matches any IP protocol.
    srcIpRanges List<String>
    Source IP ranges to match. When unset, matches any source IP range.

    Import

    UllMirroringCollectorRule can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/ullMirroringCollectors/{{ull_mirroring_collector}}/rules/{{ull_mirroring_collector_rule_id}}
    • {{project}}/{{location}}/{{ull_mirroring_collector}}/{{ull_mirroring_collector_rule_id}}
    • {{location}}/{{ull_mirroring_collector}}/{{ull_mirroring_collector_rule_id}}

    When using the pulumi import command, UllMirroringCollectorRule can be imported using one of the formats above. For example:

    $ pulumi import gcp:networksecurity/ullMirroringCollectorRule:UllMirroringCollectorRule default projects/{{project}}/locations/{{location}}/ullMirroringCollectors/{{ull_mirroring_collector}}/rules/{{ull_mirroring_collector_rule_id}}
$ pulumi import gcp:networksecurity/ullMirroringCollectorRule:UllMirroringCollectorRule default {{project}}/{{location}}/{{ull_mirroring_collector}}/{{ull_mirroring_collector_rule_id}}
$ pulumi import gcp:networksecurity/ullMirroringCollectorRule:UllMirroringCollectorRule default {{location}}/{{ull_mirroring_collector}}/{{ull_mirroring_collector_rule_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.23.0
    published on Thursday, May 7, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp
      Try Pulumi Cloud free. Your team will thank you.