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

volcenginecc.transitrouter.VpnAttachment

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    By establishing a connection between the IPsec connection of the VPN and the transit router, you can enable communication between the VPN-connected network and the private network of the transit router.

    Example Usage

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

const transitRouterVpnAttachmentDemo = new volcenginecc.transitrouter.VpnAttachment("TransitRouterVpnAttachmentDemo", {
    description: "test",
    tags: [{
        key: "env",
        value: "test",
    }],
    transitRouterAttachmentName: "ccapi-test-1",
    transitRouterId: "tr-mjl8zkxxxxxsmt1boobol4",
    transitRouterRouteTableId: "tr-rtb-mjlxxxxxo5smt1bnewrhh",
    vpnConnectionId: "vgc-ij0yxxxxx474o8cux0n08t",
    zoneId: "cn-beijing-a",
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

transit_router_vpn_attachment_demo = volcenginecc.transitrouter.VpnAttachment("TransitRouterVpnAttachmentDemo",
    description="test",
    tags=[{
        "key": "env",
        "value": "test",
    }],
    transit_router_attachment_name="ccapi-test-1",
    transit_router_id="tr-mjl8zkxxxxxsmt1boobol4",
    transit_router_route_table_id="tr-rtb-mjlxxxxxo5smt1bnewrhh",
    vpn_connection_id="vgc-ij0yxxxxx474o8cux0n08t",
    zone_id="cn-beijing-a")

    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.NewVpnAttachment(ctx, "TransitRouterVpnAttachmentDemo", &transitrouter.VpnAttachmentArgs{
			Description: pulumi.String("test"),
			Tags: transitrouter.VpnAttachmentTagArray{
				&transitrouter.VpnAttachmentTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
			TransitRouterAttachmentName: pulumi.String("ccapi-test-1"),
			TransitRouterId:             pulumi.String("tr-mjl8zkxxxxxsmt1boobol4"),
			TransitRouterRouteTableId:   pulumi.String("tr-rtb-mjlxxxxxo5smt1bnewrhh"),
			VpnConnectionId:             pulumi.String("vgc-ij0yxxxxx474o8cux0n08t"),
			ZoneId:                      pulumi.String("cn-beijing-a"),
		})
		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 transitRouterVpnAttachmentDemo = new Volcenginecc.Transitrouter.VpnAttachment("TransitRouterVpnAttachmentDemo", new()
    {
        Description = "test",
        Tags = new[]
        {
            new Volcenginecc.Transitrouter.Inputs.VpnAttachmentTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
        TransitRouterAttachmentName = "ccapi-test-1",
        TransitRouterId = "tr-mjl8zkxxxxxsmt1boobol4",
        TransitRouterRouteTableId = "tr-rtb-mjlxxxxxo5smt1bnewrhh",
        VpnConnectionId = "vgc-ij0yxxxxx474o8cux0n08t",
        ZoneId = "cn-beijing-a",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.transitrouter.VpnAttachment;
import com.volcengine.volcenginecc.transitrouter.VpnAttachmentArgs;
import com.pulumi.volcenginecc.transitrouter.inputs.VpnAttachmentTagArgs;
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 transitRouterVpnAttachmentDemo = new VpnAttachment("transitRouterVpnAttachmentDemo", VpnAttachmentArgs.builder()
            .description("test")
            .tags(VpnAttachmentTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .transitRouterAttachmentName("ccapi-test-1")
            .transitRouterId("tr-mjl8zkxxxxxsmt1boobol4")
            .transitRouterRouteTableId("tr-rtb-mjlxxxxxo5smt1bnewrhh")
            .vpnConnectionId("vgc-ij0yxxxxx474o8cux0n08t")
            .zoneId("cn-beijing-a")
            .build());

    }
}

    resources:
  transitRouterVpnAttachmentDemo:
    type: volcenginecc:transitrouter:VpnAttachment
    name: TransitRouterVpnAttachmentDemo
    properties:
      description: test
      tags:
        - key: env
          value: test
      transitRouterAttachmentName: ccapi-test-1
      transitRouterId: tr-mjl8zkxxxxxsmt1boobol4
      transitRouterRouteTableId: tr-rtb-mjlxxxxxo5smt1bnewrhh
      vpnConnectionId: vgc-ij0yxxxxx474o8cux0n08t
      zoneId: cn-beijing-a

    Create VpnAttachment Resource

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

    Constructor syntax

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

@overload
def VpnAttachment(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  transit_router_id: Optional[str] = None,
                  vpn_connection_id: Optional[str] = None,
                  zone_id: Optional[str] = None,
                  description: Optional[str] = None,
                  health_check_revoke_route_enabled: Optional[bool] = None,
                  tags: Optional[Sequence[VpnAttachmentTagArgs]] = None,
                  transit_router_attachment_name: Optional[str] = None,
                  transit_router_route_table_id: Optional[str] = None)
    func NewVpnAttachment(ctx *Context, name string, args VpnAttachmentArgs, opts ...ResourceOption) (*VpnAttachment, error)
    public VpnAttachment(string name, VpnAttachmentArgs args, CustomResourceOptions? opts = null)
    public VpnAttachment(String name, VpnAttachmentArgs args)
public VpnAttachment(String name, VpnAttachmentArgs args, CustomResourceOptions options)

    type: volcenginecc:transitrouter:VpnAttachment
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 VpnAttachmentArgs
    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 VpnAttachmentArgs
    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 VpnAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpnAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpnAttachmentArgs
    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 vpnAttachmentResource = new Volcenginecc.Transitrouter.VpnAttachment("vpnAttachmentResource", new()
{
    TransitRouterId = "string",
    VpnConnectionId = "string",
    ZoneId = "string",
    Description = "string",
    HealthCheckRevokeRouteEnabled = false,
    Tags = new[]
    {
        new Volcenginecc.Transitrouter.Inputs.VpnAttachmentTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TransitRouterAttachmentName = "string",
    TransitRouterRouteTableId = "string",
});

    example, err := transitrouter.NewVpnAttachment(ctx, "vpnAttachmentResource", &transitrouter.VpnAttachmentArgs{
	TransitRouterId:               pulumi.String("string"),
	VpnConnectionId:               pulumi.String("string"),
	ZoneId:                        pulumi.String("string"),
	Description:                   pulumi.String("string"),
	HealthCheckRevokeRouteEnabled: pulumi.Bool(false),
	Tags: transitrouter.VpnAttachmentTagArray{
		&transitrouter.VpnAttachmentTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TransitRouterAttachmentName: pulumi.String("string"),
	TransitRouterRouteTableId:   pulumi.String("string"),
})

    var vpnAttachmentResource = new VpnAttachment("vpnAttachmentResource", VpnAttachmentArgs.builder()
    .transitRouterId("string")
    .vpnConnectionId("string")
    .zoneId("string")
    .description("string")
    .healthCheckRevokeRouteEnabled(false)
    .tags(VpnAttachmentTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .transitRouterAttachmentName("string")
    .transitRouterRouteTableId("string")
    .build());

    vpn_attachment_resource = volcenginecc.transitrouter.VpnAttachment("vpnAttachmentResource",
    transit_router_id="string",
    vpn_connection_id="string",
    zone_id="string",
    description="string",
    health_check_revoke_route_enabled=False,
    tags=[{
        "key": "string",
        "value": "string",
    }],
    transit_router_attachment_name="string",
    transit_router_route_table_id="string")

    const vpnAttachmentResource = new volcenginecc.transitrouter.VpnAttachment("vpnAttachmentResource", {
    transitRouterId: "string",
    vpnConnectionId: "string",
    zoneId: "string",
    description: "string",
    healthCheckRevokeRouteEnabled: false,
    tags: [{
        key: "string",
        value: "string",
    }],
    transitRouterAttachmentName: "string",
    transitRouterRouteTableId: "string",
});

    type: volcenginecc:transitrouter:VpnAttachment
properties:
    description: string
    healthCheckRevokeRouteEnabled: false
    tags:
        - key: string
          value: string
    transitRouterAttachmentName: string
    transitRouterId: string
    transitRouterRouteTableId: string
    vpnConnectionId: string
    zoneId: string

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

    TransitRouterId string
    Transit router instance ID.
    VpnConnectionId string
    IPsec connection ID.
    ZoneId string
    ID of the availability zone to which the IPsec connection belongs.
    Description string
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    HealthCheckRevokeRouteEnabled bool
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    Tags List<Volcengine.VpnAttachmentTag>
    TransitRouterAttachmentName string
    Network instance connection name. 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 network instance connection ID.
    TransitRouterRouteTableId string
    Associated TR route table ID.
    TransitRouterId string
    Transit router instance ID.
    VpnConnectionId string
    IPsec connection ID.
    ZoneId string
    ID of the availability zone to which the IPsec connection belongs.
    Description string
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    HealthCheckRevokeRouteEnabled bool
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    Tags []VpnAttachmentTagArgs
    TransitRouterAttachmentName string
    Network instance connection name. 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 network instance connection ID.
    TransitRouterRouteTableId string
    Associated TR route table ID.
    transitRouterId String
    Transit router instance ID.
    vpnConnectionId String
    IPsec connection ID.
    zoneId String
    ID of the availability zone to which the IPsec connection belongs.
    description String
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    healthCheckRevokeRouteEnabled Boolean
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    tags List<VpnAttachmentTag>
    transitRouterAttachmentName String
    Network instance connection name. 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 network instance connection ID.
    transitRouterRouteTableId String
    Associated TR route table ID.
    transitRouterId string
    Transit router instance ID.
    vpnConnectionId string
    IPsec connection ID.
    zoneId string
    ID of the availability zone to which the IPsec connection belongs.
    description string
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    healthCheckRevokeRouteEnabled boolean
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    tags VpnAttachmentTag[]
    transitRouterAttachmentName string
    Network instance connection name. 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 network instance connection ID.
    transitRouterRouteTableId string
    Associated TR route table ID.
    transit_router_id str
    Transit router instance ID.
    vpn_connection_id str
    IPsec connection ID.
    zone_id str
    ID of the availability zone to which the IPsec connection belongs.
    description str
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    health_check_revoke_route_enabled bool
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    tags Sequence[VpnAttachmentTagArgs]
    transit_router_attachment_name str
    Network instance connection name. 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 network instance connection ID.
    transit_router_route_table_id str
    Associated TR route table ID.
    transitRouterId String
    Transit router instance ID.
    vpnConnectionId String
    IPsec connection ID.
    zoneId String
    ID of the availability zone to which the IPsec connection belongs.
    description String
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    healthCheckRevokeRouteEnabled Boolean
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    tags List<Property Map>
    transitRouterAttachmentName String
    Network instance connection name. 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 network instance connection ID.
    transitRouterRouteTableId String
    Associated TR route table ID.

    Outputs

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

    AutoPublishRouteEnabled bool
    Whether to automatically sync TR routes to the network instance route table.
    CreatedTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv6Enabled bool
    Whether to enable IPv6.
    Status string
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    TransitRouterAttachmentId string
    Network instance connection ID.
    UpdatedTime string
    Update time.
    AutoPublishRouteEnabled bool
    Whether to automatically sync TR routes to the network instance route table.
    CreatedTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv6Enabled bool
    Whether to enable IPv6.
    Status string
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    TransitRouterAttachmentId string
    Network instance connection ID.
    UpdatedTime string
    Update time.
    autoPublishRouteEnabled Boolean
    Whether to automatically sync TR routes to the network instance route table.
    createdTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv6Enabled Boolean
    Whether to enable IPv6.
    status String
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    transitRouterAttachmentId String
    Network instance connection ID.
    updatedTime String
    Update time.
    autoPublishRouteEnabled boolean
    Whether to automatically sync TR routes to the network instance route table.
    createdTime string
    Creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    ipv6Enabled boolean
    Whether to enable IPv6.
    status string
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    transitRouterAttachmentId string
    Network instance connection ID.
    updatedTime string
    Update time.
    auto_publish_route_enabled bool
    Whether to automatically sync TR routes to the network instance route table.
    created_time str
    Creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    ipv6_enabled bool
    Whether to enable IPv6.
    status str
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    transit_router_attachment_id str
    Network instance connection ID.
    updated_time str
    Update time.
    autoPublishRouteEnabled Boolean
    Whether to automatically sync TR routes to the network instance route table.
    createdTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv6Enabled Boolean
    Whether to enable IPv6.
    status String
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    transitRouterAttachmentId String
    Network instance connection ID.
    updatedTime String
    Update time.

    Look up Existing VpnAttachment Resource

    Get an existing VpnAttachment 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?: VpnAttachmentState, opts?: CustomResourceOptions): VpnAttachment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_publish_route_enabled: Optional[bool] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        health_check_revoke_route_enabled: Optional[bool] = None,
        ipv6_enabled: Optional[bool] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[VpnAttachmentTagArgs]] = None,
        transit_router_attachment_id: Optional[str] = None,
        transit_router_attachment_name: Optional[str] = None,
        transit_router_id: Optional[str] = None,
        transit_router_route_table_id: Optional[str] = None,
        updated_time: Optional[str] = None,
        vpn_connection_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> VpnAttachment
    func GetVpnAttachment(ctx *Context, name string, id IDInput, state *VpnAttachmentState, opts ...ResourceOption) (*VpnAttachment, error)
    public static VpnAttachment Get(string name, Input<string> id, VpnAttachmentState? state, CustomResourceOptions? opts = null)
    public static VpnAttachment get(String name, Output<String> id, VpnAttachmentState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:transitrouter:VpnAttachment    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
    Whether to automatically sync TR routes to the network instance route table.
    CreatedTime string
    Creation time.
    Description string
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    HealthCheckRevokeRouteEnabled bool
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    Ipv6Enabled bool
    Whether to enable IPv6.
    Status string
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    Tags List<Volcengine.VpnAttachmentTag>
    TransitRouterAttachmentId string
    Network instance connection ID.
    TransitRouterAttachmentName string
    Network instance connection name. 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 network instance connection ID.
    TransitRouterId string
    Transit router instance ID.
    TransitRouterRouteTableId string
    Associated TR route table ID.
    UpdatedTime string
    Update time.
    VpnConnectionId string
    IPsec connection ID.
    ZoneId string
    ID of the availability zone to which the IPsec connection belongs.
    AutoPublishRouteEnabled bool
    Whether to automatically sync TR routes to the network instance route table.
    CreatedTime string
    Creation time.
    Description string
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    HealthCheckRevokeRouteEnabled bool
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    Ipv6Enabled bool
    Whether to enable IPv6.
    Status string
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    Tags []VpnAttachmentTagArgs
    TransitRouterAttachmentId string
    Network instance connection ID.
    TransitRouterAttachmentName string
    Network instance connection name. 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 network instance connection ID.
    TransitRouterId string
    Transit router instance ID.
    TransitRouterRouteTableId string
    Associated TR route table ID.
    UpdatedTime string
    Update time.
    VpnConnectionId string
    IPsec connection ID.
    ZoneId string
    ID of the availability zone to which the IPsec connection belongs.
    autoPublishRouteEnabled Boolean
    Whether to automatically sync TR routes to the network instance route table.
    createdTime String
    Creation time.
    description String
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    healthCheckRevokeRouteEnabled Boolean
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    ipv6Enabled Boolean
    Whether to enable IPv6.
    status String
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    tags List<VpnAttachmentTag>
    transitRouterAttachmentId String
    Network instance connection ID.
    transitRouterAttachmentName String
    Network instance connection name. 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 network instance connection ID.
    transitRouterId String
    Transit router instance ID.
    transitRouterRouteTableId String
    Associated TR route table ID.
    updatedTime String
    Update time.
    vpnConnectionId String
    IPsec connection ID.
    zoneId String
    ID of the availability zone to which the IPsec connection belongs.
    autoPublishRouteEnabled boolean
    Whether to automatically sync TR routes to the network instance route table.
    createdTime string
    Creation time.
    description string
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    healthCheckRevokeRouteEnabled boolean
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    ipv6Enabled boolean
    Whether to enable IPv6.
    status string
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    tags VpnAttachmentTag[]
    transitRouterAttachmentId string
    Network instance connection ID.
    transitRouterAttachmentName string
    Network instance connection name. 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 network instance connection ID.
    transitRouterId string
    Transit router instance ID.
    transitRouterRouteTableId string
    Associated TR route table ID.
    updatedTime string
    Update time.
    vpnConnectionId string
    IPsec connection ID.
    zoneId string
    ID of the availability zone to which the IPsec connection belongs.
    auto_publish_route_enabled bool
    Whether to automatically sync TR routes to the network instance route table.
    created_time str
    Creation time.
    description str
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    health_check_revoke_route_enabled bool
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    ipv6_enabled bool
    Whether to enable IPv6.
    status str
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    tags Sequence[VpnAttachmentTagArgs]
    transit_router_attachment_id str
    Network instance connection ID.
    transit_router_attachment_name str
    Network instance connection name. 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 network instance connection ID.
    transit_router_id str
    Transit router instance ID.
    transit_router_route_table_id str
    Associated TR route table ID.
    updated_time str
    Update time.
    vpn_connection_id str
    IPsec connection ID.
    zone_id str
    ID of the availability zone to which the IPsec connection belongs.
    autoPublishRouteEnabled Boolean
    Whether to automatically sync TR routes to the network instance route table.
    createdTime String
    Creation time.
    description String
    Network instance connection description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: 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.
    healthCheckRevokeRouteEnabled Boolean
    Whether to enable health check route convergence. true: Yes. Effective only when the IPsec connection has health check enabled; supports convergence of static routes only, not BGP routes. false: No.
    ipv6Enabled Boolean
    Whether to enable IPv6.
    status String
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    tags List<Property Map>
    transitRouterAttachmentId String
    Network instance connection ID.
    transitRouterAttachmentName String
    Network instance connection name. 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 network instance connection ID.
    transitRouterId String
    Transit router instance ID.
    transitRouterRouteTableId String
    Associated TR route table ID.
    updatedTime String
    Update time.
    vpnConnectionId String
    IPsec connection ID.
    zoneId String
    ID of the availability zone to which the IPsec connection belongs.

    Supporting Types

    VpnAttachmentTag, VpnAttachmentTagArgs

    Key string
    User tag key.
    Value string
    User tag value.
    Key string
    User tag key.
    Value string
    User tag value.
    key String
    User tag key.
    value String
    User tag value.
    key string
    User tag key.
    value string
    User tag value.
    key str
    User tag key.
    value str
    User tag value.
    key String
    User tag key.
    value String
    User tag value.

    Import

    $ pulumi import volcenginecc:transitrouter/vpnAttachment:VpnAttachment example "transit_router_id|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.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.