1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. cen
  5. TransitRouterMulticastDomain
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

alicloud.cen.TransitRouterMulticastDomain

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

    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 example = new alicloud.cen.Instance("example", {
        cenInstanceName: "tf_example",
        description: "an example for cen",
    });
    const exampleTransitRouter = new alicloud.cen.TransitRouter("example", {
        transitRouterName: "tf_example",
        cenId: example.id,
        supportMulticast: true,
    });
    const exampleTransitRouterMulticastDomain = new alicloud.cen.TransitRouterMulticastDomain("example", {
        transitRouterId: exampleTransitRouter.transitRouterId,
        transitRouterMulticastDomainName: "tf_example",
        transitRouterMulticastDomainDescription: "tf_example",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.cen.Instance("example",
        cen_instance_name="tf_example",
        description="an example for cen")
    example_transit_router = alicloud.cen.TransitRouter("example",
        transit_router_name="tf_example",
        cen_id=example.id,
        support_multicast=True)
    example_transit_router_multicast_domain = alicloud.cen.TransitRouterMulticastDomain("example",
        transit_router_id=example_transit_router.transit_router_id,
        transit_router_multicast_domain_name="tf_example",
        transit_router_multicast_domain_description="tf_example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cen"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := cen.NewInstance(ctx, "example", &cen.InstanceArgs{
    			CenInstanceName: pulumi.String("tf_example"),
    			Description:     pulumi.String("an example for cen"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleTransitRouter, err := cen.NewTransitRouter(ctx, "example", &cen.TransitRouterArgs{
    			TransitRouterName: pulumi.String("tf_example"),
    			CenId:             example.ID(),
    			SupportMulticast:  pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cen.NewTransitRouterMulticastDomain(ctx, "example", &cen.TransitRouterMulticastDomainArgs{
    			TransitRouterId:                         exampleTransitRouter.TransitRouterId,
    			TransitRouterMulticastDomainName:        pulumi.String("tf_example"),
    			TransitRouterMulticastDomainDescription: pulumi.String("tf_example"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AliCloud.Cen.Instance("example", new()
        {
            CenInstanceName = "tf_example",
            Description = "an example for cen",
        });
    
        var exampleTransitRouter = new AliCloud.Cen.TransitRouter("example", new()
        {
            TransitRouterName = "tf_example",
            CenId = example.Id,
            SupportMulticast = true,
        });
    
        var exampleTransitRouterMulticastDomain = new AliCloud.Cen.TransitRouterMulticastDomain("example", new()
        {
            TransitRouterId = exampleTransitRouter.TransitRouterId,
            TransitRouterMulticastDomainName = "tf_example",
            TransitRouterMulticastDomainDescription = "tf_example",
        });
    
    });
    
    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 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 example = new Instance("example", InstanceArgs.builder()
                .cenInstanceName("tf_example")
                .description("an example for cen")
                .build());
    
            var exampleTransitRouter = new TransitRouter("exampleTransitRouter", TransitRouterArgs.builder()
                .transitRouterName("tf_example")
                .cenId(example.id())
                .supportMulticast(true)
                .build());
    
            var exampleTransitRouterMulticastDomain = new TransitRouterMulticastDomain("exampleTransitRouterMulticastDomain", TransitRouterMulticastDomainArgs.builder()
                .transitRouterId(exampleTransitRouter.transitRouterId())
                .transitRouterMulticastDomainName("tf_example")
                .transitRouterMulticastDomainDescription("tf_example")
                .build());
    
        }
    }
    
    resources:
      example:
        type: alicloud:cen:Instance
        properties:
          cenInstanceName: tf_example
          description: an example for cen
      exampleTransitRouter:
        type: alicloud:cen:TransitRouter
        name: example
        properties:
          transitRouterName: tf_example
          cenId: ${example.id}
          supportMulticast: true
      exampleTransitRouterMulticastDomain:
        type: alicloud:cen:TransitRouterMulticastDomain
        name: example
        properties:
          transitRouterId: ${exampleTransitRouter.transitRouterId}
          transitRouterMulticastDomainName: tf_example
          transitRouterMulticastDomainDescription: tf_example
    

    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,
                                     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 string
    The unique name of the resource.
    args TransitRouterMulticastDomainArgs
    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 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 string
    The unique name of the resource.
    args TransitRouterMulticastDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransitRouterMulticastDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
        Tags = 
        {
            { "string", "string" },
        },
        TransitRouterMulticastDomainDescription = "string",
        TransitRouterMulticastDomainName = "string",
    });
    
    example, err := cen.NewTransitRouterMulticastDomain(ctx, "transitRouterMulticastDomainResource", &cen.TransitRouterMulticastDomainArgs{
    	TransitRouterId: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TransitRouterMulticastDomainDescription: pulumi.String("string"),
    	TransitRouterMulticastDomainName:        pulumi.String("string"),
    })
    
    var transitRouterMulticastDomainResource = new TransitRouterMulticastDomain("transitRouterMulticastDomainResource", TransitRouterMulticastDomainArgs.builder()
        .transitRouterId("string")
        .tags(Map.of("string", "string"))
        .transitRouterMulticastDomainDescription("string")
        .transitRouterMulticastDomainName("string")
        .build());
    
    transit_router_multicast_domain_resource = alicloud.cen.TransitRouterMulticastDomain("transitRouterMulticastDomainResource",
        transit_router_id="string",
        tags={
            "string": "string",
        },
        transit_router_multicast_domain_description="string",
        transit_router_multicast_domain_name="string")
    
    const transitRouterMulticastDomainResource = new alicloud.cen.TransitRouterMulticastDomain("transitRouterMulticastDomainResource", {
        transitRouterId: "string",
        tags: {
            string: "string",
        },
        transitRouterMulticastDomainDescription: "string",
        transitRouterMulticastDomainName: "string",
    });
    
    type: alicloud:cen:TransitRouterMulticastDomain
    properties:
        tags:
            string: string
        transitRouterId: string
        transitRouterMulticastDomainDescription: string
        transitRouterMulticastDomainName: string
    

    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 string
    The ID of the transit router.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TransitRouterMulticastDomainDescription string
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    TransitRouterMulticastDomainName string
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    TransitRouterId string
    The ID of the transit router.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TransitRouterMulticastDomainDescription string
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    TransitRouterMulticastDomainName string
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transitRouterId String
    The ID of the transit router.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    transitRouterMulticastDomainDescription String
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transitRouterMulticastDomainName String
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transitRouterId string
    The ID of the transit router.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    transitRouterMulticastDomainDescription string
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transitRouterMulticastDomainName string
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transit_router_id str
    The ID of the transit router.
    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. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transit_router_multicast_domain_name str
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transitRouterId String
    The ID of the transit router.
    tags Map<String>
    A mapping of tags to assign to the resource.
    transitRouterMulticastDomainDescription String
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transitRouterMulticastDomainName String
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).

    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.
    Status string
    The status of the Transit Router Multicast Domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the Transit Router Multicast Domain.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the Transit Router Multicast Domain.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the Transit Router Multicast Domain.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the Transit Router Multicast Domain.
    id String
    The provider-assigned unique ID for this managed resource.
    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,
            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)
    Resource lookup is not supported in YAML
    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:
    Status string
    The status of the Transit Router Multicast Domain.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TransitRouterId string
    The ID of the transit router.
    TransitRouterMulticastDomainDescription string
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    TransitRouterMulticastDomainName string
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    Status string
    The status of the Transit Router Multicast Domain.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TransitRouterId string
    The ID of the transit router.
    TransitRouterMulticastDomainDescription string
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    TransitRouterMulticastDomainName string
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    status String
    The status of the Transit Router Multicast Domain.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    transitRouterId String
    The ID of the transit router.
    transitRouterMulticastDomainDescription String
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transitRouterMulticastDomainName String
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    status string
    The status of the Transit Router Multicast Domain.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    transitRouterId string
    The ID of the transit router.
    transitRouterMulticastDomainDescription string
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transitRouterMulticastDomainName string
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    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 str
    The ID of the transit router.
    transit_router_multicast_domain_description str
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transit_router_multicast_domain_name str
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    status String
    The status of the Transit Router Multicast Domain.
    tags Map<String>
    A mapping of tags to assign to the resource.
    transitRouterId String
    The ID of the transit router.
    transitRouterMulticastDomainDescription String
    The description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
    transitRouterMulticastDomainName String
    The name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).

    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>
    

    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.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi