Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. cen
  5. TransitRouter
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.cen.TransitRouter

Explore with Pulumi AI

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

    Provides a CEN transit router resource that associate the transitRouter with the CEN instance.What is Cen Transit Router

    NOTE: Available since v1.126.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,
});

    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)

    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
		}
		_, err = cen.NewTransitRouter(ctx, "example", &cen.TransitRouterArgs{
			TransitRouterName: pulumi.String("tf_example"),
			CenId:             example.ID(),
		})
		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,
    });

});

    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 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())
            .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}

    Create TransitRouter Resource

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

    Constructor syntax

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

@overload
def TransitRouter(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  cen_id: Optional[str] = None,
                  dry_run: Optional[bool] = None,
                  support_multicast: Optional[bool] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  transit_router_description: Optional[str] = None,
                  transit_router_name: Optional[str] = None)
    func NewTransitRouter(ctx *Context, name string, args TransitRouterArgs, opts ...ResourceOption) (*TransitRouter, error)
    public TransitRouter(string name, TransitRouterArgs args, CustomResourceOptions? opts = null)
    public TransitRouter(String name, TransitRouterArgs args)
public TransitRouter(String name, TransitRouterArgs args, CustomResourceOptions options)

    type: alicloud:cen:TransitRouter
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 TransitRouterArgs
    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 TransitRouterArgs
    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 TransitRouterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransitRouterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TransitRouterArgs
    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 transitRouterResource = new AliCloud.Cen.TransitRouter("transitRouterResource", new()
{
    CenId = "string",
    DryRun = false,
    SupportMulticast = false,
    Tags = 
    {
        { "string", "string" },
    },
    TransitRouterDescription = "string",
    TransitRouterName = "string",
});

    example, err := cen.NewTransitRouter(ctx, "transitRouterResource", &cen.TransitRouterArgs{
	CenId:            pulumi.String("string"),
	DryRun:           pulumi.Bool(false),
	SupportMulticast: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TransitRouterDescription: pulumi.String("string"),
	TransitRouterName:        pulumi.String("string"),
})

    var transitRouterResource = new TransitRouter("transitRouterResource", TransitRouterArgs.builder()
    .cenId("string")
    .dryRun(false)
    .supportMulticast(false)
    .tags(Map.of("string", "string"))
    .transitRouterDescription("string")
    .transitRouterName("string")
    .build());

    transit_router_resource = alicloud.cen.TransitRouter("transitRouterResource",
    cen_id="string",
    dry_run=False,
    support_multicast=False,
    tags={
        "string": "string",
    },
    transit_router_description="string",
    transit_router_name="string")

    const transitRouterResource = new alicloud.cen.TransitRouter("transitRouterResource", {
    cenId: "string",
    dryRun: false,
    supportMulticast: false,
    tags: {
        string: "string",
    },
    transitRouterDescription: "string",
    transitRouterName: "string",
});

    type: alicloud:cen:TransitRouter
properties:
    cenId: string
    dryRun: false
    supportMulticast: false
    tags:
        string: string
    transitRouterDescription: string
    transitRouterName: string

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

    CenId string
    The ID of the CEN.
    DryRun bool
    The dry run.
    SupportMulticast bool
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TransitRouterDescription string
    The description of the transit router.
    TransitRouterName string
    The name of the transit router.
    CenId string
    The ID of the CEN.
    DryRun bool
    The dry run.
    SupportMulticast bool
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TransitRouterDescription string
    The description of the transit router.
    TransitRouterName string
    The name of the transit router.
    cenId String
    The ID of the CEN.
    dryRun Boolean
    The dry run.
    supportMulticast Boolean
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    transitRouterDescription String
    The description of the transit router.
    transitRouterName String
    The name of the transit router.
    cenId string
    The ID of the CEN.
    dryRun boolean
    The dry run.
    supportMulticast boolean
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    transitRouterDescription string
    The description of the transit router.
    transitRouterName string
    The name of the transit router.
    cen_id str
    The ID of the CEN.
    dry_run bool
    The dry run.
    support_multicast bool
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    transit_router_description str
    The description of the transit router.
    transit_router_name str
    The name of the transit router.
    cenId String
    The ID of the CEN.
    dryRun Boolean
    The dry run.
    supportMulticast Boolean
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    tags Map<String>
    A mapping of tags to assign to the resource.
    transitRouterDescription String
    The description of the transit router.
    transitRouterName String
    The name of the transit router.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The associating status of the Transit Router.
    TransitRouterId string
    The transit router id of the transit router.
    Type string
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The associating status of the Transit Router.
    TransitRouterId string
    The transit router id of the transit router.
    Type string
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The associating status of the Transit Router.
    transitRouterId String
    The transit router id of the transit router.
    type String
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The associating status of the Transit Router.
    transitRouterId string
    The transit router id of the transit router.
    type string
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The associating status of the Transit Router.
    transit_router_id str
    The transit router id of the transit router.
    type str
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The associating status of the Transit Router.
    transitRouterId String
    The transit router id of the transit router.
    type String
    The Type of the Transit Router. Valid values: Enterprise, Basic.

    Look up Existing TransitRouter Resource

    Get an existing TransitRouter 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?: TransitRouterState, opts?: CustomResourceOptions): TransitRouter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cen_id: Optional[str] = None,
        dry_run: Optional[bool] = None,
        status: Optional[str] = None,
        support_multicast: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        transit_router_description: Optional[str] = None,
        transit_router_id: Optional[str] = None,
        transit_router_name: Optional[str] = None,
        type: Optional[str] = None) -> TransitRouter
    func GetTransitRouter(ctx *Context, name string, id IDInput, state *TransitRouterState, opts ...ResourceOption) (*TransitRouter, error)
    public static TransitRouter Get(string name, Input<string> id, TransitRouterState? state, CustomResourceOptions? opts = null)
    public static TransitRouter get(String name, Output<String> id, TransitRouterState 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:
    CenId string
    The ID of the CEN.
    DryRun bool
    The dry run.
    Status string
    The associating status of the Transit Router.
    SupportMulticast bool
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TransitRouterDescription string
    The description of the transit router.
    TransitRouterId string
    The transit router id of the transit router.
    TransitRouterName string
    The name of the transit router.
    Type string
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    CenId string
    The ID of the CEN.
    DryRun bool
    The dry run.
    Status string
    The associating status of the Transit Router.
    SupportMulticast bool
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TransitRouterDescription string
    The description of the transit router.
    TransitRouterId string
    The transit router id of the transit router.
    TransitRouterName string
    The name of the transit router.
    Type string
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    cenId String
    The ID of the CEN.
    dryRun Boolean
    The dry run.
    status String
    The associating status of the Transit Router.
    supportMulticast Boolean
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    transitRouterDescription String
    The description of the transit router.
    transitRouterId String
    The transit router id of the transit router.
    transitRouterName String
    The name of the transit router.
    type String
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    cenId string
    The ID of the CEN.
    dryRun boolean
    The dry run.
    status string
    The associating status of the Transit Router.
    supportMulticast boolean
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    transitRouterDescription string
    The description of the transit router.
    transitRouterId string
    The transit router id of the transit router.
    transitRouterName string
    The name of the transit router.
    type string
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    cen_id str
    The ID of the CEN.
    dry_run bool
    The dry run.
    status str
    The associating status of the Transit Router.
    support_multicast bool
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    transit_router_description str
    The description of the transit router.
    transit_router_id str
    The transit router id of the transit router.
    transit_router_name str
    The name of the transit router.
    type str
    The Type of the Transit Router. Valid values: Enterprise, Basic.
    cenId String
    The ID of the CEN.
    dryRun Boolean
    The dry run.
    status String
    The associating status of the Transit Router.
    supportMulticast Boolean
    Specifies whether to enable the multicast feature for the Enterprise Edition transit router. Valid values: false, true. Default Value: false. The multicast feature is supported only in specific regions. You can call ListTransitRouterAvailableResource to query the regions that support multicast.
    tags Map<String>
    A mapping of tags to assign to the resource.
    transitRouterDescription String
    The description of the transit router.
    transitRouterId String
    The transit router id of the transit router.
    transitRouterName String
    The name of the transit router.
    type String
    The Type of the Transit Router. Valid values: Enterprise, Basic.

    Import

    CEN instance can be imported using the id, e.g.

    $ pulumi import alicloud:cen/transitRouter:TransitRouter default cen-*****:tr-*******

    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
    pulumi/pulumi-alicloud