1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. networkservices
  5. MulticastDomainGroup
Google Cloud v9.7.0 published on Wednesday, Dec 24, 2025 by Pulumi
gcp logo
Google Cloud v9.7.0 published on Wednesday, Dec 24, 2025 by Pulumi

    Create a multicast domain group in the current project.

    To get more information about MulticastDomainGroup, see:

    Example Usage

    Network Services Multicast Domain Group Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const mdgTest = new gcp.networkservices.MulticastDomainGroup("mdg_test", {
        multicastDomainGroupId: "test-mdg-resource",
        location: "global",
        description: "my description",
        labels: {
            fake_label: "label123",
        },
    });
    const network = new gcp.compute.Network("network", {
        name: "test-mdg-network",
        autoCreateSubnetworks: false,
    });
    const multicastDomainA = new gcp.networkservices.MulticastDomain("multicast_domain_a", {
        multicastDomainId: "test-mdg-domain-a",
        location: "global",
        adminNetwork: network.id,
        connectionConfig: {
            connectionType: "SAME_VPC",
        },
        multicastDomainGroup: mdgTest.id,
    }, {
        dependsOn: [network],
    });
    const multicastDomainB = new gcp.networkservices.MulticastDomain("multicast_domain_b", {
        multicastDomainId: "test-mdg-domain-b",
        location: "global",
        adminNetwork: network.id,
        connectionConfig: {
            connectionType: "SAME_VPC",
        },
        multicastDomainGroup: mdgTest.id,
    }, {
        dependsOn: [network],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    mdg_test = gcp.networkservices.MulticastDomainGroup("mdg_test",
        multicast_domain_group_id="test-mdg-resource",
        location="global",
        description="my description",
        labels={
            "fake_label": "label123",
        })
    network = gcp.compute.Network("network",
        name="test-mdg-network",
        auto_create_subnetworks=False)
    multicast_domain_a = gcp.networkservices.MulticastDomain("multicast_domain_a",
        multicast_domain_id="test-mdg-domain-a",
        location="global",
        admin_network=network.id,
        connection_config={
            "connection_type": "SAME_VPC",
        },
        multicast_domain_group=mdg_test.id,
        opts = pulumi.ResourceOptions(depends_on=[network]))
    multicast_domain_b = gcp.networkservices.MulticastDomain("multicast_domain_b",
        multicast_domain_id="test-mdg-domain-b",
        location="global",
        admin_network=network.id,
        connection_config={
            "connection_type": "SAME_VPC",
        },
        multicast_domain_group=mdg_test.id,
        opts = pulumi.ResourceOptions(depends_on=[network]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networkservices"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		mdgTest, err := networkservices.NewMulticastDomainGroup(ctx, "mdg_test", &networkservices.MulticastDomainGroupArgs{
    			MulticastDomainGroupId: pulumi.String("test-mdg-resource"),
    			Location:               pulumi.String("global"),
    			Description:            pulumi.String("my description"),
    			Labels: pulumi.StringMap{
    				"fake_label": pulumi.String("label123"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		network, err := compute.NewNetwork(ctx, "network", &compute.NetworkArgs{
    			Name:                  pulumi.String("test-mdg-network"),
    			AutoCreateSubnetworks: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = networkservices.NewMulticastDomain(ctx, "multicast_domain_a", &networkservices.MulticastDomainArgs{
    			MulticastDomainId: pulumi.String("test-mdg-domain-a"),
    			Location:          pulumi.String("global"),
    			AdminNetwork:      network.ID(),
    			ConnectionConfig: &networkservices.MulticastDomainConnectionConfigArgs{
    				ConnectionType: pulumi.String("SAME_VPC"),
    			},
    			MulticastDomainGroup: mdgTest.ID(),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			network,
    		}))
    		if err != nil {
    			return err
    		}
    		_, err = networkservices.NewMulticastDomain(ctx, "multicast_domain_b", &networkservices.MulticastDomainArgs{
    			MulticastDomainId: pulumi.String("test-mdg-domain-b"),
    			Location:          pulumi.String("global"),
    			AdminNetwork:      network.ID(),
    			ConnectionConfig: &networkservices.MulticastDomainConnectionConfigArgs{
    				ConnectionType: pulumi.String("SAME_VPC"),
    			},
    			MulticastDomainGroup: mdgTest.ID(),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			network,
    		}))
    		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 mdgTest = new Gcp.NetworkServices.MulticastDomainGroup("mdg_test", new()
        {
            MulticastDomainGroupId = "test-mdg-resource",
            Location = "global",
            Description = "my description",
            Labels = 
            {
                { "fake_label", "label123" },
            },
        });
    
        var network = new Gcp.Compute.Network("network", new()
        {
            Name = "test-mdg-network",
            AutoCreateSubnetworks = false,
        });
    
        var multicastDomainA = new Gcp.NetworkServices.MulticastDomain("multicast_domain_a", new()
        {
            MulticastDomainId = "test-mdg-domain-a",
            Location = "global",
            AdminNetwork = network.Id,
            ConnectionConfig = new Gcp.NetworkServices.Inputs.MulticastDomainConnectionConfigArgs
            {
                ConnectionType = "SAME_VPC",
            },
            MulticastDomainGroup = mdgTest.Id,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                network,
            },
        });
    
        var multicastDomainB = new Gcp.NetworkServices.MulticastDomain("multicast_domain_b", new()
        {
            MulticastDomainId = "test-mdg-domain-b",
            Location = "global",
            AdminNetwork = network.Id,
            ConnectionConfig = new Gcp.NetworkServices.Inputs.MulticastDomainConnectionConfigArgs
            {
                ConnectionType = "SAME_VPC",
            },
            MulticastDomainGroup = mdgTest.Id,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                network,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.networkservices.MulticastDomainGroup;
    import com.pulumi.gcp.networkservices.MulticastDomainGroupArgs;
    import com.pulumi.gcp.compute.Network;
    import com.pulumi.gcp.compute.NetworkArgs;
    import com.pulumi.gcp.networkservices.MulticastDomain;
    import com.pulumi.gcp.networkservices.MulticastDomainArgs;
    import com.pulumi.gcp.networkservices.inputs.MulticastDomainConnectionConfigArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 mdgTest = new MulticastDomainGroup("mdgTest", MulticastDomainGroupArgs.builder()
                .multicastDomainGroupId("test-mdg-resource")
                .location("global")
                .description("my description")
                .labels(Map.of("fake_label", "label123"))
                .build());
    
            var network = new Network("network", NetworkArgs.builder()
                .name("test-mdg-network")
                .autoCreateSubnetworks(false)
                .build());
    
            var multicastDomainA = new MulticastDomain("multicastDomainA", MulticastDomainArgs.builder()
                .multicastDomainId("test-mdg-domain-a")
                .location("global")
                .adminNetwork(network.id())
                .connectionConfig(MulticastDomainConnectionConfigArgs.builder()
                    .connectionType("SAME_VPC")
                    .build())
                .multicastDomainGroup(mdgTest.id())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(network)
                    .build());
    
            var multicastDomainB = new MulticastDomain("multicastDomainB", MulticastDomainArgs.builder()
                .multicastDomainId("test-mdg-domain-b")
                .location("global")
                .adminNetwork(network.id())
                .connectionConfig(MulticastDomainConnectionConfigArgs.builder()
                    .connectionType("SAME_VPC")
                    .build())
                .multicastDomainGroup(mdgTest.id())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(network)
                    .build());
    
        }
    }
    
    resources:
      mdgTest:
        type: gcp:networkservices:MulticastDomainGroup
        name: mdg_test
        properties:
          multicastDomainGroupId: test-mdg-resource
          location: global
          description: my description
          labels:
            fake_label: label123
      network:
        type: gcp:compute:Network
        properties:
          name: test-mdg-network
          autoCreateSubnetworks: false
      multicastDomainA:
        type: gcp:networkservices:MulticastDomain
        name: multicast_domain_a
        properties:
          multicastDomainId: test-mdg-domain-a
          location: global
          adminNetwork: ${network.id}
          connectionConfig:
            connectionType: SAME_VPC
          multicastDomainGroup: ${mdgTest.id}
        options:
          dependsOn:
            - ${network}
      multicastDomainB:
        type: gcp:networkservices:MulticastDomain
        name: multicast_domain_b
        properties:
          multicastDomainId: test-mdg-domain-b
          location: global
          adminNetwork: ${network.id}
          connectionConfig:
            connectionType: SAME_VPC
          multicastDomainGroup: ${mdgTest.id}
        options:
          dependsOn:
            - ${network}
    

    Create MulticastDomainGroup Resource

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

    Constructor syntax

    new MulticastDomainGroup(name: string, args: MulticastDomainGroupArgs, opts?: CustomResourceOptions);
    @overload
    def MulticastDomainGroup(resource_name: str,
                             args: MulticastDomainGroupArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def MulticastDomainGroup(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             location: Optional[str] = None,
                             multicast_domain_group_id: Optional[str] = None,
                             description: Optional[str] = None,
                             labels: Optional[Mapping[str, str]] = None,
                             project: Optional[str] = None)
    func NewMulticastDomainGroup(ctx *Context, name string, args MulticastDomainGroupArgs, opts ...ResourceOption) (*MulticastDomainGroup, error)
    public MulticastDomainGroup(string name, MulticastDomainGroupArgs args, CustomResourceOptions? opts = null)
    public MulticastDomainGroup(String name, MulticastDomainGroupArgs args)
    public MulticastDomainGroup(String name, MulticastDomainGroupArgs args, CustomResourceOptions options)
    
    type: gcp:networkservices:MulticastDomainGroup
    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 MulticastDomainGroupArgs
    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 MulticastDomainGroupArgs
    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 MulticastDomainGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MulticastDomainGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MulticastDomainGroupArgs
    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 multicastDomainGroupResource = new Gcp.NetworkServices.MulticastDomainGroup("multicastDomainGroupResource", new()
    {
        Location = "string",
        MulticastDomainGroupId = "string",
        Description = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Project = "string",
    });
    
    example, err := networkservices.NewMulticastDomainGroup(ctx, "multicastDomainGroupResource", &networkservices.MulticastDomainGroupArgs{
    	Location:               pulumi.String("string"),
    	MulticastDomainGroupId: pulumi.String("string"),
    	Description:            pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Project: pulumi.String("string"),
    })
    
    var multicastDomainGroupResource = new MulticastDomainGroup("multicastDomainGroupResource", MulticastDomainGroupArgs.builder()
        .location("string")
        .multicastDomainGroupId("string")
        .description("string")
        .labels(Map.of("string", "string"))
        .project("string")
        .build());
    
    multicast_domain_group_resource = gcp.networkservices.MulticastDomainGroup("multicastDomainGroupResource",
        location="string",
        multicast_domain_group_id="string",
        description="string",
        labels={
            "string": "string",
        },
        project="string")
    
    const multicastDomainGroupResource = new gcp.networkservices.MulticastDomainGroup("multicastDomainGroupResource", {
        location: "string",
        multicastDomainGroupId: "string",
        description: "string",
        labels: {
            string: "string",
        },
        project: "string",
    });
    
    type: gcp:networkservices:MulticastDomainGroup
    properties:
        description: string
        labels:
            string: string
        location: string
        multicastDomainGroupId: string
        project: string
    

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

    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MulticastDomainGroupId string
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    Description string
    An optional text description of the multicast domain group.
    Labels Dictionary<string, string>
    Labels as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MulticastDomainGroupId string
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    Description string
    An optional text description of the multicast domain group.
    Labels map[string]string
    Labels as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    multicastDomainGroupId String
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    description String
    An optional text description of the multicast domain group.
    labels Map<String,String>
    Labels as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    multicastDomainGroupId string
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    description string
    An optional text description of the multicast domain group.
    labels {[key: string]: string}
    Labels as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    multicast_domain_group_id str
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    description str
    An optional text description of the multicast domain group.
    labels Mapping[str, str]
    Labels as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    multicastDomainGroupId String
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    description String
    An optional text description of the multicast domain group.
    labels Map<String>
    Labels as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MulticastDomainGroup resource produces the following output properties:

    CreateTime string
    The timestamp when the multicast domain group was created.
    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.
    MulticastDomains List<string>
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    Name string
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    States List<MulticastDomainGroupState>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    UniqueId string
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    UpdateTime string
    The timestamp when the multicast domain group was most recently updated.
    CreateTime string
    The timestamp when the multicast domain group was created.
    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.
    MulticastDomains []string
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    Name string
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    States []MulticastDomainGroupStateType
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    UniqueId string
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    UpdateTime string
    The timestamp when the multicast domain group was most recently updated.
    createTime String
    The timestamp when the multicast domain group was created.
    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.
    multicastDomains List<String>
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    name String
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    states List<MulticastDomainGroupState>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId String
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    updateTime String
    The timestamp when the multicast domain group was most recently updated.
    createTime string
    The timestamp when the multicast domain group was created.
    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.
    multicastDomains string[]
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    name string
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    states MulticastDomainGroupState[]
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId string
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    updateTime string
    The timestamp when the multicast domain group was most recently updated.
    create_time str
    The timestamp when the multicast domain group was created.
    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.
    multicast_domains Sequence[str]
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    name str
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    states Sequence[MulticastDomainGroupState]
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    unique_id str
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    update_time str
    The timestamp when the multicast domain group was most recently updated.
    createTime String
    The timestamp when the multicast domain group was created.
    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.
    multicastDomains List<String>
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    name String
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    states List<Property Map>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId String
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    updateTime String
    The timestamp when the multicast domain group was most recently updated.

    Look up Existing MulticastDomainGroup Resource

    Get an existing MulticastDomainGroup 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?: MulticastDomainGroupState, opts?: CustomResourceOptions): MulticastDomainGroup
    @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,
            multicast_domain_group_id: Optional[str] = None,
            multicast_domains: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            pulumi_labels: Optional[Mapping[str, str]] = None,
            states: Optional[Sequence[MulticastDomainGroupStateArgs]] = None,
            unique_id: Optional[str] = None,
            update_time: Optional[str] = None) -> MulticastDomainGroup
    func GetMulticastDomainGroup(ctx *Context, name string, id IDInput, state *MulticastDomainGroupState, opts ...ResourceOption) (*MulticastDomainGroup, error)
    public static MulticastDomainGroup Get(string name, Input<string> id, MulticastDomainGroupState? state, CustomResourceOptions? opts = null)
    public static MulticastDomainGroup get(String name, Output<String> id, MulticastDomainGroupState state, CustomResourceOptions options)
    resources:  _:    type: gcp:networkservices:MulticastDomainGroup    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 multicast domain group was created.
    Description string
    An optional text description of the multicast domain group.
    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 as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MulticastDomainGroupId string
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    MulticastDomains List<string>
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    Name string
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    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.
    States List<MulticastDomainGroupState>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    UniqueId string
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    UpdateTime string
    The timestamp when the multicast domain group was most recently updated.
    CreateTime string
    The timestamp when the multicast domain group was created.
    Description string
    An optional text description of the multicast domain group.
    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 as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MulticastDomainGroupId string
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    MulticastDomains []string
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    Name string
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    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.
    States []MulticastDomainGroupStateTypeArgs
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    UniqueId string
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    UpdateTime string
    The timestamp when the multicast domain group was most recently updated.
    createTime String
    The timestamp when the multicast domain group was created.
    description String
    An optional text description of the multicast domain group.
    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 as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    multicastDomainGroupId String
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    multicastDomains List<String>
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    name String
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    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.
    states List<MulticastDomainGroupState>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId String
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    updateTime String
    The timestamp when the multicast domain group was most recently updated.
    createTime string
    The timestamp when the multicast domain group was created.
    description string
    An optional text description of the multicast domain group.
    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 as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    multicastDomainGroupId string
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    multicastDomains string[]
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    name string
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    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.
    states MulticastDomainGroupState[]
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId string
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    updateTime string
    The timestamp when the multicast domain group was most recently updated.
    create_time str
    The timestamp when the multicast domain group was created.
    description str
    An optional text description of the multicast domain group.
    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 as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    multicast_domain_group_id str
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    multicast_domains Sequence[str]
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    name str
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    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.
    states Sequence[MulticastDomainGroupStateArgs]
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    unique_id str
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    update_time str
    The timestamp when the multicast domain group was most recently updated.
    createTime String
    The timestamp when the multicast domain group was created.
    description String
    An optional text description of the multicast domain group.
    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 as key-value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    multicastDomainGroupId String
    A unique name for the multicast domain group. The name is restricted to letters, numbers, and hyphen, with the first character a letter, and the last a letter or a number. The name must not exceed 48 characters.
    multicastDomains List<String>
    Multicast domains associated with the group. There can be at most 2 multicast domains in a group.
    name String
    Identifier. The resource name of the multicast domain group. Use the following format: projects/*/locations/global/multicastDomainGroups/*
    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.
    states List<Property Map>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId String
    The Google-generated UUID for the resource. This value is unique across all multicast domain group resources. If a domain is deleted and another with the same name is created, the new domain is assigned a different unique_id.
    updateTime String
    The timestamp when the multicast domain group was most recently updated.

    Supporting Types

    MulticastDomainGroupState, MulticastDomainGroupStateArgs

    State string
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    State string
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    state String
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    state string
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    state str
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    state String
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE

    Import

    MulticastDomainGroup can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/multicastDomainGroups/{{multicast_domain_group_id}}

    • {{project}}/{{location}}/{{multicast_domain_group_id}}

    • {{location}}/{{multicast_domain_group_id}}

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

    $ pulumi import gcp:networkservices/multicastDomainGroup:MulticastDomainGroup default projects/{{project}}/locations/{{location}}/multicastDomainGroups/{{multicast_domain_group_id}}
    
    $ pulumi import gcp:networkservices/multicastDomainGroup:MulticastDomainGroup default {{project}}/{{location}}/{{multicast_domain_group_id}}
    
    $ pulumi import gcp:networkservices/multicastDomainGroup:MulticastDomainGroup default {{location}}/{{multicast_domain_group_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.7.0 published on Wednesday, Dec 24, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate