dataIonoscloudVolume.typescript.md

dataIonoscloudVolume Submodule

Constructs

DataIonoscloudVolume

Represents a {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume ionoscloud_volume}.

Initializers

import { dataIonoscloudVolume } from '@cdktf/provider-ionoscloud'

new dataIonoscloudVolume.DataIonoscloudVolume(scope: Construct, id: string, config: DataIonoscloudVolumeConfig)

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

---

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.
putTimeouts	No description.
resetId	No description.
resetName	No description.
resetTimeouts	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

---

putTimeouts

public putTimeouts(value: DataIonoscloudVolumeTimeouts): void

value^Required

• Type: DataIonoscloudVolumeTimeouts

---

resetId

public resetId(): void

resetName

public resetName(): void

resetTimeouts

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

---

isConstruct

import { dataIonoscloudVolume } from '@cdktf/provider-ionoscloud'

dataIonoscloudVolume.DataIonoscloudVolume.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 { dataIonoscloudVolume } from '@cdktf/provider-ionoscloud'

dataIonoscloudVolume.DataIonoscloudVolume.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

import { dataIonoscloudVolume } from '@cdktf/provider-ionoscloud'

dataIonoscloudVolume.DataIonoscloudVolume.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dataIonoscloudVolume } from '@cdktf/provider-ionoscloud'

dataIonoscloudVolume.DataIonoscloudVolume.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing DataIonoscloudVolume that should be imported.

Refer to the {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#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 DataIonoscloudVolume 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.
availabilityZone	string	No description.
backupUnitId	string	No description.
bootServer	string	No description.
bus	string	No description.
cpuHotPlug	cdktf.IResolvable	No description.
deviceNumber	number	No description.
discVirtioHotPlug	cdktf.IResolvable	No description.
discVirtioHotUnplug	cdktf.IResolvable	No description.
diskType	string	No description.
image	string	No description.
imagePassword	string	No description.
licenceType	string	No description.
nicHotPlug	cdktf.IResolvable	No description.
nicHotUnplug	cdktf.IResolvable	No description.
ramHotPlug	cdktf.IResolvable	No description.
size	number	No description.
sshkey	string	No description.
timeouts	DataIonoscloudVolumeTimeoutsOutputReference	No description.
userData	string	No description.
datacenterIdInput	string	No description.
idInput	string	No description.
nameInput	string	No description.
timeoutsInput	cdktf.IResolvable | DataIonoscloudVolumeTimeouts	No description.
datacenterId	string	No description.
id	string	No description.
name	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

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

---

backupUnitId^Required

public readonly backupUnitId: string;

• Type: string

---

bootServer^Required

public readonly bootServer: string;

• Type: string

---

bus^Required

public readonly bus: string;

• Type: string

---

cpuHotPlug^Required

public readonly cpuHotPlug: IResolvable;

• Type: cdktf.IResolvable

---

deviceNumber^Required

public readonly deviceNumber: number;

• Type: number

---

discVirtioHotPlug^Required

public readonly discVirtioHotPlug: IResolvable;

• Type: cdktf.IResolvable

---

discVirtioHotUnplug^Required

public readonly discVirtioHotUnplug: IResolvable;

• Type: cdktf.IResolvable

---

diskType^Required

public readonly diskType: string;

• Type: string

---

image^Required

public readonly image: string;

• Type: string

---

imagePassword^Required

public readonly imagePassword: string;

• Type: string

---

licenceType^Required

public readonly licenceType: string;

• Type: string

---

nicHotPlug^Required

public readonly nicHotPlug: IResolvable;

• Type: cdktf.IResolvable

---

nicHotUnplug^Required

public readonly nicHotUnplug: IResolvable;

• Type: cdktf.IResolvable

---

ramHotPlug^Required

public readonly ramHotPlug: IResolvable;

• Type: cdktf.IResolvable

---

size^Required

public readonly size: number;

• Type: number

---

sshkey^Required

public readonly sshkey: string;

• Type: string

---

timeouts^Required

public readonly timeouts: DataIonoscloudVolumeTimeoutsOutputReference;

• Type: DataIonoscloudVolumeTimeoutsOutputReference

---

userData^Required

public readonly userData: string;

• Type: string

---

datacenterIdInput^Optional

public readonly datacenterIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | DataIonoscloudVolumeTimeouts;

• Type: cdktf.IResolvable | DataIonoscloudVolumeTimeouts

---

datacenterId^Required

public readonly datacenterId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataIonoscloudVolumeConfig

Initializer

import { dataIonoscloudVolume } from '@cdktf/provider-ionoscloud'

const dataIonoscloudVolumeConfig: dataIonoscloudVolume.DataIonoscloudVolumeConfig = { ... }

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.
datacenterId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#datacenter_id DataIonoscloudVolume#datacenter_id}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#id DataIonoscloudVolume#id}.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#name DataIonoscloudVolume#name}.
timeouts	DataIonoscloudVolumeTimeouts	timeouts block.

---

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

---

datacenterId^Required

public readonly datacenterId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#datacenter_id DataIonoscloudVolume#datacenter_id}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#id DataIonoscloudVolume#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.

---

name^Optional

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#name DataIonoscloudVolume#name}.

---

timeouts^Optional

public readonly timeouts: DataIonoscloudVolumeTimeouts;

• Type: DataIonoscloudVolumeTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#timeouts DataIonoscloudVolume#timeouts}

---

DataIonoscloudVolumeTimeouts

Initializer

import { dataIonoscloudVolume } from '@cdktf/provider-ionoscloud'

const dataIonoscloudVolumeTimeouts: dataIonoscloudVolume.DataIonoscloudVolumeTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#create DataIonoscloudVolume#create}.
default	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#default DataIonoscloudVolume#default}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#delete DataIonoscloudVolume#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#update DataIonoscloudVolume#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#create DataIonoscloudVolume#create}.

---

default^Optional

public readonly default: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#default DataIonoscloudVolume#default}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#delete DataIonoscloudVolume#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/volume#update DataIonoscloudVolume#update}.

---

Classes

DataIonoscloudVolumeTimeoutsOutputReference

Initializers

import { dataIonoscloudVolume } from '@cdktf/provider-ionoscloud'

new dataIonoscloudVolume.DataIonoscloudVolumeTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

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.
resetCreate	No description.
resetDefault	No description.
resetDelete	No description.
resetUpdate	No description.

---

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.

resetCreate

public resetCreate(): void

resetDefault

public resetDefault(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): void

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.
createInput	string	No description.
defaultInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
default	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | DataIonoscloudVolumeTimeouts	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

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

defaultInput^Optional

public readonly defaultInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

default^Required

public readonly default: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | DataIonoscloudVolumeTimeouts;

• Type: cdktf.IResolvable | DataIonoscloudVolumeTimeouts

---