1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. networksecurity
  5. MirroringEndpoint
Google Cloud v9.5.0 published on Monday, Nov 17, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.networksecurity.MirroringEndpoint

gcp logo
Google Cloud v9.5.0 published on Monday, Nov 17, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    An endpoint is a managed mirroring collector that provides enhanced packet enrichment capabilities and support for multiple replica destinations. Endpoints are always part of a global endpoint group which represents a global “mirroring broker” service.

    Example Usage

    Network Security Mirroring Endpoint 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 deploymentGroup = new gcp.networksecurity.MirroringDeploymentGroup("deployment_group", {
    mirroringDeploymentGroupId: "example-dg",
    location: "global",
    network: network.id,
});
const endpointGroup = new gcp.networksecurity.MirroringEndpointGroup("endpoint_group", {
    mirroringEndpointGroupId: "example-eg",
    location: "global",
    type: "BROKER",
    mirroringDeploymentGroups: [deploymentGroup.id],
});
const _default = new gcp.networksecurity.MirroringEndpoint("default", {
    mirroringEndpointId: "example-endpoint",
    location: "us-west2-a",
    mirroringEndpointGroup: endpointGroup.id,
    description: "some description",
    labels: {
        foo: "bar",
    },
});

    import pulumi
import pulumi_gcp as gcp

network = gcp.compute.Network("network",
    name="example-network",
    auto_create_subnetworks=False)
deployment_group = gcp.networksecurity.MirroringDeploymentGroup("deployment_group",
    mirroring_deployment_group_id="example-dg",
    location="global",
    network=network.id)
endpoint_group = gcp.networksecurity.MirroringEndpointGroup("endpoint_group",
    mirroring_endpoint_group_id="example-eg",
    location="global",
    type="BROKER",
    mirroring_deployment_groups=[deployment_group.id])
default = gcp.networksecurity.MirroringEndpoint("default",
    mirroring_endpoint_id="example-endpoint",
    location="us-west2-a",
    mirroring_endpoint_group=endpoint_group.id,
    description="some description",
    labels={
        "foo": "bar",
    })

    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
		}
		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
		}
		endpointGroup, err := networksecurity.NewMirroringEndpointGroup(ctx, "endpoint_group", &networksecurity.MirroringEndpointGroupArgs{
			MirroringEndpointGroupId: pulumi.String("example-eg"),
			Location:                 pulumi.String("global"),
			Type:                     pulumi.String("BROKER"),
			MirroringDeploymentGroups: pulumi.StringArray{
				deploymentGroup.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = networksecurity.NewMirroringEndpoint(ctx, "default", &networksecurity.MirroringEndpointArgs{
			MirroringEndpointId:    pulumi.String("example-endpoint"),
			Location:               pulumi.String("us-west2-a"),
			MirroringEndpointGroup: endpointGroup.ID(),
			Description:            pulumi.String("some description"),
			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 deploymentGroup = new Gcp.NetworkSecurity.MirroringDeploymentGroup("deployment_group", new()
    {
        MirroringDeploymentGroupId = "example-dg",
        Location = "global",
        Network = network.Id,
    });

    var endpointGroup = new Gcp.NetworkSecurity.MirroringEndpointGroup("endpoint_group", new()
    {
        MirroringEndpointGroupId = "example-eg",
        Location = "global",
        Type = "BROKER",
        MirroringDeploymentGroups = new[]
        {
            deploymentGroup.Id,
        },
    });

    var @default = new Gcp.NetworkSecurity.MirroringEndpoint("default", new()
    {
        MirroringEndpointId = "example-endpoint",
        Location = "us-west2-a",
        MirroringEndpointGroup = endpointGroup.Id,
        Description = "some description",
        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.networksecurity.MirroringDeploymentGroup;
import com.pulumi.gcp.networksecurity.MirroringDeploymentGroupArgs;
import com.pulumi.gcp.networksecurity.MirroringEndpointGroup;
import com.pulumi.gcp.networksecurity.MirroringEndpointGroupArgs;
import com.pulumi.gcp.networksecurity.MirroringEndpoint;
import com.pulumi.gcp.networksecurity.MirroringEndpointArgs;
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 deploymentGroup = new MirroringDeploymentGroup("deploymentGroup", MirroringDeploymentGroupArgs.builder()
            .mirroringDeploymentGroupId("example-dg")
            .location("global")
            .network(network.id())
            .build());

        var endpointGroup = new MirroringEndpointGroup("endpointGroup", MirroringEndpointGroupArgs.builder()
            .mirroringEndpointGroupId("example-eg")
            .location("global")
            .type("BROKER")
            .mirroringDeploymentGroups(deploymentGroup.id())
            .build());

        var default_ = new MirroringEndpoint("default", MirroringEndpointArgs.builder()
            .mirroringEndpointId("example-endpoint")
            .location("us-west2-a")
            .mirroringEndpointGroup(endpointGroup.id())
            .description("some description")
            .labels(Map.of("foo", "bar"))
            .build());

    }
}

    resources:
  network:
    type: gcp:compute:Network
    properties:
      name: example-network
      autoCreateSubnetworks: false
  deploymentGroup:
    type: gcp:networksecurity:MirroringDeploymentGroup
    name: deployment_group
    properties:
      mirroringDeploymentGroupId: example-dg
      location: global
      network: ${network.id}
  endpointGroup:
    type: gcp:networksecurity:MirroringEndpointGroup
    name: endpoint_group
    properties:
      mirroringEndpointGroupId: example-eg
      location: global
      type: BROKER
      mirroringDeploymentGroups:
        - ${deploymentGroup.id}
  default:
    type: gcp:networksecurity:MirroringEndpoint
    properties:
      mirroringEndpointId: example-endpoint
      location: us-west2-a
      mirroringEndpointGroup: ${endpointGroup.id}
      description: some description
      labels:
        foo: bar

    Create MirroringEndpoint Resource

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

    Constructor syntax

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

@overload
def MirroringEndpoint(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      location: Optional[str] = None,
                      mirroring_endpoint_group: Optional[str] = None,
                      mirroring_endpoint_id: Optional[str] = None,
                      description: Optional[str] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      project: Optional[str] = None)
    func NewMirroringEndpoint(ctx *Context, name string, args MirroringEndpointArgs, opts ...ResourceOption) (*MirroringEndpoint, error)
    public MirroringEndpoint(string name, MirroringEndpointArgs args, CustomResourceOptions? opts = null)
    public MirroringEndpoint(String name, MirroringEndpointArgs args)
public MirroringEndpoint(String name, MirroringEndpointArgs args, CustomResourceOptions options)

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

    example, err := networksecurity.NewMirroringEndpoint(ctx, "mirroringEndpointResource", &networksecurity.MirroringEndpointArgs{
	Location:               pulumi.String("string"),
	MirroringEndpointGroup: pulumi.String("string"),
	MirroringEndpointId:    pulumi.String("string"),
	Description:            pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var mirroringEndpointResource = new MirroringEndpoint("mirroringEndpointResource", MirroringEndpointArgs.builder()
    .location("string")
    .mirroringEndpointGroup("string")
    .mirroringEndpointId("string")
    .description("string")
    .labels(Map.of("string", "string"))
    .project("string")
    .build());

    mirroring_endpoint_resource = gcp.networksecurity.MirroringEndpoint("mirroringEndpointResource",
    location="string",
    mirroring_endpoint_group="string",
    mirroring_endpoint_id="string",
    description="string",
    labels={
        "string": "string",
    },
    project="string")

    const mirroringEndpointResource = new gcp.networksecurity.MirroringEndpoint("mirroringEndpointResource", {
    location: "string",
    mirroringEndpointGroup: "string",
    mirroringEndpointId: "string",
    description: "string",
    labels: {
        string: "string",
    },
    project: "string",
});

    type: gcp:networksecurity:MirroringEndpoint
properties:
    description: string
    labels:
        string: string
    location: string
    mirroringEndpointGroup: string
    mirroringEndpointId: string
    project: string

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

    Location string
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    MirroringEndpointGroup string
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    MirroringEndpointId string
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    Description string
    User-provided description of the endpoint. Used as additional context for the endpoint.
    Labels Dictionary<string, string>
    Labels are key/value pairs that help to organize and filter resources. 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.
    Location string
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    MirroringEndpointGroup string
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    MirroringEndpointId string
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    Description string
    User-provided description of the endpoint. Used as additional context for the endpoint.
    Labels map[string]string
    Labels are key/value pairs that help to organize and filter resources. 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.
    location String
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    mirroringEndpointGroup String
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    mirroringEndpointId String
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    description String
    User-provided description of the endpoint. Used as additional context for the endpoint.
    labels Map<String,String>
    Labels are key/value pairs that help to organize and filter resources. 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.
    location string
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    mirroringEndpointGroup string
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    mirroringEndpointId string
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    description string
    User-provided description of the endpoint. Used as additional context for the endpoint.
    labels {[key: string]: string}
    Labels are key/value pairs that help to organize and filter resources. 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.
    location str
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    mirroring_endpoint_group str
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    mirroring_endpoint_id str
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    description str
    User-provided description of the endpoint. Used as additional context for the endpoint.
    labels Mapping[str, str]
    Labels are key/value pairs that help to organize and filter resources. 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.
    location String
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    mirroringEndpointGroup String
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    mirroringEndpointId String
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    description String
    User-provided description of the endpoint. Used as additional context for the endpoint.
    labels Map<String>
    Labels are key/value pairs that help to organize and filter resources. 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 MirroringEndpoint resource produces the following output properties:

    CreateTime string
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    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
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Reconciling bool
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    State string
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    UpdateTime string
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    CreateTime string
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    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
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Reconciling bool
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    State string
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    UpdateTime string
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    createTime String
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    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
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling Boolean
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    state String
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    updateTime String
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    createTime string
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    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
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling boolean
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    state string
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    updateTime string
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    create_time str
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    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
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling bool
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    state str
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    update_time str
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    createTime String
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    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
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reconciling Boolean
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    state String
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    updateTime String
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

    Look up Existing MirroringEndpoint Resource

    Get an existing MirroringEndpoint 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?: MirroringEndpointState, opts?: CustomResourceOptions): MirroringEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        mirroring_endpoint_group: Optional[str] = None,
        mirroring_endpoint_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) -> MirroringEndpoint
    func GetMirroringEndpoint(ctx *Context, name string, id IDInput, state *MirroringEndpointState, opts ...ResourceOption) (*MirroringEndpoint, error)
    public static MirroringEndpoint Get(string name, Input<string> id, MirroringEndpointState? state, CustomResourceOptions? opts = null)
    public static MirroringEndpoint get(String name, Output<String> id, MirroringEndpointState state, CustomResourceOptions options)
    resources:  _:    type: gcp:networksecurity:MirroringEndpoint    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
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    Description string
    User-provided description of the endpoint. Used as additional context for the endpoint.
    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 are key/value pairs that help to organize and filter resources. 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
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    MirroringEndpointGroup string
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    MirroringEndpointId string
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    Name string
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    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
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    State string
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    UpdateTime string
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    CreateTime string
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    Description string
    User-provided description of the endpoint. Used as additional context for the endpoint.
    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 are key/value pairs that help to organize and filter resources. 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
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    MirroringEndpointGroup string
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    MirroringEndpointId string
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    Name string
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    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
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    State string
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    UpdateTime string
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    createTime String
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    description String
    User-provided description of the endpoint. Used as additional context for the endpoint.
    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 are key/value pairs that help to organize and filter resources. 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
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    mirroringEndpointGroup String
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    mirroringEndpointId String
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    name String
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    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
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    state String
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    updateTime String
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    createTime string
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    description string
    User-provided description of the endpoint. Used as additional context for the endpoint.
    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 are key/value pairs that help to organize and filter resources. 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
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    mirroringEndpointGroup string
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    mirroringEndpointId string
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    name string
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    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
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    state string
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    updateTime string
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    create_time str
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    description str
    User-provided description of the endpoint. Used as additional context for the endpoint.
    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 are key/value pairs that help to organize and filter resources. 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
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    mirroring_endpoint_group str
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    mirroring_endpoint_id str
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    name str
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    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
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    state str
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    update_time str
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
    createTime String
    The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.
    description String
    User-provided description of the endpoint. Used as additional context for the endpoint.
    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 are key/value pairs that help to organize and filter resources. 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
    The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.
    mirroringEndpointGroup String
    The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}
    mirroringEndpointId String
    The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.
    name String
    The resource name of this endpoint, for example: projects/123456789/locations/us-central1-a/mirroringEndpoints/my-endpoint. See https://google.aip.dev/122 for more details.
    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
    The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.
    state String
    The current state of the endpoint. See https://google.aip.dev/216. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DELETE_FAILED OUT_OF_SYNC
    updateTime String
    The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

    Import

    MirroringEndpoint can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/mirroringEndpoints/{{mirroring_endpoint_id}}

    • {{project}}/{{location}}/{{mirroring_endpoint_id}}

    • {{location}}/{{mirroring_endpoint_id}}

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

    $ pulumi import gcp:networksecurity/mirroringEndpoint:MirroringEndpoint default projects/{{project}}/locations/{{location}}/mirroringEndpoints/{{mirroring_endpoint_id}}

    $ pulumi import gcp:networksecurity/mirroringEndpoint:MirroringEndpoint default {{project}}/{{location}}/{{mirroring_endpoint_id}}

    $ pulumi import gcp:networksecurity/mirroringEndpoint:MirroringEndpoint default {{location}}/{{mirroring_endpoint_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 v9.5.0 published on Monday, Nov 17, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp
      Meet Neo: Your AI Platform Teammate