MirroringEndpointGroup class

An endpoint group is a consumer frontend for a deployment group (backend). In order to configure mirroring for a network, consumers must create:

• An association between their network and the endpoint group.
• A security profile that points to the endpoint group.
• A mirroring rule that references the security profile (group).

To get more information about MirroringEndpointGroup, see:

• API documentation
• How-to Guides
• Mirroring endpoint group overview

Example Usage

Network Security Mirroring Endpoint Group 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 _default = new gcp.networksecurity.MirroringEndpointGroup("default", {
    mirroringEndpointGroupId: "example-eg",
    location: "global",
    mirroringDeploymentGroup: deploymentGroup.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)
default = gcp.networksecurity.MirroringEndpointGroup("default",
    mirroring_endpoint_group_id="example-eg",
    location="global",
    mirroring_deployment_group=deployment_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 @default = new Gcp.NetworkSecurity.MirroringEndpointGroup("default", new()
    {
        MirroringEndpointGroupId = "example-eg",
        Location = "global",
        MirroringDeploymentGroup = deploymentGroup.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
		}
		_, err = networksecurity.NewMirroringEndpointGroup(ctx, "default", &networksecurity.MirroringEndpointGroupArgs{
			MirroringEndpointGroupId: pulumi.String("example-eg"),
			Location:                 pulumi.String("global"),
			MirroringDeploymentGroup: deploymentGroup.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" "default" {
  mirroring_endpoint_group_id = "example-eg"
  location                    = "global"
  mirroring_deployment_group  = gcp_networksecurity_mirroringdeploymentgroup.deployment_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 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 default_ = new MirroringEndpointGroup("default", MirroringEndpointGroupArgs.builder()
            .mirroringEndpointGroupId("example-eg")
            .location("global")
            .mirroringDeploymentGroup(deploymentGroup.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}
  default:
    type: gcp:networksecurity:MirroringEndpointGroup
    properties:
      mirroringEndpointGroupId: example-eg
      location: global
      mirroringDeploymentGroup: ${deploymentGroup.id}
      description: some description
      labels:
        foo: bar

Network Security Mirroring Endpoint Group Broker 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 _default = new gcp.networksecurity.MirroringEndpointGroup("default", {
    mirroringEndpointGroupId: "example-eg",
    location: "global",
    type: "BROKER",
    mirroringDeploymentGroups: [deploymentGroup.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)
default = gcp.networksecurity.MirroringEndpointGroup("default",
    mirroring_endpoint_group_id="example-eg",
    location="global",
    type="BROKER",
    mirroring_deployment_groups=[deployment_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 @default = new Gcp.NetworkSecurity.MirroringEndpointGroup("default", new()
    {
        MirroringEndpointGroupId = "example-eg",
        Location = "global",
        Type = "BROKER",
        MirroringDeploymentGroups = new[]
        {
            deploymentGroup.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
		}
		_, err = networksecurity.NewMirroringEndpointGroup(ctx, "default", &networksecurity.MirroringEndpointGroupArgs{
			MirroringEndpointGroupId: pulumi.String("example-eg"),
			Location:                 pulumi.String("global"),
			Type:                     pulumi.String("BROKER"),
			MirroringDeploymentGroups: pulumi.StringArray{
				deploymentGroup.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" "default" {
  mirroring_endpoint_group_id = "example-eg"
  location                    = "global"
  type                        = "BROKER"
  mirroring_deployment_groups = [gcp_networksecurity_mirroringdeploymentgroup.deployment_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 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 default_ = new MirroringEndpointGroup("default", MirroringEndpointGroupArgs.builder()
            .mirroringEndpointGroupId("example-eg")
            .location("global")
            .type("BROKER")
            .mirroringDeploymentGroups(deploymentGroup.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}
  default:
    type: gcp:networksecurity:MirroringEndpointGroup
    properties:
      mirroringEndpointGroupId: example-eg
      location: global
      type: BROKER
      mirroringDeploymentGroups:
        - ${deploymentGroup.id}
      description: some description
      labels:
        foo: bar

Import

MirroringEndpointGroup can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/mirroringEndpointGroups/{{mirroring_endpoint_group_id}}
• {{project}}/{{location}}/{{mirroring_endpoint_group_id}}
• {{location}}/{{mirroring_endpoint_group_id}}

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

$ pulumi import gcp:networksecurity/mirroringEndpointGroup:MirroringEndpointGroup default projects/{{project}}/locations/{{location}}/mirroringEndpointGroups/{{mirroring_endpoint_group_id}}
$ pulumi import gcp:networksecurity/mirroringEndpointGroup:MirroringEndpointGroup default {{project}}/{{location}}/{{mirroring_endpoint_group_id}}
$ pulumi import gcp:networksecurity/mirroringEndpointGroup:MirroringEndpointGroup default {{location}}/{{mirroring_endpoint_group_id}}

Constructors

MirroringEndpointGroup(String name, {MirroringEndpointGroupArgs? args, CustomResourceOptions? options})

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

MirroringEndpointGroup.reference(String urn)

Creates a typed reference to an existing MirroringEndpointGroup resource.

Properties

associations ↔ Output<List<MirroringEndpointGroupAssociation>>

List of associations to this endpoint group. Structure is documented below.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

connectedDeploymentGroups ↔ Output<List<MirroringEndpointGroupConnectedDeploymentGroup>>

List of details about the connected deployment groups to this endpoint group. Structure is documented below.

late, final

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 group. Used as additional context for the endpoint group.

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 group, currently restricted to global.

late, final

mirroringDeploymentGroup ↔ Output<String?>

The deployment group that this DIRECT endpoint group is connected to, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg. See https://google.aip.dev/124.

late, final

mirroringDeploymentGroups ↔ Output<List<String>?>

A list of the deployment groups that this BROKER endpoint group is connected to, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg. See https://google.aip.dev/124.

late, final

mirroringEndpointGroupId ↔ Output<String>

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

late, final

name ↔ Output<String>

(Output) The connected deployment group's resource name, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg. See https://google.aip.dev/124.

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 is part of the normal operation (e.g. adding a new association to the 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>

(Output) The current state of the association in this location. Possible values: STATE_UNSPECIFIED ACTIVE OUT_OF_SYNC

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String?>

The type of the endpoint group. If left unspecified, defaults to DIRECT. Possible values: DIRECT BROKER

late, final

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, {MirroringEndpointGroupState? state, CustomResourceOptions? options}) → MirroringEndpointGroup

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