Represents a {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage upcloud_storage}.
from cdktf_cdktf_provider_upcloud import storage
storage.Storage(
scope: Construct,
id: str,
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
count: typing.Union[typing.Union[int, float], TerraformCount] = None,
depends_on: typing.List[ITerraformDependable] = None,
for_each: ITerraformIterator = None,
lifecycle: TerraformResourceLifecycle = None,
provider: TerraformProvider = None,
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
size: typing.Union[int, float],
title: str,
zone: str,
backup_rule: typing.Union[IResolvable, typing.List[StorageBackupRule]] = None,
clone: typing.Union[IResolvable, typing.List[StorageClone]] = None,
delete_autoresize_backup: typing.Union[bool, IResolvable] = None,
encrypt: typing.Union[bool, IResolvable] = None,
filesystem_autoresize: typing.Union[bool, IResolvable] = None,
import: typing.Union[IResolvable, typing.List[StorageImport]] = None,
labels: typing.Mapping[str] = None,
tier: str = None
)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
str |
The scoped construct ID. |
connection |
typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] |
No description. |
count |
typing.Union[typing.Union[int, float], cdktf.TerraformCount] |
No description. |
depends_on |
typing.List[cdktf.ITerraformDependable] |
No description. |
for_each |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] |
No description. |
size |
typing.Union[int, float] |
The size of the storage in gigabytes. |
title |
str |
The title of the storage. |
zone |
str |
The zone the storage is in, e.g. de-fra1 . You can list available zones with upctl zone list . |
backup_rule |
typing.Union[cdktf.IResolvable, typing.List[StorageBackupRule]] |
backup_rule block. |
clone |
typing.Union[cdktf.IResolvable, typing.List[StorageClone]] |
clone block. |
delete_autoresize_backup |
typing.Union[bool, cdktf.IResolvable] |
If set to true, the backup taken before the partition and filesystem resize attempt will be deleted immediately after success. |
encrypt |
typing.Union[bool, cdktf.IResolvable] |
Sets if the storage is encrypted at rest. |
filesystem_autoresize |
typing.Union[bool, cdktf.IResolvable] |
If set to true, provider will attempt to resize partition and filesystem when the size of the storage changes. |
import |
typing.Union[cdktf.IResolvable, typing.List[StorageImport]] |
import block. |
labels |
typing.Mapping[str] |
User defined key-value pairs to classify the storage. |
tier |
str |
The tier of the storage. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
- Type: typing.List[cdktf.ITerraformDependable]
- Type: cdktf.ITerraformIterator
- Type: cdktf.TerraformResourceLifecycle
- Type: cdktf.TerraformProvider
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
- Type: typing.Union[int, float]
The size of the storage in gigabytes.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#size Storage#size}
- Type: str
The title of the storage.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#title Storage#title}
- Type: str
The zone the storage is in, e.g. de-fra1
. You can list available zones with upctl zone list
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#zone Storage#zone}
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageBackupRule]]
backup_rule block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#backup_rule Storage#backup_rule}
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageClone]]
clone block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#clone Storage#clone}
- Type: typing.Union[bool, cdktf.IResolvable]
If set to true, the backup taken before the partition and filesystem resize attempt will be deleted immediately after success.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#delete_autoresize_backup Storage#delete_autoresize_backup}
- Type: typing.Union[bool, cdktf.IResolvable]
Sets if the storage is encrypted at rest.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#encrypt Storage#encrypt}
- Type: typing.Union[bool, cdktf.IResolvable]
If set to true, provider will attempt to resize partition and filesystem when the size of the storage changes.
Please note that before the resize attempt is made, backup of the storage will be taken. If the resize attempt fails, the backup will be used to restore the storage and then deleted. If the resize attempt succeeds, backup will be kept (unless delete_autoresize_backup
option is set to true).
Taking and keeping backups incure costs.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#filesystem_autoresize Storage#filesystem_autoresize}
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageImport]]
import block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#import Storage#import}
- Type: typing.Mapping[str]
User defined key-value pairs to classify the storage.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#labels Storage#labels}
- Type: str
The tier of the storage.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#tier Storage#tier}
Name | Description |
---|---|
to_string |
Returns a string representation of this construct. |
add_override |
No description. |
override_logical_id |
Overrides the auto-generated logical ID with a specific ID. |
reset_override_logical_id |
Resets a previously passed logical Id to use the auto-generated logical id again. |
to_hcl_terraform |
No description. |
to_metadata |
No description. |
to_terraform |
Adds this resource to the terraform JSON output. |
add_move_target |
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
has_resource_move |
No description. |
import_from |
No description. |
interpolation_for_attribute |
No description. |
move_from_id |
Move the resource corresponding to "id" to this resource. |
move_to |
Moves this resource to the target resource given by moveTarget. |
move_to_id |
Moves this resource to the resource corresponding to "id". |
put_backup_rule |
No description. |
put_clone |
No description. |
put_import |
No description. |
reset_backup_rule |
No description. |
reset_clone |
No description. |
reset_delete_autoresize_backup |
No description. |
reset_encrypt |
No description. |
reset_filesystem_autoresize |
No description. |
reset_import |
No description. |
reset_labels |
No description. |
reset_tier |
No description. |
def to_string() -> str
Returns a string representation of this construct.
def add_override(
path: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
def override_logical_id(
new_logical_id: str
) -> None
Overrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
def reset_override_logical_id() -> None
Resets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.Any
def to_metadata() -> typing.Any
def to_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
def add_move_target(
move_target: str
) -> None
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: str
The string move target that will correspond to this resource.
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str
- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
- Type: str
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
def import_from(
id: str,
provider: TerraformProvider = None
) -> None
- Type: str
- Type: cdktf.TerraformProvider
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def move_from_id(
id: str
) -> None
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.
- Type: str
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
def move_to(
move_target: str,
index: typing.Union[str, typing.Union[int, float]] = None
) -> None
Moves this resource to the target resource given by moveTarget.
- Type: str
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: typing.Union[str, typing.Union[int, float]]
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
def move_to_id(
id: str
) -> None
Moves this resource to the resource corresponding to "id".
- Type: str
Full id of resource to move to, e.g. "aws_s3_bucket.example".
def put_backup_rule(
value: typing.Union[IResolvable, typing.List[StorageBackupRule]]
) -> None
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageBackupRule]]
def put_clone(
value: typing.Union[IResolvable, typing.List[StorageClone]]
) -> None
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageClone]]
def put_import(
value: typing.Union[IResolvable, typing.List[StorageImport]]
) -> None
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageImport]]
def reset_backup_rule() -> None
def reset_clone() -> None
def reset_delete_autoresize_backup() -> None
def reset_encrypt() -> None
def reset_filesystem_autoresize() -> None
def reset_import() -> None
def reset_labels() -> None
def reset_tier() -> None
Name | Description |
---|---|
is_construct |
Checks if x is a construct. |
is_terraform_element |
No description. |
is_terraform_resource |
No description. |
generate_config_for_import |
Generates CDKTF code for importing a Storage resource upon running "cdktf plan ". |
from cdktf_cdktf_provider_upcloud import storage
storage.Storage.is_construct(
x: typing.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.
- Type: typing.Any
Any object.
from cdktf_cdktf_provider_upcloud import storage
storage.Storage.is_terraform_element(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_upcloud import storage
storage.Storage.is_terraform_resource(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_upcloud import storage
storage.Storage.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)
Generates CDKTF code for importing a Storage resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The construct id used in the generated config for the Storage to import.
- Type: str
The id of the existing Storage that should be imported.
Refer to the {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the Storage to import is found.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
cdktf_stack |
cdktf.TerraformStack |
No description. |
fqn |
str |
No description. |
friendly_unique_id |
str |
No description. |
terraform_meta_arguments |
typing.Mapping[typing.Any] |
No description. |
terraform_resource_type |
str |
No description. |
terraform_generator_metadata |
cdktf.TerraformProviderGeneratorMetadata |
No description. |
connection |
typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] |
No description. |
count |
typing.Union[typing.Union[int, float], cdktf.TerraformCount] |
No description. |
depends_on |
typing.List[str] |
No description. |
for_each |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] |
No description. |
backup_rule |
StorageBackupRuleList |
No description. |
clone |
StorageCloneList |
No description. |
id |
str |
No description. |
import |
StorageImportList |
No description. |
system_labels |
cdktf.StringMap |
No description. |
type |
str |
No description. |
backup_rule_input |
typing.Union[cdktf.IResolvable, typing.List[StorageBackupRule]] |
No description. |
clone_input |
typing.Union[cdktf.IResolvable, typing.List[StorageClone]] |
No description. |
delete_autoresize_backup_input |
typing.Union[bool, cdktf.IResolvable] |
No description. |
encrypt_input |
typing.Union[bool, cdktf.IResolvable] |
No description. |
filesystem_autoresize_input |
typing.Union[bool, cdktf.IResolvable] |
No description. |
import_input |
typing.Union[cdktf.IResolvable, typing.List[StorageImport]] |
No description. |
labels_input |
typing.Mapping[str] |
No description. |
size_input |
typing.Union[int, float] |
No description. |
tier_input |
str |
No description. |
title_input |
str |
No description. |
zone_input |
str |
No description. |
delete_autoresize_backup |
typing.Union[bool, cdktf.IResolvable] |
No description. |
encrypt |
typing.Union[bool, cdktf.IResolvable] |
No description. |
filesystem_autoresize |
typing.Union[bool, cdktf.IResolvable] |
No description. |
labels |
typing.Mapping[str] |
No description. |
size |
typing.Union[int, float] |
No description. |
tier |
str |
No description. |
title |
str |
No description. |
zone |
str |
No description. |
node: Node
- Type: constructs.Node
The tree node.
cdktf_stack: TerraformStack
- Type: cdktf.TerraformStack
fqn: str
- Type: str
friendly_unique_id: str
- Type: str
terraform_meta_arguments: typing.Mapping[typing.Any]
- Type: typing.Mapping[typing.Any]
terraform_resource_type: str
- Type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata
- Type: cdktf.TerraformProviderGeneratorMetadata
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
count: typing.Union[typing.Union[int, float], TerraformCount]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_on: typing.List[str]
- Type: typing.List[str]
for_each: ITerraformIterator
- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle
- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider
- Type: cdktf.TerraformProvider
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
backup_rule: StorageBackupRuleList
- Type: StorageBackupRuleList
clone: StorageCloneList
- Type: StorageCloneList
id: str
- Type: str
import: StorageImportList
- Type: StorageImportList
system_labels: StringMap
- Type: cdktf.StringMap
type: str
- Type: str
backup_rule_input: typing.Union[IResolvable, typing.List[StorageBackupRule]]
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageBackupRule]]
clone_input: typing.Union[IResolvable, typing.List[StorageClone]]
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageClone]]
delete_autoresize_backup_input: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
encrypt_input: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
filesystem_autoresize_input: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
import_input: typing.Union[IResolvable, typing.List[StorageImport]]
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageImport]]
labels_input: typing.Mapping[str]
- Type: typing.Mapping[str]
size_input: typing.Union[int, float]
- Type: typing.Union[int, float]
tier_input: str
- Type: str
title_input: str
- Type: str
zone_input: str
- Type: str
delete_autoresize_backup: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
encrypt: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
filesystem_autoresize: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
labels: typing.Mapping[str]
- Type: typing.Mapping[str]
size: typing.Union[int, float]
- Type: typing.Union[int, float]
tier: str
- Type: str
title: str
- Type: str
zone: str
- Type: str
Name | Type | Description |
---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str
- Type: str
from cdktf_cdktf_provider_upcloud import storage
storage.StorageBackupRule(
interval: str,
retention: typing.Union[int, float],
time: str
)
Name | Type | Description |
---|---|---|
interval |
str |
The weekday when the backup is created. |
retention |
typing.Union[int, float] |
The number of days before a backup is automatically deleted. |
time |
str |
The time of day when the backup is created. |
interval: str
- Type: str
The weekday when the backup is created.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#interval Storage#interval}
retention: typing.Union[int, float]
- Type: typing.Union[int, float]
The number of days before a backup is automatically deleted.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#retention Storage#retention}
time: str
- Type: str
The time of day when the backup is created.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#time Storage#time}
from cdktf_cdktf_provider_upcloud import storage
storage.StorageClone(
id: str
)
Name | Type | Description |
---|---|---|
id |
str |
The unique identifier of the storage/template to clone. |
id: str
- Type: str
The unique identifier of the storage/template to clone.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#id Storage#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.
from cdktf_cdktf_provider_upcloud import storage
storage.StorageConfig(
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
count: typing.Union[typing.Union[int, float], TerraformCount] = None,
depends_on: typing.List[ITerraformDependable] = None,
for_each: ITerraformIterator = None,
lifecycle: TerraformResourceLifecycle = None,
provider: TerraformProvider = None,
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
size: typing.Union[int, float],
title: str,
zone: str,
backup_rule: typing.Union[IResolvable, typing.List[StorageBackupRule]] = None,
clone: typing.Union[IResolvable, typing.List[StorageClone]] = None,
delete_autoresize_backup: typing.Union[bool, IResolvable] = None,
encrypt: typing.Union[bool, IResolvable] = None,
filesystem_autoresize: typing.Union[bool, IResolvable] = None,
import: typing.Union[IResolvable, typing.List[StorageImport]] = None,
labels: typing.Mapping[str] = None,
tier: str = None
)
Name | Type | Description |
---|---|---|
connection |
typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] |
No description. |
count |
typing.Union[typing.Union[int, float], cdktf.TerraformCount] |
No description. |
depends_on |
typing.List[cdktf.ITerraformDependable] |
No description. |
for_each |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] |
No description. |
size |
typing.Union[int, float] |
The size of the storage in gigabytes. |
title |
str |
The title of the storage. |
zone |
str |
The zone the storage is in, e.g. de-fra1 . You can list available zones with upctl zone list . |
backup_rule |
typing.Union[cdktf.IResolvable, typing.List[StorageBackupRule]] |
backup_rule block. |
clone |
typing.Union[cdktf.IResolvable, typing.List[StorageClone]] |
clone block. |
delete_autoresize_backup |
typing.Union[bool, cdktf.IResolvable] |
If set to true, the backup taken before the partition and filesystem resize attempt will be deleted immediately after success. |
encrypt |
typing.Union[bool, cdktf.IResolvable] |
Sets if the storage is encrypted at rest. |
filesystem_autoresize |
typing.Union[bool, cdktf.IResolvable] |
If set to true, provider will attempt to resize partition and filesystem when the size of the storage changes. |
import |
typing.Union[cdktf.IResolvable, typing.List[StorageImport]] |
import block. |
labels |
typing.Mapping[str] |
User defined key-value pairs to classify the storage. |
tier |
str |
The tier of the storage. |
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
count: typing.Union[typing.Union[int, float], TerraformCount]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_on: typing.List[ITerraformDependable]
- Type: typing.List[cdktf.ITerraformDependable]
for_each: ITerraformIterator
- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle
- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider
- Type: cdktf.TerraformProvider
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
size: typing.Union[int, float]
- Type: typing.Union[int, float]
The size of the storage in gigabytes.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#size Storage#size}
title: str
- Type: str
The title of the storage.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#title Storage#title}
zone: str
- Type: str
The zone the storage is in, e.g. de-fra1
. You can list available zones with upctl zone list
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#zone Storage#zone}
backup_rule: typing.Union[IResolvable, typing.List[StorageBackupRule]]
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageBackupRule]]
backup_rule block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#backup_rule Storage#backup_rule}
clone: typing.Union[IResolvable, typing.List[StorageClone]]
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageClone]]
clone block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#clone Storage#clone}
delete_autoresize_backup: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
If set to true, the backup taken before the partition and filesystem resize attempt will be deleted immediately after success.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#delete_autoresize_backup Storage#delete_autoresize_backup}
encrypt: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
Sets if the storage is encrypted at rest.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#encrypt Storage#encrypt}
filesystem_autoresize: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
If set to true, provider will attempt to resize partition and filesystem when the size of the storage changes.
Please note that before the resize attempt is made, backup of the storage will be taken. If the resize attempt fails, the backup will be used to restore the storage and then deleted. If the resize attempt succeeds, backup will be kept (unless delete_autoresize_backup
option is set to true).
Taking and keeping backups incure costs.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#filesystem_autoresize Storage#filesystem_autoresize}
import: typing.Union[IResolvable, typing.List[StorageImport]]
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageImport]]
import block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#import Storage#import}
labels: typing.Mapping[str]
- Type: typing.Mapping[str]
User defined key-value pairs to classify the storage.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#labels Storage#labels}
tier: str
- Type: str
The tier of the storage.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#tier Storage#tier}
from cdktf_cdktf_provider_upcloud import storage
storage.StorageImport(
source: str,
source_location: str,
source_hash: str = None
)
Name | Type | Description |
---|---|---|
source |
str |
The mode of the import task. One of http_import or direct_upload . |
source_location |
str |
The location of the file to import. |
source_hash |
str |
SHA256 hash of the source content. |
source: str
- Type: str
The mode of the import task. One of http_import
or direct_upload
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#source Storage#source}
source_location: str
- Type: str
The location of the file to import.
For http_import
an accessible URL. For direct_upload
a local file. When direct uploading a compressed image, Content-Type
header of the PUT request is set automatically based on the file extension (.gz
or .xz
, case-insensitive).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#source_location Storage#source_location}
source_hash: str
- Type: str
SHA256 hash of the source content.
This hash is used to verify the integrity of the imported data by comparing it to sha256sum
after the import has completed. Possible filename is automatically removed from the hash before comparison.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/upcloudltd/upcloud/5.13.0/docs/resources/storage#source_hash Storage#source_hash}
from cdktf_cdktf_provider_upcloud import storage
storage.StorageBackupRuleList(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
wraps_set: bool
)
Name | Type | Description |
---|---|---|
terraform_resource |
cdktf.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
wraps_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
all_with_map_key |
Creating an iterator for this complex list. |
compute_fqn |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
get |
No description. |
def all_with_map_key(
map_key_attribute_name: str
) -> DynamicListTerraformIterator
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: str
def compute_fqn() -> str
def resolve(
_context: IResolveContext
) -> typing.Any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
def to_string() -> str
Return a string representation of this resolvable object.
Returns a reversible string representation.
def get(
index: typing.Union[int, float]
) -> StorageBackupRuleOutputReference
- Type: typing.Union[int, float]
the index of the item to return.
Name | Type | Description |
---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
internal_value |
typing.Union[cdktf.IResolvable, typing.List[StorageBackupRule]] |
No description. |
creation_stack: typing.List[str]
- Type: typing.List[str]
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: str
- Type: str
internal_value: typing.Union[IResolvable, typing.List[StorageBackupRule]]
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageBackupRule]]
from cdktf_cdktf_provider_upcloud import storage
storage.StorageBackupRuleOutputReference(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
complex_object_index: typing.Union[int, float],
complex_object_is_from_set: bool
)
Name | Type | Description |
---|---|---|
terraform_resource |
cdktf.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
complex_object_index |
typing.Union[int, float] |
the index of this item in the list. |
complex_object_is_from_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: typing.Union[int, float]
the index of this item in the list.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
compute_fqn |
No description. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
interpolation_for_attribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
def compute_fqn() -> str
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str
- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
- Type: str
def interpolation_for_attribute(
property: str
) -> IResolvable
- Type: str
def resolve(
_context: IResolveContext
) -> typing.Any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
def to_string() -> str
Return a string representation of this resolvable object.
Returns a reversible string representation.
Name | Type | Description |
---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
interval_input |
str |
No description. |
retention_input |
typing.Union[int, float] |
No description. |
time_input |
str |
No description. |
interval |
str |
No description. |
retention |
typing.Union[int, float] |
No description. |
time |
str |
No description. |
internal_value |
typing.Union[cdktf.IResolvable, StorageBackupRule] |
No description. |
creation_stack: typing.List[str]
- Type: typing.List[str]
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: str
- Type: str
interval_input: str
- Type: str
retention_input: typing.Union[int, float]
- Type: typing.Union[int, float]
time_input: str
- Type: str
interval: str
- Type: str
retention: typing.Union[int, float]
- Type: typing.Union[int, float]
time: str
- Type: str
internal_value: typing.Union[IResolvable, StorageBackupRule]
- Type: typing.Union[cdktf.IResolvable, StorageBackupRule]
from cdktf_cdktf_provider_upcloud import storage
storage.StorageCloneList(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
wraps_set: bool
)
Name | Type | Description |
---|---|---|
terraform_resource |
cdktf.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
wraps_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
all_with_map_key |
Creating an iterator for this complex list. |
compute_fqn |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
get |
No description. |
def all_with_map_key(
map_key_attribute_name: str
) -> DynamicListTerraformIterator
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: str
def compute_fqn() -> str
def resolve(
_context: IResolveContext
) -> typing.Any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
def to_string() -> str
Return a string representation of this resolvable object.
Returns a reversible string representation.
def get(
index: typing.Union[int, float]
) -> StorageCloneOutputReference
- Type: typing.Union[int, float]
the index of the item to return.
Name | Type | Description |
---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
internal_value |
typing.Union[cdktf.IResolvable, typing.List[StorageClone]] |
No description. |
creation_stack: typing.List[str]
- Type: typing.List[str]
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: str
- Type: str
internal_value: typing.Union[IResolvable, typing.List[StorageClone]]
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageClone]]
from cdktf_cdktf_provider_upcloud import storage
storage.StorageCloneOutputReference(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
complex_object_index: typing.Union[int, float],
complex_object_is_from_set: bool
)
Name | Type | Description |
---|---|---|
terraform_resource |
cdktf.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
complex_object_index |
typing.Union[int, float] |
the index of this item in the list. |
complex_object_is_from_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: typing.Union[int, float]
the index of this item in the list.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
compute_fqn |
No description. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
interpolation_for_attribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
def compute_fqn() -> str
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str
- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
- Type: str
def interpolation_for_attribute(
property: str
) -> IResolvable
- Type: str
def resolve(
_context: IResolveContext
) -> typing.Any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
def to_string() -> str
Return a string representation of this resolvable object.
Returns a reversible string representation.
Name | Type | Description |
---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
id_input |
str |
No description. |
id |
str |
No description. |
internal_value |
typing.Union[cdktf.IResolvable, StorageClone] |
No description. |
creation_stack: typing.List[str]
- Type: typing.List[str]
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: str
- Type: str
id_input: str
- Type: str
id: str
- Type: str
internal_value: typing.Union[IResolvable, StorageClone]
- Type: typing.Union[cdktf.IResolvable, StorageClone]
from cdktf_cdktf_provider_upcloud import storage
storage.StorageImportList(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
wraps_set: bool
)
Name | Type | Description |
---|---|---|
terraform_resource |
cdktf.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
wraps_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
all_with_map_key |
Creating an iterator for this complex list. |
compute_fqn |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
get |
No description. |
def all_with_map_key(
map_key_attribute_name: str
) -> DynamicListTerraformIterator
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: str
def compute_fqn() -> str
def resolve(
_context: IResolveContext
) -> typing.Any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
def to_string() -> str
Return a string representation of this resolvable object.
Returns a reversible string representation.
def get(
index: typing.Union[int, float]
) -> StorageImportOutputReference
- Type: typing.Union[int, float]
the index of the item to return.
Name | Type | Description |
---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
internal_value |
typing.Union[cdktf.IResolvable, typing.List[StorageImport]] |
No description. |
creation_stack: typing.List[str]
- Type: typing.List[str]
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: str
- Type: str
internal_value: typing.Union[IResolvable, typing.List[StorageImport]]
- Type: typing.Union[cdktf.IResolvable, typing.List[StorageImport]]
from cdktf_cdktf_provider_upcloud import storage
storage.StorageImportOutputReference(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
complex_object_index: typing.Union[int, float],
complex_object_is_from_set: bool
)
Name | Type | Description |
---|---|---|
terraform_resource |
cdktf.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
complex_object_index |
typing.Union[int, float] |
the index of this item in the list. |
complex_object_is_from_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: typing.Union[int, float]
the index of this item in the list.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
compute_fqn |
No description. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
interpolation_for_attribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
reset_source_hash |
No description. |
def compute_fqn() -> str
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str
- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
- Type: str
def interpolation_for_attribute(
property: str
) -> IResolvable
- Type: str
def resolve(
_context: IResolveContext
) -> typing.Any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
def to_string() -> str
Return a string representation of this resolvable object.
Returns a reversible string representation.
def reset_source_hash() -> None
Name | Type | Description |
---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
sha256_sum |
str |
No description. |
written_bytes |
typing.Union[int, float] |
No description. |
source_hash_input |
str |
No description. |
source_input |
str |
No description. |
source_location_input |
str |
No description. |
source |
str |
No description. |
source_hash |
str |
No description. |
source_location |
str |
No description. |
internal_value |
typing.Union[cdktf.IResolvable, StorageImport] |
No description. |
creation_stack: typing.List[str]
- Type: typing.List[str]
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: str
- Type: str
sha256_sum: str
- Type: str
written_bytes: typing.Union[int, float]
- Type: typing.Union[int, float]
source_hash_input: str
- Type: str
source_input: str
- Type: str
source_location_input: str
- Type: str
source: str
- Type: str
source_hash: str
- Type: str
source_location: str
- Type: str
internal_value: typing.Union[IResolvable, StorageImport]
- Type: typing.Union[cdktf.IResolvable, StorageImport]