MirroringEndpoint class

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",
    })

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 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().ToIDOutput().ToStringOutput(),
		})
		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().ToIDOutput().ToStringOutput(),
			},
		})
		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().ToIDOutput().ToStringOutput(),
			Description:            pulumi.String("some description"),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_network" "network" {
  name                    = "example-network"
  auto_create_subnetworks = false
}
resource "gcp_networksecurity_mirroringdeploymentgroup" "deployment_group" {
  mirroring_deployment_group_id = "example-dg"
  location                      = "global"
  network                       = gcp_compute_network.network.id
}
resource "gcp_networksecurity_mirroringendpointgroup" "endpoint_group" {
  mirroring_endpoint_group_id = "example-eg"
  location                    = "global"
  type                        = "BROKER"
  mirroring_deployment_groups = [gcp_networksecurity_mirroringdeploymentgroup.deployment_group.id]
}
resource "gcp_networksecurity_mirroringendpoint" "default" {
  mirroring_endpoint_id    = "example-endpoint"
  location                 = "us-west2-a"
  mirroring_endpoint_group = gcp_networksecurity_mirroringendpointgroup.endpoint_group.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.ArrayList;
import java.util.Arrays;
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

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}}

Constructors

MirroringEndpoint(String name, {MirroringEndpointArgs? args, CustomResourceOptions? options})

Creates a new MirroringEndpoint. name The Pulumi resource name. args Arguments used to configure this MirroringEndpoint. The set of arguments for MirroringEndpoint. options Resource options controlling this resource's behavior.

MirroringEndpoint.reference(String urn)

Creates a typed reference to an existing MirroringEndpoint resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

User-provided description of the endpoint. Used as additional context for the endpoint.

late, final

effectiveLabels ↔ Output<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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<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 effectiveLabels for all of the labels present on the resource.

late, final

location ↔ Output<String>

The cloud location of the endpoint, e.g. us-central1-a or asia-south1-b.

late, final

mirroringEndpointGroup ↔ Output<String>

The endpoint group that this endpoint belongs to. Format is: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroringEndpointGroup}

late, final

mirroringEndpointId ↔ Output<String>

The ID to use for the new endpoint, which will become the final component of the endpoint's resource name.

late, final

name ↔ Output<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.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

reconciling ↔ Output<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.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<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

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {MirroringEndpointState? state, CustomResourceOptions? options}) → MirroringEndpoint

Gets an existing MirroringEndpoint resource's state with the given name and id.