dataOpentelekomcloudDirectConnectV2.typescript.md

dataOpentelekomcloudDirectConnectV2 Submodule

Constructs

DataOpentelekomcloudDirectConnectV2

Represents a {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2 opentelekomcloud_direct_connect_v2}.

Initializers

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

new dataOpentelekomcloudDirectConnectV2.DataOpentelekomcloudDirectConnectV2(scope: Construct, id: string, config?: DataOpentelekomcloudDirectConnectV2Config)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DataOpentelekomcloudDirectConnectV2Config	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^Optional

• Type: DataOpentelekomcloudDirectConnectV2Config

---

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	Adds this resource to the terraform JSON output.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
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.
resetBandwidth	No description.
resetDescription	No description.
resetDeviceId	No description.
resetId	No description.
resetLocation	No description.
resetName	No description.
resetPortType	No description.
resetRegion	No description.
resetVlan	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

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

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(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetBandwidth

public resetBandwidth(): void

resetDescription

public resetDescription(): void

resetDeviceId

public resetDeviceId(): void

resetId

public resetId(): void

resetLocation

public resetLocation(): void

resetName

public resetName(): void

resetPortType

public resetPortType(): void

resetRegion

public resetRegion(): void

resetVlan

public resetVlan(): void

Static Functions

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

---

isConstruct

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

dataOpentelekomcloudDirectConnectV2.DataOpentelekomcloudDirectConnectV2.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 { dataOpentelekomcloudDirectConnectV2 } from '@cdktf/provider-opentelekomcloud'

dataOpentelekomcloudDirectConnectV2.DataOpentelekomcloudDirectConnectV2.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

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

dataOpentelekomcloudDirectConnectV2.DataOpentelekomcloudDirectConnectV2.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

dataOpentelekomcloudDirectConnectV2.DataOpentelekomcloudDirectConnectV2.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a DataOpentelekomcloudDirectConnectV2 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 DataOpentelekomcloudDirectConnectV2 to import.

---

importFromId^Required

• Type: string

The id of the existing DataOpentelekomcloudDirectConnectV2 that should be imported.

Refer to the {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#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 DataOpentelekomcloudDirectConnectV2 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.
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.
adminStateUp	cdktf.IResolvable	No description.
applicant	string	No description.
applyTime	string	No description.
buildingLineProductId	string	No description.
cableLabel	string	No description.
chargeMode	string	No description.
createTime	string	No description.
deleteTime	string	No description.
email	string	No description.
hostingId	string	No description.
interfaceName	string	No description.
lagId	string	No description.
lastOnestopProductId	string	No description.
mobile	string	No description.
onestopProductId	string	No description.
orderId	string	No description.
peerLocation	string	No description.
peerPortType	string	No description.
peerProvider	string	No description.
periodNum	number	No description.
periodType	number	No description.
productId	string	No description.
providerName	string	No description.
providerStatus	string	No description.
reason	string	No description.
redundantId	string	No description.
regionId	string	No description.
serviceKey	string	No description.
specCode	string	No description.
status	string	No description.
tenantId	string	No description.
type	string	No description.
vgwType	string	No description.
bandwidthInput	number	No description.
descriptionInput	string	No description.
deviceIdInput	string	No description.
idInput	string	No description.
locationInput	string	No description.
nameInput	string	No description.
portTypeInput	string	No description.
regionInput	string	No description.
vlanInput	number	No description.
bandwidth	number	No description.
description	string	No description.
deviceId	string	No description.
id	string	No description.
location	string	No description.
name	string	No description.
portType	string	No description.
region	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

---

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

---

adminStateUp^Required

public readonly adminStateUp: IResolvable;

• Type: cdktf.IResolvable

---

applicant^Required

public readonly applicant: string;

• Type: string

---

applyTime^Required

public readonly applyTime: string;

• Type: string

---

buildingLineProductId^Required

public readonly buildingLineProductId: string;

• Type: string

---

cableLabel^Required

public readonly cableLabel: string;

• Type: string

---

chargeMode^Required

public readonly chargeMode: string;

• Type: string

---

createTime^Required

public readonly createTime: string;

• Type: string

---

deleteTime^Required

public readonly deleteTime: string;

• Type: string

---

email^Required

public readonly email: string;

• Type: string

---

hostingId^Required

public readonly hostingId: string;

• Type: string

---

interfaceName^Required

public readonly interfaceName: string;

• Type: string

---

lagId^Required

public readonly lagId: string;

• Type: string

---

lastOnestopProductId^Required

public readonly lastOnestopProductId: string;

• Type: string

---

mobile^Required

public readonly mobile: string;

• Type: string

---

onestopProductId^Required

public readonly onestopProductId: string;

• Type: string

---

orderId^Required

public readonly orderId: string;

• Type: string

---

peerLocation^Required

public readonly peerLocation: string;

• Type: string

---

peerPortType^Required

public readonly peerPortType: string;

• Type: string

---

peerProvider^Required

public readonly peerProvider: string;

• Type: string

---

periodNum^Required

public readonly periodNum: number;

• Type: number

---

periodType^Required

public readonly periodType: number;

• Type: number

---

productId^Required

public readonly productId: string;

• Type: string

---

providerName^Required

public readonly providerName: string;

• Type: string

---

providerStatus^Required

public readonly providerStatus: string;

• Type: string

---

reason^Required

public readonly reason: string;

• Type: string

---

redundantId^Required

public readonly redundantId: string;

• Type: string

---

regionId^Required

public readonly regionId: string;

• Type: string

---

serviceKey^Required

public readonly serviceKey: string;

• Type: string

---

specCode^Required

public readonly specCode: string;

• Type: string

---

status^Required

public readonly status: string;

• Type: string

---

tenantId^Required

public readonly tenantId: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

vgwType^Required

public readonly vgwType: string;

• Type: string

---

bandwidthInput^Optional

public readonly bandwidthInput: number;

• Type: number

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

deviceIdInput^Optional

public readonly deviceIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

locationInput^Optional

public readonly locationInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

portTypeInput^Optional

public readonly portTypeInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

vlanInput^Optional

public readonly vlanInput: number;

• Type: number

---

bandwidth^Required

public readonly bandwidth: number;

• Type: number

---

description^Required

public readonly description: string;

• Type: string

---

deviceId^Required

public readonly deviceId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

location^Required

public readonly location: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

portType^Required

public readonly portType: string;

• Type: string

---

region^Required

public readonly region: 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

DataOpentelekomcloudDirectConnectV2Config

Initializer

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

const dataOpentelekomcloudDirectConnectV2Config: dataOpentelekomcloudDirectConnectV2.DataOpentelekomcloudDirectConnectV2Config = { ... }

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/data-sources/direct_connect_v2#bandwidth DataOpentelekomcloudDirectConnectV2#bandwidth}.
description	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#description DataOpentelekomcloudDirectConnectV2#description}.
deviceId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#device_id DataOpentelekomcloudDirectConnectV2#device_id}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#id DataOpentelekomcloudDirectConnectV2#id}.
location	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#location DataOpentelekomcloudDirectConnectV2#location}.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#name DataOpentelekomcloudDirectConnectV2#name}.
portType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#port_type DataOpentelekomcloudDirectConnectV2#port_type}.
region	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#region DataOpentelekomcloudDirectConnectV2#region}.
vlan	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#vlan DataOpentelekomcloudDirectConnectV2#vlan}.

---

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^Optional

public readonly bandwidth: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#bandwidth DataOpentelekomcloudDirectConnectV2#bandwidth}.

---

description^Optional

public readonly description: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#description DataOpentelekomcloudDirectConnectV2#description}.

---

deviceId^Optional

public readonly deviceId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#device_id DataOpentelekomcloudDirectConnectV2#device_id}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#id DataOpentelekomcloudDirectConnectV2#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.

---

location^Optional

public readonly location: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#location DataOpentelekomcloudDirectConnectV2#location}.

---

name^Optional

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#name DataOpentelekomcloudDirectConnectV2#name}.

---

portType^Optional

public readonly portType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#port_type DataOpentelekomcloudDirectConnectV2#port_type}.

---

region^Optional

public readonly region: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#region DataOpentelekomcloudDirectConnectV2#region}.

---

vlan^Optional

public readonly vlan: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/direct_connect_v2#vlan DataOpentelekomcloudDirectConnectV2#vlan}.

---