1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. networkservices
  5. MulticastConsumerAssociation
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 consumer association in the specified location of the current project.

    Example Usage

    Network Services Multicast Consumer Association Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const network = new gcp.compute.Network("network", {
        name: "test-network-mca",
        autoCreateSubnetworks: false,
    });
    const multicastDomain = new gcp.networkservices.MulticastDomain("multicast_domain", {
        multicastDomainId: "test-domain-mca",
        location: "global",
        adminNetwork: network.id,
        connectionConfig: {
            connectionType: "SAME_VPC",
        },
    }, {
        dependsOn: [network],
    });
    const multicastDomainActivation = new gcp.networkservices.MulticastDomainActivation("multicast_domain_activation", {
        multicastDomainActivationId: "test-domain-activation-mca",
        location: "us-central1-b",
        multicastDomain: multicastDomain.id,
    });
    const mcaTest = new gcp.networkservices.MulticastConsumerAssociation("mca_test", {
        multicastConsumerAssociationId: "test-consumer-association-mca",
        location: "us-central1-b",
        network: network.id,
        multicastDomainActivation: multicastDomainActivation.id,
    }, {
        dependsOn: [network],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    network = gcp.compute.Network("network",
        name="test-network-mca",
        auto_create_subnetworks=False)
    multicast_domain = gcp.networkservices.MulticastDomain("multicast_domain",
        multicast_domain_id="test-domain-mca",
        location="global",
        admin_network=network.id,
        connection_config={
            "connection_type": "SAME_VPC",
        },
        opts = pulumi.ResourceOptions(depends_on=[network]))
    multicast_domain_activation = gcp.networkservices.MulticastDomainActivation("multicast_domain_activation",
        multicast_domain_activation_id="test-domain-activation-mca",
        location="us-central1-b",
        multicast_domain=multicast_domain.id)
    mca_test = gcp.networkservices.MulticastConsumerAssociation("mca_test",
        multicast_consumer_association_id="test-consumer-association-mca",
        location="us-central1-b",
        network=network.id,
        multicast_domain_activation=multicast_domain_activation.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 {
    		network, err := compute.NewNetwork(ctx, "network", &compute.NetworkArgs{
    			Name:                  pulumi.String("test-network-mca"),
    			AutoCreateSubnetworks: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		multicastDomain, err := networkservices.NewMulticastDomain(ctx, "multicast_domain", &networkservices.MulticastDomainArgs{
    			MulticastDomainId: pulumi.String("test-domain-mca"),
    			Location:          pulumi.String("global"),
    			AdminNetwork:      network.ID(),
    			ConnectionConfig: &networkservices.MulticastDomainConnectionConfigArgs{
    				ConnectionType: pulumi.String("SAME_VPC"),
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			network,
    		}))
    		if err != nil {
    			return err
    		}
    		multicastDomainActivation, err := networkservices.NewMulticastDomainActivation(ctx, "multicast_domain_activation", &networkservices.MulticastDomainActivationArgs{
    			MulticastDomainActivationId: pulumi.String("test-domain-activation-mca"),
    			Location:                    pulumi.String("us-central1-b"),
    			MulticastDomain:             multicastDomain.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = networkservices.NewMulticastConsumerAssociation(ctx, "mca_test", &networkservices.MulticastConsumerAssociationArgs{
    			MulticastConsumerAssociationId: pulumi.String("test-consumer-association-mca"),
    			Location:                       pulumi.String("us-central1-b"),
    			Network:                        network.ID(),
    			MulticastDomainActivation:      multicastDomainActivation.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 network = new Gcp.Compute.Network("network", new()
        {
            Name = "test-network-mca",
            AutoCreateSubnetworks = false,
        });
    
        var multicastDomain = new Gcp.NetworkServices.MulticastDomain("multicast_domain", new()
        {
            MulticastDomainId = "test-domain-mca",
            Location = "global",
            AdminNetwork = network.Id,
            ConnectionConfig = new Gcp.NetworkServices.Inputs.MulticastDomainConnectionConfigArgs
            {
                ConnectionType = "SAME_VPC",
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                network,
            },
        });
    
        var multicastDomainActivation = new Gcp.NetworkServices.MulticastDomainActivation("multicast_domain_activation", new()
        {
            MulticastDomainActivationId = "test-domain-activation-mca",
            Location = "us-central1-b",
            MulticastDomain = multicastDomain.Id,
        });
    
        var mcaTest = new Gcp.NetworkServices.MulticastConsumerAssociation("mca_test", new()
        {
            MulticastConsumerAssociationId = "test-consumer-association-mca",
            Location = "us-central1-b",
            Network = network.Id,
            MulticastDomainActivation = multicastDomainActivation.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.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.gcp.networkservices.MulticastDomainActivation;
    import com.pulumi.gcp.networkservices.MulticastDomainActivationArgs;
    import com.pulumi.gcp.networkservices.MulticastConsumerAssociation;
    import com.pulumi.gcp.networkservices.MulticastConsumerAssociationArgs;
    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 network = new Network("network", NetworkArgs.builder()
                .name("test-network-mca")
                .autoCreateSubnetworks(false)
                .build());
    
            var multicastDomain = new MulticastDomain("multicastDomain", MulticastDomainArgs.builder()
                .multicastDomainId("test-domain-mca")
                .location("global")
                .adminNetwork(network.id())
                .connectionConfig(MulticastDomainConnectionConfigArgs.builder()
                    .connectionType("SAME_VPC")
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(network)
                    .build());
    
            var multicastDomainActivation = new MulticastDomainActivation("multicastDomainActivation", MulticastDomainActivationArgs.builder()
                .multicastDomainActivationId("test-domain-activation-mca")
                .location("us-central1-b")
                .multicastDomain(multicastDomain.id())
                .build());
    
            var mcaTest = new MulticastConsumerAssociation("mcaTest", MulticastConsumerAssociationArgs.builder()
                .multicastConsumerAssociationId("test-consumer-association-mca")
                .location("us-central1-b")
                .network(network.id())
                .multicastDomainActivation(multicastDomainActivation.id())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(network)
                    .build());
    
        }
    }
    
    resources:
      network:
        type: gcp:compute:Network
        properties:
          name: test-network-mca
          autoCreateSubnetworks: false
      multicastDomain:
        type: gcp:networkservices:MulticastDomain
        name: multicast_domain
        properties:
          multicastDomainId: test-domain-mca
          location: global
          adminNetwork: ${network.id}
          connectionConfig:
            connectionType: SAME_VPC
        options:
          dependsOn:
            - ${network}
      multicastDomainActivation:
        type: gcp:networkservices:MulticastDomainActivation
        name: multicast_domain_activation
        properties:
          multicastDomainActivationId: test-domain-activation-mca
          location: us-central1-b
          multicastDomain: ${multicastDomain.id}
      mcaTest:
        type: gcp:networkservices:MulticastConsumerAssociation
        name: mca_test
        properties:
          multicastConsumerAssociationId: test-consumer-association-mca
          location: us-central1-b
          network: ${network.id}
          multicastDomainActivation: ${multicastDomainActivation.id}
        options:
          dependsOn:
            - ${network}
    

    Create MulticastConsumerAssociation Resource

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

    Constructor syntax

    new MulticastConsumerAssociation(name: string, args: MulticastConsumerAssociationArgs, opts?: CustomResourceOptions);
    @overload
    def MulticastConsumerAssociation(resource_name: str,
                                     args: MulticastConsumerAssociationArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def MulticastConsumerAssociation(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     location: Optional[str] = None,
                                     multicast_consumer_association_id: Optional[str] = None,
                                     multicast_domain_activation: Optional[str] = None,
                                     network: Optional[str] = None,
                                     description: Optional[str] = None,
                                     labels: Optional[Mapping[str, str]] = None,
                                     project: Optional[str] = None)
    func NewMulticastConsumerAssociation(ctx *Context, name string, args MulticastConsumerAssociationArgs, opts ...ResourceOption) (*MulticastConsumerAssociation, error)
    public MulticastConsumerAssociation(string name, MulticastConsumerAssociationArgs args, CustomResourceOptions? opts = null)
    public MulticastConsumerAssociation(String name, MulticastConsumerAssociationArgs args)
    public MulticastConsumerAssociation(String name, MulticastConsumerAssociationArgs args, CustomResourceOptions options)
    
    type: gcp:networkservices:MulticastConsumerAssociation
    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 MulticastConsumerAssociationArgs
    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 MulticastConsumerAssociationArgs
    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 MulticastConsumerAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MulticastConsumerAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MulticastConsumerAssociationArgs
    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 multicastConsumerAssociationResource = new Gcp.NetworkServices.MulticastConsumerAssociation("multicastConsumerAssociationResource", new()
    {
        Location = "string",
        MulticastConsumerAssociationId = "string",
        MulticastDomainActivation = "string",
        Network = "string",
        Description = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Project = "string",
    });
    
    example, err := networkservices.NewMulticastConsumerAssociation(ctx, "multicastConsumerAssociationResource", &networkservices.MulticastConsumerAssociationArgs{
    	Location:                       pulumi.String("string"),
    	MulticastConsumerAssociationId: pulumi.String("string"),
    	MulticastDomainActivation:      pulumi.String("string"),
    	Network:                        pulumi.String("string"),
    	Description:                    pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Project: pulumi.String("string"),
    })
    
    var multicastConsumerAssociationResource = new MulticastConsumerAssociation("multicastConsumerAssociationResource", MulticastConsumerAssociationArgs.builder()
        .location("string")
        .multicastConsumerAssociationId("string")
        .multicastDomainActivation("string")
        .network("string")
        .description("string")
        .labels(Map.of("string", "string"))
        .project("string")
        .build());
    
    multicast_consumer_association_resource = gcp.networkservices.MulticastConsumerAssociation("multicastConsumerAssociationResource",
        location="string",
        multicast_consumer_association_id="string",
        multicast_domain_activation="string",
        network="string",
        description="string",
        labels={
            "string": "string",
        },
        project="string")
    
    const multicastConsumerAssociationResource = new gcp.networkservices.MulticastConsumerAssociation("multicastConsumerAssociationResource", {
        location: "string",
        multicastConsumerAssociationId: "string",
        multicastDomainActivation: "string",
        network: "string",
        description: "string",
        labels: {
            string: "string",
        },
        project: "string",
    });
    
    type: gcp:networkservices:MulticastConsumerAssociation
    properties:
        description: string
        labels:
            string: string
        location: string
        multicastConsumerAssociationId: string
        multicastDomainActivation: string
        network: string
        project: string
    

    MulticastConsumerAssociation 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 MulticastConsumerAssociation 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.
    MulticastConsumerAssociationId string
    A unique name for the multicast consumer association. 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.
    MulticastDomainActivation string
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    Network string
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    Description string
    An optional text description of the multicast consumer association.
    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.
    MulticastConsumerAssociationId string
    A unique name for the multicast consumer association. 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.
    MulticastDomainActivation string
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    Network string
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    Description string
    An optional text description of the multicast consumer association.
    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.
    multicastConsumerAssociationId String
    A unique name for the multicast consumer association. 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.
    multicastDomainActivation String
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    network String
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    description String
    An optional text description of the multicast consumer association.
    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.
    multicastConsumerAssociationId string
    A unique name for the multicast consumer association. 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.
    multicastDomainActivation string
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    network string
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    description string
    An optional text description of the multicast consumer association.
    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_consumer_association_id str
    A unique name for the multicast consumer association. 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_domain_activation str
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    network str
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    description str
    An optional text description of the multicast consumer association.
    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.
    multicastConsumerAssociationId String
    A unique name for the multicast consumer association. 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.
    multicastDomainActivation String
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    network String
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    description String
    An optional text description of the multicast consumer association.
    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 MulticastConsumerAssociation resource produces the following output properties:

    CreateTime string
    [Output only] The timestamp when the multicast consumer association 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.
    Name string
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    PlacementPolicy string
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    States List<MulticastConsumerAssociationState>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    UniqueId string
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    UpdateTime string
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    CreateTime string
    [Output only] The timestamp when the multicast consumer association 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.
    Name string
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    PlacementPolicy string
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    States []MulticastConsumerAssociationStateType
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    UniqueId string
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    UpdateTime string
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    createTime String
    [Output only] The timestamp when the multicast consumer association 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.
    name String
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    placementPolicy String
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    states List<MulticastConsumerAssociationState>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId String
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    updateTime String
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    createTime string
    [Output only] The timestamp when the multicast consumer association 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.
    name string
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    placementPolicy string
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    states MulticastConsumerAssociationState[]
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId string
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    updateTime string
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    create_time str
    [Output only] The timestamp when the multicast consumer association 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.
    name str
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    placement_policy str
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    states Sequence[MulticastConsumerAssociationState]
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    unique_id str
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    update_time str
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    createTime String
    [Output only] The timestamp when the multicast consumer association 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.
    name String
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    placementPolicy String
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    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
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    updateTime String
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.

    Look up Existing MulticastConsumerAssociation Resource

    Get an existing MulticastConsumerAssociation 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?: MulticastConsumerAssociationState, opts?: CustomResourceOptions): MulticastConsumerAssociation
    @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_consumer_association_id: Optional[str] = None,
            multicast_domain_activation: Optional[str] = None,
            name: Optional[str] = None,
            network: Optional[str] = None,
            placement_policy: Optional[str] = None,
            project: Optional[str] = None,
            pulumi_labels: Optional[Mapping[str, str]] = None,
            states: Optional[Sequence[MulticastConsumerAssociationStateArgs]] = None,
            unique_id: Optional[str] = None,
            update_time: Optional[str] = None) -> MulticastConsumerAssociation
    func GetMulticastConsumerAssociation(ctx *Context, name string, id IDInput, state *MulticastConsumerAssociationState, opts ...ResourceOption) (*MulticastConsumerAssociation, error)
    public static MulticastConsumerAssociation Get(string name, Input<string> id, MulticastConsumerAssociationState? state, CustomResourceOptions? opts = null)
    public static MulticastConsumerAssociation get(String name, Output<String> id, MulticastConsumerAssociationState state, CustomResourceOptions options)
    resources:  _:    type: gcp:networkservices:MulticastConsumerAssociation    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
    [Output only] The timestamp when the multicast consumer association was created.
    Description string
    An optional text description of the multicast consumer association.
    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.
    MulticastConsumerAssociationId string
    A unique name for the multicast consumer association. 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.
    MulticastDomainActivation string
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    Name string
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    Network string
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    PlacementPolicy string
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    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<MulticastConsumerAssociationState>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    UniqueId string
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    UpdateTime string
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    CreateTime string
    [Output only] The timestamp when the multicast consumer association was created.
    Description string
    An optional text description of the multicast consumer association.
    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.
    MulticastConsumerAssociationId string
    A unique name for the multicast consumer association. 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.
    MulticastDomainActivation string
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    Name string
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    Network string
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    PlacementPolicy string
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    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 []MulticastConsumerAssociationStateTypeArgs
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    UniqueId string
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    UpdateTime string
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    createTime String
    [Output only] The timestamp when the multicast consumer association was created.
    description String
    An optional text description of the multicast consumer association.
    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.
    multicastConsumerAssociationId String
    A unique name for the multicast consumer association. 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.
    multicastDomainActivation String
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    name String
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    network String
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    placementPolicy String
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    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<MulticastConsumerAssociationState>
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId String
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    updateTime String
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    createTime string
    [Output only] The timestamp when the multicast consumer association was created.
    description string
    An optional text description of the multicast consumer association.
    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.
    multicastConsumerAssociationId string
    A unique name for the multicast consumer association. 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.
    multicastDomainActivation string
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    name string
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    network string
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    placementPolicy string
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    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 MulticastConsumerAssociationState[]
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    uniqueId string
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    updateTime string
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    create_time str
    [Output only] The timestamp when the multicast consumer association was created.
    description str
    An optional text description of the multicast consumer association.
    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_consumer_association_id str
    A unique name for the multicast consumer association. 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_domain_activation str
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    name str
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    network str
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    placement_policy str
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    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[MulticastConsumerAssociationStateArgs]
    (Output) The state of the multicast resource. Possible values: CREATING ACTIVE DELETING DELETE_FAILED UPDATING UPDATE_FAILED INACTIVE
    unique_id str
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    update_time str
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.
    createTime String
    [Output only] The timestamp when the multicast consumer association was created.
    description String
    An optional text description of the multicast consumer association.
    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.
    multicastConsumerAssociationId String
    A unique name for the multicast consumer association. 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.
    multicastDomainActivation String
    The resource name of the multicast domain activation that is in the same zone as this multicast producer association. Use the following format: // projects/*/locations/*/multicastDomainActivations/*.
    name String
    Identifier. The resource name of the multicast consumer association. Use the following format: projects/*/locations/*/multicastConsumerAssociations/*.
    network String
    The resource name of the multicast consumer VPC network. Use following format: projects/{project}/locations/global/networks/{network}.
    placementPolicy String
    [Output only] A Compute Engine (placement policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview] that can be used to place virtual machine (VM) instances as multicast consumers close to the multicast infrastructure created for this domain, on a best effort basis.
    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
    [Output only] The Google-generated UUID for the resource. This value is unique across all multicast consumer association resources. If a consumer association is deleted and another with the same name is created, the new consumer association is assigned a different unique_id.
    updateTime String
    [Output only] The timestamp when the Multicast Consumer Association was most recently updated.

    Supporting Types

    MulticastConsumerAssociationState, MulticastConsumerAssociationStateArgs

    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

    MulticastConsumerAssociation can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/multicastConsumerAssociations/{{multicast_consumer_association_id}}

    • {{project}}/{{location}}/{{multicast_consumer_association_id}}

    • {{location}}/{{multicast_consumer_association_id}}

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

    $ pulumi import gcp:networkservices/multicastConsumerAssociation:MulticastConsumerAssociation default projects/{{project}}/locations/{{location}}/multicastConsumerAssociations/{{multicast_consumer_association_id}}
    
    $ pulumi import gcp:networkservices/multicastConsumerAssociation:MulticastConsumerAssociation default {{project}}/{{location}}/{{multicast_consumer_association_id}}
    
    $ pulumi import gcp:networkservices/multicastConsumerAssociation:MulticastConsumerAssociation default {{location}}/{{multicast_consumer_association_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