databaseKafkaTopic.typescript.md

databaseKafkaTopic Submodule

Constructs

DatabaseKafkaTopic

Represents a {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic digitalocean_database_kafka_topic}.

Initializers

import { databaseKafkaTopic } from '@cdktf/provider-digitalocean'

new databaseKafkaTopic.DatabaseKafkaTopic(scope: Construct, id: string, config: DatabaseKafkaTopicConfig)

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

---

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".
putConfig	No description.
resetConfig	No description.
resetId	No description.
resetPartitionCount	No description.
resetReplicationFactor	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".

---

putConfig

public putConfig(value: IResolvable | DatabaseKafkaTopicConfigA[]): void

value^Required

• Type: cdktf.IResolvable | DatabaseKafkaTopicConfigA[]

---

resetConfig

public resetConfig(): void

resetId

public resetId(): void

resetPartitionCount

public resetPartitionCount(): void

resetReplicationFactor

public resetReplicationFactor(): 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 DatabaseKafkaTopic resource upon running "cdktf plan ".

---

isConstruct

import { databaseKafkaTopic } from '@cdktf/provider-digitalocean'

databaseKafkaTopic.DatabaseKafkaTopic.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 { databaseKafkaTopic } from '@cdktf/provider-digitalocean'

databaseKafkaTopic.DatabaseKafkaTopic.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { databaseKafkaTopic } from '@cdktf/provider-digitalocean'

databaseKafkaTopic.DatabaseKafkaTopic.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { databaseKafkaTopic } from '@cdktf/provider-digitalocean'

databaseKafkaTopic.DatabaseKafkaTopic.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing DatabaseKafkaTopic that should be imported.

Refer to the {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#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 DatabaseKafkaTopic 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.
config	DatabaseKafkaTopicConfigAList	No description.
state	string	No description.
clusterIdInput	string	No description.
configInput	cdktf.IResolvable | DatabaseKafkaTopicConfigA[]	No description.
idInput	string	No description.
nameInput	string	No description.
partitionCountInput	number	No description.
replicationFactorInput	number	No description.
clusterId	string	No description.
id	string	No description.
name	string	No description.
partitionCount	number	No description.
replicationFactor	number	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[]

---

config^Required

public readonly config: DatabaseKafkaTopicConfigAList;

• Type: DatabaseKafkaTopicConfigAList

---

state^Required

public readonly state: string;

• Type: string

---

clusterIdInput^Optional

public readonly clusterIdInput: string;

• Type: string

---

configInput^Optional

public readonly configInput: IResolvable | DatabaseKafkaTopicConfigA[];

• Type: cdktf.IResolvable | DatabaseKafkaTopicConfigA[]

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

partitionCountInput^Optional

public readonly partitionCountInput: number;

• Type: number

---

replicationFactorInput^Optional

public readonly replicationFactorInput: number;

• Type: number

---

clusterId^Required

public readonly clusterId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

partitionCount^Required

public readonly partitionCount: number;

• Type: number

---

replicationFactor^Required

public readonly replicationFactor: number;

• Type: number

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DatabaseKafkaTopicConfig

Initializer

import { databaseKafkaTopic } from '@cdktf/provider-digitalocean'

const databaseKafkaTopicConfig: databaseKafkaTopic.DatabaseKafkaTopicConfig = { ... }

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.
clusterId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#cluster_id DatabaseKafkaTopic#cluster_id}.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#name DatabaseKafkaTopic#name}.
config	cdktf.IResolvable | DatabaseKafkaTopicConfigA[]	config block.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#id DatabaseKafkaTopic#id}.
partitionCount	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#partition_count DatabaseKafkaTopic#partition_count}.
replicationFactor	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#replication_factor DatabaseKafkaTopic#replication_factor}.

---

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

---

clusterId^Required

public readonly clusterId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#cluster_id DatabaseKafkaTopic#cluster_id}.

---

name^Required

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#name DatabaseKafkaTopic#name}.

---

config^Optional

public readonly config: IResolvable | DatabaseKafkaTopicConfigA[];

• Type: cdktf.IResolvable | DatabaseKafkaTopicConfigA[]

config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#config DatabaseKafkaTopic#config}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#id DatabaseKafkaTopic#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.

---

partitionCount^Optional

public readonly partitionCount: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#partition_count DatabaseKafkaTopic#partition_count}.

---

replicationFactor^Optional

public readonly replicationFactor: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#replication_factor DatabaseKafkaTopic#replication_factor}.

---

DatabaseKafkaTopicConfigA

Initializer

import { databaseKafkaTopic } from '@cdktf/provider-digitalocean'

const databaseKafkaTopicConfigA: databaseKafkaTopic.DatabaseKafkaTopicConfigA = { ... }

Properties

Name	Type	Description
cleanupPolicy	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#cleanup_policy DatabaseKafkaTopic#cleanup_policy}.
compressionType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#compression_type DatabaseKafkaTopic#compression_type}.
deleteRetentionMs	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#delete_retention_ms DatabaseKafkaTopic#delete_retention_ms}.
fileDeleteDelayMs	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#file_delete_delay_ms DatabaseKafkaTopic#file_delete_delay_ms}.
flushMessages	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#flush_messages DatabaseKafkaTopic#flush_messages}.
flushMs	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#flush_ms DatabaseKafkaTopic#flush_ms}.
indexIntervalBytes	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#index_interval_bytes DatabaseKafkaTopic#index_interval_bytes}.
maxCompactionLagMs	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#max_compaction_lag_ms DatabaseKafkaTopic#max_compaction_lag_ms}.
maxMessageBytes	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#max_message_bytes DatabaseKafkaTopic#max_message_bytes}.
messageDownConversionEnable	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#message_down_conversion_enable DatabaseKafkaTopic#message_down_conversion_enable}.
messageFormatVersion	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#message_format_version DatabaseKafkaTopic#message_format_version}.
messageTimestampDifferenceMaxMs	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#message_timestamp_difference_max_ms DatabaseKafkaTopic#message_timestamp_difference_max_ms}.
messageTimestampType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#message_timestamp_type DatabaseKafkaTopic#message_timestamp_type}.
minCleanableDirtyRatio	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#min_cleanable_dirty_ratio DatabaseKafkaTopic#min_cleanable_dirty_ratio}.
minCompactionLagMs	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#min_compaction_lag_ms DatabaseKafkaTopic#min_compaction_lag_ms}.
minInsyncReplicas	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#min_insync_replicas DatabaseKafkaTopic#min_insync_replicas}.
preallocate	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#preallocate DatabaseKafkaTopic#preallocate}.
retentionBytes	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#retention_bytes DatabaseKafkaTopic#retention_bytes}.
retentionMs	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#retention_ms DatabaseKafkaTopic#retention_ms}.
segmentBytes	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#segment_bytes DatabaseKafkaTopic#segment_bytes}.
segmentIndexBytes	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#segment_index_bytes DatabaseKafkaTopic#segment_index_bytes}.
segmentJitterMs	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#segment_jitter_ms DatabaseKafkaTopic#segment_jitter_ms}.
segmentMs	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#segment_ms DatabaseKafkaTopic#segment_ms}.

---

cleanupPolicy^Optional

public readonly cleanupPolicy: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#cleanup_policy DatabaseKafkaTopic#cleanup_policy}.

---

compressionType^Optional

public readonly compressionType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#compression_type DatabaseKafkaTopic#compression_type}.

---

deleteRetentionMs^Optional

public readonly deleteRetentionMs: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#delete_retention_ms DatabaseKafkaTopic#delete_retention_ms}.

---

fileDeleteDelayMs^Optional

public readonly fileDeleteDelayMs: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#file_delete_delay_ms DatabaseKafkaTopic#file_delete_delay_ms}.

---

flushMessages^Optional

public readonly flushMessages: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#flush_messages DatabaseKafkaTopic#flush_messages}.

---

flushMs^Optional

public readonly flushMs: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#flush_ms DatabaseKafkaTopic#flush_ms}.

---

indexIntervalBytes^Optional

public readonly indexIntervalBytes: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#index_interval_bytes DatabaseKafkaTopic#index_interval_bytes}.

---

maxCompactionLagMs^Optional

public readonly maxCompactionLagMs: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#max_compaction_lag_ms DatabaseKafkaTopic#max_compaction_lag_ms}.

---

maxMessageBytes^Optional

public readonly maxMessageBytes: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#max_message_bytes DatabaseKafkaTopic#max_message_bytes}.

---

messageDownConversionEnable^Optional

public readonly messageDownConversionEnable: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#message_down_conversion_enable DatabaseKafkaTopic#message_down_conversion_enable}.

---

messageFormatVersion^Optional

public readonly messageFormatVersion: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#message_format_version DatabaseKafkaTopic#message_format_version}.

---

messageTimestampDifferenceMaxMs^Optional

public readonly messageTimestampDifferenceMaxMs: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#message_timestamp_difference_max_ms DatabaseKafkaTopic#message_timestamp_difference_max_ms}.

---

messageTimestampType^Optional

public readonly messageTimestampType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#message_timestamp_type DatabaseKafkaTopic#message_timestamp_type}.

---

minCleanableDirtyRatio^Optional

public readonly minCleanableDirtyRatio: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#min_cleanable_dirty_ratio DatabaseKafkaTopic#min_cleanable_dirty_ratio}.

---

minCompactionLagMs^Optional

public readonly minCompactionLagMs: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#min_compaction_lag_ms DatabaseKafkaTopic#min_compaction_lag_ms}.

---

minInsyncReplicas^Optional

public readonly minInsyncReplicas: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#min_insync_replicas DatabaseKafkaTopic#min_insync_replicas}.

---

preallocate^Optional

public readonly preallocate: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#preallocate DatabaseKafkaTopic#preallocate}.

---

retentionBytes^Optional

public readonly retentionBytes: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#retention_bytes DatabaseKafkaTopic#retention_bytes}.

---

retentionMs^Optional

public readonly retentionMs: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#retention_ms DatabaseKafkaTopic#retention_ms}.

---

segmentBytes^Optional

public readonly segmentBytes: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#segment_bytes DatabaseKafkaTopic#segment_bytes}.

---

segmentIndexBytes^Optional

public readonly segmentIndexBytes: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#segment_index_bytes DatabaseKafkaTopic#segment_index_bytes}.

---

segmentJitterMs^Optional

public readonly segmentJitterMs: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#segment_jitter_ms DatabaseKafkaTopic#segment_jitter_ms}.

---

segmentMs^Optional

public readonly segmentMs: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_kafka_topic#segment_ms DatabaseKafkaTopic#segment_ms}.

---

Classes

DatabaseKafkaTopicConfigAList

Initializers

import { databaseKafkaTopic } from '@cdktf/provider-digitalocean'

new databaseKafkaTopic.DatabaseKafkaTopicConfigAList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): 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.

get

public get(index: number): DatabaseKafkaTopicConfigAOutputReference

index^Required

• Type: number

the index of the item to return.

---

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.
internalValue	cdktf.IResolvable | DatabaseKafkaTopicConfigA[]	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

---

internalValue^Optional

public readonly internalValue: IResolvable | DatabaseKafkaTopicConfigA[];

• Type: cdktf.IResolvable | DatabaseKafkaTopicConfigA[]

---

DatabaseKafkaTopicConfigAOutputReference

Initializers

import { databaseKafkaTopic } from '@cdktf/provider-digitalocean'

new databaseKafkaTopic.DatabaseKafkaTopicConfigAOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

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.
resetCleanupPolicy	No description.
resetCompressionType	No description.
resetDeleteRetentionMs	No description.
resetFileDeleteDelayMs	No description.
resetFlushMessages	No description.
resetFlushMs	No description.
resetIndexIntervalBytes	No description.
resetMaxCompactionLagMs	No description.
resetMaxMessageBytes	No description.
resetMessageDownConversionEnable	No description.
resetMessageFormatVersion	No description.
resetMessageTimestampDifferenceMaxMs	No description.
resetMessageTimestampType	No description.
resetMinCleanableDirtyRatio	No description.
resetMinCompactionLagMs	No description.
resetMinInsyncReplicas	No description.
resetPreallocate	No description.
resetRetentionBytes	No description.
resetRetentionMs	No description.
resetSegmentBytes	No description.
resetSegmentIndexBytes	No description.
resetSegmentJitterMs	No description.
resetSegmentMs	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.

resetCleanupPolicy

public resetCleanupPolicy(): void

resetCompressionType

public resetCompressionType(): void

resetDeleteRetentionMs

public resetDeleteRetentionMs(): void

resetFileDeleteDelayMs

public resetFileDeleteDelayMs(): void

resetFlushMessages

public resetFlushMessages(): void

resetFlushMs

public resetFlushMs(): void

resetIndexIntervalBytes

public resetIndexIntervalBytes(): void

resetMaxCompactionLagMs

public resetMaxCompactionLagMs(): void

resetMaxMessageBytes

public resetMaxMessageBytes(): void

resetMessageDownConversionEnable

public resetMessageDownConversionEnable(): void

resetMessageFormatVersion

public resetMessageFormatVersion(): void

resetMessageTimestampDifferenceMaxMs

public resetMessageTimestampDifferenceMaxMs(): void

resetMessageTimestampType

public resetMessageTimestampType(): void

resetMinCleanableDirtyRatio

public resetMinCleanableDirtyRatio(): void

resetMinCompactionLagMs

public resetMinCompactionLagMs(): void

resetMinInsyncReplicas

public resetMinInsyncReplicas(): void

resetPreallocate

public resetPreallocate(): void

resetRetentionBytes

public resetRetentionBytes(): void

resetRetentionMs

public resetRetentionMs(): void

resetSegmentBytes

public resetSegmentBytes(): void

resetSegmentIndexBytes

public resetSegmentIndexBytes(): void

resetSegmentJitterMs

public resetSegmentJitterMs(): void

resetSegmentMs

public resetSegmentMs(): 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.
cleanupPolicyInput	string	No description.
compressionTypeInput	string	No description.
deleteRetentionMsInput	string	No description.
fileDeleteDelayMsInput	string	No description.
flushMessagesInput	string	No description.
flushMsInput	string	No description.
indexIntervalBytesInput	string	No description.
maxCompactionLagMsInput	string	No description.
maxMessageBytesInput	string	No description.
messageDownConversionEnableInput	boolean | cdktf.IResolvable	No description.
messageFormatVersionInput	string	No description.
messageTimestampDifferenceMaxMsInput	string	No description.
messageTimestampTypeInput	string	No description.
minCleanableDirtyRatioInput	number	No description.
minCompactionLagMsInput	string	No description.
minInsyncReplicasInput	number	No description.
preallocateInput	boolean | cdktf.IResolvable	No description.
retentionBytesInput	string	No description.
retentionMsInput	string	No description.
segmentBytesInput	string	No description.
segmentIndexBytesInput	string	No description.
segmentJitterMsInput	string	No description.
segmentMsInput	string	No description.
cleanupPolicy	string	No description.
compressionType	string	No description.
deleteRetentionMs	string	No description.
fileDeleteDelayMs	string	No description.
flushMessages	string	No description.
flushMs	string	No description.
indexIntervalBytes	string	No description.
maxCompactionLagMs	string	No description.
maxMessageBytes	string	No description.
messageDownConversionEnable	boolean | cdktf.IResolvable	No description.
messageFormatVersion	string	No description.
messageTimestampDifferenceMaxMs	string	No description.
messageTimestampType	string	No description.
minCleanableDirtyRatio	number	No description.
minCompactionLagMs	string	No description.
minInsyncReplicas	number	No description.
preallocate	boolean | cdktf.IResolvable	No description.
retentionBytes	string	No description.
retentionMs	string	No description.
segmentBytes	string	No description.
segmentIndexBytes	string	No description.
segmentJitterMs	string	No description.
segmentMs	string	No description.
internalValue	cdktf.IResolvable | DatabaseKafkaTopicConfigA	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

---

cleanupPolicyInput^Optional

public readonly cleanupPolicyInput: string;

• Type: string

---

compressionTypeInput^Optional

public readonly compressionTypeInput: string;

• Type: string

---

deleteRetentionMsInput^Optional

public readonly deleteRetentionMsInput: string;

• Type: string

---

fileDeleteDelayMsInput^Optional

public readonly fileDeleteDelayMsInput: string;

• Type: string

---

flushMessagesInput^Optional

public readonly flushMessagesInput: string;

• Type: string

---

flushMsInput^Optional

public readonly flushMsInput: string;

• Type: string

---

indexIntervalBytesInput^Optional

public readonly indexIntervalBytesInput: string;

• Type: string

---

maxCompactionLagMsInput^Optional

public readonly maxCompactionLagMsInput: string;

• Type: string

---

maxMessageBytesInput^Optional

public readonly maxMessageBytesInput: string;

• Type: string

---

messageDownConversionEnableInput^Optional

public readonly messageDownConversionEnableInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

messageFormatVersionInput^Optional

public readonly messageFormatVersionInput: string;

• Type: string

---

messageTimestampDifferenceMaxMsInput^Optional

public readonly messageTimestampDifferenceMaxMsInput: string;

• Type: string

---

messageTimestampTypeInput^Optional

public readonly messageTimestampTypeInput: string;

• Type: string

---

minCleanableDirtyRatioInput^Optional

public readonly minCleanableDirtyRatioInput: number;

• Type: number

---

minCompactionLagMsInput^Optional

public readonly minCompactionLagMsInput: string;

• Type: string

---

minInsyncReplicasInput^Optional

public readonly minInsyncReplicasInput: number;

• Type: number

---

preallocateInput^Optional

public readonly preallocateInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

retentionBytesInput^Optional

public readonly retentionBytesInput: string;

• Type: string

---

retentionMsInput^Optional

public readonly retentionMsInput: string;

• Type: string

---

segmentBytesInput^Optional

public readonly segmentBytesInput: string;

• Type: string

---

segmentIndexBytesInput^Optional

public readonly segmentIndexBytesInput: string;

• Type: string

---

segmentJitterMsInput^Optional

public readonly segmentJitterMsInput: string;

• Type: string

---

segmentMsInput^Optional

public readonly segmentMsInput: string;

• Type: string

---

cleanupPolicy^Required

public readonly cleanupPolicy: string;

• Type: string

---

compressionType^Required

public readonly compressionType: string;

• Type: string

---

deleteRetentionMs^Required

public readonly deleteRetentionMs: string;

• Type: string

---

fileDeleteDelayMs^Required

public readonly fileDeleteDelayMs: string;

• Type: string

---

flushMessages^Required

public readonly flushMessages: string;

• Type: string

---

flushMs^Required

public readonly flushMs: string;

• Type: string

---

indexIntervalBytes^Required

public readonly indexIntervalBytes: string;

• Type: string

---

maxCompactionLagMs^Required

public readonly maxCompactionLagMs: string;

• Type: string

---

maxMessageBytes^Required

public readonly maxMessageBytes: string;

• Type: string

---

messageDownConversionEnable^Required

public readonly messageDownConversionEnable: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

messageFormatVersion^Required

public readonly messageFormatVersion: string;

• Type: string

---

messageTimestampDifferenceMaxMs^Required

public readonly messageTimestampDifferenceMaxMs: string;

• Type: string

---

messageTimestampType^Required

public readonly messageTimestampType: string;

• Type: string

---

minCleanableDirtyRatio^Required

public readonly minCleanableDirtyRatio: number;

• Type: number

---

minCompactionLagMs^Required

public readonly minCompactionLagMs: string;

• Type: string

---

minInsyncReplicas^Required

public readonly minInsyncReplicas: number;

• Type: number

---

preallocate^Required

public readonly preallocate: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

retentionBytes^Required

public readonly retentionBytes: string;

• Type: string

---

retentionMs^Required

public readonly retentionMs: string;

• Type: string

---

segmentBytes^Required

public readonly segmentBytes: string;

• Type: string

---

segmentIndexBytes^Required

public readonly segmentIndexBytes: string;

• Type: string

---

segmentJitterMs^Required

public readonly segmentJitterMs: string;

• Type: string

---

segmentMs^Required

public readonly segmentMs: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | DatabaseKafkaTopicConfigA;

• Type: cdktf.IResolvable | DatabaseKafkaTopicConfigA

---