Skip to content

Latest commit

 

History

History
3027 lines (1906 loc) · 136 KB

s3Object.java.md

File metadata and controls

3027 lines (1906 loc) · 136 KB
Raw

s3Object Submodule

Constructs

S3Object

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object aws_s3_object}.

Initializers 

import com.hashicorp.cdktf.providers.aws.s3_object.S3Object;

S3Object.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .bucket(java.lang.String)
    .key(java.lang.String)
//  .acl(java.lang.String)
//  .bucketKeyEnabled(java.lang.Boolean)
//  .bucketKeyEnabled(IResolvable)
//  .cacheControl(java.lang.String)
//  .checksumAlgorithm(java.lang.String)
//  .content(java.lang.String)
//  .contentBase64(java.lang.String)
//  .contentDisposition(java.lang.String)
//  .contentEncoding(java.lang.String)
//  .contentLanguage(java.lang.String)
//  .contentType(java.lang.String)
//  .etag(java.lang.String)
//  .forceDestroy(java.lang.Boolean)
//  .forceDestroy(IResolvable)
//  .id(java.lang.String)
//  .kmsKeyId(java.lang.String)
//  .metadata(java.util.Map<java.lang.String, java.lang.String>)
//  .objectLockLegalHoldStatus(java.lang.String)
//  .objectLockMode(java.lang.String)
//  .objectLockRetainUntilDate(java.lang.String)
//  .overrideProvider(S3ObjectOverrideProvider)
//  .serverSideEncryption(java.lang.String)
//  .source(java.lang.String)
//  .sourceHash(java.lang.String)
//  .storageClass(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .websiteRedirect(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
bucket java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#bucket S3Object#bucket}.
key java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#key S3Object#key}.
acl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#acl S3Object#acl}.
bucketKeyEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#bucket_key_enabled S3Object#bucket_key_enabled}.
cacheControl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#cache_control S3Object#cache_control}.
checksumAlgorithm java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#checksum_algorithm S3Object#checksum_algorithm}.
content java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content S3Object#content}.
contentBase64 java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_base64 S3Object#content_base64}.
contentDisposition java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_disposition S3Object#content_disposition}.
contentEncoding java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_encoding S3Object#content_encoding}.
contentLanguage java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_language S3Object#content_language}.
contentType java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_type S3Object#content_type}.
etag java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#etag S3Object#etag}.
forceDestroy java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#force_destroy S3Object#force_destroy}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#id S3Object#id}.
kmsKeyId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#kms_key_id S3Object#kms_key_id}.
metadata java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#metadata S3Object#metadata}.
objectLockLegalHoldStatus java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_legal_hold_status S3Object#object_lock_legal_hold_status}.
objectLockMode java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_mode S3Object#object_lock_mode}.
objectLockRetainUntilDate java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_retain_until_date S3Object#object_lock_retain_until_date}.
overrideProvider S3ObjectOverrideProvider override_provider block.
serverSideEncryption java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#server_side_encryption S3Object#server_side_encryption}.
source java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#source S3Object#source}.
sourceHash java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#source_hash S3Object#source_hash}.
storageClass java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#storage_class S3Object#storage_class}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags S3Object#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags_all S3Object#tags_all}.
websiteRedirect java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#website_redirect S3Object#website_redirect}.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#bucket S3Object#bucket}.

keyRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#key S3Object#key}.

aclOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#acl S3Object#acl}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#bucket_key_enabled S3Object#bucket_key_enabled}.

cacheControlOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#cache_control S3Object#cache_control}.

checksumAlgorithmOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#checksum_algorithm S3Object#checksum_algorithm}.

contentOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content S3Object#content}.

contentBase64Optional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_base64 S3Object#content_base64}.

contentDispositionOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_disposition S3Object#content_disposition}.

contentEncodingOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_encoding S3Object#content_encoding}.

contentLanguageOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_language S3Object#content_language}.

contentTypeOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_type S3Object#content_type}.

etagOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#etag S3Object#etag}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#force_destroy S3Object#force_destroy}.

idOptional
  • Type: java.lang.String

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

kmsKeyIdOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#kms_key_id S3Object#kms_key_id}.

metadataOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#metadata S3Object#metadata}.

objectLockLegalHoldStatusOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_legal_hold_status S3Object#object_lock_legal_hold_status}.

objectLockModeOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_mode S3Object#object_lock_mode}.

objectLockRetainUntilDateOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_retain_until_date S3Object#object_lock_retain_until_date}.

overrideProviderOptional

override_provider block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#override_provider S3Object#override_provider}

serverSideEncryptionOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#server_side_encryption S3Object#server_side_encryption}.

sourceOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#source S3Object#source}.

sourceHashOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#source_hash S3Object#source_hash}.

storageClassOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#storage_class S3Object#storage_class}.

tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags S3Object#tags}.

tagsAllOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags_all S3Object#tags_all}.

websiteRedirectOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#website_redirect S3Object#website_redirect}.

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putOverrideProvider No description.
resetAcl No description.
resetBucketKeyEnabled No description.
resetCacheControl No description.
resetChecksumAlgorithm No description.
resetContent No description.
resetContentBase64 No description.
resetContentDisposition No description.
resetContentEncoding No description.
resetContentLanguage No description.
resetContentType No description.
resetEtag No description.
resetForceDestroy No description.
resetId No description.
resetKmsKeyId No description.
resetMetadata No description.
resetObjectLockLegalHoldStatus No description.
resetObjectLockMode No description.
resetObjectLockRetainUntilDate No description.
resetOverrideProvider No description.
resetServerSideEncryption No description.
resetSource No description.
resetSourceHash No description.
resetStorageClass No description.
resetTags No description.
resetTagsAll No description.
resetWebsiteRedirect No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

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

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

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

Adds this resource to the terraform JSON output.

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

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

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

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

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

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

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

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

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

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

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

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

idRequired
  • Type: java.lang.String

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

putOverrideProvider 
public void putOverrideProvider(S3ObjectOverrideProvider value)
valueRequired
resetAcl 
public void resetAcl()
resetBucketKeyEnabled 
public void resetBucketKeyEnabled()
resetCacheControl 
public void resetCacheControl()
resetChecksumAlgorithm 
public void resetChecksumAlgorithm()
resetContent 
public void resetContent()
resetContentBase64 
public void resetContentBase64()
resetContentDisposition 
public void resetContentDisposition()
resetContentEncoding 
public void resetContentEncoding()
resetContentLanguage 
public void resetContentLanguage()
resetContentType 
public void resetContentType()
resetEtag 
public void resetEtag()
resetForceDestroy 
public void resetForceDestroy()
resetId 
public void resetId()
resetKmsKeyId 
public void resetKmsKeyId()
resetMetadata 
public void resetMetadata()
resetObjectLockLegalHoldStatus 
public void resetObjectLockLegalHoldStatus()
resetObjectLockMode 
public void resetObjectLockMode()
resetObjectLockRetainUntilDate 
public void resetObjectLockRetainUntilDate()
resetOverrideProvider 
public void resetOverrideProvider()
resetServerSideEncryption 
public void resetServerSideEncryption()
resetSource 
public void resetSource()
resetSourceHash 
public void resetSourceHash()
resetStorageClass 
public void resetStorageClass()
resetTags 
public void resetTags()
resetTagsAll 
public void resetTagsAll()
resetWebsiteRedirect 
public void resetWebsiteRedirect()

Static Functions

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

S3Object.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.aws.s3_object.S3Object;

S3Object.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.aws.s3_object.S3Object;

S3Object.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.aws.s3_object.S3Object;

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

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing S3Object that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
arn java.lang.String No description.
checksumCrc32 java.lang.String No description.
checksumCrc32C java.lang.String No description.
checksumSha1 java.lang.String No description.
checksumSha256 java.lang.String No description.
overrideProvider S3ObjectOverrideProviderOutputReference No description.
versionId java.lang.String No description.
aclInput java.lang.String No description.
bucketInput java.lang.String No description.
bucketKeyEnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
cacheControlInput java.lang.String No description.
checksumAlgorithmInput java.lang.String No description.
contentBase64Input java.lang.String No description.
contentDispositionInput java.lang.String No description.
contentEncodingInput java.lang.String No description.
contentInput java.lang.String No description.
contentLanguageInput java.lang.String No description.
contentTypeInput java.lang.String No description.
etagInput java.lang.String No description.
forceDestroyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
keyInput java.lang.String No description.
kmsKeyIdInput java.lang.String No description.
metadataInput java.util.Map<java.lang.String, java.lang.String> No description.
objectLockLegalHoldStatusInput java.lang.String No description.
objectLockModeInput java.lang.String No description.
objectLockRetainUntilDateInput java.lang.String No description.
overrideProviderInput S3ObjectOverrideProvider No description.
serverSideEncryptionInput java.lang.String No description.
sourceHashInput java.lang.String No description.
sourceInput java.lang.String No description.
storageClassInput java.lang.String No description.
tagsAllInput java.util.Map<java.lang.String, java.lang.String> No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
websiteRedirectInput java.lang.String No description.
acl java.lang.String No description.
bucket java.lang.String No description.
bucketKeyEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
cacheControl java.lang.String No description.
checksumAlgorithm java.lang.String No description.
content java.lang.String No description.
contentBase64 java.lang.String No description.
contentDisposition java.lang.String No description.
contentEncoding java.lang.String No description.
contentLanguage java.lang.String No description.
contentType java.lang.String No description.
etag java.lang.String No description.
forceDestroy java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
key java.lang.String No description.
kmsKeyId java.lang.String No description.
metadata java.util.Map<java.lang.String, java.lang.String> No description.
objectLockLegalHoldStatus java.lang.String No description.
objectLockMode java.lang.String No description.
objectLockRetainUntilDate java.lang.String No description.
serverSideEncryption java.lang.String No description.
source java.lang.String No description.
sourceHash java.lang.String No description.
storageClass java.lang.String No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
tagsAll java.util.Map<java.lang.String, java.lang.String> No description.
websiteRedirect java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
arnRequired 
public java.lang.String getArn();
  • Type: java.lang.String
checksumCrc32Required 
public java.lang.String getChecksumCrc32();
  • Type: java.lang.String
checksumCrc32CRequired 
public java.lang.String getChecksumCrc32C();
  • Type: java.lang.String
checksumSha1Required 
public java.lang.String getChecksumSha1();
  • Type: java.lang.String
checksumSha256Required 
public java.lang.String getChecksumSha256();
  • Type: java.lang.String
overrideProviderRequired 
public S3ObjectOverrideProviderOutputReference getOverrideProvider();
versionIdRequired 
public java.lang.String getVersionId();
  • Type: java.lang.String
aclInputOptional 
public java.lang.String getAclInput();
  • Type: java.lang.String
bucketInputOptional 
public java.lang.String getBucketInput();
  • Type: java.lang.String
bucketKeyEnabledInputOptional 
public java.lang.Object getBucketKeyEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
cacheControlInputOptional 
public java.lang.String getCacheControlInput();
  • Type: java.lang.String
checksumAlgorithmInputOptional 
public java.lang.String getChecksumAlgorithmInput();
  • Type: java.lang.String
contentBase64InputOptional 
public java.lang.String getContentBase64Input();
  • Type: java.lang.String
contentDispositionInputOptional 
public java.lang.String getContentDispositionInput();
  • Type: java.lang.String
contentEncodingInputOptional 
public java.lang.String getContentEncodingInput();
  • Type: java.lang.String
contentInputOptional 
public java.lang.String getContentInput();
  • Type: java.lang.String
contentLanguageInputOptional 
public java.lang.String getContentLanguageInput();
  • Type: java.lang.String
contentTypeInputOptional 
public java.lang.String getContentTypeInput();
  • Type: java.lang.String
etagInputOptional 
public java.lang.String getEtagInput();
  • Type: java.lang.String
forceDestroyInputOptional 
public java.lang.Object getForceDestroyInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
keyInputOptional 
public java.lang.String getKeyInput();
  • Type: java.lang.String
kmsKeyIdInputOptional 
public java.lang.String getKmsKeyIdInput();
  • Type: java.lang.String
metadataInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getMetadataInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
objectLockLegalHoldStatusInputOptional 
public java.lang.String getObjectLockLegalHoldStatusInput();
  • Type: java.lang.String
objectLockModeInputOptional 
public java.lang.String getObjectLockModeInput();
  • Type: java.lang.String
objectLockRetainUntilDateInputOptional 
public java.lang.String getObjectLockRetainUntilDateInput();
  • Type: java.lang.String
overrideProviderInputOptional 
public S3ObjectOverrideProvider getOverrideProviderInput();
serverSideEncryptionInputOptional 
public java.lang.String getServerSideEncryptionInput();
  • Type: java.lang.String
sourceHashInputOptional 
public java.lang.String getSourceHashInput();
  • Type: java.lang.String
sourceInputOptional 
public java.lang.String getSourceInput();
  • Type: java.lang.String
storageClassInputOptional 
public java.lang.String getStorageClassInput();
  • Type: java.lang.String
tagsAllInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
websiteRedirectInputOptional 
public java.lang.String getWebsiteRedirectInput();
  • Type: java.lang.String
aclRequired 
public java.lang.String getAcl();
  • Type: java.lang.String
bucketRequired 
public java.lang.String getBucket();
  • Type: java.lang.String
bucketKeyEnabledRequired 
public java.lang.Object getBucketKeyEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
cacheControlRequired 
public java.lang.String getCacheControl();
  • Type: java.lang.String
checksumAlgorithmRequired 
public java.lang.String getChecksumAlgorithm();
  • Type: java.lang.String
contentRequired 
public java.lang.String getContent();
  • Type: java.lang.String
contentBase64Required 
public java.lang.String getContentBase64();
  • Type: java.lang.String
contentDispositionRequired 
public java.lang.String getContentDisposition();
  • Type: java.lang.String
contentEncodingRequired 
public java.lang.String getContentEncoding();
  • Type: java.lang.String
contentLanguageRequired 
public java.lang.String getContentLanguage();
  • Type: java.lang.String
contentTypeRequired 
public java.lang.String getContentType();
  • Type: java.lang.String
etagRequired 
public java.lang.String getEtag();
  • Type: java.lang.String
forceDestroyRequired 
public java.lang.Object getForceDestroy();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
keyRequired 
public java.lang.String getKey();
  • Type: java.lang.String
kmsKeyIdRequired 
public java.lang.String getKmsKeyId();
  • Type: java.lang.String
metadataRequired 
public java.util.Map<java.lang.String, java.lang.String> getMetadata();
  • Type: java.util.Map<java.lang.String, java.lang.String>
objectLockLegalHoldStatusRequired 
public java.lang.String getObjectLockLegalHoldStatus();
  • Type: java.lang.String
objectLockModeRequired 
public java.lang.String getObjectLockMode();
  • Type: java.lang.String
objectLockRetainUntilDateRequired 
public java.lang.String getObjectLockRetainUntilDate();
  • Type: java.lang.String
serverSideEncryptionRequired 
public java.lang.String getServerSideEncryption();
  • Type: java.lang.String
sourceRequired 
public java.lang.String getSource();
  • Type: java.lang.String
sourceHashRequired 
public java.lang.String getSourceHash();
  • Type: java.lang.String
storageClassRequired 
public java.lang.String getStorageClass();
  • Type: java.lang.String
tagsRequired 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsAllRequired 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>
websiteRedirectRequired 
public java.lang.String getWebsiteRedirect();
  • Type: java.lang.String

Constants

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

Structs

S3ObjectConfig

Initializer 

import com.hashicorp.cdktf.providers.aws.s3_object.S3ObjectConfig;

S3ObjectConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .bucket(java.lang.String)
    .key(java.lang.String)
//  .acl(java.lang.String)
//  .bucketKeyEnabled(java.lang.Boolean)
//  .bucketKeyEnabled(IResolvable)
//  .cacheControl(java.lang.String)
//  .checksumAlgorithm(java.lang.String)
//  .content(java.lang.String)
//  .contentBase64(java.lang.String)
//  .contentDisposition(java.lang.String)
//  .contentEncoding(java.lang.String)
//  .contentLanguage(java.lang.String)
//  .contentType(java.lang.String)
//  .etag(java.lang.String)
//  .forceDestroy(java.lang.Boolean)
//  .forceDestroy(IResolvable)
//  .id(java.lang.String)
//  .kmsKeyId(java.lang.String)
//  .metadata(java.util.Map<java.lang.String, java.lang.String>)
//  .objectLockLegalHoldStatus(java.lang.String)
//  .objectLockMode(java.lang.String)
//  .objectLockRetainUntilDate(java.lang.String)
//  .overrideProvider(S3ObjectOverrideProvider)
//  .serverSideEncryption(java.lang.String)
//  .source(java.lang.String)
//  .sourceHash(java.lang.String)
//  .storageClass(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .websiteRedirect(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
bucket java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#bucket S3Object#bucket}.
key java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#key S3Object#key}.
acl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#acl S3Object#acl}.
bucketKeyEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#bucket_key_enabled S3Object#bucket_key_enabled}.
cacheControl java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#cache_control S3Object#cache_control}.
checksumAlgorithm java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#checksum_algorithm S3Object#checksum_algorithm}.
content java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content S3Object#content}.
contentBase64 java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_base64 S3Object#content_base64}.
contentDisposition java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_disposition S3Object#content_disposition}.
contentEncoding java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_encoding S3Object#content_encoding}.
contentLanguage java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_language S3Object#content_language}.
contentType java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_type S3Object#content_type}.
etag java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#etag S3Object#etag}.
forceDestroy java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#force_destroy S3Object#force_destroy}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#id S3Object#id}.
kmsKeyId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#kms_key_id S3Object#kms_key_id}.
metadata java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#metadata S3Object#metadata}.
objectLockLegalHoldStatus java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_legal_hold_status S3Object#object_lock_legal_hold_status}.
objectLockMode java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_mode S3Object#object_lock_mode}.
objectLockRetainUntilDate java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_retain_until_date S3Object#object_lock_retain_until_date}.
overrideProvider S3ObjectOverrideProvider override_provider block.
serverSideEncryption java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#server_side_encryption S3Object#server_side_encryption}.
source java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#source S3Object#source}.
sourceHash java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#source_hash S3Object#source_hash}.
storageClass java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#storage_class S3Object#storage_class}.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags S3Object#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags_all S3Object#tags_all}.
websiteRedirect java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#website_redirect S3Object#website_redirect}.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
bucketRequired 
public java.lang.String getBucket();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#bucket S3Object#bucket}.

keyRequired 
public java.lang.String getKey();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#key S3Object#key}.

aclOptional 
public java.lang.String getAcl();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#acl S3Object#acl}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#bucket_key_enabled S3Object#bucket_key_enabled}.

cacheControlOptional 
public java.lang.String getCacheControl();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#cache_control S3Object#cache_control}.

checksumAlgorithmOptional 
public java.lang.String getChecksumAlgorithm();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#checksum_algorithm S3Object#checksum_algorithm}.

contentOptional 
public java.lang.String getContent();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content S3Object#content}.

contentBase64Optional 
public java.lang.String getContentBase64();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_base64 S3Object#content_base64}.

contentDispositionOptional 
public java.lang.String getContentDisposition();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_disposition S3Object#content_disposition}.

contentEncodingOptional 
public java.lang.String getContentEncoding();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_encoding S3Object#content_encoding}.

contentLanguageOptional 
public java.lang.String getContentLanguage();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_language S3Object#content_language}.

contentTypeOptional 
public java.lang.String getContentType();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#content_type S3Object#content_type}.

etagOptional 
public java.lang.String getEtag();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#etag S3Object#etag}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#force_destroy S3Object#force_destroy}.

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

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

kmsKeyIdOptional 
public java.lang.String getKmsKeyId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#kms_key_id S3Object#kms_key_id}.

metadataOptional 
public java.util.Map<java.lang.String, java.lang.String> getMetadata();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#metadata S3Object#metadata}.

objectLockLegalHoldStatusOptional 
public java.lang.String getObjectLockLegalHoldStatus();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_legal_hold_status S3Object#object_lock_legal_hold_status}.

objectLockModeOptional 
public java.lang.String getObjectLockMode();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_mode S3Object#object_lock_mode}.

objectLockRetainUntilDateOptional 
public java.lang.String getObjectLockRetainUntilDate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#object_lock_retain_until_date S3Object#object_lock_retain_until_date}.

overrideProviderOptional 
public S3ObjectOverrideProvider getOverrideProvider();

override_provider block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#override_provider S3Object#override_provider}

serverSideEncryptionOptional 
public java.lang.String getServerSideEncryption();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#server_side_encryption S3Object#server_side_encryption}.

sourceOptional 
public java.lang.String getSource();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#source S3Object#source}.

sourceHashOptional 
public java.lang.String getSourceHash();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#source_hash S3Object#source_hash}.

storageClassOptional 
public java.lang.String getStorageClass();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#storage_class S3Object#storage_class}.

tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags S3Object#tags}.

tagsAllOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags_all S3Object#tags_all}.

websiteRedirectOptional 
public java.lang.String getWebsiteRedirect();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#website_redirect S3Object#website_redirect}.

S3ObjectOverrideProvider

Initializer 

import com.hashicorp.cdktf.providers.aws.s3_object.S3ObjectOverrideProvider;

S3ObjectOverrideProvider.builder()
//  .defaultTags(S3ObjectOverrideProviderDefaultTags)
    .build();

Properties

Name Type Description
defaultTags S3ObjectOverrideProviderDefaultTags default_tags block.
defaultTagsOptional 
public S3ObjectOverrideProviderDefaultTags getDefaultTags();

default_tags block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#default_tags S3Object#default_tags}

S3ObjectOverrideProviderDefaultTags

Initializer 

import com.hashicorp.cdktf.providers.aws.s3_object.S3ObjectOverrideProviderDefaultTags;

S3ObjectOverrideProviderDefaultTags.builder()
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name Type Description
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags S3Object#tags}.
tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.73.0/docs/resources/s3_object#tags S3Object#tags}.

Classes

S3ObjectOverrideProviderDefaultTagsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.aws.s3_object.S3ObjectOverrideProviderDefaultTagsOutputReference;

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

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetTags No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetTags 
public void resetTags()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
internalValue S3ObjectOverrideProviderDefaultTags No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
tagsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsRequired 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>
internalValueOptional 
public S3ObjectOverrideProviderDefaultTags getInternalValue();

S3ObjectOverrideProviderOutputReference

Initializers 

import com.hashicorp.cdktf.providers.aws.s3_object.S3ObjectOverrideProviderOutputReference;

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

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
putDefaultTags No description.
resetDefaultTags No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

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

Return a string representation of this resolvable object.

Returns a reversible string representation.

putDefaultTags 
public void putDefaultTags(S3ObjectOverrideProviderDefaultTags value)
valueRequired
resetDefaultTags 
public void resetDefaultTags()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
defaultTags S3ObjectOverrideProviderDefaultTagsOutputReference No description.
defaultTagsInput S3ObjectOverrideProviderDefaultTags No description.
internalValue S3ObjectOverrideProvider No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
defaultTagsRequired 
public S3ObjectOverrideProviderDefaultTagsOutputReference getDefaultTags();
defaultTagsInputOptional 
public S3ObjectOverrideProviderDefaultTags getDefaultTagsInput();
internalValueOptional 
public S3ObjectOverrideProvider getInternalValue();