Skip to content

s3BucketObject.python.md

Latest commit

 

History

History
2341 lines (1498 loc) · 102 KB

s3BucketObject.python.md

File metadata and controls

2341 lines (1498 loc) · 102 KB

s3BucketObject Submodule

Constructs

S3BucketObject

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object aws_s3_bucket_object}.

Initializers 

from cdktn_provider_aws import s3_bucket_object

s3BucketObject.S3BucketObject(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  bucket: str,
  key: str,
  acl: str = None,
  bucket_key_enabled: bool | IResolvable = None,
  cache_control: str = None,
  content: str = None,
  content_base64: str = None,
  content_disposition: str = None,
  content_encoding: str = None,
  content_language: str = None,
  content_type: str = None,
  etag: str = None,
  force_destroy: bool | IResolvable = None,
  id: str = None,
  kms_key_id: str = None,
  metadata: typing.Mapping[str] = None,
  object_lock_legal_hold_status: str = None,
  object_lock_mode: str = None,
  object_lock_retain_until_date: str = None,
  region: str = None,
  server_side_encryption: str = None,
  source: str = None,
  source_hash: str = None,
  storage_class: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: 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 cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
bucket str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#bucket S3BucketObject#bucket}.
key str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#key S3BucketObject#key}.
acl str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#acl S3BucketObject#acl}.
bucket_key_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#bucket_key_enabled S3BucketObject#bucket_key_enabled}.
cache_control str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#cache_control S3BucketObject#cache_control}.
content str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content S3BucketObject#content}.
content_base64 str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_base64 S3BucketObject#content_base64}.
content_disposition str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_disposition S3BucketObject#content_disposition}.
content_encoding str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_encoding S3BucketObject#content_encoding}.
content_language str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_language S3BucketObject#content_language}.
content_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_type S3BucketObject#content_type}.
etag str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#etag S3BucketObject#etag}.
force_destroy bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#force_destroy S3BucketObject#force_destroy}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#id S3BucketObject#id}.
kms_key_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#kms_key_id S3BucketObject#kms_key_id}.
metadata typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#metadata S3BucketObject#metadata}.
object_lock_legal_hold_status str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_legal_hold_status S3BucketObject#object_lock_legal_hold_status}.
object_lock_mode str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_mode S3BucketObject#object_lock_mode}.
object_lock_retain_until_date str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_retain_until_date S3BucketObject#object_lock_retain_until_date}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
server_side_encryption str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#server_side_encryption S3BucketObject#server_side_encryption}.
source str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#source S3BucketObject#source}.
source_hash str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#source_hash S3BucketObject#source_hash}.
storage_class str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#storage_class S3BucketObject#storage_class}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#tags S3BucketObject#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#tags_all S3BucketObject#tags_all}.
website_redirect str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#website_redirect S3BucketObject#website_redirect}.
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: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional
  • Type: cdktn.ITerraformIterator
lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle
providerOptional
  • Type: cdktn.TerraformProvider
provisionersOptional
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
bucketRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#bucket S3BucketObject#bucket}.

keyRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#key S3BucketObject#key}.

aclOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#acl S3BucketObject#acl}.

bucket_key_enabledOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#bucket_key_enabled S3BucketObject#bucket_key_enabled}.

cache_controlOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#cache_control S3BucketObject#cache_control}.

contentOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content S3BucketObject#content}.

content_base64Optional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_base64 S3BucketObject#content_base64}.

content_dispositionOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_disposition S3BucketObject#content_disposition}.

content_encodingOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_encoding S3BucketObject#content_encoding}.

content_languageOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_language S3BucketObject#content_language}.

content_typeOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_type S3BucketObject#content_type}.

etagOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#etag S3BucketObject#etag}.

force_destroyOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#force_destroy S3BucketObject#force_destroy}.

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#id S3BucketObject#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.

kms_key_idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#kms_key_id S3BucketObject#kms_key_id}.

metadataOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#metadata S3BucketObject#metadata}.

object_lock_legal_hold_statusOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_legal_hold_status S3BucketObject#object_lock_legal_hold_status}.

object_lock_modeOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_mode S3BucketObject#object_lock_mode}.

object_lock_retain_until_dateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_retain_until_date S3BucketObject#object_lock_retain_until_date}.

regionOptional
  • Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#region S3BucketObject#region}

server_side_encryptionOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#server_side_encryption S3BucketObject#server_side_encryption}.

sourceOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#source S3BucketObject#source}.

source_hashOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#source_hash S3BucketObject#source_hash}.

storage_classOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#storage_class S3BucketObject#storage_class}.

tagsOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#tags S3BucketObject#tags}.

tags_allOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#tags_all S3BucketObject#tags_all}.

website_redirectOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#website_redirect S3BucketObject#website_redirect}.

Methods

Name Description
to_string Returns a string representation of this construct.
with Applies one or more mixins to 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_acl No description.
reset_bucket_key_enabled No description.
reset_cache_control No description.
reset_content No description.
reset_content_base64 No description.
reset_content_disposition No description.
reset_content_encoding No description.
reset_content_language No description.
reset_content_type No description.
reset_etag No description.
reset_force_destroy No description.
reset_id No description.
reset_kms_key_id No description.
reset_metadata No description.
reset_object_lock_legal_hold_status No description.
reset_object_lock_mode No description.
reset_object_lock_retain_until_date No description.
reset_region No description.
reset_server_side_encryption No description.
reset_source No description.
reset_source_hash No description.
reset_storage_class No description.
reset_tags No description.
reset_tags_all No description.
reset_website_redirect No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

with 
def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: *constructs.IMixin

The mixins to apply.

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() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktn.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: 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: 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_acl 
def reset_acl() -> None
reset_bucket_key_enabled 
def reset_bucket_key_enabled() -> None
reset_cache_control 
def reset_cache_control() -> None
reset_content 
def reset_content() -> None
reset_content_base64 
def reset_content_base64() -> 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_etag 
def reset_etag() -> None
reset_force_destroy 
def reset_force_destroy() -> None
reset_id 
def reset_id() -> None
reset_kms_key_id 
def reset_kms_key_id() -> None
reset_metadata 
def reset_metadata() -> None
reset_object_lock_legal_hold_status 
def reset_object_lock_legal_hold_status() -> 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_region 
def reset_region() -> None
reset_server_side_encryption 
def reset_server_side_encryption() -> None
reset_source 
def reset_source() -> None
reset_source_hash 
def reset_source_hash() -> None
reset_storage_class 
def reset_storage_class() -> None
reset_tags 
def reset_tags() -> None
reset_tags_all 
def reset_tags_all() -> 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 CDKTN code for importing a S3BucketObject resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_aws import s3_bucket_object

s3BucketObject.S3BucketObject.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 cdktn_provider_aws import s3_bucket_object

s3BucketObject.S3BucketObject.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktn_provider_aws import s3_bucket_object

s3BucketObject.S3BucketObject.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_aws import s3_bucket_object

s3BucketObject.S3BucketObject.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a S3BucketObject resource upon running "cdktn 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 S3BucketObject to import.

import_from_idRequired
  • Type: str

The id of the existing S3BucketObject that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktn.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktn.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 cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
arn str No description.
version_id str No description.
acl_input str No description.
bucket_input str No description.
bucket_key_enabled_input bool | cdktn.IResolvable No description.
cache_control_input str No description.
content_base64_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.
etag_input str No description.
force_destroy_input bool | cdktn.IResolvable No description.
id_input str No description.
key_input str No description.
kms_key_id_input str No description.
metadata_input typing.Mapping[str] No description.
object_lock_legal_hold_status_input str No description.
object_lock_mode_input str No description.
object_lock_retain_until_date_input str No description.
region_input str No description.
server_side_encryption_input str No description.
source_hash_input str No description.
source_input str No description.
storage_class_input str No description.
tags_all_input typing.Mapping[str] No description.
tags_input typing.Mapping[str] No description.
website_redirect_input str No description.
acl str No description.
bucket str No description.
bucket_key_enabled bool | cdktn.IResolvable No description.
cache_control str No description.
content str No description.
content_base64 str No description.
content_disposition str No description.
content_encoding str No description.
content_language str No description.
content_type str No description.
etag str No description.
force_destroy bool | cdktn.IResolvable No description.
id str No description.
key str No description.
kms_key_id str No description.
metadata typing.Mapping[str] No description.
object_lock_legal_hold_status str No description.
object_lock_mode str No description.
object_lock_retain_until_date str No description.
region str No description.
server_side_encryption str No description.
source str No description.
source_hash str No description.
storage_class str No description.
tags typing.Mapping[str] No description.
tags_all 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: cdktn.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: cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
arnRequired 
arn: str
  • Type: str
version_idRequired 
version_id: str
  • Type: str
acl_inputOptional 
acl_input: str
  • Type: str
bucket_inputOptional 
bucket_input: str
  • Type: str
bucket_key_enabled_inputOptional 
bucket_key_enabled_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
cache_control_inputOptional 
cache_control_input: str
  • Type: str
content_base64_inputOptional 
content_base64_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
etag_inputOptional 
etag_input: str
  • Type: str
force_destroy_inputOptional 
force_destroy_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
id_inputOptional 
id_input: str
  • Type: str
key_inputOptional 
key_input: str
  • Type: str
kms_key_id_inputOptional 
kms_key_id_input: str
  • Type: str
metadata_inputOptional 
metadata_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
object_lock_legal_hold_status_inputOptional 
object_lock_legal_hold_status_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
region_inputOptional 
region_input: str
  • Type: str
server_side_encryption_inputOptional 
server_side_encryption_input: str
  • Type: str
source_hash_inputOptional 
source_hash_input: str
  • Type: str
source_inputOptional 
source_input: str
  • Type: str
storage_class_inputOptional 
storage_class_input: str
  • Type: str
tags_all_inputOptional 
tags_all_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_inputOptional 
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
website_redirect_inputOptional 
website_redirect_input: str
  • Type: str
aclRequired 
acl: str
  • Type: str
bucketRequired 
bucket: str
  • Type: str
bucket_key_enabledRequired 
bucket_key_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable
cache_controlRequired 
cache_control: str
  • Type: str
contentRequired 
content: str
  • Type: str
content_base64Required 
content_base64: 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
etagRequired 
etag: str
  • Type: str
force_destroyRequired 
force_destroy: bool | IResolvable
  • Type: bool | cdktn.IResolvable
idRequired 
id: str
  • Type: str
keyRequired 
key: str
  • Type: str
kms_key_idRequired 
kms_key_id: str
  • Type: str
metadataRequired 
metadata: typing.Mapping[str]
  • Type: typing.Mapping[str]
object_lock_legal_hold_statusRequired 
object_lock_legal_hold_status: 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
regionRequired 
region: str
  • Type: str
server_side_encryptionRequired 
server_side_encryption: str
  • Type: str
sourceRequired 
source: str
  • Type: str
source_hashRequired 
source_hash: str
  • Type: str
storage_classRequired 
storage_class: str
  • Type: str
tagsRequired 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_allRequired 
tags_all: 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

S3BucketObjectConfig

Initializer 

from cdktn_provider_aws import s3_bucket_object

s3BucketObject.S3BucketObjectConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  bucket: str,
  key: str,
  acl: str = None,
  bucket_key_enabled: bool | IResolvable = None,
  cache_control: str = None,
  content: str = None,
  content_base64: str = None,
  content_disposition: str = None,
  content_encoding: str = None,
  content_language: str = None,
  content_type: str = None,
  etag: str = None,
  force_destroy: bool | IResolvable = None,
  id: str = None,
  kms_key_id: str = None,
  metadata: typing.Mapping[str] = None,
  object_lock_legal_hold_status: str = None,
  object_lock_mode: str = None,
  object_lock_retain_until_date: str = None,
  region: str = None,
  server_side_encryption: str = None,
  source: str = None,
  source_hash: str = None,
  storage_class: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  website_redirect: str = None
)

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
bucket str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#bucket S3BucketObject#bucket}.
key str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#key S3BucketObject#key}.
acl str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#acl S3BucketObject#acl}.
bucket_key_enabled bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#bucket_key_enabled S3BucketObject#bucket_key_enabled}.
cache_control str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#cache_control S3BucketObject#cache_control}.
content str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content S3BucketObject#content}.
content_base64 str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_base64 S3BucketObject#content_base64}.
content_disposition str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_disposition S3BucketObject#content_disposition}.
content_encoding str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_encoding S3BucketObject#content_encoding}.
content_language str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_language S3BucketObject#content_language}.
content_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_type S3BucketObject#content_type}.
etag str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#etag S3BucketObject#etag}.
force_destroy bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#force_destroy S3BucketObject#force_destroy}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#id S3BucketObject#id}.
kms_key_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#kms_key_id S3BucketObject#kms_key_id}.
metadata typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#metadata S3BucketObject#metadata}.
object_lock_legal_hold_status str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_legal_hold_status S3BucketObject#object_lock_legal_hold_status}.
object_lock_mode str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_mode S3BucketObject#object_lock_mode}.
object_lock_retain_until_date str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_retain_until_date S3BucketObject#object_lock_retain_until_date}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
server_side_encryption str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#server_side_encryption S3BucketObject#server_side_encryption}.
source str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#source S3BucketObject#source}.
source_hash str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#source_hash S3BucketObject#source_hash}.
storage_class str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#storage_class S3BucketObject#storage_class}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#tags S3BucketObject#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#tags_all S3BucketObject#tags_all}.
website_redirect str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#website_redirect S3BucketObject#website_redirect}.
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
bucketRequired 
bucket: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#bucket S3BucketObject#bucket}.

keyRequired 
key: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#key S3BucketObject#key}.

aclOptional 
acl: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#acl S3BucketObject#acl}.

bucket_key_enabledOptional 
bucket_key_enabled: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#bucket_key_enabled S3BucketObject#bucket_key_enabled}.

cache_controlOptional 
cache_control: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#cache_control S3BucketObject#cache_control}.

contentOptional 
content: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content S3BucketObject#content}.

content_base64Optional 
content_base64: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_base64 S3BucketObject#content_base64}.

content_dispositionOptional 
content_disposition: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_disposition S3BucketObject#content_disposition}.

content_encodingOptional 
content_encoding: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_encoding S3BucketObject#content_encoding}.

content_languageOptional 
content_language: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_language S3BucketObject#content_language}.

content_typeOptional 
content_type: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#content_type S3BucketObject#content_type}.

etagOptional 
etag: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#etag S3BucketObject#etag}.

force_destroyOptional 
force_destroy: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#force_destroy S3BucketObject#force_destroy}.

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#id S3BucketObject#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.

kms_key_idOptional 
kms_key_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#kms_key_id S3BucketObject#kms_key_id}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#metadata S3BucketObject#metadata}.

object_lock_legal_hold_statusOptional 
object_lock_legal_hold_status: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_legal_hold_status S3BucketObject#object_lock_legal_hold_status}.

object_lock_modeOptional 
object_lock_mode: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_mode S3BucketObject#object_lock_mode}.

object_lock_retain_until_dateOptional 
object_lock_retain_until_date: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#object_lock_retain_until_date S3BucketObject#object_lock_retain_until_date}.

regionOptional 
region: str
  • Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#region S3BucketObject#region}

server_side_encryptionOptional 
server_side_encryption: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#server_side_encryption S3BucketObject#server_side_encryption}.

sourceOptional 
source: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#source S3BucketObject#source}.

source_hashOptional 
source_hash: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#source_hash S3BucketObject#source_hash}.

storage_classOptional 
storage_class: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#storage_class S3BucketObject#storage_class}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#tags S3BucketObject#tags}.

tags_allOptional 
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#tags_all S3BucketObject#tags_all}.

website_redirectOptional 
website_redirect: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/s3_bucket_object#website_redirect S3BucketObject#website_redirect}.