Skip to content

Latest commit

 

History

History
2333 lines (1474 loc) · 96.6 KB

s3Object.python.md

File metadata and controls

2333 lines (1474 loc) · 96.6 KB
Raw

s3Object Submodule

Constructs

S3Object

Represents a {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object ionoscloud_s3_object}.

Initializers 

from cdktf_cdktf_provider_ionoscloud import s3_object

s3Object.S3Object(
  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,
  bucket: str,
  key: str,
  cache_control: str = None,
  content: str = None,
  content_disposition: str = None,
  content_encoding: str = None,
  content_language: str = None,
  content_type: str = None,
  expires: str = None,
  force_destroy: typing.Union[bool, IResolvable] = None,
  metadata: typing.Mapping[str] = None,
  mfa: str = None,
  object_lock_legal_hold: str = None,
  object_lock_mode: str = None,
  object_lock_retain_until_date: str = None,
  request_payer: str = None,
  server_side_encryption: str = None,
  server_side_encryption_context: str = None,
  server_side_encryption_customer_algorithm: str = None,
  server_side_encryption_customer_key: str = None,
  server_side_encryption_customer_key_md5: str = None,
  source: str = None,
  storage_class: str = None,
  tags: typing.Mapping[str] = None,
  website_redirect: 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.
bucket str The name of the bucket.
key str The key of the object.
cache_control str Can be used to specify caching behavior along the request/reply chain.
content str The utf-8 content of the object.
content_disposition str Specifies presentational information for the object.
content_encoding str Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
content_language str The natural language or languages of the intended audience for the object.
content_type str A standard MIME type describing the format of the contents.
expires str The date and time at which the object is no longer cacheable.
force_destroy typing.Union[bool, cdktf.IResolvable] Specifies whether to delete the object even if it has a governance-type Object Lock in place.
metadata typing.Mapping[str] A map of metadata to store with the object in IONOS Object Storage Object Storage.
mfa str The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
object_lock_legal_hold str Specifies whether a legal hold will be applied to this object.
object_lock_mode str Confirms that the requester knows that they will be charged for the request.
object_lock_retain_until_date str The date and time when you want this object's Object Lock to expire.
request_payer str Confirms that the requester knows that they will be charged for the request.
server_side_encryption str The server-side encryption algorithm used when storing this object in IONOS Object Storage Object Storage (AES256).
server_side_encryption_context str Specifies the IONOS Object Storage Object Storage Encryption Context to use for object encryption.
server_side_encryption_customer_algorithm str Specifies the algorithm to use to when encrypting the object (e.g., AES256).
server_side_encryption_customer_key str Specifies the 256-bit, base64-encoded encryption key to use to encrypt and decrypt your data.
server_side_encryption_customer_key_md5 str Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
source str The path to the file to upload.
storage_class str The storage class of the object. Valid value is 'STANDARD'.
tags typing.Mapping[str] The tag-set for the object.
website_redirect str If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
bucketRequired
  • Type: str

The name of the bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#bucket S3Object#bucket}

keyRequired
  • Type: str

The key of the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#key S3Object#key}

cache_controlOptional
  • Type: str

Can be used to specify caching behavior along the request/reply chain.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#cache_control S3Object#cache_control}

contentOptional
  • Type: str

The utf-8 content of the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content S3Object#content}

content_dispositionOptional
  • Type: str

Specifies presentational information for the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content_disposition S3Object#content_disposition}

content_encodingOptional
  • Type: str

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content_encoding S3Object#content_encoding}

content_languageOptional
  • Type: str

The natural language or languages of the intended audience for the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content_language S3Object#content_language}

content_typeOptional
  • Type: str

A standard MIME type describing the format of the contents.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content_type S3Object#content_type}

expiresOptional
  • Type: str

The date and time at which the object is no longer cacheable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#expires S3Object#expires}

force_destroyOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies whether to delete the object even if it has a governance-type Object Lock in place.

You must explicitly pass a value of true for this parameter to delete the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#force_destroy S3Object#force_destroy}

metadataOptional
  • Type: typing.Mapping[str]

A map of metadata to store with the object in IONOS Object Storage Object Storage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#metadata S3Object#metadata}

mfaOptional
  • Type: str

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

Required to permanently delete a versioned object if versioning is configured with MFA Delete enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#mfa S3Object#mfa}

object_lock_legal_holdOptional
  • Type: str

Specifies whether a legal hold will be applied to this object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#object_lock_legal_hold S3Object#object_lock_legal_hold}

object_lock_modeOptional
  • Type: str

Confirms that the requester knows that they will be charged for the request.

Bucket owners need not specify this parameter in their requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#object_lock_mode S3Object#object_lock_mode}

object_lock_retain_until_dateOptional
  • Type: str

The date and time when you want this object's Object Lock to expire.

Must be formatted as a timestamp parameter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#object_lock_retain_until_date S3Object#object_lock_retain_until_date}

request_payerOptional
  • Type: str

Confirms that the requester knows that they will be charged for the request.

Bucket owners need not specify this parameter in their requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#request_payer S3Object#request_payer}

server_side_encryptionOptional
  • Type: str

The server-side encryption algorithm used when storing this object in IONOS Object Storage Object Storage (AES256).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption S3Object#server_side_encryption}

server_side_encryption_contextOptional
  • Type: str

Specifies the IONOS Object Storage Object Storage Encryption Context to use for object encryption.

The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption_context S3Object#server_side_encryption_context}

server_side_encryption_customer_algorithmOptional
  • Type: str

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption_customer_algorithm S3Object#server_side_encryption_customer_algorithm}

server_side_encryption_customer_keyOptional
  • Type: str

Specifies the 256-bit, base64-encoded encryption key to use to encrypt and decrypt your data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption_customer_key S3Object#server_side_encryption_customer_key}

server_side_encryption_customer_key_md5Optional
  • Type: str

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.

IONOS Object Storage Object Storage uses this header for a message integrity check to ensure that the encryption key was transmitted without error

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption_customer_key_md5 S3Object#server_side_encryption_customer_key_md5}

sourceOptional
  • Type: str

The path to the file to upload.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#source S3Object#source}

storage_classOptional
  • Type: str

The storage class of the object. Valid value is 'STANDARD'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#storage_class S3Object#storage_class}

tagsOptional
  • Type: typing.Mapping[str]

The tag-set for the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#tags S3Object#tags}

website_redirectOptional
  • Type: str

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.

IONOS Object Storage Object Storage stores the value of this header in the object metadata

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#website_redirect S3Object#website_redirect}

Methods

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".
reset_cache_control No description.
reset_content No description.
reset_content_disposition No description.
reset_content_encoding No description.
reset_content_language No description.
reset_content_type No description.
reset_expires No description.
reset_force_destroy No description.
reset_metadata No description.
reset_mfa No description.
reset_object_lock_legal_hold No description.
reset_object_lock_mode No description.
reset_object_lock_retain_until_date No description.
reset_request_payer No description.
reset_server_side_encryption No description.
reset_server_side_encryption_context No description.
reset_server_side_encryption_customer_algorithm No description.
reset_server_side_encryption_customer_key No description.
reset_server_side_encryption_customer_key_md5 No description.
reset_source No description.
reset_storage_class No description.
reset_tags No description.
reset_website_redirect No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
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.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
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.

idRequired
  • Type: str

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

move_to 
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.

move_targetRequired
  • Type: str

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

indexOptional
  • 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.

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

reset_cache_control 
def reset_cache_control() -> None
reset_content 
def reset_content() -> None
reset_content_disposition 
def reset_content_disposition() -> None
reset_content_encoding 
def reset_content_encoding() -> None
reset_content_language 
def reset_content_language() -> None
reset_content_type 
def reset_content_type() -> None
reset_expires 
def reset_expires() -> None
reset_force_destroy 
def reset_force_destroy() -> None
reset_metadata 
def reset_metadata() -> None
reset_mfa 
def reset_mfa() -> None
reset_object_lock_legal_hold 
def reset_object_lock_legal_hold() -> None
reset_object_lock_mode 
def reset_object_lock_mode() -> None
reset_object_lock_retain_until_date 
def reset_object_lock_retain_until_date() -> None
reset_request_payer 
def reset_request_payer() -> None
reset_server_side_encryption 
def reset_server_side_encryption() -> None
reset_server_side_encryption_context 
def reset_server_side_encryption_context() -> None
reset_server_side_encryption_customer_algorithm 
def reset_server_side_encryption_customer_algorithm() -> None
reset_server_side_encryption_customer_key 
def reset_server_side_encryption_customer_key() -> None
reset_server_side_encryption_customer_key_md5 
def reset_server_side_encryption_customer_key_md5() -> None
reset_source 
def reset_source() -> None
reset_storage_class 
def reset_storage_class() -> None
reset_tags 
def reset_tags() -> None
reset_website_redirect 
def reset_website_redirect() -> None

Static Functions

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 S3Object resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_ionoscloud import s3_object

s3Object.S3Object.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.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_ionoscloud import s3_object

s3Object.S3Object.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_ionoscloud import s3_object

s3Object.S3Object.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_ionoscloud import s3_object

s3Object.S3Object.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing S3Object that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

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.
etag str No description.
version_id str No description.
bucket_input str No description.
cache_control_input str No description.
content_disposition_input str No description.
content_encoding_input str No description.
content_input str No description.
content_language_input str No description.
content_type_input str No description.
expires_input str No description.
force_destroy_input typing.Union[bool, cdktf.IResolvable] No description.
key_input str No description.
metadata_input typing.Mapping[str] No description.
mfa_input str No description.
object_lock_legal_hold_input str No description.
object_lock_mode_input str No description.
object_lock_retain_until_date_input str No description.
request_payer_input str No description.
server_side_encryption_context_input str No description.
server_side_encryption_customer_algorithm_input str No description.
server_side_encryption_customer_key_input str No description.
server_side_encryption_customer_key_md5_input str No description.
server_side_encryption_input str No description.
source_input str No description.
storage_class_input str No description.
tags_input typing.Mapping[str] No description.
website_redirect_input str No description.
bucket str No description.
cache_control str No description.
content str No description.
content_disposition str No description.
content_encoding str No description.
content_language str No description.
content_type str No description.
expires str No description.
force_destroy typing.Union[bool, cdktf.IResolvable] No description.
key str No description.
metadata typing.Mapping[str] No description.
mfa str No description.
object_lock_legal_hold str No description.
object_lock_mode str No description.
object_lock_retain_until_date str No description.
request_payer str No description.
server_side_encryption str No description.
server_side_encryption_context str No description.
server_side_encryption_customer_algorithm str No description.
server_side_encryption_customer_key str No description.
server_side_encryption_customer_key_md5 str No description.
source str No description.
storage_class str No description.
tags typing.Mapping[str] No description.
website_redirect str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
etagRequired 
etag: str
  • Type: str
version_idRequired 
version_id: str
  • Type: str
bucket_inputOptional 
bucket_input: str
  • Type: str
cache_control_inputOptional 
cache_control_input: str
  • Type: str
content_disposition_inputOptional 
content_disposition_input: str
  • Type: str
content_encoding_inputOptional 
content_encoding_input: str
  • Type: str
content_inputOptional 
content_input: str
  • Type: str
content_language_inputOptional 
content_language_input: str
  • Type: str
content_type_inputOptional 
content_type_input: str
  • Type: str
expires_inputOptional 
expires_input: str
  • Type: str
force_destroy_inputOptional 
force_destroy_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
key_inputOptional 
key_input: str
  • Type: str
metadata_inputOptional 
metadata_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
mfa_inputOptional 
mfa_input: str
  • Type: str
object_lock_legal_hold_inputOptional 
object_lock_legal_hold_input: str
  • Type: str
object_lock_mode_inputOptional 
object_lock_mode_input: str
  • Type: str
object_lock_retain_until_date_inputOptional 
object_lock_retain_until_date_input: str
  • Type: str
request_payer_inputOptional 
request_payer_input: str
  • Type: str
server_side_encryption_context_inputOptional 
server_side_encryption_context_input: str
  • Type: str
server_side_encryption_customer_algorithm_inputOptional 
server_side_encryption_customer_algorithm_input: str
  • Type: str
server_side_encryption_customer_key_inputOptional 
server_side_encryption_customer_key_input: str
  • Type: str
server_side_encryption_customer_key_md5_inputOptional 
server_side_encryption_customer_key_md5_input: str
  • Type: str
server_side_encryption_inputOptional 
server_side_encryption_input: str
  • Type: str
source_inputOptional 
source_input: str
  • Type: str
storage_class_inputOptional 
storage_class_input: str
  • Type: str
tags_inputOptional 
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
website_redirect_inputOptional 
website_redirect_input: str
  • Type: str
bucketRequired 
bucket: str
  • Type: str
cache_controlRequired 
cache_control: str
  • Type: str
contentRequired 
content: str
  • Type: str
content_dispositionRequired 
content_disposition: str
  • Type: str
content_encodingRequired 
content_encoding: str
  • Type: str
content_languageRequired 
content_language: str
  • Type: str
content_typeRequired 
content_type: str
  • Type: str
expiresRequired 
expires: str
  • Type: str
force_destroyRequired 
force_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
keyRequired 
key: str
  • Type: str
metadataRequired 
metadata: typing.Mapping[str]
  • Type: typing.Mapping[str]
mfaRequired 
mfa: str
  • Type: str
object_lock_legal_holdRequired 
object_lock_legal_hold: str
  • Type: str
object_lock_modeRequired 
object_lock_mode: str
  • Type: str
object_lock_retain_until_dateRequired 
object_lock_retain_until_date: str
  • Type: str
request_payerRequired 
request_payer: str
  • Type: str
server_side_encryptionRequired 
server_side_encryption: str
  • Type: str
server_side_encryption_contextRequired 
server_side_encryption_context: str
  • Type: str
server_side_encryption_customer_algorithmRequired 
server_side_encryption_customer_algorithm: str
  • Type: str
server_side_encryption_customer_keyRequired 
server_side_encryption_customer_key: str
  • Type: str
server_side_encryption_customer_key_md5Required 
server_side_encryption_customer_key_md5: str
  • Type: str
sourceRequired 
source: str
  • Type: str
storage_classRequired 
storage_class: str
  • Type: str
tagsRequired 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]
website_redirectRequired 
website_redirect: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

S3ObjectConfig

Initializer 

from cdktf_cdktf_provider_ionoscloud import s3_object

s3Object.S3ObjectConfig(
  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,
  bucket: str,
  key: str,
  cache_control: str = None,
  content: str = None,
  content_disposition: str = None,
  content_encoding: str = None,
  content_language: str = None,
  content_type: str = None,
  expires: str = None,
  force_destroy: typing.Union[bool, IResolvable] = None,
  metadata: typing.Mapping[str] = None,
  mfa: str = None,
  object_lock_legal_hold: str = None,
  object_lock_mode: str = None,
  object_lock_retain_until_date: str = None,
  request_payer: str = None,
  server_side_encryption: str = None,
  server_side_encryption_context: str = None,
  server_side_encryption_customer_algorithm: str = None,
  server_side_encryption_customer_key: str = None,
  server_side_encryption_customer_key_md5: str = None,
  source: str = None,
  storage_class: str = None,
  tags: typing.Mapping[str] = None,
  website_redirect: str = None
)

Properties

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.
bucket str The name of the bucket.
key str The key of the object.
cache_control str Can be used to specify caching behavior along the request/reply chain.
content str The utf-8 content of the object.
content_disposition str Specifies presentational information for the object.
content_encoding str Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
content_language str The natural language or languages of the intended audience for the object.
content_type str A standard MIME type describing the format of the contents.
expires str The date and time at which the object is no longer cacheable.
force_destroy typing.Union[bool, cdktf.IResolvable] Specifies whether to delete the object even if it has a governance-type Object Lock in place.
metadata typing.Mapping[str] A map of metadata to store with the object in IONOS Object Storage Object Storage.
mfa str The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
object_lock_legal_hold str Specifies whether a legal hold will be applied to this object.
object_lock_mode str Confirms that the requester knows that they will be charged for the request.
object_lock_retain_until_date str The date and time when you want this object's Object Lock to expire.
request_payer str Confirms that the requester knows that they will be charged for the request.
server_side_encryption str The server-side encryption algorithm used when storing this object in IONOS Object Storage Object Storage (AES256).
server_side_encryption_context str Specifies the IONOS Object Storage Object Storage Encryption Context to use for object encryption.
server_side_encryption_customer_algorithm str Specifies the algorithm to use to when encrypting the object (e.g., AES256).
server_side_encryption_customer_key str Specifies the 256-bit, base64-encoded encryption key to use to encrypt and decrypt your data.
server_side_encryption_customer_key_md5 str Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
source str The path to the file to upload.
storage_class str The storage class of the object. Valid value is 'STANDARD'.
tags typing.Mapping[str] The tag-set for the object.
website_redirect str If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
bucketRequired 
bucket: str
  • Type: str

The name of the bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#bucket S3Object#bucket}

keyRequired 
key: str
  • Type: str

The key of the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#key S3Object#key}

cache_controlOptional 
cache_control: str
  • Type: str

Can be used to specify caching behavior along the request/reply chain.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#cache_control S3Object#cache_control}

contentOptional 
content: str
  • Type: str

The utf-8 content of the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content S3Object#content}

content_dispositionOptional 
content_disposition: str
  • Type: str

Specifies presentational information for the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content_disposition S3Object#content_disposition}

content_encodingOptional 
content_encoding: str
  • Type: str

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content_encoding S3Object#content_encoding}

content_languageOptional 
content_language: str
  • Type: str

The natural language or languages of the intended audience for the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content_language S3Object#content_language}

content_typeOptional 
content_type: str
  • Type: str

A standard MIME type describing the format of the contents.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#content_type S3Object#content_type}

expiresOptional 
expires: str
  • Type: str

The date and time at which the object is no longer cacheable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#expires S3Object#expires}

force_destroyOptional 
force_destroy: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Specifies whether to delete the object even if it has a governance-type Object Lock in place.

You must explicitly pass a value of true for this parameter to delete the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#force_destroy S3Object#force_destroy}

metadataOptional 
metadata: typing.Mapping[str]
  • Type: typing.Mapping[str]

A map of metadata to store with the object in IONOS Object Storage Object Storage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#metadata S3Object#metadata}

mfaOptional 
mfa: str
  • Type: str

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

Required to permanently delete a versioned object if versioning is configured with MFA Delete enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#mfa S3Object#mfa}

object_lock_legal_holdOptional 
object_lock_legal_hold: str
  • Type: str

Specifies whether a legal hold will be applied to this object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#object_lock_legal_hold S3Object#object_lock_legal_hold}

object_lock_modeOptional 
object_lock_mode: str
  • Type: str

Confirms that the requester knows that they will be charged for the request.

Bucket owners need not specify this parameter in their requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#object_lock_mode S3Object#object_lock_mode}

object_lock_retain_until_dateOptional 
object_lock_retain_until_date: str
  • Type: str

The date and time when you want this object's Object Lock to expire.

Must be formatted as a timestamp parameter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#object_lock_retain_until_date S3Object#object_lock_retain_until_date}

request_payerOptional 
request_payer: str
  • Type: str

Confirms that the requester knows that they will be charged for the request.

Bucket owners need not specify this parameter in their requests.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#request_payer S3Object#request_payer}

server_side_encryptionOptional 
server_side_encryption: str
  • Type: str

The server-side encryption algorithm used when storing this object in IONOS Object Storage Object Storage (AES256).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption S3Object#server_side_encryption}

server_side_encryption_contextOptional 
server_side_encryption_context: str
  • Type: str

Specifies the IONOS Object Storage Object Storage Encryption Context to use for object encryption.

The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption_context S3Object#server_side_encryption_context}

server_side_encryption_customer_algorithmOptional 
server_side_encryption_customer_algorithm: str
  • Type: str

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption_customer_algorithm S3Object#server_side_encryption_customer_algorithm}

server_side_encryption_customer_keyOptional 
server_side_encryption_customer_key: str
  • Type: str

Specifies the 256-bit, base64-encoded encryption key to use to encrypt and decrypt your data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption_customer_key S3Object#server_side_encryption_customer_key}

server_side_encryption_customer_key_md5Optional 
server_side_encryption_customer_key_md5: str
  • Type: str

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.

IONOS Object Storage Object Storage uses this header for a message integrity check to ensure that the encryption key was transmitted without error

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#server_side_encryption_customer_key_md5 S3Object#server_side_encryption_customer_key_md5}

sourceOptional 
source: str
  • Type: str

The path to the file to upload.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#source S3Object#source}

storage_classOptional 
storage_class: str
  • Type: str

The storage class of the object. Valid value is 'STANDARD'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#storage_class S3Object#storage_class}

tagsOptional 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

The tag-set for the object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#tags S3Object#tags}

website_redirectOptional 
website_redirect: str
  • Type: str

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.

IONOS Object Storage Object Storage stores the value of this header in the object metadata

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/s3_object#website_redirect S3Object#website_redirect}