Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. networksecurity
  5. MirroringDeployment
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.networksecurity.MirroringDeployment

Explore with Pulumi AI

gcp logo
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

    Example Usage

    Network Security Mirroring Deployment 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-central1",
    ipCidrRange: "10.1.0.0/16",
    network: network.name,
});
const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
    name: "example-hc",
    region: "us-central1",
    httpHealthCheck: {
        port: 80,
    },
});
const backendService = new gcp.compute.RegionBackendService("backend_service", {
    name: "example-bs",
    region: "us-central1",
    healthChecks: healthCheck.id,
    protocol: "UDP",
    loadBalancingScheme: "INTERNAL",
});
const forwardingRule = new gcp.compute.ForwardingRule("forwarding_rule", {
    name: "example-fwr",
    region: "us-central1",
    network: network.name,
    subnetwork: subnetwork.name,
    backendService: backendService.id,
    loadBalancingScheme: "INTERNAL",
    ports: ["6081"],
    ipProtocol: "UDP",
    isMirroringCollector: true,
});
const deploymentGroup = new gcp.networksecurity.MirroringDeploymentGroup("deployment_group", {
    mirroringDeploymentGroupId: "example-dg",
    location: "global",
    network: network.id,
});
const _default = new gcp.networksecurity.MirroringDeployment("default", {
    mirroringDeploymentId: "example-deployment",
    location: "us-central1-a",
    forwardingRule: forwardingRule.id,
    mirroringDeploymentGroup: deploymentGroup.id,
    labels: {
        foo: "bar",
    },
});

    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-central1",
    ip_cidr_range="10.1.0.0/16",
    network=network.name)
health_check = gcp.compute.RegionHealthCheck("health_check",
    name="example-hc",
    region="us-central1",
    http_health_check={
        "port": 80,
    })
backend_service = gcp.compute.RegionBackendService("backend_service",
    name="example-bs",
    region="us-central1",
    health_checks=health_check.id,
    protocol="UDP",
    load_balancing_scheme="INTERNAL")
forwarding_rule = gcp.compute.ForwardingRule("forwarding_rule",
    name="example-fwr",
    region="us-central1",
    network=network.name,
    subnetwork=subnetwork.name,
    backend_service=backend_service.id,
    load_balancing_scheme="INTERNAL",
    ports=["6081"],
    ip_protocol="UDP",
    is_mirroring_collector=True)
deployment_group = gcp.networksecurity.MirroringDeploymentGroup("deployment_group",
    mirroring_deployment_group_id="example-dg",
    location="global",
    network=network.id)
default = gcp.networksecurity.MirroringDeployment("default",
    mirroring_deployment_id="example-deployment",
    location="us-central1-a",
    forwarding_rule=forwarding_rule.id,
    mirroring_deployment_group=deployment_group.id,
    labels={
        "foo": "bar",
    })

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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-central1"),
			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-central1"),
			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-central1"),
			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-central1"),
			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
		}
		deploymentGroup, err := networksecurity.NewMirroringDeploymentGroup(ctx, "deployment_group", &networksecurity.MirroringDeploymentGroupArgs{
			MirroringDeploymentGroupId: pulumi.String("example-dg"),
			Location:                   pulumi.String("global"),
			Network:                    network.ID(),
		})
		if err != nil {
			return err
		}
		_, err = networksecurity.NewMirroringDeployment(ctx, "default", &networksecurity.MirroringDeploymentArgs{
			MirroringDeploymentId:    pulumi.String("example-deployment"),
			Location:                 pulumi.String("us-central1-a"),
			ForwardingRule:           forwardingRule.ID(),
			MirroringDeploymentGroup: deploymentGroup.ID(),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		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-central1",
        IpCidrRange = "10.1.0.0/16",
        Network = network.Name,
    });

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

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

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

    var deploymentGroup = new Gcp.NetworkSecurity.MirroringDeploymentGroup("deployment_group", new()
    {
        MirroringDeploymentGroupId = "example-dg",
        Location = "global",
        Network = network.Id,
    });

    var @default = new Gcp.NetworkSecurity.MirroringDeployment("default", new()
    {
        MirroringDeploymentId = "example-deployment",
        Location = "us-central1-a",
        ForwardingRule = forwardingRule.Id,
        MirroringDeploymentGroup = deploymentGroup.Id,
        Labels = 
        {
            { "foo", "bar" },
        },
    });

});

    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.MirroringDeploymentGroup;
import com.pulumi.gcp.networksecurity.MirroringDeploymentGroupArgs;
import com.pulumi.gcp.networksecurity.MirroringDeployment;
import com.pulumi.gcp.networksecurity.MirroringDeploymentArgs;
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-central1")
            .ipCidrRange("10.1.0.0/16")
            .network(network.name())
            .build());

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

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

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

        var deploymentGroup = new MirroringDeploymentGroup("deploymentGroup", MirroringDeploymentGroupArgs.builder()
            .mirroringDeploymentGroupId("example-dg")
            .location("global")
            .network(network.id())
            .build());

        var default_ = new MirroringDeployment("default", MirroringDeploymentArgs.builder()
            .mirroringDeploymentId("example-deployment")
            .location("us-central1-a")
            .forwardingRule(forwardingRule.id())
            .mirroringDeploymentGroup(deploymentGroup.id())
            .labels(Map.of("foo", "bar"))
            .build());

    }
}

    resources:
  network:
    type: gcp:compute:Network
    properties:
      name: example-network
      autoCreateSubnetworks: false
  subnetwork:
    type: gcp:compute:Subnetwork
    properties:
      name: example-subnet
      region: us-central1
      ipCidrRange: 10.1.0.0/16
      network: ${network.name}
  healthCheck:
    type: gcp:compute:RegionHealthCheck
    name: health_check
    properties:
      name: example-hc
      region: us-central1
      httpHealthCheck:
        port: 80
  backendService:
    type: gcp:compute:RegionBackendService
    name: backend_service
    properties:
      name: example-bs
      region: us-central1
      healthChecks: ${healthCheck.id}
      protocol: UDP
      loadBalancingScheme: INTERNAL
  forwardingRule:
    type: gcp:compute:ForwardingRule
    name: forwarding_rule
    properties:
      name: example-fwr
      region: us-central1
      network: ${network.name}
      subnetwork: ${subnetwork.name}
      backendService: ${backendService.id}
      loadBalancingScheme: INTERNAL
      ports:
        - 6081
      ipProtocol: UDP
      isMirroringCollector: true
  deploymentGroup:
    type: gcp:networksecurity:MirroringDeploymentGroup
    name: deployment_group
    properties:
      mirroringDeploymentGroupId: example-dg
      location: global
      network: ${network.id}
  default:
    type: gcp:networksecurity:MirroringDeployment
    properties:
      mirroringDeploymentId: example-deployment
      location: us-central1-a
      forwardingRule: ${forwardingRule.id}
      mirroringDeploymentGroup: ${deploymentGroup.id}
      labels:
        foo: bar

    Create MirroringDeployment Resource

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

    Constructor syntax

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

@overload
def MirroringDeployment(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        forwarding_rule: Optional[str] = None,
                        location: Optional[str] = None,
                        mirroring_deployment_group: Optional[str] = None,
                        mirroring_deployment_id: Optional[str] = None,
                        labels: Optional[Mapping[str, str]] = None,
                        project: Optional[str] = None)
    func NewMirroringDeployment(ctx *Context, name string, args MirroringDeploymentArgs, opts ...ResourceOption) (*MirroringDeployment, error)
    public MirroringDeployment(string name, MirroringDeploymentArgs args, CustomResourceOptions? opts = null)
    public MirroringDeployment(String name, MirroringDeploymentArgs args)
public MirroringDeployment(String name, MirroringDeploymentArgs args, CustomResourceOptions options)

    type: gcp:networksecurity:MirroringDeployment
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 MirroringDeploymentArgs
    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 MirroringDeploymentArgs
    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 MirroringDeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MirroringDeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MirroringDeploymentArgs
    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 mirroringDeploymentResource = new Gcp.NetworkSecurity.MirroringDeployment("mirroringDeploymentResource", new()
{
    ForwardingRule = "string",
    Location = "string",
    MirroringDeploymentGroup = "string",
    MirroringDeploymentId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});

    example, err := networksecurity.NewMirroringDeployment(ctx, "mirroringDeploymentResource", &networksecurity.MirroringDeploymentArgs{
	ForwardingRule:           pulumi.String("string"),
	Location:                 pulumi.String("string"),
	MirroringDeploymentGroup: pulumi.String("string"),
	MirroringDeploymentId:    pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var mirroringDeploymentResource = new MirroringDeployment("mirroringDeploymentResource", MirroringDeploymentArgs.builder()
    .forwardingRule("string")
    .location("string")
    .mirroringDeploymentGroup("string")
    .mirroringDeploymentId("string")
    .labels(Map.of("string", "string"))
    .project("string")
    .build());

    mirroring_deployment_resource = gcp.networksecurity.MirroringDeployment("mirroringDeploymentResource",
    forwarding_rule="string",
    location="string",
    mirroring_deployment_group="string",
    mirroring_deployment_id="string",
    labels={
        "string": "string",
    },
    project="string")

    const mirroringDeploymentResource = new gcp.networksecurity.MirroringDeployment("mirroringDeploymentResource", {
    forwardingRule: "string",
    location: "string",
    mirroringDeploymentGroup: "string",
    mirroringDeploymentId: "string",
    labels: {
        string: "string",
    },
    project: "string",
});

    type: gcp:networksecurity:MirroringDeployment
properties:
    forwardingRule: string
    labels:
        string: string
    location: string
    mirroringDeploymentGroup: string
    mirroringDeploymentId: string
    project: string

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

    ForwardingRule string
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    MirroringDeploymentGroup string
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    MirroringDeploymentId string
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    Labels Dictionary<string, string>
    Optional. 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 effective_labels 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.
    ForwardingRule string
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    MirroringDeploymentGroup string
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    MirroringDeploymentId string
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    Labels map[string]string
    Optional. 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 effective_labels 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.
    forwardingRule String
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    mirroringDeploymentGroup String
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    mirroringDeploymentId String
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    labels Map<String,String>
    Optional. 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 effective_labels 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.
    forwardingRule string
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    mirroringDeploymentGroup string
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    mirroringDeploymentId string
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    labels {[key: string]: string}
    Optional. 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 effective_labels 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.
    forwarding_rule str
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    mirroring_deployment_group str
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    mirroring_deployment_id str
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    labels Mapping[str, str]
    Optional. 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 effective_labels 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.
    forwardingRule String
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    mirroringDeploymentGroup String
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    mirroringDeploymentId String
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    labels Map<String>
    Optional. 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 effective_labels 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 MirroringDeployment resource produces the following output properties:

    CreateTime string
    Output only. [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
    Immutable. Identifier. The name of the MirroringDeployment.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Reconciling bool
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    State string
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    UpdateTime string
    Output only. [Output only] Update time stamp
    CreateTime string
    Output only. [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
    Immutable. Identifier. The name of the MirroringDeployment.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Reconciling bool
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    State string
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    UpdateTime string
    Output only. [Output only] Update time stamp
    createTime String
    Output only. [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
    Immutable. Identifier. The name of the MirroringDeployment.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling Boolean
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    state String
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    updateTime String
    Output only. [Output only] Update time stamp
    createTime string
    Output only. [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
    Immutable. Identifier. The name of the MirroringDeployment.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling boolean
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    state string
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    updateTime string
    Output only. [Output only] Update time stamp
    create_time str
    Output only. [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
    Immutable. Identifier. The name of the MirroringDeployment.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling bool
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    state str
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    update_time str
    Output only. [Output only] Update time stamp
    createTime String
    Output only. [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
    Immutable. Identifier. The name of the MirroringDeployment.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling Boolean
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    state String
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    updateTime String
    Output only. [Output only] Update time stamp

    Look up Existing MirroringDeployment Resource

    Get an existing MirroringDeployment 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?: MirroringDeploymentState, opts?: CustomResourceOptions): MirroringDeployment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        forwarding_rule: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        mirroring_deployment_group: Optional[str] = None,
        mirroring_deployment_id: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        reconciling: Optional[bool] = None,
        state: Optional[str] = None,
        update_time: Optional[str] = None) -> MirroringDeployment
    func GetMirroringDeployment(ctx *Context, name string, id IDInput, state *MirroringDeploymentState, opts ...ResourceOption) (*MirroringDeployment, error)
    public static MirroringDeployment Get(string name, Input<string> id, MirroringDeploymentState? state, CustomResourceOptions? opts = null)
    public static MirroringDeployment get(String name, Output<String> id, MirroringDeploymentState state, CustomResourceOptions options)
    resources:  _:    type: gcp:networksecurity:MirroringDeployment    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. [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.
    ForwardingRule string
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    Labels Dictionary<string, string>
    Optional. 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 effective_labels 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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    MirroringDeploymentGroup string
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    MirroringDeploymentId string
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    Name string
    Immutable. Identifier. The name of the MirroringDeployment.
    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
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    State string
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    UpdateTime string
    Output only. [Output only] Update time stamp
    CreateTime string
    Output only. [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.
    ForwardingRule string
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    Labels map[string]string
    Optional. 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 effective_labels 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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    MirroringDeploymentGroup string
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    MirroringDeploymentId string
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    Name string
    Immutable. Identifier. The name of the MirroringDeployment.
    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
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    State string
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    UpdateTime string
    Output only. [Output only] Update time stamp
    createTime String
    Output only. [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.
    forwardingRule String
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    labels Map<String,String>
    Optional. 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 effective_labels 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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    mirroringDeploymentGroup String
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    mirroringDeploymentId String
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    name String
    Immutable. Identifier. The name of the MirroringDeployment.
    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
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    state String
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    updateTime String
    Output only. [Output only] Update time stamp
    createTime string
    Output only. [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.
    forwardingRule string
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    labels {[key: string]: string}
    Optional. 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 effective_labels 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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    mirroringDeploymentGroup string
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    mirroringDeploymentId string
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    name string
    Immutable. Identifier. The name of the MirroringDeployment.
    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
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    state string
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    updateTime string
    Output only. [Output only] Update time stamp
    create_time str
    Output only. [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.
    forwarding_rule str
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    labels Mapping[str, str]
    Optional. 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 effective_labels 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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    mirroring_deployment_group str
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    mirroring_deployment_id str
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    name str
    Immutable. Identifier. The name of the MirroringDeployment.
    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
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    state str
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    update_time str
    Output only. [Output only] Update time stamp
    createTime String
    Output only. [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.
    forwardingRule String
    Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
    labels Map<String>
    Optional. 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 effective_labels 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. See documentation for resource type networksecurity.googleapis.com/MirroringDeployment.
    mirroringDeploymentGroup String
    Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}
    mirroringDeploymentId String
    Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC

    name String
    Immutable. Identifier. The name of the MirroringDeployment.
    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
    Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
    state String
    Output only. Current state of the deployment. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING OUT_OF_SYNC DELETE_FAILED
    updateTime String
    Output only. [Output only] Update time stamp

    Import

    MirroringDeployment can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/mirroringDeployments/{{mirroring_deployment_id}}

    • {{project}}/{{location}}/{{mirroring_deployment_id}}

    • {{location}}/{{mirroring_deployment_id}}

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

    $ pulumi import gcp:networksecurity/mirroringDeployment:MirroringDeployment default projects/{{project}}/locations/{{location}}/mirroringDeployments/{{mirroring_deployment_id}}

    $ pulumi import gcp:networksecurity/mirroringDeployment:MirroringDeployment default {{project}}/{{location}}/{{mirroring_deployment_id}}

    $ pulumi import gcp:networksecurity/mirroringDeployment:MirroringDeployment default {{location}}/{{mirroring_deployment_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
    Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
    pulumi/pulumi-gcp