1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. transitrouter
  5. TransitRouter
Viewing docs for bytepluscc v0.0.22
published on Thursday, Apr 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.transitrouter.TransitRouter

bytepluscc logo
Viewing docs for bytepluscc v0.0.22
published on Thursday, Apr 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Platform on which the transit router service runs. Receives traffic from network instances and forwards it according to the associated forwarding route table

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const transitRouterDemo = new bytepluscc.transitrouter.TransitRouter("TransitRouterDemo", {
    transitRouterName: "TransitRouterDemo",
    asn: 4200001111,
    description: "TransitRouterDemo",
    projectName: "default",
    tags: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

transit_router_demo = bytepluscc.transitrouter.TransitRouter("TransitRouterDemo",
    transit_router_name="TransitRouterDemo",
    asn=4200001111,
    description="TransitRouterDemo",
    project_name="default",
    tags=[{
        "key": "env",
        "value": "test",
    }])

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/transitrouter"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := transitrouter.NewTransitRouter(ctx, "TransitRouterDemo", &transitrouter.TransitRouterArgs{
			TransitRouterName: pulumi.String("TransitRouterDemo"),
			Asn:               pulumi.Int(4200001111),
			Description:       pulumi.String("TransitRouterDemo"),
			ProjectName:       pulumi.String("default"),
			Tags: transitrouter.TransitRouterTagArray{
				&transitrouter.TransitRouterTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var transitRouterDemo = new Bytepluscc.Transitrouter.TransitRouter("TransitRouterDemo", new()
    {
        TransitRouterName = "TransitRouterDemo",
        Asn = 4200001111,
        Description = "TransitRouterDemo",
        ProjectName = "default",
        Tags = new[]
        {
            new Bytepluscc.Transitrouter.Inputs.TransitRouterTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.transitrouter.TransitRouter;
import com.byteplus.bytepluscc.transitrouter.TransitRouterArgs;
import com.pulumi.bytepluscc.transitrouter.inputs.TransitRouterTagArgs;
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 transitRouterDemo = new TransitRouter("transitRouterDemo", TransitRouterArgs.builder()
            .transitRouterName("TransitRouterDemo")
            .asn(4200001111)
            .description("TransitRouterDemo")
            .projectName("default")
            .tags(TransitRouterTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  transitRouterDemo:
    type: bytepluscc:transitrouter:TransitRouter
    name: TransitRouterDemo
    properties:
      transitRouterName: TransitRouterDemo
      asn: 4.200001111e+09
      description: TransitRouterDemo
      projectName: default
      tags:
        - key: env
          value: test

    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: Optional[TransitRouterArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def TransitRouter(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  asn: Optional[int] = None,
                  description: Optional[str] = None,
                  multicast_enabled: Optional[bool] = None,
                  project_name: Optional[str] = None,
                  tags: Optional[Sequence[TransitRouterTagArgs]] = 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 = null, CustomResourceOptions? opts = null)
    public TransitRouter(String name, TransitRouterArgs args)
public TransitRouter(String name, TransitRouterArgs args, CustomResourceOptions options)

    type: bytepluscc:transitrouter: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 Bytepluscc.Transitrouter.TransitRouter("transitRouterResource", new()
{
    Asn = 0,
    Description = "string",
    MulticastEnabled = false,
    ProjectName = "string",
    Tags = new[]
    {
        new Bytepluscc.Transitrouter.Inputs.TransitRouterTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TransitRouterName = "string",
});

    example, err := transitrouter.NewTransitRouter(ctx, "transitRouterResource", &transitrouter.TransitRouterArgs{
	Asn:              pulumi.Int(0),
	Description:      pulumi.String("string"),
	MulticastEnabled: pulumi.Bool(false),
	ProjectName:      pulumi.String("string"),
	Tags: transitrouter.TransitRouterTagArray{
		&transitrouter.TransitRouterTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TransitRouterName: pulumi.String("string"),
})

    var transitRouterResource = new TransitRouter("transitRouterResource", TransitRouterArgs.builder()
    .asn(0)
    .description("string")
    .multicastEnabled(false)
    .projectName("string")
    .tags(TransitRouterTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .transitRouterName("string")
    .build());

    transit_router_resource = bytepluscc.transitrouter.TransitRouter("transitRouterResource",
    asn=0,
    description="string",
    multicast_enabled=False,
    project_name="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    transit_router_name="string")

    const transitRouterResource = new bytepluscc.transitrouter.TransitRouter("transitRouterResource", {
    asn: 0,
    description: "string",
    multicastEnabled: false,
    projectName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    transitRouterName: "string",
});

    type: bytepluscc:transitrouter:TransitRouter
properties:
    asn: 0
    description: string
    multicastEnabled: false
    projectName: string
    tags:
        - key: string
          value: 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:

    Asn int
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    Description string
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    MulticastEnabled bool
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    ProjectName string
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    Tags List<Byteplus.TransitRouterTag>
    TransitRouterName string
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    Asn int
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    Description string
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    MulticastEnabled bool
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    ProjectName string
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    Tags []TransitRouterTagArgs
    TransitRouterName string
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    asn Integer
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    description String
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    multicastEnabled Boolean
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    projectName String
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    tags List<TransitRouterTag>
    transitRouterName String
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    asn number
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    description string
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    multicastEnabled boolean
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    projectName string
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    tags TransitRouterTag[]
    transitRouterName string
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    asn int
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    description str
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    multicast_enabled bool
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    project_name str
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    tags Sequence[TransitRouterTagArgs]
    transit_router_name str
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    asn Number
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    description String
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    multicastEnabled Boolean
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    projectName String
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    tags List<Property Map>
    transitRouterName String
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.

    Outputs

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

    Attachments List<Byteplus.TransitRouterAttachment>
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    GrantSourceType string
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    GrantStatus string
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    Id string
    The provider-assigned unique ID for this managed resource.
    OverdueTime string
    Shutdown time due to overdue payment for the transit router instance
    Status string
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    TransitRouterId string
    Transit router instance ID.
    UpdateTime string
    Last operation time of the transit router instance
    Attachments []TransitRouterAttachment
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    GrantSourceType string
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    GrantStatus string
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    Id string
    The provider-assigned unique ID for this managed resource.
    OverdueTime string
    Shutdown time due to overdue payment for the transit router instance
    Status string
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    TransitRouterId string
    Transit router instance ID.
    UpdateTime string
    Last operation time of the transit router instance
    attachments List<TransitRouterAttachment>
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    grantSourceType String
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grantStatus String
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    id String
    The provider-assigned unique ID for this managed resource.
    overdueTime String
    Shutdown time due to overdue payment for the transit router instance
    status String
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    transitRouterId String
    Transit router instance ID.
    updateTime String
    Last operation time of the transit router instance
    attachments TransitRouterAttachment[]
    businessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime string
    Creation time of the network instance connection.
    deletedTime string
    Deletion time of the network instance connection.
    grantSourceType string
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grantStatus string
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    id string
    The provider-assigned unique ID for this managed resource.
    overdueTime string
    Shutdown time due to overdue payment for the transit router instance
    status string
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    transitRouterId string
    Transit router instance ID.
    updateTime string
    Last operation time of the transit router instance
    attachments Sequence[TransitRouterAttachment]
    business_status str
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creation_time str
    Creation time of the network instance connection.
    deleted_time str
    Deletion time of the network instance connection.
    grant_source_type str
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grant_status str
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    id str
    The provider-assigned unique ID for this managed resource.
    overdue_time str
    Shutdown time due to overdue payment for the transit router instance
    status str
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    transit_router_id str
    Transit router instance ID.
    update_time str
    Last operation time of the transit router instance
    attachments List<Property Map>
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    grantSourceType String
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grantStatus String
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    id String
    The provider-assigned unique ID for this managed resource.
    overdueTime String
    Shutdown time due to overdue payment for the transit router instance
    status String
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    transitRouterId String
    Transit router instance ID.
    updateTime String
    Last operation time of the transit router instance

    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,
        asn: Optional[int] = None,
        attachments: Optional[Sequence[TransitRouterAttachmentArgs]] = None,
        business_status: Optional[str] = None,
        creation_time: Optional[str] = None,
        deleted_time: Optional[str] = None,
        description: Optional[str] = None,
        grant_source_type: Optional[str] = None,
        grant_status: Optional[str] = None,
        multicast_enabled: Optional[bool] = None,
        overdue_time: Optional[str] = None,
        project_name: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[TransitRouterTagArgs]] = None,
        transit_router_id: Optional[str] = None,
        transit_router_name: Optional[str] = None,
        update_time: 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)
    resources:  _:    type: bytepluscc:transitrouter:TransitRouter    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:
    Asn int
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    Attachments List<Byteplus.TransitRouterAttachment>
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    Description string
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    GrantSourceType string
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    GrantStatus string
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    MulticastEnabled bool
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    OverdueTime string
    Shutdown time due to overdue payment for the transit router instance
    ProjectName string
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    Status string
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags List<Byteplus.TransitRouterTag>
    TransitRouterId string
    Transit router instance ID.
    TransitRouterName string
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    UpdateTime string
    Last operation time of the transit router instance
    Asn int
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    Attachments []TransitRouterAttachmentArgs
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    Description string
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    GrantSourceType string
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    GrantStatus string
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    MulticastEnabled bool
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    OverdueTime string
    Shutdown time due to overdue payment for the transit router instance
    ProjectName string
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    Status string
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags []TransitRouterTagArgs
    TransitRouterId string
    Transit router instance ID.
    TransitRouterName string
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    UpdateTime string
    Last operation time of the transit router instance
    asn Integer
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    attachments List<TransitRouterAttachment>
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    description String
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    grantSourceType String
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grantStatus String
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    multicastEnabled Boolean
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    overdueTime String
    Shutdown time due to overdue payment for the transit router instance
    projectName String
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    status String
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<TransitRouterTag>
    transitRouterId String
    Transit router instance ID.
    transitRouterName String
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    updateTime String
    Last operation time of the transit router instance
    asn number
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    attachments TransitRouterAttachment[]
    businessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime string
    Creation time of the network instance connection.
    deletedTime string
    Deletion time of the network instance connection.
    description string
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    grantSourceType string
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grantStatus string
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    multicastEnabled boolean
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    overdueTime string
    Shutdown time due to overdue payment for the transit router instance
    projectName string
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    status string
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags TransitRouterTag[]
    transitRouterId string
    Transit router instance ID.
    transitRouterName string
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    updateTime string
    Last operation time of the transit router instance
    asn int
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    attachments Sequence[TransitRouterAttachmentArgs]
    business_status str
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creation_time str
    Creation time of the network instance connection.
    deleted_time str
    Deletion time of the network instance connection.
    description str
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    grant_source_type str
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grant_status str
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    multicast_enabled bool
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    overdue_time str
    Shutdown time due to overdue payment for the transit router instance
    project_name str
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    status str
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags Sequence[TransitRouterTagArgs]
    transit_router_id str
    Transit router instance ID.
    transit_router_name str
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    update_time str
    Last operation time of the transit router instance
    asn Number
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    attachments List<Property Map>
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    description String
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    grantSourceType String
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grantStatus String
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    multicastEnabled Boolean
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    overdueTime String
    Shutdown time due to overdue payment for the transit router instance
    projectName String
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    status String
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<Property Map>
    transitRouterId String
    Transit router instance ID.
    transitRouterName String
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    updateTime String
    Last operation time of the transit router instance

    Supporting Types

    TransitRouterAttachment, TransitRouterAttachmentArgs

    AutoPublishRouteEnabled bool
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    Description string
    Description of the network instance connection.
    Ipv6Enabled bool
    Whether IPv6 is enabled. true: yes. false: no
    OverdueTime string
    Shutdown time due to overdue payment for the network instance connection
    ResourceId string
    ID of the network instance
    ResourceType string
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    Status string
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags List<Byteplus.TransitRouterAttachmentTag>
    TransitRouterAttachmentId string
    Network instance connection ID.
    TransitRouterAttachmentName string
    Name of the network instance connection
    TransitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection
    TransitRouterId string
    Transit router instance ID.
    TransitRouterRouteTableId string
    Route table ID associated with the forwarding of the network instance connection.
    TransitRouterTrafficQosMarkingPolicyId string
    ID of the flow marking policy associated with the cross-region connection
    TransitRouterTrafficQosQueuePolicyId string
    ID of the flow queue policy associated with the cross-region connection
    UpdateTime string
    Last operation time of the network instance connection
    AutoPublishRouteEnabled bool
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    Description string
    Description of the network instance connection.
    Ipv6Enabled bool
    Whether IPv6 is enabled. true: yes. false: no
    OverdueTime string
    Shutdown time due to overdue payment for the network instance connection
    ResourceId string
    ID of the network instance
    ResourceType string
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    Status string
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags []TransitRouterAttachmentTag
    TransitRouterAttachmentId string
    Network instance connection ID.
    TransitRouterAttachmentName string
    Name of the network instance connection
    TransitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection
    TransitRouterId string
    Transit router instance ID.
    TransitRouterRouteTableId string
    Route table ID associated with the forwarding of the network instance connection.
    TransitRouterTrafficQosMarkingPolicyId string
    ID of the flow marking policy associated with the cross-region connection
    TransitRouterTrafficQosQueuePolicyId string
    ID of the flow queue policy associated with the cross-region connection
    UpdateTime string
    Last operation time of the network instance connection
    autoPublishRouteEnabled Boolean
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    description String
    Description of the network instance connection.
    ipv6Enabled Boolean
    Whether IPv6 is enabled. true: yes. false: no
    overdueTime String
    Shutdown time due to overdue payment for the network instance connection
    resourceId String
    ID of the network instance
    resourceType String
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    status String
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<TransitRouterAttachmentTag>
    transitRouterAttachmentId String
    Network instance connection ID.
    transitRouterAttachmentName String
    Name of the network instance connection
    transitRouterForwardPolicyTableId String
    ID of the forwarding policy associated with the cross-region connection
    transitRouterId String
    Transit router instance ID.
    transitRouterRouteTableId String
    Route table ID associated with the forwarding of the network instance connection.
    transitRouterTrafficQosMarkingPolicyId String
    ID of the flow marking policy associated with the cross-region connection
    transitRouterTrafficQosQueuePolicyId String
    ID of the flow queue policy associated with the cross-region connection
    updateTime String
    Last operation time of the network instance connection
    autoPublishRouteEnabled boolean
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    businessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime string
    Creation time of the network instance connection.
    deletedTime string
    Deletion time of the network instance connection.
    description string
    Description of the network instance connection.
    ipv6Enabled boolean
    Whether IPv6 is enabled. true: yes. false: no
    overdueTime string
    Shutdown time due to overdue payment for the network instance connection
    resourceId string
    ID of the network instance
    resourceType string
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    status string
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags TransitRouterAttachmentTag[]
    transitRouterAttachmentId string
    Network instance connection ID.
    transitRouterAttachmentName string
    Name of the network instance connection
    transitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection
    transitRouterId string
    Transit router instance ID.
    transitRouterRouteTableId string
    Route table ID associated with the forwarding of the network instance connection.
    transitRouterTrafficQosMarkingPolicyId string
    ID of the flow marking policy associated with the cross-region connection
    transitRouterTrafficQosQueuePolicyId string
    ID of the flow queue policy associated with the cross-region connection
    updateTime string
    Last operation time of the network instance connection
    auto_publish_route_enabled bool
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    business_status str
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creation_time str
    Creation time of the network instance connection.
    deleted_time str
    Deletion time of the network instance connection.
    description str
    Description of the network instance connection.
    ipv6_enabled bool
    Whether IPv6 is enabled. true: yes. false: no
    overdue_time str
    Shutdown time due to overdue payment for the network instance connection
    resource_id str
    ID of the network instance
    resource_type str
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    status str
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags Sequence[TransitRouterAttachmentTag]
    transit_router_attachment_id str
    Network instance connection ID.
    transit_router_attachment_name str
    Name of the network instance connection
    transit_router_forward_policy_table_id str
    ID of the forwarding policy associated with the cross-region connection
    transit_router_id str
    Transit router instance ID.
    transit_router_route_table_id str
    Route table ID associated with the forwarding of the network instance connection.
    transit_router_traffic_qos_marking_policy_id str
    ID of the flow marking policy associated with the cross-region connection
    transit_router_traffic_qos_queue_policy_id str
    ID of the flow queue policy associated with the cross-region connection
    update_time str
    Last operation time of the network instance connection
    autoPublishRouteEnabled Boolean
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    description String
    Description of the network instance connection.
    ipv6Enabled Boolean
    Whether IPv6 is enabled. true: yes. false: no
    overdueTime String
    Shutdown time due to overdue payment for the network instance connection
    resourceId String
    ID of the network instance
    resourceType String
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    status String
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<Property Map>
    transitRouterAttachmentId String
    Network instance connection ID.
    transitRouterAttachmentName String
    Name of the network instance connection
    transitRouterForwardPolicyTableId String
    ID of the forwarding policy associated with the cross-region connection
    transitRouterId String
    Transit router instance ID.
    transitRouterRouteTableId String
    Route table ID associated with the forwarding of the network instance connection.
    transitRouterTrafficQosMarkingPolicyId String
    ID of the flow marking policy associated with the cross-region connection
    transitRouterTrafficQosQueuePolicyId String
    ID of the flow queue policy associated with the cross-region connection
    updateTime String
    Last operation time of the network instance connection

    TransitRouterAttachmentTag, TransitRouterAttachmentTagArgs

    Key string
    Tag key
    Value string
    Tag value.
    Key string
    Tag key
    Value string
    Tag value.
    key String
    Tag key
    value String
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key str
    Tag key
    value str
    Tag value.
    key String
    Tag key
    value String
    Tag value.

    TransitRouterTag, TransitRouterTagArgs

    Key string
    Tag key
    Value string
    Tag value.
    Key string
    Tag key
    Value string
    Tag value.
    key String
    Tag key
    value String
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key str
    Tag key
    value str
    Tag value.
    key String
    Tag key
    value String
    Tag value.

    Import

    $ pulumi import bytepluscc:transitrouter/transitRouter:TransitRouter example "transit_router_id"

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.22
    published on Thursday, Apr 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.