`timestreamwriteTable` Submodule

Constructs

TimestreamwriteTable

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table aws_timestreamwrite_table}.

Initializers

import { timestreamwriteTable } from '@cdktf/aws-cdk'

new timestreamwriteTable.TimestreamwriteTable(scope: Construct, id: string, config: TimestreamwriteTableConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`TimestreamwriteTableConfig`	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: TimestreamwriteTableConfig

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".
`putMagneticStoreWriteProperties`	No description.
`putRetentionProperties`	No description.
`resetId`	No description.
`resetMagneticStoreWriteProperties`	No description.
`resetRetentionProperties`	No description.
`resetTags`	No description.
`resetTagsAll`	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

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`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

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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.

`id`^Required

Type: string

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

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`putMagneticStoreWriteProperties`

public putMagneticStoreWriteProperties(value: TimestreamwriteTableMagneticStoreWriteProperties): void

`value`^Required

Type: TimestreamwriteTableMagneticStoreWriteProperties

`putRetentionProperties`

public putRetentionProperties(value: TimestreamwriteTableRetentionProperties): void

`value`^Required

Type: TimestreamwriteTableRetentionProperties

`resetId`

public resetId(): void

`resetMagneticStoreWriteProperties`

public resetMagneticStoreWriteProperties(): void

`resetRetentionProperties`

public resetRetentionProperties(): void

`resetTags`

public resetTags(): void

`resetTagsAll`

public resetTagsAll(): void

Static Functions

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

`isConstruct`

import { timestreamwriteTable } from '@cdktf/aws-cdk'

timestreamwriteTable.TimestreamwriteTable.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { timestreamwriteTable } from '@cdktf/aws-cdk'

timestreamwriteTable.TimestreamwriteTable.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { timestreamwriteTable } from '@cdktf/aws-cdk'

timestreamwriteTable.TimestreamwriteTable.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { timestreamwriteTable } from '@cdktf/aws-cdk'

timestreamwriteTable.TimestreamwriteTable.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a TimestreamwriteTable 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 TimestreamwriteTable to import.

`importFromId`^Required

Type: string

The id of the existing TimestreamwriteTable that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#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 TimestreamwriteTable 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.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	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.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`arn`	`string`	No description.
`magneticStoreWriteProperties`	`TimestreamwriteTableMagneticStoreWritePropertiesOutputReference`	No description.
`retentionProperties`	`TimestreamwriteTableRetentionPropertiesOutputReference`	No description.
`databaseNameInput`	`string`	No description.
`idInput`	`string`	No description.
`magneticStoreWritePropertiesInput`	`TimestreamwriteTableMagneticStoreWriteProperties`	No description.
`retentionPropertiesInput`	`TimestreamwriteTableRetentionProperties`	No description.
`tableNameInput`	`string`	No description.
`tagsAllInput`	`{[ key: string ]: string}`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`databaseName`	`string`	No description.
`id`	`string`	No description.
`tableName`	`string`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`tagsAll`	`{[ key: string ]: 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

`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: 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

`provisioners`^Optional

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

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

`arn`^Required

public readonly arn: string;

Type: string

`magneticStoreWriteProperties`^Required

public readonly magneticStoreWriteProperties: TimestreamwriteTableMagneticStoreWritePropertiesOutputReference;

Type: TimestreamwriteTableMagneticStoreWritePropertiesOutputReference

`retentionProperties`^Required

public readonly retentionProperties: TimestreamwriteTableRetentionPropertiesOutputReference;

Type: TimestreamwriteTableRetentionPropertiesOutputReference

`databaseNameInput`^Optional

public readonly databaseNameInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`magneticStoreWritePropertiesInput`^Optional

public readonly magneticStoreWritePropertiesInput: TimestreamwriteTableMagneticStoreWriteProperties;

Type: TimestreamwriteTableMagneticStoreWriteProperties

`retentionPropertiesInput`^Optional

public readonly retentionPropertiesInput: TimestreamwriteTableRetentionProperties;

Type: TimestreamwriteTableRetentionProperties

`tableNameInput`^Optional

public readonly tableNameInput: string;

Type: string

`tagsAllInput`^Optional

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

Type: {[ key: string ]: string}

`tagsInput`^Optional

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

Type: {[ key: string ]: string}

`databaseName`^Required

public readonly databaseName: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`tableName`^Required

public readonly tableName: string;

Type: string

`tags`^Required

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

Type: {[ key: string ]: string}

`tagsAll`^Required

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

Type: {[ key: string ]: string}

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

TimestreamwriteTableConfig

Initializer

import { timestreamwriteTable } from '@cdktf/aws-cdk'

const timestreamwriteTableConfig: timestreamwriteTable.TimestreamwriteTableConfig = { ... }

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.
`databaseName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#database_name TimestreamwriteTable#database_name}.
`tableName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#table_name TimestreamwriteTable#table_name}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#id TimestreamwriteTable#id}.
`magneticStoreWriteProperties`	`TimestreamwriteTableMagneticStoreWriteProperties`	magnetic_store_write_properties block.
`retentionProperties`	`TimestreamwriteTableRetentionProperties`	retention_properties block.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#tags TimestreamwriteTable#tags}.
`tagsAll`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#tags_all TimestreamwriteTable#tags_all}.

`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[]

`databaseName`^Required

public readonly databaseName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#database_name TimestreamwriteTable#database_name}.

`tableName`^Required

public readonly tableName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#table_name TimestreamwriteTable#table_name}.

`id`^Optional

public readonly id: string;

Type: string

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

`magneticStoreWriteProperties`^Optional

public readonly magneticStoreWriteProperties: TimestreamwriteTableMagneticStoreWriteProperties;

Type: TimestreamwriteTableMagneticStoreWriteProperties

magnetic_store_write_properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#magnetic_store_write_properties TimestreamwriteTable#magnetic_store_write_properties}

`retentionProperties`^Optional

public readonly retentionProperties: TimestreamwriteTableRetentionProperties;

Type: TimestreamwriteTableRetentionProperties

retention_properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#retention_properties TimestreamwriteTable#retention_properties}

`tags`^Optional

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

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#tags TimestreamwriteTable#tags}.

`tagsAll`^Optional

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

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#tags_all TimestreamwriteTable#tags_all}.

TimestreamwriteTableMagneticStoreWriteProperties

Initializer

import { timestreamwriteTable } from '@cdktf/aws-cdk'

const timestreamwriteTableMagneticStoreWriteProperties: timestreamwriteTable.TimestreamwriteTableMagneticStoreWriteProperties = { ... }

Properties

Name	Type	Description
`enableMagneticStoreWrites`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#enable_magnetic_store_writes TimestreamwriteTable#enable_magnetic_store_writes}.
`magneticStoreRejectedDataLocation`	`TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation`	magnetic_store_rejected_data_location block.

`enableMagneticStoreWrites`^Optional

public readonly enableMagneticStoreWrites: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#enable_magnetic_store_writes TimestreamwriteTable#enable_magnetic_store_writes}.

`magneticStoreRejectedDataLocation`^Optional

public readonly magneticStoreRejectedDataLocation: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation;

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation

magnetic_store_rejected_data_location block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#magnetic_store_rejected_data_location TimestreamwriteTable#magnetic_store_rejected_data_location}

TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation

Initializer

import { timestreamwriteTable } from '@cdktf/aws-cdk'

const timestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation: timestreamwriteTable.TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation = { ... }

Properties

Name	Type	Description
`s3Configuration`	`TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration`	s3_configuration block.

`s3Configuration`^Optional

public readonly s3Configuration: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration;

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration

s3_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#s3_configuration TimestreamwriteTable#s3_configuration}

TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration

Initializer

import { timestreamwriteTable } from '@cdktf/aws-cdk'

const timestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration: timestreamwriteTable.TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration = { ... }

Properties

Name	Type	Description
`bucketName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#bucket_name TimestreamwriteTable#bucket_name}.
`encryptionOption`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#encryption_option TimestreamwriteTable#encryption_option}.
`kmsKeyId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#kms_key_id TimestreamwriteTable#kms_key_id}.
`objectKeyPrefix`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#object_key_prefix TimestreamwriteTable#object_key_prefix}.

`bucketName`^Optional

public readonly bucketName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#bucket_name TimestreamwriteTable#bucket_name}.

`encryptionOption`^Optional

public readonly encryptionOption: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#encryption_option TimestreamwriteTable#encryption_option}.

`kmsKeyId`^Optional

public readonly kmsKeyId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#kms_key_id TimestreamwriteTable#kms_key_id}.

`objectKeyPrefix`^Optional

public readonly objectKeyPrefix: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#object_key_prefix TimestreamwriteTable#object_key_prefix}.

TimestreamwriteTableRetentionProperties

Initializer

import { timestreamwriteTable } from '@cdktf/aws-cdk'

const timestreamwriteTableRetentionProperties: timestreamwriteTable.TimestreamwriteTableRetentionProperties = { ... }

Properties

Name	Type	Description
`magneticStoreRetentionPeriodInDays`	`number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#magnetic_store_retention_period_in_days TimestreamwriteTable#magnetic_store_retention_period_in_days}.
`memoryStoreRetentionPeriodInHours`	`number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#memory_store_retention_period_in_hours TimestreamwriteTable#memory_store_retention_period_in_hours}.

`magneticStoreRetentionPeriodInDays`^Required

public readonly magneticStoreRetentionPeriodInDays: number;

Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#magnetic_store_retention_period_in_days TimestreamwriteTable#magnetic_store_retention_period_in_days}.

`memoryStoreRetentionPeriodInHours`^Required

public readonly memoryStoreRetentionPeriodInHours: number;

Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/timestreamwrite_table#memory_store_retention_period_in_hours TimestreamwriteTable#memory_store_retention_period_in_hours}.

Classes

TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationOutputReference

Initializers

import { timestreamwriteTable } from '@cdktf/aws-cdk'

new timestreamwriteTable.TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: 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.
`putS3Configuration`	No description.
`resetS3Configuration`	No description.

`computeFqn`

public computeFqn(): string

`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(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putS3Configuration`

public putS3Configuration(value: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration): void

`value`^Required

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration

`resetS3Configuration`

public resetS3Configuration(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`s3Configuration`	`TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationOutputReference`	No description.
`s3ConfigurationInput`	`TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration`	No description.
`internalValue`	`TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: 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.

`fqn`^Required

public readonly fqn: string;

Type: string

`s3Configuration`^Required

public readonly s3Configuration: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationOutputReference;

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationOutputReference

`s3ConfigurationInput`^Optional

public readonly s3ConfigurationInput: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration;

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration

`internalValue`^Optional

public readonly internalValue: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation;

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation

TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationOutputReference

Initializers

import { timestreamwriteTable } from '@cdktf/aws-cdk'

new timestreamwriteTable.TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3ConfigurationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: 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.
`resetBucketName`	No description.
`resetEncryptionOption`	No description.
`resetKmsKeyId`	No description.
`resetObjectKeyPrefix`	No description.

`computeFqn`

public computeFqn(): string

`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(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetBucketName`

public resetBucketName(): void

`resetEncryptionOption`

public resetEncryptionOption(): void

`resetKmsKeyId`

public resetKmsKeyId(): void

`resetObjectKeyPrefix`

public resetObjectKeyPrefix(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`bucketNameInput`	`string`	No description.
`encryptionOptionInput`	`string`	No description.
`kmsKeyIdInput`	`string`	No description.
`objectKeyPrefixInput`	`string`	No description.
`bucketName`	`string`	No description.
`encryptionOption`	`string`	No description.
`kmsKeyId`	`string`	No description.
`objectKeyPrefix`	`string`	No description.
`internalValue`	`TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: 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.

`fqn`^Required

public readonly fqn: string;

Type: string

`bucketNameInput`^Optional

public readonly bucketNameInput: string;

Type: string

`encryptionOptionInput`^Optional

public readonly encryptionOptionInput: string;

Type: string

`kmsKeyIdInput`^Optional

public readonly kmsKeyIdInput: string;

Type: string

`objectKeyPrefixInput`^Optional

public readonly objectKeyPrefixInput: string;

Type: string

`bucketName`^Required

public readonly bucketName: string;

Type: string

`encryptionOption`^Required

public readonly encryptionOption: string;

Type: string

`kmsKeyId`^Required

public readonly kmsKeyId: string;

Type: string

`objectKeyPrefix`^Required

public readonly objectKeyPrefix: string;

Type: string

`internalValue`^Optional

public readonly internalValue: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration;

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationS3Configuration

TimestreamwriteTableMagneticStoreWritePropertiesOutputReference

Initializers

import { timestreamwriteTable } from '@cdktf/aws-cdk'

new timestreamwriteTable.TimestreamwriteTableMagneticStoreWritePropertiesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: 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.
`putMagneticStoreRejectedDataLocation`	No description.
`resetEnableMagneticStoreWrites`	No description.
`resetMagneticStoreRejectedDataLocation`	No description.

`computeFqn`

public computeFqn(): string

`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(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putMagneticStoreRejectedDataLocation`

public putMagneticStoreRejectedDataLocation(value: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation): void

`value`^Required

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation

`resetEnableMagneticStoreWrites`

public resetEnableMagneticStoreWrites(): void

`resetMagneticStoreRejectedDataLocation`

public resetMagneticStoreRejectedDataLocation(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`magneticStoreRejectedDataLocation`	`TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationOutputReference`	No description.
`enableMagneticStoreWritesInput`	`boolean \| cdktf.IResolvable`	No description.
`magneticStoreRejectedDataLocationInput`	`TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation`	No description.
`enableMagneticStoreWrites`	`boolean \| cdktf.IResolvable`	No description.
`internalValue`	`TimestreamwriteTableMagneticStoreWriteProperties`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: 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.

`fqn`^Required

public readonly fqn: string;

Type: string

`magneticStoreRejectedDataLocation`^Required

public readonly magneticStoreRejectedDataLocation: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationOutputReference;

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocationOutputReference

`enableMagneticStoreWritesInput`^Optional

public readonly enableMagneticStoreWritesInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`magneticStoreRejectedDataLocationInput`^Optional

public readonly magneticStoreRejectedDataLocationInput: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation;

Type: TimestreamwriteTableMagneticStoreWritePropertiesMagneticStoreRejectedDataLocation

`enableMagneticStoreWrites`^Required

public readonly enableMagneticStoreWrites: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`internalValue`^Optional

public readonly internalValue: TimestreamwriteTableMagneticStoreWriteProperties;

Type: TimestreamwriteTableMagneticStoreWriteProperties

TimestreamwriteTableRetentionPropertiesOutputReference

Initializers

import { timestreamwriteTable } from '@cdktf/aws-cdk'

new timestreamwriteTable.TimestreamwriteTableRetentionPropertiesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: 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.

`computeFqn`

public computeFqn(): string

`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(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`magneticStoreRetentionPeriodInDaysInput`	`number`	No description.
`memoryStoreRetentionPeriodInHoursInput`	`number`	No description.
`magneticStoreRetentionPeriodInDays`	`number`	No description.
`memoryStoreRetentionPeriodInHours`	`number`	No description.
`internalValue`	`TimestreamwriteTableRetentionProperties`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: 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.

`fqn`^Required

public readonly fqn: string;

Type: string

`magneticStoreRetentionPeriodInDaysInput`^Optional

public readonly magneticStoreRetentionPeriodInDaysInput: number;

Type: number

`memoryStoreRetentionPeriodInHoursInput`^Optional

public readonly memoryStoreRetentionPeriodInHoursInput: number;

Type: number

`magneticStoreRetentionPeriodInDays`^Required

public readonly magneticStoreRetentionPeriodInDays: number;

Type: number

`memoryStoreRetentionPeriodInHours`^Required

public readonly memoryStoreRetentionPeriodInHours: number;

Type: number

`internalValue`^Optional

public readonly internalValue: TimestreamwriteTableRetentionProperties;

Type: TimestreamwriteTableRetentionProperties

Files

timestreamwriteTable.md

Latest commit

History

timestreamwriteTable.md

File metadata and controls

timestreamwriteTable Submodule

Constructs