1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. transitrouter
  6. PeerAttachment
Viewing docs for volcenginecc v0.0.33
published on Thursday, May 7, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.transitrouter.PeerAttachment

volcenginecc logo
Viewing docs for volcenginecc v0.0.33
published on Thursday, May 7, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    A connection established between TR instances in two different regions enables cross-region communication.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const transitRouterPeerAttachmentDemo = new volcenginecc.transitrouter.PeerAttachment("TransitRouterPeerAttachmentDemo", {
    transitRouterId: "tr-mjcxxxx",
    transitRouterAttachmentName: "ccapi-test-tf",
    description: "tf-test",
    peerTransitRouterId: "tr-xxx",
    peerTransitRouterRegionId: "cn-xx",
    transitRouterBandwidthPackageId: "tbp-13f34rxxxx",
    bandwidth: 2,
    tags: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

transit_router_peer_attachment_demo = volcenginecc.transitrouter.PeerAttachment("TransitRouterPeerAttachmentDemo",
    transit_router_id="tr-mjcxxxx",
    transit_router_attachment_name="ccapi-test-tf",
    description="tf-test",
    peer_transit_router_id="tr-xxx",
    peer_transit_router_region_id="cn-xx",
    transit_router_bandwidth_package_id="tbp-13f34rxxxx",
    bandwidth=2,
    tags=[{
        "key": "env",
        "value": "test",
    }])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/transitrouter"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := transitrouter.NewPeerAttachment(ctx, "TransitRouterPeerAttachmentDemo", &transitrouter.PeerAttachmentArgs{
			TransitRouterId:                 pulumi.String("tr-mjcxxxx"),
			TransitRouterAttachmentName:     pulumi.String("ccapi-test-tf"),
			Description:                     pulumi.String("tf-test"),
			PeerTransitRouterId:             pulumi.String("tr-xxx"),
			PeerTransitRouterRegionId:       pulumi.String("cn-xx"),
			TransitRouterBandwidthPackageId: pulumi.String("tbp-13f34rxxxx"),
			Bandwidth:                       pulumi.Int(2),
			Tags: transitrouter.PeerAttachmentTagArray{
				&transitrouter.PeerAttachmentTagArgs{
					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 Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var transitRouterPeerAttachmentDemo = new Volcenginecc.Transitrouter.PeerAttachment("TransitRouterPeerAttachmentDemo", new()
    {
        TransitRouterId = "tr-mjcxxxx",
        TransitRouterAttachmentName = "ccapi-test-tf",
        Description = "tf-test",
        PeerTransitRouterId = "tr-xxx",
        PeerTransitRouterRegionId = "cn-xx",
        TransitRouterBandwidthPackageId = "tbp-13f34rxxxx",
        Bandwidth = 2,
        Tags = new[]
        {
            new Volcenginecc.Transitrouter.Inputs.PeerAttachmentTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.transitrouter.PeerAttachment;
import com.volcengine.volcenginecc.transitrouter.PeerAttachmentArgs;
import com.pulumi.volcenginecc.transitrouter.inputs.PeerAttachmentTagArgs;
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 transitRouterPeerAttachmentDemo = new PeerAttachment("transitRouterPeerAttachmentDemo", PeerAttachmentArgs.builder()
            .transitRouterId("tr-mjcxxxx")
            .transitRouterAttachmentName("ccapi-test-tf")
            .description("tf-test")
            .peerTransitRouterId("tr-xxx")
            .peerTransitRouterRegionId("cn-xx")
            .transitRouterBandwidthPackageId("tbp-13f34rxxxx")
            .bandwidth(2)
            .tags(PeerAttachmentTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  transitRouterPeerAttachmentDemo:
    type: volcenginecc:transitrouter:PeerAttachment
    name: TransitRouterPeerAttachmentDemo
    properties:
      transitRouterId: tr-mjcxxxx
      transitRouterAttachmentName: ccapi-test-tf
      description: tf-test
      peerTransitRouterId: tr-xxx
      peerTransitRouterRegionId: cn-xx
      transitRouterBandwidthPackageId: tbp-13f34rxxxx
      bandwidth: 2
      tags:
        - key: env
          value: test

    Create PeerAttachment Resource

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

    Constructor syntax

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

@overload
def PeerAttachment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   peer_transit_router_id: Optional[str] = None,
                   peer_transit_router_region_id: Optional[str] = None,
                   transit_router_id: Optional[str] = None,
                   bandwidth: Optional[int] = None,
                   description: Optional[str] = None,
                   tags: Optional[Sequence[PeerAttachmentTagArgs]] = None,
                   transit_router_attachment_name: Optional[str] = None,
                   transit_router_bandwidth_package_id: Optional[str] = None)
    func NewPeerAttachment(ctx *Context, name string, args PeerAttachmentArgs, opts ...ResourceOption) (*PeerAttachment, error)
    public PeerAttachment(string name, PeerAttachmentArgs args, CustomResourceOptions? opts = null)
    public PeerAttachment(String name, PeerAttachmentArgs args)
public PeerAttachment(String name, PeerAttachmentArgs args, CustomResourceOptions options)

    type: volcenginecc:transitrouter:PeerAttachment
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 PeerAttachmentArgs
    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 PeerAttachmentArgs
    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 PeerAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PeerAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PeerAttachmentArgs
    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 peerAttachmentResource = new Volcenginecc.Transitrouter.PeerAttachment("peerAttachmentResource", new()
{
    PeerTransitRouterId = "string",
    PeerTransitRouterRegionId = "string",
    TransitRouterId = "string",
    Bandwidth = 0,
    Description = "string",
    Tags = new[]
    {
        new Volcenginecc.Transitrouter.Inputs.PeerAttachmentTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TransitRouterAttachmentName = "string",
    TransitRouterBandwidthPackageId = "string",
});

    example, err := transitrouter.NewPeerAttachment(ctx, "peerAttachmentResource", &transitrouter.PeerAttachmentArgs{
	PeerTransitRouterId:       pulumi.String("string"),
	PeerTransitRouterRegionId: pulumi.String("string"),
	TransitRouterId:           pulumi.String("string"),
	Bandwidth:                 pulumi.Int(0),
	Description:               pulumi.String("string"),
	Tags: transitrouter.PeerAttachmentTagArray{
		&transitrouter.PeerAttachmentTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TransitRouterAttachmentName:     pulumi.String("string"),
	TransitRouterBandwidthPackageId: pulumi.String("string"),
})

    var peerAttachmentResource = new PeerAttachment("peerAttachmentResource", PeerAttachmentArgs.builder()
    .peerTransitRouterId("string")
    .peerTransitRouterRegionId("string")
    .transitRouterId("string")
    .bandwidth(0)
    .description("string")
    .tags(PeerAttachmentTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .transitRouterAttachmentName("string")
    .transitRouterBandwidthPackageId("string")
    .build());

    peer_attachment_resource = volcenginecc.transitrouter.PeerAttachment("peerAttachmentResource",
    peer_transit_router_id="string",
    peer_transit_router_region_id="string",
    transit_router_id="string",
    bandwidth=0,
    description="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    transit_router_attachment_name="string",
    transit_router_bandwidth_package_id="string")

    const peerAttachmentResource = new volcenginecc.transitrouter.PeerAttachment("peerAttachmentResource", {
    peerTransitRouterId: "string",
    peerTransitRouterRegionId: "string",
    transitRouterId: "string",
    bandwidth: 0,
    description: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    transitRouterAttachmentName: "string",
    transitRouterBandwidthPackageId: "string",
});

    type: volcenginecc:transitrouter:PeerAttachment
properties:
    bandwidth: 0
    description: string
    peerTransitRouterId: string
    peerTransitRouterRegionId: string
    tags:
        - key: string
          value: string
    transitRouterAttachmentName: string
    transitRouterBandwidthPackageId: string
    transitRouterId: string

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

    PeerTransitRouterId string
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    PeerTransitRouterRegionId string
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    TransitRouterId string
    ID of the local transit router instance.
    Bandwidth int
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    Description string
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    Tags List<Volcengine.PeerAttachmentTag>
    TransitRouterAttachmentName string
    Name of the cross-region connection. 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.
    TransitRouterBandwidthPackageId string
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    PeerTransitRouterId string
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    PeerTransitRouterRegionId string
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    TransitRouterId string
    ID of the local transit router instance.
    Bandwidth int
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    Description string
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    Tags []PeerAttachmentTagArgs
    TransitRouterAttachmentName string
    Name of the cross-region connection. 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.
    TransitRouterBandwidthPackageId string
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    peerTransitRouterId String
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    peerTransitRouterRegionId String
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    transitRouterId String
    ID of the local transit router instance.
    bandwidth Integer
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    description String
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    tags List<PeerAttachmentTag>
    transitRouterAttachmentName String
    Name of the cross-region connection. 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.
    transitRouterBandwidthPackageId String
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    peerTransitRouterId string
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    peerTransitRouterRegionId string
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    transitRouterId string
    ID of the local transit router instance.
    bandwidth number
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    description string
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    tags PeerAttachmentTag[]
    transitRouterAttachmentName string
    Name of the cross-region connection. 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.
    transitRouterBandwidthPackageId string
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    peer_transit_router_id str
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    peer_transit_router_region_id str
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    transit_router_id str
    ID of the local transit router instance.
    bandwidth int
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    description str
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    tags Sequence[PeerAttachmentTagArgs]
    transit_router_attachment_name str
    Name of the cross-region connection. 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.
    transit_router_bandwidth_package_id str
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    peerTransitRouterId String
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    peerTransitRouterRegionId String
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    transitRouterId String
    ID of the local transit router instance.
    bandwidth Number
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    description String
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    tags List<Property Map>
    transitRouterAttachmentName String
    Name of the cross-region connection. 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.
    transitRouterBandwidthPackageId String
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.

    Outputs

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

    AutoPublishRouteEnabled bool
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    CreationTime string
    Creation time of the cross-region connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv6Enabled bool
    Enable IPv6. true: Yes. false: No.
    Status string
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    TransitRouterAttachmentId string
    ID of the cross-region connection.
    TransitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection.
    TransitRouterRouteTableId string
    Associated forwarding route table for the cross-region connection.
    TransitRouterTrafficQosMarkingPolicyId string
    ID of the traffic 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 cross-region connection.
    AutoPublishRouteEnabled bool
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    CreationTime string
    Creation time of the cross-region connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv6Enabled bool
    Enable IPv6. true: Yes. false: No.
    Status string
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    TransitRouterAttachmentId string
    ID of the cross-region connection.
    TransitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection.
    TransitRouterRouteTableId string
    Associated forwarding route table for the cross-region connection.
    TransitRouterTrafficQosMarkingPolicyId string
    ID of the traffic 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 cross-region connection.
    autoPublishRouteEnabled Boolean
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    creationTime String
    Creation time of the cross-region connection.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv6Enabled Boolean
    Enable IPv6. true: Yes. false: No.
    status String
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    transitRouterAttachmentId String
    ID of the cross-region connection.
    transitRouterForwardPolicyTableId String
    ID of the forwarding policy associated with the cross-region connection.
    transitRouterRouteTableId String
    Associated forwarding route table for the cross-region connection.
    transitRouterTrafficQosMarkingPolicyId String
    ID of the traffic 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 cross-region connection.
    autoPublishRouteEnabled boolean
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    creationTime string
    Creation time of the cross-region connection.
    id string
    The provider-assigned unique ID for this managed resource.
    ipv6Enabled boolean
    Enable IPv6. true: Yes. false: No.
    status string
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    transitRouterAttachmentId string
    ID of the cross-region connection.
    transitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection.
    transitRouterRouteTableId string
    Associated forwarding route table for the cross-region connection.
    transitRouterTrafficQosMarkingPolicyId string
    ID of the traffic 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 cross-region connection.
    auto_publish_route_enabled bool
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    creation_time str
    Creation time of the cross-region connection.
    id str
    The provider-assigned unique ID for this managed resource.
    ipv6_enabled bool
    Enable IPv6. true: Yes. false: No.
    status str
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    transit_router_attachment_id str
    ID of the cross-region connection.
    transit_router_forward_policy_table_id str
    ID of the forwarding policy associated with the cross-region connection.
    transit_router_route_table_id str
    Associated forwarding route table for the cross-region connection.
    transit_router_traffic_qos_marking_policy_id str
    ID of the traffic 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 cross-region connection.
    autoPublishRouteEnabled Boolean
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    creationTime String
    Creation time of the cross-region connection.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv6Enabled Boolean
    Enable IPv6. true: Yes. false: No.
    status String
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    transitRouterAttachmentId String
    ID of the cross-region connection.
    transitRouterForwardPolicyTableId String
    ID of the forwarding policy associated with the cross-region connection.
    transitRouterRouteTableId String
    Associated forwarding route table for the cross-region connection.
    transitRouterTrafficQosMarkingPolicyId String
    ID of the traffic 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 cross-region connection.

    Look up Existing PeerAttachment Resource

    Get an existing PeerAttachment 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?: PeerAttachmentState, opts?: CustomResourceOptions): PeerAttachment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_publish_route_enabled: Optional[bool] = None,
        bandwidth: Optional[int] = None,
        creation_time: Optional[str] = None,
        description: Optional[str] = None,
        ipv6_enabled: Optional[bool] = None,
        peer_transit_router_id: Optional[str] = None,
        peer_transit_router_region_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[PeerAttachmentTagArgs]] = None,
        transit_router_attachment_id: Optional[str] = None,
        transit_router_attachment_name: Optional[str] = None,
        transit_router_bandwidth_package_id: Optional[str] = None,
        transit_router_forward_policy_table_id: Optional[str] = None,
        transit_router_id: Optional[str] = None,
        transit_router_route_table_id: Optional[str] = None,
        transit_router_traffic_qos_marking_policy_id: Optional[str] = None,
        transit_router_traffic_qos_queue_policy_id: Optional[str] = None,
        update_time: Optional[str] = None) -> PeerAttachment
    func GetPeerAttachment(ctx *Context, name string, id IDInput, state *PeerAttachmentState, opts ...ResourceOption) (*PeerAttachment, error)
    public static PeerAttachment Get(string name, Input<string> id, PeerAttachmentState? state, CustomResourceOptions? opts = null)
    public static PeerAttachment get(String name, Output<String> id, PeerAttachmentState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:transitrouter:PeerAttachment    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:
    AutoPublishRouteEnabled bool
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    Bandwidth int
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    CreationTime string
    Creation time of the cross-region connection.
    Description string
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    Ipv6Enabled bool
    Enable IPv6. true: Yes. false: No.
    PeerTransitRouterId string
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    PeerTransitRouterRegionId string
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    Status string
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    Tags List<Volcengine.PeerAttachmentTag>
    TransitRouterAttachmentId string
    ID of the cross-region connection.
    TransitRouterAttachmentName string
    Name of the cross-region connection. 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.
    TransitRouterBandwidthPackageId string
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    TransitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection.
    TransitRouterId string
    ID of the local transit router instance.
    TransitRouterRouteTableId string
    Associated forwarding route table for the cross-region connection.
    TransitRouterTrafficQosMarkingPolicyId string
    ID of the traffic 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 cross-region connection.
    AutoPublishRouteEnabled bool
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    Bandwidth int
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    CreationTime string
    Creation time of the cross-region connection.
    Description string
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    Ipv6Enabled bool
    Enable IPv6. true: Yes. false: No.
    PeerTransitRouterId string
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    PeerTransitRouterRegionId string
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    Status string
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    Tags []PeerAttachmentTagArgs
    TransitRouterAttachmentId string
    ID of the cross-region connection.
    TransitRouterAttachmentName string
    Name of the cross-region connection. 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.
    TransitRouterBandwidthPackageId string
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    TransitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection.
    TransitRouterId string
    ID of the local transit router instance.
    TransitRouterRouteTableId string
    Associated forwarding route table for the cross-region connection.
    TransitRouterTrafficQosMarkingPolicyId string
    ID of the traffic 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 cross-region connection.
    autoPublishRouteEnabled Boolean
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    bandwidth Integer
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    creationTime String
    Creation time of the cross-region connection.
    description String
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    ipv6Enabled Boolean
    Enable IPv6. true: Yes. false: No.
    peerTransitRouterId String
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    peerTransitRouterRegionId String
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    status String
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    tags List<PeerAttachmentTag>
    transitRouterAttachmentId String
    ID of the cross-region connection.
    transitRouterAttachmentName String
    Name of the cross-region connection. 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.
    transitRouterBandwidthPackageId String
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    transitRouterForwardPolicyTableId String
    ID of the forwarding policy associated with the cross-region connection.
    transitRouterId String
    ID of the local transit router instance.
    transitRouterRouteTableId String
    Associated forwarding route table for the cross-region connection.
    transitRouterTrafficQosMarkingPolicyId String
    ID of the traffic 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 cross-region connection.
    autoPublishRouteEnabled boolean
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    bandwidth number
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    creationTime string
    Creation time of the cross-region connection.
    description string
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    ipv6Enabled boolean
    Enable IPv6. true: Yes. false: No.
    peerTransitRouterId string
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    peerTransitRouterRegionId string
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    status string
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    tags PeerAttachmentTag[]
    transitRouterAttachmentId string
    ID of the cross-region connection.
    transitRouterAttachmentName string
    Name of the cross-region connection. 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.
    transitRouterBandwidthPackageId string
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    transitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection.
    transitRouterId string
    ID of the local transit router instance.
    transitRouterRouteTableId string
    Associated forwarding route table for the cross-region connection.
    transitRouterTrafficQosMarkingPolicyId string
    ID of the traffic 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 cross-region connection.
    auto_publish_route_enabled bool
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    bandwidth int
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    creation_time str
    Creation time of the cross-region connection.
    description str
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    ipv6_enabled bool
    Enable IPv6. true: Yes. false: No.
    peer_transit_router_id str
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    peer_transit_router_region_id str
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    status str
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    tags Sequence[PeerAttachmentTagArgs]
    transit_router_attachment_id str
    ID of the cross-region connection.
    transit_router_attachment_name str
    Name of the cross-region connection. 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.
    transit_router_bandwidth_package_id str
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    transit_router_forward_policy_table_id str
    ID of the forwarding policy associated with the cross-region connection.
    transit_router_id str
    ID of the local transit router instance.
    transit_router_route_table_id str
    Associated forwarding route table for the cross-region connection.
    transit_router_traffic_qos_marking_policy_id str
    ID of the traffic 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 cross-region connection.
    autoPublishRouteEnabled Boolean
    Automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    bandwidth Number
    Bandwidth for cross-region connection, measured in Mbps. The maximum bandwidth cannot exceed the remaining unallocated bandwidth limit of the specified transit router bandwidth package.
    creationTime String
    Creation time of the cross-region connection.
    description String
    Description of the cross-region connection. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is specified, the default is an empty string.
    ipv6Enabled Boolean
    Enable IPv6. true: Yes. false: No.
    peerTransitRouterId String
    ID of the peer transit router instance. You can call the DescribeTransitRouters API to obtain the transit router instance ID.
    peerTransitRouterRegionId String
    Region ID of the peer transit router instance. Refer to the region documentation to obtain the region ID.
    status String
    Status of the cross-region connection. Creating: In progress. Deleting: In progress. Pending: Configuring. Available: Available.
    tags List<Property Map>
    transitRouterAttachmentId String
    ID of the cross-region connection.
    transitRouterAttachmentName String
    Name of the cross-region connection. 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.
    transitRouterBandwidthPackageId String
    ID of the transit router bandwidth package. You can call the DescribeTransitRouters API to obtain the transit router instance ID. If this parameter is provided, the Bandwidth parameter must also be provided. If this parameter is not provided, the Bandwidth parameter is not required.
    transitRouterForwardPolicyTableId String
    ID of the forwarding policy associated with the cross-region connection.
    transitRouterId String
    ID of the local transit router instance.
    transitRouterRouteTableId String
    Associated forwarding route table for the cross-region connection.
    transitRouterTrafficQosMarkingPolicyId String
    ID of the traffic 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 cross-region connection.

    Supporting Types

    PeerAttachmentTag, PeerAttachmentTagArgs

    Key string
    Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.
    Value string
    Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.
    Key string
    Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.
    Value string
    Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.
    key String
    Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.
    value String
    Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.
    key string
    Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.
    value string
    Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.
    key str
    Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.
    value str
    Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.
    key String
    Tag key for cross-region connection user tags. Length must be between 1 and 128 characters. Case-sensitive; cannot start with any case combination of sys:. Cannot start or end with a space character. Allowed characters include letters, numbers, space character, underscore (_), period (.), colon (:), slash (/), equals sign (=), plus sign (+), minus sign (-), and @. Note: Tag keys for the same resource must be unique. If this parameter is not provided or no value is specified, the default is empty.
    value String
    Tag value for the cross-region connection user tag. Length limit: 0–255 characters. Case-sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Note: If this parameter is provided, Tags.N.Key must be provided first.

    Import

    $ pulumi import volcenginecc:transitrouter/peerAttachment:PeerAttachment example "transit_router_attachment_id"

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.33
    published on Thursday, May 7, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.