Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. cen
  5. TransitRouterMulticastDomain
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.cen.TransitRouterMulticastDomain

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Provides a Cloud Enterprise Network (CEN) Transit Router Multicast Domain resource.

For information about Cloud Enterprise Network (CEN) Transit Router Multicast Domain and how to use it, see What is Transit Router Multicast Domain.

NOTE: Available since v1.195.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const example = new alicloud.cen.Instance("example", {cenInstanceName: name});
const exampleTransitRouter = new alicloud.cen.TransitRouter("example", {
    transitRouterName: name,
    cenId: example.id,
    supportMulticast: true,
});
const _default = new alicloud.cen.TransitRouterMulticastDomain("default", {
    transitRouterId: exampleTransitRouter.transitRouterId,
    transitRouterMulticastDomainName: name,
    transitRouterMulticastDomainDescription: name,
    options: {
        igmpv2Support: "disable",
    },
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
example = alicloud.cen.Instance("example", cen_instance_name=name)
example_transit_router = alicloud.cen.TransitRouter("example",
    transit_router_name=name,
    cen_id=example.id,
    support_multicast=True)
default = alicloud.cen.TransitRouterMulticastDomain("default",
    transit_router_id=example_transit_router.transit_router_id,
    transit_router_multicast_domain_name=name,
    transit_router_multicast_domain_description=name,
    options={
        "igmpv2_support": "disable",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cen"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		example, err := cen.NewInstance(ctx, "example", &cen.InstanceArgs{
			CenInstanceName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		exampleTransitRouter, err := cen.NewTransitRouter(ctx, "example", &cen.TransitRouterArgs{
			TransitRouterName: pulumi.String(name),
			CenId:             example.ID(),
			SupportMulticast:  pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = cen.NewTransitRouterMulticastDomain(ctx, "default", &cen.TransitRouterMulticastDomainArgs{
			TransitRouterId:                         exampleTransitRouter.TransitRouterId,
			TransitRouterMulticastDomainName:        pulumi.String(name),
			TransitRouterMulticastDomainDescription: pulumi.String(name),
			Options: &cen.TransitRouterMulticastDomainOptionsArgs{
				Igmpv2Support: pulumi.String("disable"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var example = new AliCloud.Cen.Instance("example", new()
    {
        CenInstanceName = name,
    });

    var exampleTransitRouter = new AliCloud.Cen.TransitRouter("example", new()
    {
        TransitRouterName = name,
        CenId = example.Id,
        SupportMulticast = true,
    });

    var @default = new AliCloud.Cen.TransitRouterMulticastDomain("default", new()
    {
        TransitRouterId = exampleTransitRouter.TransitRouterId,
        TransitRouterMulticastDomainName = name,
        TransitRouterMulticastDomainDescription = name,
        Options = new AliCloud.Cen.Inputs.TransitRouterMulticastDomainOptionsArgs
        {
            Igmpv2Support = "disable",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.cen.Instance;
import com.pulumi.alicloud.cen.InstanceArgs;
import com.pulumi.alicloud.cen.TransitRouter;
import com.pulumi.alicloud.cen.TransitRouterArgs;
import com.pulumi.alicloud.cen.TransitRouterMulticastDomain;
import com.pulumi.alicloud.cen.TransitRouterMulticastDomainArgs;
import com.pulumi.alicloud.cen.inputs.TransitRouterMulticastDomainOptionsArgs;
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) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        var example = new Instance("example", InstanceArgs.builder()
            .cenInstanceName(name)
            .build());

        var exampleTransitRouter = new TransitRouter("exampleTransitRouter", TransitRouterArgs.builder()
            .transitRouterName(name)
            .cenId(example.id())
            .supportMulticast(true)
            .build());

        var default_ = new TransitRouterMulticastDomain("default", TransitRouterMulticastDomainArgs.builder()
            .transitRouterId(exampleTransitRouter.transitRouterId())
            .transitRouterMulticastDomainName(name)
            .transitRouterMulticastDomainDescription(name)
            .options(TransitRouterMulticastDomainOptionsArgs.builder()
                .igmpv2Support("disable")
                .build())
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: terraform-example
resources:
  example:
    type: alicloud:cen:Instance
    properties:
      cenInstanceName: ${name}
  exampleTransitRouter:
    type: alicloud:cen:TransitRouter
    name: example
    properties:
      transitRouterName: ${name}
      cenId: ${example.id}
      supportMulticast: true
  default:
    type: alicloud:cen:TransitRouterMulticastDomain
    properties:
      transitRouterId: ${exampleTransitRouter.transitRouterId}
      transitRouterMulticastDomainName: ${name}
      transitRouterMulticastDomainDescription: ${name}
      options:
        igmpv2Support: disable
Copy

Create TransitRouterMulticastDomain Resource

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

Constructor syntax

new TransitRouterMulticastDomain(name: string, args: TransitRouterMulticastDomainArgs, opts?: CustomResourceOptions);
@overload
def TransitRouterMulticastDomain(resource_name: str,
                                 args: TransitRouterMulticastDomainArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def TransitRouterMulticastDomain(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 transit_router_id: Optional[str] = None,
                                 options: Optional[TransitRouterMulticastDomainOptionsArgs] = None,
                                 tags: Optional[Mapping[str, str]] = None,
                                 transit_router_multicast_domain_description: Optional[str] = None,
                                 transit_router_multicast_domain_name: Optional[str] = None)
func NewTransitRouterMulticastDomain(ctx *Context, name string, args TransitRouterMulticastDomainArgs, opts ...ResourceOption) (*TransitRouterMulticastDomain, error)
public TransitRouterMulticastDomain(string name, TransitRouterMulticastDomainArgs args, CustomResourceOptions? opts = null)
public TransitRouterMulticastDomain(String name, TransitRouterMulticastDomainArgs args)
public TransitRouterMulticastDomain(String name, TransitRouterMulticastDomainArgs args, CustomResourceOptions options)

type: alicloud:cen:TransitRouterMulticastDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TransitRouterMulticastDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TransitRouterMulticastDomainArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TransitRouterMulticastDomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TransitRouterMulticastDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TransitRouterMulticastDomainArgs
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 transitRouterMulticastDomainResource = new AliCloud.Cen.TransitRouterMulticastDomain("transitRouterMulticastDomainResource", new()
{
    TransitRouterId = "string",
    Options = new AliCloud.Cen.Inputs.TransitRouterMulticastDomainOptionsArgs
    {
        Igmpv2Support = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    TransitRouterMulticastDomainDescription = "string",
    TransitRouterMulticastDomainName = "string",
});
Copy
example, err := cen.NewTransitRouterMulticastDomain(ctx, "transitRouterMulticastDomainResource", &cen.TransitRouterMulticastDomainArgs{
	TransitRouterId: pulumi.String("string"),
	Options: &cen.TransitRouterMulticastDomainOptionsArgs{
		Igmpv2Support: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TransitRouterMulticastDomainDescription: pulumi.String("string"),
	TransitRouterMulticastDomainName:        pulumi.String("string"),
})
Copy
var transitRouterMulticastDomainResource = new TransitRouterMulticastDomain("transitRouterMulticastDomainResource", TransitRouterMulticastDomainArgs.builder()
    .transitRouterId("string")
    .options(TransitRouterMulticastDomainOptionsArgs.builder()
        .igmpv2Support("string")
        .build())
    .tags(Map.of("string", "string"))
    .transitRouterMulticastDomainDescription("string")
    .transitRouterMulticastDomainName("string")
    .build());
Copy
transit_router_multicast_domain_resource = alicloud.cen.TransitRouterMulticastDomain("transitRouterMulticastDomainResource",
    transit_router_id="string",
    options={
        "igmpv2_support": "string",
    },
    tags={
        "string": "string",
    },
    transit_router_multicast_domain_description="string",
    transit_router_multicast_domain_name="string")
Copy
const transitRouterMulticastDomainResource = new alicloud.cen.TransitRouterMulticastDomain("transitRouterMulticastDomainResource", {
    transitRouterId: "string",
    options: {
        igmpv2Support: "string",
    },
    tags: {
        string: "string",
    },
    transitRouterMulticastDomainDescription: "string",
    transitRouterMulticastDomainName: "string",
});
Copy
type: alicloud:cen:TransitRouterMulticastDomain
properties:
    options:
        igmpv2Support: string
    tags:
        string: string
    transitRouterId: string
    transitRouterMulticastDomainDescription: string
    transitRouterMulticastDomainName: string
Copy

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

TransitRouterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the forwarding router instance.
Options Pulumi.AliCloud.Cen.Inputs.TransitRouterMulticastDomainOptions
The function options of the multicast domain. See options below.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
TransitRouterMulticastDomainDescription string
The description of the multicast domain.
TransitRouterMulticastDomainName string
The name of the multicast domain.
TransitRouterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the forwarding router instance.
Options TransitRouterMulticastDomainOptionsArgs
The function options of the multicast domain. See options below.
Tags map[string]string
A mapping of tags to assign to the resource.
TransitRouterMulticastDomainDescription string
The description of the multicast domain.
TransitRouterMulticastDomainName string
The name of the multicast domain.
transitRouterId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the forwarding router instance.
options TransitRouterMulticastDomainOptions
The function options of the multicast domain. See options below.
tags Map<String,String>
A mapping of tags to assign to the resource.
transitRouterMulticastDomainDescription String
The description of the multicast domain.
transitRouterMulticastDomainName String
The name of the multicast domain.
transitRouterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the forwarding router instance.
options TransitRouterMulticastDomainOptions
The function options of the multicast domain. See options below.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
transitRouterMulticastDomainDescription string
The description of the multicast domain.
transitRouterMulticastDomainName string
The name of the multicast domain.
transit_router_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the forwarding router instance.
options TransitRouterMulticastDomainOptionsArgs
The function options of the multicast domain. See options below.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
transit_router_multicast_domain_description str
The description of the multicast domain.
transit_router_multicast_domain_name str
The name of the multicast domain.
transitRouterId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the forwarding router instance.
options Property Map
The function options of the multicast domain. See options below.
tags Map<String>
A mapping of tags to assign to the resource.
transitRouterMulticastDomainDescription String
The description of the multicast domain.
transitRouterMulticastDomainName String
The name of the multicast domain.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
RegionId string
(Available since v1.242.0) The region ID of the transit router.
Status string
The status of the Transit Router Multicast Domain.
Id string
The provider-assigned unique ID for this managed resource.
RegionId string
(Available since v1.242.0) The region ID of the transit router.
Status string
The status of the Transit Router Multicast Domain.
id String
The provider-assigned unique ID for this managed resource.
regionId String
(Available since v1.242.0) The region ID of the transit router.
status String
The status of the Transit Router Multicast Domain.
id string
The provider-assigned unique ID for this managed resource.
regionId string
(Available since v1.242.0) The region ID of the transit router.
status string
The status of the Transit Router Multicast Domain.
id str
The provider-assigned unique ID for this managed resource.
region_id str
(Available since v1.242.0) The region ID of the transit router.
status str
The status of the Transit Router Multicast Domain.
id String
The provider-assigned unique ID for this managed resource.
regionId String
(Available since v1.242.0) The region ID of the transit router.
status String
The status of the Transit Router Multicast Domain.

Look up Existing TransitRouterMulticastDomain Resource

Get an existing TransitRouterMulticastDomain 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?: TransitRouterMulticastDomainState, opts?: CustomResourceOptions): TransitRouterMulticastDomain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        options: Optional[TransitRouterMulticastDomainOptionsArgs] = None,
        region_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        transit_router_id: Optional[str] = None,
        transit_router_multicast_domain_description: Optional[str] = None,
        transit_router_multicast_domain_name: Optional[str] = None) -> TransitRouterMulticastDomain
func GetTransitRouterMulticastDomain(ctx *Context, name string, id IDInput, state *TransitRouterMulticastDomainState, opts ...ResourceOption) (*TransitRouterMulticastDomain, error)
public static TransitRouterMulticastDomain Get(string name, Input<string> id, TransitRouterMulticastDomainState? state, CustomResourceOptions? opts = null)
public static TransitRouterMulticastDomain get(String name, Output<String> id, TransitRouterMulticastDomainState state, CustomResourceOptions options)
resources:  _:    type: alicloud:cen:TransitRouterMulticastDomain    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Options Pulumi.AliCloud.Cen.Inputs.TransitRouterMulticastDomainOptions
The function options of the multicast domain. See options below.
RegionId string
(Available since v1.242.0) The region ID of the transit router.
Status string
The status of the Transit Router Multicast Domain.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
TransitRouterId Changes to this property will trigger replacement. string
The ID of the forwarding router instance.
TransitRouterMulticastDomainDescription string
The description of the multicast domain.
TransitRouterMulticastDomainName string
The name of the multicast domain.
Options TransitRouterMulticastDomainOptionsArgs
The function options of the multicast domain. See options below.
RegionId string
(Available since v1.242.0) The region ID of the transit router.
Status string
The status of the Transit Router Multicast Domain.
Tags map[string]string
A mapping of tags to assign to the resource.
TransitRouterId Changes to this property will trigger replacement. string
The ID of the forwarding router instance.
TransitRouterMulticastDomainDescription string
The description of the multicast domain.
TransitRouterMulticastDomainName string
The name of the multicast domain.
options TransitRouterMulticastDomainOptions
The function options of the multicast domain. See options below.
regionId String
(Available since v1.242.0) The region ID of the transit router.
status String
The status of the Transit Router Multicast Domain.
tags Map<String,String>
A mapping of tags to assign to the resource.
transitRouterId Changes to this property will trigger replacement. String
The ID of the forwarding router instance.
transitRouterMulticastDomainDescription String
The description of the multicast domain.
transitRouterMulticastDomainName String
The name of the multicast domain.
options TransitRouterMulticastDomainOptions
The function options of the multicast domain. See options below.
regionId string
(Available since v1.242.0) The region ID of the transit router.
status string
The status of the Transit Router Multicast Domain.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
transitRouterId Changes to this property will trigger replacement. string
The ID of the forwarding router instance.
transitRouterMulticastDomainDescription string
The description of the multicast domain.
transitRouterMulticastDomainName string
The name of the multicast domain.
options TransitRouterMulticastDomainOptionsArgs
The function options of the multicast domain. See options below.
region_id str
(Available since v1.242.0) The region ID of the transit router.
status str
The status of the Transit Router Multicast Domain.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
transit_router_id Changes to this property will trigger replacement. str
The ID of the forwarding router instance.
transit_router_multicast_domain_description str
The description of the multicast domain.
transit_router_multicast_domain_name str
The name of the multicast domain.
options Property Map
The function options of the multicast domain. See options below.
regionId String
(Available since v1.242.0) The region ID of the transit router.
status String
The status of the Transit Router Multicast Domain.
tags Map<String>
A mapping of tags to assign to the resource.
transitRouterId Changes to this property will trigger replacement. String
The ID of the forwarding router instance.
transitRouterMulticastDomainDescription String
The description of the multicast domain.
transitRouterMulticastDomainName String
The name of the multicast domain.

Supporting Types

TransitRouterMulticastDomainOptions
, TransitRouterMulticastDomainOptionsArgs

Igmpv2Support string
Whether to enable IGMP function for multicast domain. Default value: disable. Valid values: enable, disable.
Igmpv2Support string
Whether to enable IGMP function for multicast domain. Default value: disable. Valid values: enable, disable.
igmpv2Support String
Whether to enable IGMP function for multicast domain. Default value: disable. Valid values: enable, disable.
igmpv2Support string
Whether to enable IGMP function for multicast domain. Default value: disable. Valid values: enable, disable.
igmpv2_support str
Whether to enable IGMP function for multicast domain. Default value: disable. Valid values: enable, disable.
igmpv2Support String
Whether to enable IGMP function for multicast domain. Default value: disable. Valid values: enable, disable.

Import

Cloud Enterprise Network (CEN) Transit Router Multicast Domain can be imported using the id, e.g.

$ pulumi import alicloud:cen/transitRouterMulticastDomain:TransitRouterMulticastDomain example <id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud