dataAwsS3Object.typescript.md

dataAwsS3Object Submodule

Constructs

DataAwsS3Object

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object aws_s3_object}.

Initializers

import { dataAwsS3Object } from '@cdktf/provider-aws'

new dataAwsS3Object.DataAwsS3Object(scope: Construct, id: string, config: DataAwsS3ObjectConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DataAwsS3ObjectConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DataAwsS3ObjectConfig

---

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	Adds this resource to the terraform JSON output.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
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.
resetChecksumMode	No description.
resetId	No description.
resetRange	No description.
resetTags	No description.
resetVersionId	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toHclTerraform

public toHclTerraform(): any

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetChecksumMode

public resetChecksumMode(): void

resetId

public resetId(): void

resetRange

public resetRange(): void

resetTags

public resetTags(): void

resetVersionId

public resetVersionId(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformDataSource	No description.
generateConfigForImport	Generates CDKTF code for importing a DataAwsS3Object resource upon running "cdktf plan ".

---

isConstruct

import { dataAwsS3Object } from '@cdktf/provider-aws'

dataAwsS3Object.DataAwsS3Object.isConstruct(x: 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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { dataAwsS3Object } from '@cdktf/provider-aws'

dataAwsS3Object.DataAwsS3Object.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

import { dataAwsS3Object } from '@cdktf/provider-aws'

dataAwsS3Object.DataAwsS3Object.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dataAwsS3Object } from '@cdktf/provider-aws'

dataAwsS3Object.DataAwsS3Object.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing DataAwsS3Object that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
arn	string	No description.
body	string	No description.
bucketKeyEnabled	cdktf.IResolvable	No description.
cacheControl	string	No description.
checksumCrc32	string	No description.
checksumCrc32C	string	No description.
checksumSha1	string	No description.
checksumSha256	string	No description.
contentDisposition	string	No description.
contentEncoding	string	No description.
contentLanguage	string	No description.
contentLength	number	No description.
contentType	string	No description.
etag	string	No description.
expiration	string	No description.
expires	string	No description.
lastModified	string	No description.
metadata	cdktf.StringMap	No description.
objectLockLegalHoldStatus	string	No description.
objectLockMode	string	No description.
objectLockRetainUntilDate	string	No description.
serverSideEncryption	string	No description.
sseKmsKeyId	string	No description.
storageClass	string	No description.
websiteRedirectLocation	string	No description.
bucketInput	string	No description.
checksumModeInput	string	No description.
idInput	string	No description.
keyInput	string	No description.
rangeInput	string	No description.
tagsInput	{[ key: string ]: string}	No description.
versionIdInput	string	No description.
bucket	string	No description.
checksumMode	string	No description.
id	string	No description.
key	string	No description.
range	string	No description.
tags	{[ key: string ]: string}	No description.
versionId	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

arn^Required

public readonly arn: string;

• Type: string

---

body^Required

public readonly body: string;

• Type: string

---

bucketKeyEnabled^Required

public readonly bucketKeyEnabled: IResolvable;

• Type: cdktf.IResolvable

---

cacheControl^Required

public readonly cacheControl: string;

• Type: string

---

checksumCrc32^Required

public readonly checksumCrc32: string;

• Type: string

---

checksumCrc32C^Required

public readonly checksumCrc32C: string;

• Type: string

---

checksumSha1^Required

public readonly checksumSha1: string;

• Type: string

---

checksumSha256^Required

public readonly checksumSha256: string;

• Type: string

---

contentDisposition^Required

public readonly contentDisposition: string;

• Type: string

---

contentEncoding^Required

public readonly contentEncoding: string;

• Type: string

---

contentLanguage^Required

public readonly contentLanguage: string;

• Type: string

---

contentLength^Required

public readonly contentLength: number;

• Type: number

---

contentType^Required

public readonly contentType: string;

• Type: string

---

etag^Required

public readonly etag: string;

• Type: string

---

expiration^Required

public readonly expiration: string;

• Type: string

---

expires^Required

public readonly expires: string;

• Type: string

---

lastModified^Required

public readonly lastModified: string;

• Type: string

---

metadata^Required

public readonly metadata: StringMap;

• Type: cdktf.StringMap

---

objectLockLegalHoldStatus^Required

public readonly objectLockLegalHoldStatus: string;

• Type: string

---

objectLockMode^Required

public readonly objectLockMode: string;

• Type: string

---

objectLockRetainUntilDate^Required

public readonly objectLockRetainUntilDate: string;

• Type: string

---

serverSideEncryption^Required

public readonly serverSideEncryption: string;

• Type: string

---

sseKmsKeyId^Required

public readonly sseKmsKeyId: string;

• Type: string

---

storageClass^Required

public readonly storageClass: string;

• Type: string

---

websiteRedirectLocation^Required

public readonly websiteRedirectLocation: string;

• Type: string

---

bucketInput^Optional

public readonly bucketInput: string;

• Type: string

---

checksumModeInput^Optional

public readonly checksumModeInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

keyInput^Optional

public readonly keyInput: string;

• Type: string

---

rangeInput^Optional

public readonly rangeInput: string;

• Type: string

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

versionIdInput^Optional

public readonly versionIdInput: string;

• Type: string

---

bucket^Required

public readonly bucket: string;

• Type: string

---

checksumMode^Required

public readonly checksumMode: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

key^Required

public readonly key: string;

• Type: string

---

range^Required

public readonly range: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

versionId^Required

public readonly versionId: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataAwsS3ObjectConfig

Initializer

import { dataAwsS3Object } from '@cdktf/provider-aws'

const dataAwsS3ObjectConfig: dataAwsS3Object.DataAwsS3ObjectConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
bucket	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#bucket DataAwsS3Object#bucket}.
key	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#key DataAwsS3Object#key}.
checksumMode	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#checksum_mode DataAwsS3Object#checksum_mode}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#id DataAwsS3Object#id}.
range	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#range DataAwsS3Object#range}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#tags DataAwsS3Object#tags}.
versionId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#version_id DataAwsS3Object#version_id}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

bucket^Required

public readonly bucket: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#bucket DataAwsS3Object#bucket}.

---

key^Required

public readonly key: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#key DataAwsS3Object#key}.

---

checksumMode^Optional

public readonly checksumMode: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#checksum_mode DataAwsS3Object#checksum_mode}.

---

id^Optional

public readonly id: string;

• Type: string

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

---

range^Optional

public readonly range: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#range DataAwsS3Object#range}.

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#tags DataAwsS3Object#tags}.

---

versionId^Optional

public readonly versionId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/s3_object#version_id DataAwsS3Object#version_id}.

---