dcVirtualInterfaceV3.typescript.md

dcVirtualInterfaceV3 Submodule

Constructs

DcVirtualInterfaceV3

Represents a {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3 opentelekomcloud_dc_virtual_interface_v3}.

Initializers

import { dcVirtualInterfaceV3 } from '@cdktf/provider-opentelekomcloud'

new dcVirtualInterfaceV3.DcVirtualInterfaceV3(scope: Construct, id: string, config: DcVirtualInterfaceV3Config)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DcVirtualInterfaceV3Config	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DcVirtualInterfaceV3Config

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
resetAddressFamily	No description.
resetAsn	No description.
resetBgpMd5	No description.
resetDescription	No description.
resetEnableBfd	No description.
resetEnableNqa	No description.
resetId	No description.
resetLagId	No description.
resetLocalGatewayV4Ip	No description.
resetLocalGatewayV6Ip	No description.
resetRemoteGatewayV4Ip	No description.
resetRemoteGatewayV6Ip	No description.
resetResourceTenantId	No description.
resetServiceEpGroup	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

resetAddressFamily

public resetAddressFamily(): void

resetAsn

public resetAsn(): void

resetBgpMd5

public resetBgpMd5(): void

resetDescription

public resetDescription(): void

resetEnableBfd

public resetEnableBfd(): void

resetEnableNqa

public resetEnableNqa(): void

resetId

public resetId(): void

resetLagId

public resetLagId(): void

resetLocalGatewayV4Ip

public resetLocalGatewayV4Ip(): void

resetLocalGatewayV6Ip

public resetLocalGatewayV6Ip(): void

resetRemoteGatewayV4Ip

public resetRemoteGatewayV4Ip(): void

resetRemoteGatewayV6Ip

public resetRemoteGatewayV6Ip(): void

resetResourceTenantId

public resetResourceTenantId(): void

resetServiceEpGroup

public resetServiceEpGroup(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a DcVirtualInterfaceV3 resource upon running "cdktf plan ".

---

isConstruct

import { dcVirtualInterfaceV3 } from '@cdktf/provider-opentelekomcloud'

dcVirtualInterfaceV3.DcVirtualInterfaceV3.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { dcVirtualInterfaceV3 } from '@cdktf/provider-opentelekomcloud'

dcVirtualInterfaceV3.DcVirtualInterfaceV3.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { dcVirtualInterfaceV3 } from '@cdktf/provider-opentelekomcloud'

dcVirtualInterfaceV3.DcVirtualInterfaceV3.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dcVirtualInterfaceV3 } from '@cdktf/provider-opentelekomcloud'

dcVirtualInterfaceV3.DcVirtualInterfaceV3.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a DcVirtualInterfaceV3 resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the DcVirtualInterfaceV3 to import.

---

importFromId^Required

• Type: string

The id of the existing DcVirtualInterfaceV3 that should be imported.

Refer to the {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the DcVirtualInterfaceV3 to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
createdAt	string	No description.
deviceId	string	No description.
region	string	No description.
status	string	No description.
updatedAt	string	No description.
vifPeers	DcVirtualInterfaceV3VifPeersList	No description.
addressFamilyInput	string	No description.
asnInput	number	No description.
bandwidthInput	number	No description.
bgpMd5Input	string	No description.
descriptionInput	string	No description.
directConnectIdInput	string	No description.
enableBfdInput	boolean | cdktf.IResolvable	No description.
enableNqaInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
lagIdInput	string	No description.
localGatewayV4IpInput	string	No description.
localGatewayV6IpInput	string	No description.
nameInput	string	No description.
remoteEpGroupInput	string[]	No description.
remoteGatewayV4IpInput	string	No description.
remoteGatewayV6IpInput	string	No description.
resourceTenantIdInput	string	No description.
routeModeInput	string	No description.
serviceEpGroupInput	string[]	No description.
typeInput	string	No description.
vgwIdInput	string	No description.
vlanInput	number	No description.
addressFamily	string	No description.
asn	number	No description.
bandwidth	number	No description.
bgpMd5	string	No description.
description	string	No description.
directConnectId	string	No description.
enableBfd	boolean | cdktf.IResolvable	No description.
enableNqa	boolean | cdktf.IResolvable	No description.
id	string	No description.
lagId	string	No description.
localGatewayV4Ip	string	No description.
localGatewayV6Ip	string	No description.
name	string	No description.
remoteEpGroup	string[]	No description.
remoteGatewayV4Ip	string	No description.
remoteGatewayV6Ip	string	No description.
resourceTenantId	string	No description.
routeMode	string	No description.
serviceEpGroup	string[]	No description.
type	string	No description.
vgwId	string	No description.
vlan	number	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

createdAt^Required

public readonly createdAt: string;

• Type: string

---

deviceId^Required

public readonly deviceId: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

status^Required

public readonly status: string;

• Type: string

---

updatedAt^Required

public readonly updatedAt: string;

• Type: string

---

vifPeers^Required

public readonly vifPeers: DcVirtualInterfaceV3VifPeersList;

• Type: DcVirtualInterfaceV3VifPeersList

---

addressFamilyInput^Optional

public readonly addressFamilyInput: string;

• Type: string

---

asnInput^Optional

public readonly asnInput: number;

• Type: number

---

bandwidthInput^Optional

public readonly bandwidthInput: number;

• Type: number

---

bgpMd5Input^Optional

public readonly bgpMd5Input: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

directConnectIdInput^Optional

public readonly directConnectIdInput: string;

• Type: string

---

enableBfdInput^Optional

public readonly enableBfdInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

enableNqaInput^Optional

public readonly enableNqaInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

lagIdInput^Optional

public readonly lagIdInput: string;

• Type: string

---

localGatewayV4IpInput^Optional

public readonly localGatewayV4IpInput: string;

• Type: string

---

localGatewayV6IpInput^Optional

public readonly localGatewayV6IpInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

remoteEpGroupInput^Optional

public readonly remoteEpGroupInput: string[];

• Type: string[]

---

remoteGatewayV4IpInput^Optional

public readonly remoteGatewayV4IpInput: string;

• Type: string

---

remoteGatewayV6IpInput^Optional

public readonly remoteGatewayV6IpInput: string;

• Type: string

---

resourceTenantIdInput^Optional

public readonly resourceTenantIdInput: string;

• Type: string

---

routeModeInput^Optional

public readonly routeModeInput: string;

• Type: string

---

serviceEpGroupInput^Optional

public readonly serviceEpGroupInput: string[];

• Type: string[]

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

vgwIdInput^Optional

public readonly vgwIdInput: string;

• Type: string

---

vlanInput^Optional

public readonly vlanInput: number;

• Type: number

---

addressFamily^Required

public readonly addressFamily: string;

• Type: string

---

asn^Required

public readonly asn: number;

• Type: number

---

bandwidth^Required

public readonly bandwidth: number;

• Type: number

---

bgpMd5^Required

public readonly bgpMd5: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

directConnectId^Required

public readonly directConnectId: string;

• Type: string

---

enableBfd^Required

public readonly enableBfd: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

enableNqa^Required

public readonly enableNqa: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

lagId^Required

public readonly lagId: string;

• Type: string

---

localGatewayV4Ip^Required

public readonly localGatewayV4Ip: string;

• Type: string

---

localGatewayV6Ip^Required

public readonly localGatewayV6Ip: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

remoteEpGroup^Required

public readonly remoteEpGroup: string[];

• Type: string[]

---

remoteGatewayV4Ip^Required

public readonly remoteGatewayV4Ip: string;

• Type: string

---

remoteGatewayV6Ip^Required

public readonly remoteGatewayV6Ip: string;

• Type: string

---

resourceTenantId^Required

public readonly resourceTenantId: string;

• Type: string

---

routeMode^Required

public readonly routeMode: string;

• Type: string

---

serviceEpGroup^Required

public readonly serviceEpGroup: string[];

• Type: string[]

---

type^Required

public readonly type: string;

• Type: string

---

vgwId^Required

public readonly vgwId: string;

• Type: string

---

vlan^Required

public readonly vlan: number;

• Type: number

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DcVirtualInterfaceV3Config

Initializer

import { dcVirtualInterfaceV3 } from '@cdktf/provider-opentelekomcloud'

const dcVirtualInterfaceV3Config: dcVirtualInterfaceV3.DcVirtualInterfaceV3Config = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
bandwidth	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#bandwidth DcVirtualInterfaceV3#bandwidth}.
directConnectId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#direct_connect_id DcVirtualInterfaceV3#direct_connect_id}.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#name DcVirtualInterfaceV3#name}.
remoteEpGroup	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#remote_ep_group DcVirtualInterfaceV3#remote_ep_group}.
routeMode	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#route_mode DcVirtualInterfaceV3#route_mode}.
type	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#type DcVirtualInterfaceV3#type}.
vgwId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#vgw_id DcVirtualInterfaceV3#vgw_id}.
vlan	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#vlan DcVirtualInterfaceV3#vlan}.
addressFamily	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#address_family DcVirtualInterfaceV3#address_family}.
asn	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#asn DcVirtualInterfaceV3#asn}.
bgpMd5	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#bgp_md5 DcVirtualInterfaceV3#bgp_md5}.
description	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#description DcVirtualInterfaceV3#description}.
enableBfd	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#enable_bfd DcVirtualInterfaceV3#enable_bfd}.
enableNqa	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#enable_nqa DcVirtualInterfaceV3#enable_nqa}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#id DcVirtualInterfaceV3#id}.
lagId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#lag_id DcVirtualInterfaceV3#lag_id}.
localGatewayV4Ip	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#local_gateway_v4_ip DcVirtualInterfaceV3#local_gateway_v4_ip}.
localGatewayV6Ip	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#local_gateway_v6_ip DcVirtualInterfaceV3#local_gateway_v6_ip}.
remoteGatewayV4Ip	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#remote_gateway_v4_ip DcVirtualInterfaceV3#remote_gateway_v4_ip}.
remoteGatewayV6Ip	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#remote_gateway_v6_ip DcVirtualInterfaceV3#remote_gateway_v6_ip}.
resourceTenantId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#resource_tenant_id DcVirtualInterfaceV3#resource_tenant_id}.
serviceEpGroup	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#service_ep_group DcVirtualInterfaceV3#service_ep_group}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

bandwidth^Required

public readonly bandwidth: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#bandwidth DcVirtualInterfaceV3#bandwidth}.

---

directConnectId^Required

public readonly directConnectId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#direct_connect_id DcVirtualInterfaceV3#direct_connect_id}.

---

name^Required

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#name DcVirtualInterfaceV3#name}.

---

remoteEpGroup^Required

public readonly remoteEpGroup: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#remote_ep_group DcVirtualInterfaceV3#remote_ep_group}.

---

routeMode^Required

public readonly routeMode: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#route_mode DcVirtualInterfaceV3#route_mode}.

---

type^Required

public readonly type: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#type DcVirtualInterfaceV3#type}.

---

vgwId^Required

public readonly vgwId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#vgw_id DcVirtualInterfaceV3#vgw_id}.

---

vlan^Required

public readonly vlan: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#vlan DcVirtualInterfaceV3#vlan}.

---

addressFamily^Optional

public readonly addressFamily: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#address_family DcVirtualInterfaceV3#address_family}.

---

asn^Optional

public readonly asn: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#asn DcVirtualInterfaceV3#asn}.

---

bgpMd5^Optional

public readonly bgpMd5: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#bgp_md5 DcVirtualInterfaceV3#bgp_md5}.

---

description^Optional

public readonly description: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#description DcVirtualInterfaceV3#description}.

---

enableBfd^Optional

public readonly enableBfd: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#enable_bfd DcVirtualInterfaceV3#enable_bfd}.

---

enableNqa^Optional

public readonly enableNqa: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#enable_nqa DcVirtualInterfaceV3#enable_nqa}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#id DcVirtualInterfaceV3#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

lagId^Optional

public readonly lagId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#lag_id DcVirtualInterfaceV3#lag_id}.

---

localGatewayV4Ip^Optional

public readonly localGatewayV4Ip: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#local_gateway_v4_ip DcVirtualInterfaceV3#local_gateway_v4_ip}.

---

localGatewayV6Ip^Optional

public readonly localGatewayV6Ip: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#local_gateway_v6_ip DcVirtualInterfaceV3#local_gateway_v6_ip}.

---

remoteGatewayV4Ip^Optional

public readonly remoteGatewayV4Ip: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#remote_gateway_v4_ip DcVirtualInterfaceV3#remote_gateway_v4_ip}.

---

remoteGatewayV6Ip^Optional

public readonly remoteGatewayV6Ip: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#remote_gateway_v6_ip DcVirtualInterfaceV3#remote_gateway_v6_ip}.

---

resourceTenantId^Optional

public readonly resourceTenantId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#resource_tenant_id DcVirtualInterfaceV3#resource_tenant_id}.

---

serviceEpGroup^Optional

public readonly serviceEpGroup: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/resources/dc_virtual_interface_v3#service_ep_group DcVirtualInterfaceV3#service_ep_group}.

---

DcVirtualInterfaceV3VifPeers

Initializer

import { dcVirtualInterfaceV3 } from '@cdktf/provider-opentelekomcloud'

const dcVirtualInterfaceV3VifPeers: dcVirtualInterfaceV3.DcVirtualInterfaceV3VifPeers = { ... }

Classes

DcVirtualInterfaceV3VifPeersList

Initializers

import { dcVirtualInterfaceV3 } from '@cdktf/provider-opentelekomcloud'

new dcVirtualInterfaceV3.DcVirtualInterfaceV3VifPeersList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): DcVirtualInterfaceV3VifPeersOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

DcVirtualInterfaceV3VifPeersOutputReference

Initializers

import { dcVirtualInterfaceV3 } from '@cdktf/provider-opentelekomcloud'

new dcVirtualInterfaceV3.DcVirtualInterfaceV3VifPeersOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
addressFamily	string	No description.
bgpAsn	number	No description.
bgpMd5	string	No description.
bgpRouteLimit	number	No description.
bgpStatus	string	No description.
description	string	No description.
deviceId	string	No description.
enableBfd	cdktf.IResolvable	No description.
enableNqa	cdktf.IResolvable	No description.
id	string	No description.
localGatewayIp	string	No description.
name	string	No description.
receiveRouteNum	number	No description.
remoteEpGroup	string[]	No description.
remoteGatewayIp	string	No description.
routeMode	string	No description.
serviceEpGroup	string[]	No description.
status	string	No description.
tenantId	string	No description.
vifId	string	No description.
internalValue	DcVirtualInterfaceV3VifPeers	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

addressFamily^Required

public readonly addressFamily: string;

• Type: string

---

bgpAsn^Required

public readonly bgpAsn: number;

• Type: number

---

bgpMd5^Required

public readonly bgpMd5: string;

• Type: string

---

bgpRouteLimit^Required

public readonly bgpRouteLimit: number;

• Type: number

---

bgpStatus^Required

public readonly bgpStatus: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

deviceId^Required

public readonly deviceId: string;

• Type: string

---

enableBfd^Required

public readonly enableBfd: IResolvable;

• Type: cdktf.IResolvable

---

enableNqa^Required

public readonly enableNqa: IResolvable;

• Type: cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

localGatewayIp^Required

public readonly localGatewayIp: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

receiveRouteNum^Required

public readonly receiveRouteNum: number;

• Type: number

---

remoteEpGroup^Required

public readonly remoteEpGroup: string[];

• Type: string[]

---

remoteGatewayIp^Required

public readonly remoteGatewayIp: string;

• Type: string

---

routeMode^Required

public readonly routeMode: string;

• Type: string

---

serviceEpGroup^Required

public readonly serviceEpGroup: string[];

• Type: string[]

---

status^Required

public readonly status: string;

• Type: string

---

tenantId^Required

public readonly tenantId: string;

• Type: string

---

vifId^Required

public readonly vifId: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: DcVirtualInterfaceV3VifPeers;

• Type: DcVirtualInterfaceV3VifPeers

---