dataOpentelekomcloudVpcEipV1.typescript.md

dataOpentelekomcloudVpcEipV1 Submodule

Constructs

DataOpentelekomcloudVpcEipV1

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

Initializers

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

new dataOpentelekomcloudVpcEipV1.DataOpentelekomcloudVpcEipV1(scope: Construct, id: string, config?: DataOpentelekomcloudVpcEipV1Config)

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

---

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.
resetBandwidthId	No description.
resetId	No description.
resetNameRegex	No description.
resetPortId	No description.
resetPrivateIpAddress	No description.
resetPublicIpAddress	No description.
resetRegion	No description.
resetStatus	No description.
resetTags	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

---

resetBandwidthId

public resetBandwidthId(): void

resetId

public resetId(): void

resetNameRegex

public resetNameRegex(): void

resetPortId

public resetPortId(): void

resetPrivateIpAddress

public resetPrivateIpAddress(): void

resetPublicIpAddress

public resetPublicIpAddress(): void

resetRegion

public resetRegion(): void

resetStatus

public resetStatus(): void

resetTags

public resetTags(): 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 DataOpentelekomcloudVpcEipV1 resource upon running "cdktf plan ".

---

isConstruct

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

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

dataOpentelekomcloudVpcEipV1.DataOpentelekomcloudVpcEipV1.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

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

dataOpentelekomcloudVpcEipV1.DataOpentelekomcloudVpcEipV1.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

dataOpentelekomcloudVpcEipV1.DataOpentelekomcloudVpcEipV1.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing DataOpentelekomcloudVpcEipV1 that should be imported.

Refer to the {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#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 DataOpentelekomcloudVpcEipV1 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.
bandwidthShareType	string	No description.
bandwidthSize	number	No description.
createTime	string	No description.
ipVersion	number	No description.
name	string	No description.
tenantId	string	No description.
type	string	No description.
bandwidthIdInput	string	No description.
idInput	string	No description.
nameRegexInput	string	No description.
portIdInput	string	No description.
privateIpAddressInput	string	No description.
publicIpAddressInput	string	No description.
regionInput	string	No description.
statusInput	string	No description.
tagsInput	{[ key: string ]: string}	No description.
bandwidthId	string	No description.
id	string	No description.
nameRegex	string	No description.
portId	string	No description.
privateIpAddress	string	No description.
publicIpAddress	string	No description.
region	string	No description.
status	string	No description.
tags	{[ key: string ]: string}	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

---

bandwidthShareType^Required

public readonly bandwidthShareType: string;

• Type: string

---

bandwidthSize^Required

public readonly bandwidthSize: number;

• Type: number

---

createTime^Required

public readonly createTime: string;

• Type: string

---

ipVersion^Required

public readonly ipVersion: number;

• Type: number

---

name^Required

public readonly name: string;

• Type: string

---

tenantId^Required

public readonly tenantId: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

bandwidthIdInput^Optional

public readonly bandwidthIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameRegexInput^Optional

public readonly nameRegexInput: string;

• Type: string

---

portIdInput^Optional

public readonly portIdInput: string;

• Type: string

---

privateIpAddressInput^Optional

public readonly privateIpAddressInput: string;

• Type: string

---

publicIpAddressInput^Optional

public readonly publicIpAddressInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

statusInput^Optional

public readonly statusInput: string;

• Type: string

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

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

---

bandwidthId^Required

public readonly bandwidthId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

nameRegex^Required

public readonly nameRegex: string;

• Type: string

---

portId^Required

public readonly portId: string;

• Type: string

---

privateIpAddress^Required

public readonly privateIpAddress: string;

• Type: string

---

publicIpAddress^Required

public readonly publicIpAddress: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

status^Required

public readonly status: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

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

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataOpentelekomcloudVpcEipV1Config

Initializer

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

const dataOpentelekomcloudVpcEipV1Config: dataOpentelekomcloudVpcEipV1.DataOpentelekomcloudVpcEipV1Config = { ... }

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.
bandwidthId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#bandwidth_id DataOpentelekomcloudVpcEipV1#bandwidth_id}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#id DataOpentelekomcloudVpcEipV1#id}.
nameRegex	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#name_regex DataOpentelekomcloudVpcEipV1#name_regex}.
portId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#port_id DataOpentelekomcloudVpcEipV1#port_id}.
privateIpAddress	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#private_ip_address DataOpentelekomcloudVpcEipV1#private_ip_address}.
publicIpAddress	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#public_ip_address DataOpentelekomcloudVpcEipV1#public_ip_address}.
region	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#region DataOpentelekomcloudVpcEipV1#region}.
status	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#status DataOpentelekomcloudVpcEipV1#status}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#tags DataOpentelekomcloudVpcEipV1#tags}.

---

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[]

---

bandwidthId^Optional

public readonly bandwidthId: string;

• Type: string

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

---

nameRegex^Optional

public readonly nameRegex: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#name_regex DataOpentelekomcloudVpcEipV1#name_regex}.

---

portId^Optional

public readonly portId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#port_id DataOpentelekomcloudVpcEipV1#port_id}.

---

privateIpAddress^Optional

public readonly privateIpAddress: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#private_ip_address DataOpentelekomcloudVpcEipV1#private_ip_address}.

---

publicIpAddress^Optional

public readonly publicIpAddress: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#public_ip_address DataOpentelekomcloudVpcEipV1#public_ip_address}.

---

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/vpc_eip_v1#region DataOpentelekomcloudVpcEipV1#region}.

---

status^Optional

public readonly status: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#status DataOpentelekomcloudVpcEipV1#status}.

---

tags^Optional

public readonly tags: {[ key: string ]: string};

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.28/docs/data-sources/vpc_eip_v1#tags DataOpentelekomcloudVpcEipV1#tags}.

---