pulumi-gcp-kotlin/com.pulumi.gcp.networksecurity.kotlin/MirroringEndpointGroupAssociation

MirroringEndpointGroupAssociation

class MirroringEndpointGroupAssociation : KotlinCustomResource

An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable mirroring by itself. To enable mirroring, the user must also create a network firewall policy containing mirroring rules and associate it with the network. To get more information about MirroringEndpointGroupAssociation, see:

API documentation
How-to Guides

Mirroring endpoint group association overview

Example Usage

Network Security Mirroring Endpoint Group Association Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const producerNetwork = new gcp.compute.Network("producer_network", {
    name: "example-prod-network",
    autoCreateSubnetworks: false,
});
const consumerNetwork = new gcp.compute.Network("consumer_network", {
    name: "example-cons-network",
    autoCreateSubnetworks: false,
});
const deploymentGroup = new gcp.networksecurity.MirroringDeploymentGroup("deployment_group", {
    mirroringDeploymentGroupId: "example-dg",
    location: "global",
    network: producerNetwork.id,
});
const endpointGroup = new gcp.networksecurity.MirroringEndpointGroup("endpoint_group", {
    mirroringEndpointGroupId: "example-eg",
    location: "global",
    mirroringDeploymentGroup: deploymentGroup.id,
});
const _default = new gcp.networksecurity.MirroringEndpointGroupAssociation("default", {
    mirroringEndpointGroupAssociationId: "example-ega",
    location: "global",
    network: consumerNetwork.id,
    mirroringEndpointGroup: endpointGroup.id,
    labels: {
        foo: "bar",
    },
});

import pulumi
import pulumi_gcp as gcp
producer_network = gcp.compute.Network("producer_network",
    name="example-prod-network",
    auto_create_subnetworks=False)
consumer_network = gcp.compute.Network("consumer_network",
    name="example-cons-network",
    auto_create_subnetworks=False)
deployment_group = gcp.networksecurity.MirroringDeploymentGroup("deployment_group",
    mirroring_deployment_group_id="example-dg",
    location="global",
    network=producer_network.id)
endpoint_group = gcp.networksecurity.MirroringEndpointGroup("endpoint_group",
    mirroring_endpoint_group_id="example-eg",
    location="global",
    mirroring_deployment_group=deployment_group.id)
default = gcp.networksecurity.MirroringEndpointGroupAssociation("default",
    mirroring_endpoint_group_association_id="example-ega",
    location="global",
    network=consumer_network.id,
    mirroring_endpoint_group=endpoint_group.id,
    labels={
        "foo": "bar",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var producerNetwork = new Gcp.Compute.Network("producer_network", new()
    {
        Name = "example-prod-network",
        AutoCreateSubnetworks = false,
    });
    var consumerNetwork = new Gcp.Compute.Network("consumer_network", new()
    {
        Name = "example-cons-network",
        AutoCreateSubnetworks = false,
    });
    var deploymentGroup = new Gcp.NetworkSecurity.MirroringDeploymentGroup("deployment_group", new()
    {
        MirroringDeploymentGroupId = "example-dg",
        Location = "global",
        Network = producerNetwork.Id,
    });
    var endpointGroup = new Gcp.NetworkSecurity.MirroringEndpointGroup("endpoint_group", new()
    {
        MirroringEndpointGroupId = "example-eg",
        Location = "global",
        MirroringDeploymentGroup = deploymentGroup.Id,
    });
    var @default = new Gcp.NetworkSecurity.MirroringEndpointGroupAssociation("default", new()
    {
        MirroringEndpointGroupAssociationId = "example-ega",
        Location = "global",
        Network = consumerNetwork.Id,
        MirroringEndpointGroup = endpointGroup.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 {
		producerNetwork, err := compute.NewNetwork(ctx, "producer_network", &compute.NetworkArgs{
			Name:                  pulumi.String("example-prod-network"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		consumerNetwork, err := compute.NewNetwork(ctx, "consumer_network", &compute.NetworkArgs{
			Name:                  pulumi.String("example-cons-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:                    producerNetwork.ID(),
		})
		if err != nil {
			return err
		}
		endpointGroup, err := networksecurity.NewMirroringEndpointGroup(ctx, "endpoint_group", &networksecurity.MirroringEndpointGroupArgs{
			MirroringEndpointGroupId: pulumi.String("example-eg"),
			Location:                 pulumi.String("global"),
			MirroringDeploymentGroup: deploymentGroup.ID(),
		})
		if err != nil {
			return err
		}
		_, err = networksecurity.NewMirroringEndpointGroupAssociation(ctx, "default", &networksecurity.MirroringEndpointGroupAssociationArgs{
			MirroringEndpointGroupAssociationId: pulumi.String("example-ega"),
			Location:                            pulumi.String("global"),
			Network:                             consumerNetwork.ID(),
			MirroringEndpointGroup:              endpointGroup.ID(),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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.MirroringEndpointGroupAssociation;
import com.pulumi.gcp.networksecurity.MirroringEndpointGroupAssociationArgs;
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 producerNetwork = new Network("producerNetwork", NetworkArgs.builder()
            .name("example-prod-network")
            .autoCreateSubnetworks(false)
            .build());
        var consumerNetwork = new Network("consumerNetwork", NetworkArgs.builder()
            .name("example-cons-network")
            .autoCreateSubnetworks(false)
            .build());
        var deploymentGroup = new MirroringDeploymentGroup("deploymentGroup", MirroringDeploymentGroupArgs.builder()
            .mirroringDeploymentGroupId("example-dg")
            .location("global")
            .network(producerNetwork.id())
            .build());
        var endpointGroup = new MirroringEndpointGroup("endpointGroup", MirroringEndpointGroupArgs.builder()
            .mirroringEndpointGroupId("example-eg")
            .location("global")
            .mirroringDeploymentGroup(deploymentGroup.id())
            .build());
        var default_ = new MirroringEndpointGroupAssociation("default", MirroringEndpointGroupAssociationArgs.builder()
            .mirroringEndpointGroupAssociationId("example-ega")
            .location("global")
            .network(consumerNetwork.id())
            .mirroringEndpointGroup(endpointGroup.id())
            .labels(Map.of("foo", "bar"))
            .build());
    }
}

resources:
  producerNetwork:
    type: gcp:compute:Network
    name: producer_network
    properties:
      name: example-prod-network
      autoCreateSubnetworks: false
  consumerNetwork:
    type: gcp:compute:Network
    name: consumer_network
    properties:
      name: example-cons-network
      autoCreateSubnetworks: false
  deploymentGroup:
    type: gcp:networksecurity:MirroringDeploymentGroup
    name: deployment_group
    properties:
      mirroringDeploymentGroupId: example-dg
      location: global
      network: ${producerNetwork.id}
  endpointGroup:
    type: gcp:networksecurity:MirroringEndpointGroup
    name: endpoint_group
    properties:
      mirroringEndpointGroupId: example-eg
      location: global
      mirroringDeploymentGroup: ${deploymentGroup.id}
  default:
    type: gcp:networksecurity:MirroringEndpointGroupAssociation
    properties:
      mirroringEndpointGroupAssociationId: example-ega
      location: global
      network: ${consumerNetwork.id}
      mirroringEndpointGroup: ${endpointGroup.id}
      labels:
        foo: bar

Import

MirroringEndpointGroupAssociation can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/mirroringEndpointGroupAssociations/{{mirroring_endpoint_group_association_id}}
{{project}}/{{location}}/{{mirroring_endpoint_group_association_id}}
{{location}}/{{mirroring_endpoint_group_association_id}} When using the pulumi import command, MirroringEndpointGroupAssociation can be imported using one of the formats above. For example:

$ pulumi import gcp:networksecurity/mirroringEndpointGroupAssociation:MirroringEndpointGroupAssociation default projects/{{project}}/locations/{{location}}/mirroringEndpointGroupAssociations/{{mirroring_endpoint_group_association_id}}

$ pulumi import gcp:networksecurity/mirroringEndpointGroupAssociation:MirroringEndpointGroupAssociation default {{project}}/{{location}}/{{mirroring_endpoint_group_association_id}}

$ pulumi import gcp:networksecurity/mirroringEndpointGroupAssociation:MirroringEndpointGroupAssociation default {{location}}/{{mirroring_endpoint_group_association_id}}

Properties

createTime

val createTime: Output<String>

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

effectiveLabels

val 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.

val id: Output<String>

labels

val 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 effective_labels for all of the labels present on the resource.

location

val location: Output<String>

The cloud location of the association, currently restricted to global.

locations

val locations: Output<List<MirroringEndpointGroupAssociationLocation>>

The list of locations where the association is configured. This information is retrieved from the linked endpoint group. Structure is documented below.

locationsDetails

val ~~locationsDetails~~: Output<List<MirroringEndpointGroupAssociationLocationsDetail>>

(Deprecated) The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself. Structure is documented below.

mirroringEndpointGroup

val mirroringEndpointGroup: Output<String>

The endpoint group that this association is connected to, for example: projects/123456789/locations/global/mirroringEndpointGroups/my-eg. See https://google.aip.dev/124.

mirroringEndpointGroupAssociationId

val mirroringEndpointGroupAssociationId: Output<String>?

The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID.

name

val name: Output<String>

The resource name of this endpoint group association, for example: projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association. See https://google.aip.dev/122 for more details.

network

val network: Output<String>

The VPC network that is associated. for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124.

project

val project: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiLabels

val pulumiLabels: Output<Map<String, String>>

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

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

reconciling

val reconciling: Output<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. adding a new location to the target deployment group). See https://google.aip.dev/128.

state

val state: Output<String>

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

updateTime

val updateTime: Output<String>

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

urn

val urn: Output<String>