bytepluscc.transitrouter.getPeerAttachment

bytepluscc v0.0.25, May 7 26

Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getPeerAttachment

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 getPeerAttachment(args: GetPeerAttachmentArgs, opts?: InvokeOptions): Promise<GetPeerAttachmentResult>
function getPeerAttachmentOutput(args: GetPeerAttachmentOutputArgs, opts?: InvokeOptions): Output<GetPeerAttachmentResult>

def get_peer_attachment(id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPeerAttachmentResult
def get_peer_attachment_output(id: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPeerAttachmentResult]

func LookupPeerAttachment(ctx *Context, args *LookupPeerAttachmentArgs, opts ...InvokeOption) (*LookupPeerAttachmentResult, error)
func LookupPeerAttachmentOutput(ctx *Context, args *LookupPeerAttachmentOutputArgs, opts ...InvokeOption) LookupPeerAttachmentResultOutput

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

public static class GetPeerAttachment 
{
    public static Task<GetPeerAttachmentResult> InvokeAsync(GetPeerAttachmentArgs args, InvokeOptions? opts = null)
    public static Output<GetPeerAttachmentResult> Invoke(GetPeerAttachmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPeerAttachmentResult> getPeerAttachment(GetPeerAttachmentArgs args, InvokeOptions options)
public static Output<GetPeerAttachmentResult> getPeerAttachment(GetPeerAttachmentArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:transitrouter/getPeerAttachment:getPeerAttachment
  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.

getPeerAttachment Result

The following output properties are available:

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.
Id string: Uniquely identifies the resource.
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<Byteplus.GetPeerAttachmentTag>: Tag list for the cross-region connection.
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.
Id string: Uniquely identifies the resource.
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 []GetPeerAttachmentTag: Tag list for the cross-region connection.
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.
id String: Uniquely identifies the resource.
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<GetPeerAttachmentTag>: Tag list for the cross-region connection.
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.
id string: Uniquely identifies the resource.
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 GetPeerAttachmentTag[]: Tag list for the cross-region connection.
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.
id str: Uniquely identifies the resource.
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[GetPeerAttachmentTag]: Tag list for the cross-region connection.
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.
id String: Uniquely identifies the resource.
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>: Tag list for the cross-region connection.
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

GetPeerAttachmentTag

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.