Skip to content

Latest commit

 

History

History
2108 lines (1328 loc) · 92.9 KB

snapshot.java.md

File metadata and controls

2108 lines (1328 loc) · 92.9 KB
Raw

snapshot Submodule

Constructs

Snapshot

Represents a {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot ionoscloud_snapshot}.

Initializers 

import com.hashicorp.cdktf.providers.ionoscloud.snapshot.Snapshot;

Snapshot.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .datacenterId(java.lang.String)
    .name(java.lang.String)
    .volumeId(java.lang.String)
//  .cpuHotPlug(java.lang.Boolean)
//  .cpuHotPlug(IResolvable)
//  .description(java.lang.String)
//  .discVirtioHotPlug(java.lang.Boolean)
//  .discVirtioHotPlug(IResolvable)
//  .discVirtioHotUnplug(java.lang.Boolean)
//  .discVirtioHotUnplug(IResolvable)
//  .id(java.lang.String)
//  .licenceType(java.lang.String)
//  .nicHotPlug(java.lang.Boolean)
//  .nicHotPlug(IResolvable)
//  .nicHotUnplug(java.lang.Boolean)
//  .nicHotUnplug(IResolvable)
//  .ramHotPlug(java.lang.Boolean)
//  .ramHotPlug(IResolvable)
//  .secAuthProtection(java.lang.Boolean)
//  .secAuthProtection(IResolvable)
//  .timeouts(SnapshotTimeouts)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
datacenterId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#datacenter_id Snapshot#datacenter_id}.
name java.lang.String A name of that resource.
volumeId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#volume_id Snapshot#volume_id}.
cpuHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#cpu_hot_plug Snapshot#cpu_hot_plug}.
description java.lang.String Human readable description.
discVirtioHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#disc_virtio_hot_plug Snapshot#disc_virtio_hot_plug}.
discVirtioHotUnplug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#disc_virtio_hot_unplug Snapshot#disc_virtio_hot_unplug}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#id Snapshot#id}.
licenceType java.lang.String OS type of this Snapshot.
nicHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#nic_hot_plug Snapshot#nic_hot_plug}.
nicHotUnplug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#nic_hot_unplug Snapshot#nic_hot_unplug}.
ramHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#ram_hot_plug Snapshot#ram_hot_plug}.
secAuthProtection java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Boolean value representing if the snapshot requires extra protection e.g. two factor protection.
timeouts SnapshotTimeouts timeouts block.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
datacenterIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#datacenter_id Snapshot#datacenter_id}.

nameRequired
  • Type: java.lang.String

A name of that resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#name Snapshot#name}

volumeIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#volume_id Snapshot#volume_id}.

cpuHotPlugOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#cpu_hot_plug Snapshot#cpu_hot_plug}.

descriptionOptional
  • Type: java.lang.String

Human readable description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#description Snapshot#description}

discVirtioHotPlugOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#disc_virtio_hot_plug Snapshot#disc_virtio_hot_plug}.

discVirtioHotUnplugOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#disc_virtio_hot_unplug Snapshot#disc_virtio_hot_unplug}.

idOptional
  • Type: java.lang.String

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

licenceTypeOptional
  • Type: java.lang.String

OS type of this Snapshot.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#licence_type Snapshot#licence_type}

nicHotPlugOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#nic_hot_plug Snapshot#nic_hot_plug}.

nicHotUnplugOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#nic_hot_unplug Snapshot#nic_hot_unplug}.

ramHotPlugOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#ram_hot_plug Snapshot#ram_hot_plug}.

secAuthProtectionOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Boolean value representing if the snapshot requires extra protection e.g. two factor protection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#sec_auth_protection Snapshot#sec_auth_protection}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#timeouts Snapshot#timeouts}

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".
putTimeouts No description.
resetCpuHotPlug No description.
resetDescription No description.
resetDiscVirtioHotPlug No description.
resetDiscVirtioHotUnplug No description.
resetId No description.
resetLicenceType No description.
resetNicHotPlug No description.
resetNicHotUnplug No description.
resetRamHotPlug No description.
resetSecAuthProtection No description.
resetTimeouts No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putTimeouts 
public void putTimeouts(SnapshotTimeouts value)
valueRequired
resetCpuHotPlug 
public void resetCpuHotPlug()
resetDescription 
public void resetDescription()
resetDiscVirtioHotPlug 
public void resetDiscVirtioHotPlug()
resetDiscVirtioHotUnplug 
public void resetDiscVirtioHotUnplug()
resetId 
public void resetId()
resetLicenceType 
public void resetLicenceType()
resetNicHotPlug 
public void resetNicHotPlug()
resetNicHotUnplug 
public void resetNicHotUnplug()
resetRamHotPlug 
public void resetRamHotPlug()
resetSecAuthProtection 
public void resetSecAuthProtection()
resetTimeouts 
public void resetTimeouts()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Snapshot resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.ionoscloud.snapshot.Snapshot;

Snapshot.isConstruct(java.lang.Object x)

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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.ionoscloud.snapshot.Snapshot;

Snapshot.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.ionoscloud.snapshot.Snapshot;

Snapshot.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.ionoscloud.snapshot.Snapshot;

Snapshot.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Snapshot.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing Snapshot that should be imported.

Refer to the {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
cpuHotUnplug com.hashicorp.cdktf.IResolvable No description.
discScsiHotPlug com.hashicorp.cdktf.IResolvable No description.
discScsiHotUnplug com.hashicorp.cdktf.IResolvable No description.
location java.lang.String No description.
ramHotUnplug com.hashicorp.cdktf.IResolvable No description.
size java.lang.Number No description.
timeouts SnapshotTimeoutsOutputReference No description.
cpuHotPlugInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
datacenterIdInput java.lang.String No description.
descriptionInput java.lang.String No description.
discVirtioHotPlugInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
discVirtioHotUnplugInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
licenceTypeInput java.lang.String No description.
nameInput java.lang.String No description.
nicHotPlugInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
nicHotUnplugInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
ramHotPlugInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
secAuthProtectionInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR SnapshotTimeouts No description.
volumeIdInput java.lang.String No description.
cpuHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
datacenterId java.lang.String No description.
description java.lang.String No description.
discVirtioHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
discVirtioHotUnplug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
licenceType java.lang.String No description.
name java.lang.String No description.
nicHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
nicHotUnplug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
ramHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
secAuthProtection java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
volumeId java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
cpuHotUnplugRequired 
public IResolvable getCpuHotUnplug();
  • Type: com.hashicorp.cdktf.IResolvable
discScsiHotPlugRequired 
public IResolvable getDiscScsiHotPlug();
  • Type: com.hashicorp.cdktf.IResolvable
discScsiHotUnplugRequired 
public IResolvable getDiscScsiHotUnplug();
  • Type: com.hashicorp.cdktf.IResolvable
locationRequired 
public java.lang.String getLocation();
  • Type: java.lang.String
ramHotUnplugRequired 
public IResolvable getRamHotUnplug();
  • Type: com.hashicorp.cdktf.IResolvable
sizeRequired 
public java.lang.Number getSize();
  • Type: java.lang.Number
timeoutsRequired 
public SnapshotTimeoutsOutputReference getTimeouts();
cpuHotPlugInputOptional 
public java.lang.Object getCpuHotPlugInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
datacenterIdInputOptional 
public java.lang.String getDatacenterIdInput();
  • Type: java.lang.String
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
discVirtioHotPlugInputOptional 
public java.lang.Object getDiscVirtioHotPlugInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
discVirtioHotUnplugInputOptional 
public java.lang.Object getDiscVirtioHotUnplugInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
licenceTypeInputOptional 
public java.lang.String getLicenceTypeInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
nicHotPlugInputOptional 
public java.lang.Object getNicHotPlugInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nicHotUnplugInputOptional 
public java.lang.Object getNicHotUnplugInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
ramHotPlugInputOptional 
public java.lang.Object getRamHotPlugInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
secAuthProtectionInputOptional 
public java.lang.Object getSecAuthProtectionInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
timeoutsInputOptional 
public java.lang.Object getTimeoutsInput();
volumeIdInputOptional 
public java.lang.String getVolumeIdInput();
  • Type: java.lang.String
cpuHotPlugRequired 
public java.lang.Object getCpuHotPlug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
datacenterIdRequired 
public java.lang.String getDatacenterId();
  • Type: java.lang.String
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
discVirtioHotPlugRequired 
public java.lang.Object getDiscVirtioHotPlug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
discVirtioHotUnplugRequired 
public java.lang.Object getDiscVirtioHotUnplug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
licenceTypeRequired 
public java.lang.String getLicenceType();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
nicHotPlugRequired 
public java.lang.Object getNicHotPlug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nicHotUnplugRequired 
public java.lang.Object getNicHotUnplug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
ramHotPlugRequired 
public java.lang.Object getRamHotPlug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
secAuthProtectionRequired 
public java.lang.Object getSecAuthProtection();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
volumeIdRequired 
public java.lang.String getVolumeId();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

SnapshotConfig

Initializer 

import com.hashicorp.cdktf.providers.ionoscloud.snapshot.SnapshotConfig;

SnapshotConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .datacenterId(java.lang.String)
    .name(java.lang.String)
    .volumeId(java.lang.String)
//  .cpuHotPlug(java.lang.Boolean)
//  .cpuHotPlug(IResolvable)
//  .description(java.lang.String)
//  .discVirtioHotPlug(java.lang.Boolean)
//  .discVirtioHotPlug(IResolvable)
//  .discVirtioHotUnplug(java.lang.Boolean)
//  .discVirtioHotUnplug(IResolvable)
//  .id(java.lang.String)
//  .licenceType(java.lang.String)
//  .nicHotPlug(java.lang.Boolean)
//  .nicHotPlug(IResolvable)
//  .nicHotUnplug(java.lang.Boolean)
//  .nicHotUnplug(IResolvable)
//  .ramHotPlug(java.lang.Boolean)
//  .ramHotPlug(IResolvable)
//  .secAuthProtection(java.lang.Boolean)
//  .secAuthProtection(IResolvable)
//  .timeouts(SnapshotTimeouts)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
datacenterId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#datacenter_id Snapshot#datacenter_id}.
name java.lang.String A name of that resource.
volumeId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#volume_id Snapshot#volume_id}.
cpuHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#cpu_hot_plug Snapshot#cpu_hot_plug}.
description java.lang.String Human readable description.
discVirtioHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#disc_virtio_hot_plug Snapshot#disc_virtio_hot_plug}.
discVirtioHotUnplug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#disc_virtio_hot_unplug Snapshot#disc_virtio_hot_unplug}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#id Snapshot#id}.
licenceType java.lang.String OS type of this Snapshot.
nicHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#nic_hot_plug Snapshot#nic_hot_plug}.
nicHotUnplug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#nic_hot_unplug Snapshot#nic_hot_unplug}.
ramHotPlug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#ram_hot_plug Snapshot#ram_hot_plug}.
secAuthProtection java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Boolean value representing if the snapshot requires extra protection e.g. two factor protection.
timeouts SnapshotTimeouts timeouts block.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
datacenterIdRequired 
public java.lang.String getDatacenterId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#datacenter_id Snapshot#datacenter_id}.

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

A name of that resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#name Snapshot#name}

volumeIdRequired 
public java.lang.String getVolumeId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#volume_id Snapshot#volume_id}.

cpuHotPlugOptional 
public java.lang.Object getCpuHotPlug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#cpu_hot_plug Snapshot#cpu_hot_plug}.

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

Human readable description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#description Snapshot#description}

discVirtioHotPlugOptional 
public java.lang.Object getDiscVirtioHotPlug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#disc_virtio_hot_plug Snapshot#disc_virtio_hot_plug}.

discVirtioHotUnplugOptional 
public java.lang.Object getDiscVirtioHotUnplug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#disc_virtio_hot_unplug Snapshot#disc_virtio_hot_unplug}.

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

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

licenceTypeOptional 
public java.lang.String getLicenceType();
  • Type: java.lang.String

OS type of this Snapshot.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#licence_type Snapshot#licence_type}

nicHotPlugOptional 
public java.lang.Object getNicHotPlug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#nic_hot_plug Snapshot#nic_hot_plug}.

nicHotUnplugOptional 
public java.lang.Object getNicHotUnplug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#nic_hot_unplug Snapshot#nic_hot_unplug}.

ramHotPlugOptional 
public java.lang.Object getRamHotPlug();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#ram_hot_plug Snapshot#ram_hot_plug}.

secAuthProtectionOptional 
public java.lang.Object getSecAuthProtection();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Boolean value representing if the snapshot requires extra protection e.g. two factor protection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#sec_auth_protection Snapshot#sec_auth_protection}

timeoutsOptional 
public SnapshotTimeouts getTimeouts();

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#timeouts Snapshot#timeouts}

SnapshotTimeouts

Initializer 

import com.hashicorp.cdktf.providers.ionoscloud.snapshot.SnapshotTimeouts;

SnapshotTimeouts.builder()
//  .create(java.lang.String)
//  .default(java.lang.String)
//  .delete(java.lang.String)
//  .update(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#create Snapshot#create}.
default java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#default Snapshot#default}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#delete Snapshot#delete}.
update java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#update Snapshot#update}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#create Snapshot#create}.

defaultOptional 
public java.lang.String getDefault();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#default Snapshot#default}.

deleteOptional 
public java.lang.String getDelete();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#delete Snapshot#delete}.

updateOptional 
public java.lang.String getUpdate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/resources/snapshot#update Snapshot#update}.

Classes

SnapshotTimeoutsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.ionoscloud.snapshot.SnapshotTimeoutsOutputReference;

new SnapshotTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public void resetCreate()
resetDefault 
public void resetDefault()
resetDelete 
public void resetDelete()
resetUpdate 
public void resetUpdate()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
createInput java.lang.String No description.
defaultInput java.lang.String No description.
deleteInput java.lang.String No description.
updateInput java.lang.String No description.
create java.lang.String No description.
default java.lang.String No description.
delete java.lang.String No description.
update java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR SnapshotTimeouts No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
defaultInputOptional 
public java.lang.String getDefaultInput();
  • Type: java.lang.String
deleteInputOptional 
public java.lang.String getDeleteInput();
  • Type: java.lang.String
updateInputOptional 
public java.lang.String getUpdateInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
defaultRequired 
public java.lang.String getDefault();
  • Type: java.lang.String
deleteRequired 
public java.lang.String getDelete();
  • Type: java.lang.String
updateRequired 
public java.lang.String getUpdate();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();