bytepluscc.transitrouter.getVpnAttachment

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

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: bytepluscc: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: 是否自动同步TR路由到网络实例路由表中。
CreatedTime string: 创建时间。
Description string: 网络实例连接的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
HealthCheckRevokeRouteEnabled bool: 是否开启健康检查收敛路由功能。true：是。仅当IPsec连接开启健康检查功能时生效，且只支持收敛静态路由，不支持收敛BGP路由。false：否。
Id string: Uniquely identifies the resource.
Ipv6Enabled bool: 是否开启IPv6功能。
Status string: 网络实例连接的状态。Creating：创建中。Deleting：删除中。Pending：配置中。Available：可用。
Tags List<Byteplus.GetVpnAttachmentTag>: 标签列表。
TransitRouterAttachmentId string: 网络实例连接的ID。
TransitRouterAttachmentName string: 网络实例连接的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为网络实例连接的ID。
TransitRouterId string: 中转路由器实例的ID。
TransitRouterRouteTableId string: 关联的TR路由表ID。
UpdatedTime string: 更新时间。
VpnConnectionId string: IPsec连接的ID。
ZoneId string: IPsec连接所属可用区的ID。

AutoPublishRouteEnabled bool: 是否自动同步TR路由到网络实例路由表中。
CreatedTime string: 创建时间。
Description string: 网络实例连接的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
HealthCheckRevokeRouteEnabled bool: 是否开启健康检查收敛路由功能。true：是。仅当IPsec连接开启健康检查功能时生效，且只支持收敛静态路由，不支持收敛BGP路由。false：否。
Id string: Uniquely identifies the resource.
Ipv6Enabled bool: 是否开启IPv6功能。
Status string: 网络实例连接的状态。Creating：创建中。Deleting：删除中。Pending：配置中。Available：可用。
Tags []GetVpnAttachmentTag: 标签列表。
TransitRouterAttachmentId string: 网络实例连接的ID。
TransitRouterAttachmentName string: 网络实例连接的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为网络实例连接的ID。
TransitRouterId string: 中转路由器实例的ID。
TransitRouterRouteTableId string: 关联的TR路由表ID。
UpdatedTime string: 更新时间。
VpnConnectionId string: IPsec连接的ID。
ZoneId string: IPsec连接所属可用区的ID。

autoPublishRouteEnabled Boolean: 是否自动同步TR路由到网络实例路由表中。
createdTime String: 创建时间。
description String: 网络实例连接的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
healthCheckRevokeRouteEnabled Boolean: 是否开启健康检查收敛路由功能。true：是。仅当IPsec连接开启健康检查功能时生效，且只支持收敛静态路由，不支持收敛BGP路由。false：否。
id String: Uniquely identifies the resource.
ipv6Enabled Boolean: 是否开启IPv6功能。
status String: 网络实例连接的状态。Creating：创建中。Deleting：删除中。Pending：配置中。Available：可用。
tags List<GetVpnAttachmentTag>: 标签列表。
transitRouterAttachmentId String: 网络实例连接的ID。
transitRouterAttachmentName String: 网络实例连接的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为网络实例连接的ID。
transitRouterId String: 中转路由器实例的ID。
transitRouterRouteTableId String: 关联的TR路由表ID。
updatedTime String: 更新时间。
vpnConnectionId String: IPsec连接的ID。
zoneId String: IPsec连接所属可用区的ID。

autoPublishRouteEnabled boolean: 是否自动同步TR路由到网络实例路由表中。
createdTime string: 创建时间。
description string: 网络实例连接的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
healthCheckRevokeRouteEnabled boolean: 是否开启健康检查收敛路由功能。true：是。仅当IPsec连接开启健康检查功能时生效，且只支持收敛静态路由，不支持收敛BGP路由。false：否。
id string: Uniquely identifies the resource.
ipv6Enabled boolean: 是否开启IPv6功能。
status string: 网络实例连接的状态。Creating：创建中。Deleting：删除中。Pending：配置中。Available：可用。
tags GetVpnAttachmentTag[]: 标签列表。
transitRouterAttachmentId string: 网络实例连接的ID。
transitRouterAttachmentName string: 网络实例连接的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为网络实例连接的ID。
transitRouterId string: 中转路由器实例的ID。
transitRouterRouteTableId string: 关联的TR路由表ID。
updatedTime string: 更新时间。
vpnConnectionId string: IPsec连接的ID。
zoneId string: IPsec连接所属可用区的ID。

auto_publish_route_enabled bool: 是否自动同步TR路由到网络实例路由表中。
created_time str: 创建时间。
description str: 网络实例连接的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
health_check_revoke_route_enabled bool: 是否开启健康检查收敛路由功能。true：是。仅当IPsec连接开启健康检查功能时生效，且只支持收敛静态路由，不支持收敛BGP路由。false：否。
id str: Uniquely identifies the resource.
ipv6_enabled bool: 是否开启IPv6功能。
status str: 网络实例连接的状态。Creating：创建中。Deleting：删除中。Pending：配置中。Available：可用。
tags Sequence[GetVpnAttachmentTag]: 标签列表。
transit_router_attachment_id str: 网络实例连接的ID。
transit_router_attachment_name str: 网络实例连接的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为网络实例连接的ID。
transit_router_id str: 中转路由器实例的ID。
transit_router_route_table_id str: 关联的TR路由表ID。
updated_time str: 更新时间。
vpn_connection_id str: IPsec连接的ID。
zone_id str: IPsec连接所属可用区的ID。

autoPublishRouteEnabled Boolean: 是否自动同步TR路由到网络实例路由表中。
createdTime String: 创建时间。
description String: 网络实例连接的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
healthCheckRevokeRouteEnabled Boolean: 是否开启健康检查收敛路由功能。true：是。仅当IPsec连接开启健康检查功能时生效，且只支持收敛静态路由，不支持收敛BGP路由。false：否。
id String: Uniquely identifies the resource.
ipv6Enabled Boolean: 是否开启IPv6功能。
status String: 网络实例连接的状态。Creating：创建中。Deleting：删除中。Pending：配置中。Available：可用。
tags List<Property Map>: 标签列表。
transitRouterAttachmentId String: 网络实例连接的ID。
transitRouterAttachmentName String: 网络实例连接的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为网络实例连接的ID。
transitRouterId String: 中转路由器实例的ID。
transitRouterRouteTableId String: 关联的TR路由表ID。
updatedTime String: 更新时间。
vpnConnectionId String: IPsec连接的ID。
zoneId String: IPsec连接所属可用区的ID。

Supporting Types

GetVpnAttachmentTag

Key string: 用户标签的标签键。
Value string: 用户标签的标签值。

Key string: 用户标签的标签键。
Value string: 用户标签的标签值。

key String: 用户标签的标签键。
value String: 用户标签的标签值。

key string: 用户标签的标签键。
value string: 用户标签的标签值。

key str: 用户标签的标签键。
value str: 用户标签的标签值。

key String: 用户标签的标签键。
value String: 用户标签的标签值。

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.transitrouter.getVpnAttachment

On this page

On this page

Using getVpnAttachment

getVpnAttachment Result

Supporting Types

GetVpnAttachmentTag

Package Details

On this page

On this page