`kafkaClusterTopic` Submodule

Constructs

KafkaClusterTopic

Represents a {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic ionoscloud_kafka_cluster_topic}.

Initializers

from cdktf_cdktf_provider_ionoscloud import kafka_cluster_topic

kafkaClusterTopic.KafkaClusterTopic(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  cluster_id: str,
  name: str,
  location: str = None,
  number_of_partitions: typing.Union[int, float] = None,
  replication_factor: typing.Union[int, float] = None,
  retention_time: typing.Union[int, float] = None,
  segment_bytes: typing.Union[int, float] = None,
  timeouts: KafkaClusterTopicTimeouts = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`cluster_id`	`str`	The ID of the Kafka Cluster to which the topic belongs.
`name`	`str`	The name of your Kafka Cluster Topic.
`location`	`str`	The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl.
`number_of_partitions`	`typing.Union[int, float]`	The number of partitions of the topic.
`replication_factor`	`typing.Union[int, float]`	The number of replicas of the topic.
`retention_time`	`typing.Union[int, float]`	This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space.
`segment_bytes`	`typing.Union[int, float]`	This configuration controls the segment file size for the log.
`timeouts`	`KafkaClusterTopicTimeouts`	timeouts block.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`cluster_id`^Required

Type: str

The ID of the Kafka Cluster to which the topic belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#cluster_id KafkaClusterTopic#cluster_id}

`name`^Required

Type: str

The name of your Kafka Cluster Topic.

Must be 63 characters or less and must begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#name KafkaClusterTopic#name}

`location`^Optional

Type: str

The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#location KafkaClusterTopic#location}

`number_of_partitions`^Optional

Type: typing.Union[int, float]

The number of partitions of the topic.

Partitions allow for parallel processing of messages. The partition count must be greater than or equal to the replication factor.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#number_of_partitions KafkaClusterTopic#number_of_partitions}

`replication_factor`^Optional

Type: typing.Union[int, float]

The number of replicas of the topic.

The replication factor determines how many copies of the topic are stored on different brokers. The replication factor must be less than or equal to the number of brokers in the Kafka Cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#replication_factor KafkaClusterTopic#replication_factor}

`retention_time`^Optional

Type: typing.Union[int, float]

This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space.

This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#retention_time KafkaClusterTopic#retention_time}

`segment_bytes`^Optional

Type: typing.Union[int, float]

This configuration controls the segment file size for the log.

Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#segment_bytes KafkaClusterTopic#segment_bytes}

`timeouts`^Optional

Type: KafkaClusterTopicTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#timeouts KafkaClusterTopic#timeouts}

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`put_timeouts`	No description.
`reset_location`	No description.
`reset_number_of_partitions`	No description.
`reset_replication_factor`	No description.
`reset_retention_time`	No description.
`reset_segment_bytes`	No description.
`reset_timeouts`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

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

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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

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

`id`^Required

Type: str

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

`move_to`

def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: typing.Union[str, typing.Union[int, float]]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

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

`id`^Required

Type: str

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

`put_timeouts`

def put_timeouts(
  create: str = None,
  default: str = None,
  delete: str = None,
  update: str = None
) -> None

`create`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#create KafkaClusterTopic#create}.

`default`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#default KafkaClusterTopic#default}.

`delete`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#delete KafkaClusterTopic#delete}.

`update`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#update KafkaClusterTopic#update}.

`reset_location`

def reset_location() -> None

`reset_number_of_partitions`

def reset_number_of_partitions() -> None

`reset_replication_factor`

def reset_replication_factor() -> None

`reset_retention_time`

def reset_retention_time() -> None

`reset_segment_bytes`

def reset_segment_bytes() -> None

`reset_timeouts`

def reset_timeouts() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a KafkaClusterTopic resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_ionoscloud import kafka_cluster_topic

kafkaClusterTopic.KafkaClusterTopic.is_construct(
  x: typing.Any
)

Checks if x is a construct.

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

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

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_ionoscloud import kafka_cluster_topic

kafkaClusterTopic.KafkaClusterTopic.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_ionoscloud import kafka_cluster_topic

kafkaClusterTopic.KafkaClusterTopic.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_ionoscloud import kafka_cluster_topic

kafkaClusterTopic.KafkaClusterTopic.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing KafkaClusterTopic that should be imported.

Refer to the {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_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 KafkaClusterTopic to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`id`	`str`	No description.
`timeouts`	`KafkaClusterTopicTimeoutsOutputReference`	No description.
`cluster_id_input`	`str`	No description.
`location_input`	`str`	No description.
`name_input`	`str`	No description.
`number_of_partitions_input`	`typing.Union[int, float]`	No description.
`replication_factor_input`	`typing.Union[int, float]`	No description.
`retention_time_input`	`typing.Union[int, float]`	No description.
`segment_bytes_input`	`typing.Union[int, float]`	No description.
`timeouts_input`	`typing.Union[cdktf.IResolvable, KafkaClusterTopicTimeouts]`	No description.
`cluster_id`	`str`	No description.
`location`	`str`	No description.
`name`	`str`	No description.
`number_of_partitions`	`typing.Union[int, float]`	No description.
`replication_factor`	`typing.Union[int, float]`	No description.
`retention_time`	`typing.Union[int, float]`	No description.
`segment_bytes`	`typing.Union[int, float]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`id`^Required

id: str

Type: str

`timeouts`^Required

timeouts: KafkaClusterTopicTimeoutsOutputReference

Type: KafkaClusterTopicTimeoutsOutputReference

`cluster_id_input`^Optional

cluster_id_input: str

Type: str

`location_input`^Optional

location_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`number_of_partitions_input`^Optional

number_of_partitions_input: typing.Union[int, float]

Type: typing.Union[int, float]

`replication_factor_input`^Optional

replication_factor_input: typing.Union[int, float]

Type: typing.Union[int, float]

`retention_time_input`^Optional

retention_time_input: typing.Union[int, float]

Type: typing.Union[int, float]

`segment_bytes_input`^Optional

segment_bytes_input: typing.Union[int, float]

Type: typing.Union[int, float]

`timeouts_input`^Optional

timeouts_input: typing.Union[IResolvable, KafkaClusterTopicTimeouts]

Type: typing.Union[cdktf.IResolvable, KafkaClusterTopicTimeouts]

`cluster_id`^Required

cluster_id: str

Type: str

`location`^Required

location: str

Type: str

`name`^Required

name: str

Type: str

`number_of_partitions`^Required

number_of_partitions: typing.Union[int, float]

Type: typing.Union[int, float]

`replication_factor`^Required

replication_factor: typing.Union[int, float]

Type: typing.Union[int, float]

`retention_time`^Required

retention_time: typing.Union[int, float]

Type: typing.Union[int, float]

`segment_bytes`^Required

segment_bytes: typing.Union[int, float]

Type: typing.Union[int, float]

Constants

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

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

KafkaClusterTopicConfig

Initializer

from cdktf_cdktf_provider_ionoscloud import kafka_cluster_topic

kafkaClusterTopic.KafkaClusterTopicConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  cluster_id: str,
  name: str,
  location: str = None,
  number_of_partitions: typing.Union[int, float] = None,
  replication_factor: typing.Union[int, float] = None,
  retention_time: typing.Union[int, float] = None,
  segment_bytes: typing.Union[int, float] = None,
  timeouts: KafkaClusterTopicTimeouts = None
)

Properties

Name	Type	Description
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`cluster_id`	`str`	The ID of the Kafka Cluster to which the topic belongs.
`name`	`str`	The name of your Kafka Cluster Topic.
`location`	`str`	The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl.
`number_of_partitions`	`typing.Union[int, float]`	The number of partitions of the topic.
`replication_factor`	`typing.Union[int, float]`	The number of replicas of the topic.
`retention_time`	`typing.Union[int, float]`	This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space.
`segment_bytes`	`typing.Union[int, float]`	This configuration controls the segment file size for the log.
`timeouts`	`KafkaClusterTopicTimeouts`	timeouts block.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`cluster_id`^Required

cluster_id: str

Type: str

The ID of the Kafka Cluster to which the topic belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#cluster_id KafkaClusterTopic#cluster_id}

`name`^Required

name: str

Type: str

The name of your Kafka Cluster Topic.

Must be 63 characters or less and must begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#name KafkaClusterTopic#name}

`location`^Optional

location: str

Type: str

The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#location KafkaClusterTopic#location}

`number_of_partitions`^Optional

number_of_partitions: typing.Union[int, float]

Type: typing.Union[int, float]

The number of partitions of the topic.

Partitions allow for parallel processing of messages. The partition count must be greater than or equal to the replication factor.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#number_of_partitions KafkaClusterTopic#number_of_partitions}

`replication_factor`^Optional

replication_factor: typing.Union[int, float]

Type: typing.Union[int, float]

The number of replicas of the topic.

The replication factor determines how many copies of the topic are stored on different brokers. The replication factor must be less than or equal to the number of brokers in the Kafka Cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#replication_factor KafkaClusterTopic#replication_factor}

`retention_time`^Optional

retention_time: typing.Union[int, float]

Type: typing.Union[int, float]

This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space.

This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#retention_time KafkaClusterTopic#retention_time}

`segment_bytes`^Optional

segment_bytes: typing.Union[int, float]

Type: typing.Union[int, float]

This configuration controls the segment file size for the log.

Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#segment_bytes KafkaClusterTopic#segment_bytes}

`timeouts`^Optional

timeouts: KafkaClusterTopicTimeouts

Type: KafkaClusterTopicTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#timeouts KafkaClusterTopic#timeouts}

KafkaClusterTopicTimeouts

Initializer

from cdktf_cdktf_provider_ionoscloud import kafka_cluster_topic

kafkaClusterTopic.KafkaClusterTopicTimeouts(
  create: str = None,
  default: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name	Type	Description
`create`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#create KafkaClusterTopic#create}.
`default`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#default KafkaClusterTopic#default}.
`delete`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#delete KafkaClusterTopic#delete}.
`update`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#update KafkaClusterTopic#update}.

`create`^Optional

create: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#create KafkaClusterTopic#create}.

`default`^Optional

default: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#default KafkaClusterTopic#default}.

`delete`^Optional

delete: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#delete KafkaClusterTopic#delete}.

`update`^Optional

update: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.8/docs/resources/kafka_cluster_topic#update KafkaClusterTopic#update}.

Classes

KafkaClusterTopicTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_ionoscloud import kafka_cluster_topic

kafkaClusterTopic.KafkaClusterTopicTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`compute_fqn`	No description.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.
`reset_create`	No description.
`reset_default`	No description.
`reset_delete`	No description.
`reset_update`	No description.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_create`

def reset_create() -> None

`reset_default`

def reset_default() -> None

`reset_delete`

def reset_delete() -> None

`reset_update`

def reset_update() -> None

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`create_input`	`str`	No description.
`default_input`	`str`	No description.
`delete_input`	`str`	No description.
`update_input`	`str`	No description.
`create`	`str`	No description.
`default`	`str`	No description.
`delete`	`str`	No description.
`update`	`str`	No description.
`internal_value`	`typing.Union[cdktf.IResolvable, KafkaClusterTopicTimeouts]`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

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

fqn: str

Type: str

`create_input`^Optional

create_input: str

Type: str

`default_input`^Optional

default_input: str

Type: str

`delete_input`^Optional

delete_input: str

Type: str

`update_input`^Optional

update_input: str

Type: str

`create`^Required

create: str

Type: str

`default`^Required

default: str

Type: str

`delete`^Required

delete: str

Type: str

`update`^Required

update: str

Type: str

`internal_value`^Optional

internal_value: typing.Union[IResolvable, KafkaClusterTopicTimeouts]

Type: typing.Union[cdktf.IResolvable, KafkaClusterTopicTimeouts]

Files

kafkaClusterTopic.python.md

Latest commit

History

kafkaClusterTopic.python.md

File metadata and controls

kafkaClusterTopic Submodule

Constructs