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

volcenginecc.transitrouter.getVpnAttachment

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

    Data Source schema for Volcengine::TransitRouter::VpnAttachment

    Using getVpnAttachment

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVpnAttachment(args: GetVpnAttachmentArgs, opts?: InvokeOptions): Promise<GetVpnAttachmentResult>
function getVpnAttachmentOutput(args: GetVpnAttachmentOutputArgs, opts?: InvokeOptions): Output<GetVpnAttachmentResult>
    def get_vpn_attachment(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetVpnAttachmentResult
def get_vpn_attachment_output(id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetVpnAttachmentResult]
    func LookupVpnAttachment(ctx *Context, args *LookupVpnAttachmentArgs, opts ...InvokeOption) (*LookupVpnAttachmentResult, error)
func LookupVpnAttachmentOutput(ctx *Context, args *LookupVpnAttachmentOutputArgs, opts ...InvokeOption) LookupVpnAttachmentResultOutput

    > Note: This function is named LookupVpnAttachment in the Go SDK.

    public static class GetVpnAttachment 
{
    public static Task<GetVpnAttachmentResult> InvokeAsync(GetVpnAttachmentArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnAttachmentResult> Invoke(GetVpnAttachmentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpnAttachmentResult> getVpnAttachment(GetVpnAttachmentArgs args, InvokeOptions options)
public static Output<GetVpnAttachmentResult> getVpnAttachment(GetVpnAttachmentArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:transitrouter/getVpnAttachment:getVpnAttachment
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getVpnAttachment Result

    The following output properties are available:

    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.
    Id string
    Uniquely identifies the resource.
    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.GetVpnAttachmentTag>
    Tag list.
    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.
    Id string
    Uniquely identifies the resource.
    Ipv6Enabled bool
    Whether to enable IPv6.
    Status string
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    Tags []GetVpnAttachmentTag
    Tag list.
    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.
    id String
    Uniquely identifies the resource.
    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<GetVpnAttachmentTag>
    Tag list.
    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.
    id string
    Uniquely identifies the resource.
    ipv6Enabled boolean
    Whether to enable IPv6.
    status string
    Network instance connection status. Creating: being created. Deleting: being deleted. Pending: being configured. Available: available.
    tags GetVpnAttachmentTag[]
    Tag list.
    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.
    id str
    Uniquely identifies the 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.
    tags Sequence[GetVpnAttachmentTag]
    Tag list.
    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.
    id String
    Uniquely identifies the resource.
    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>
    Tag list.
    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

    GetVpnAttachmentTag

    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.

    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.