Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ionoscloud Provider
  3. API Docs
  4. KafkaClusterTopic
ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud
ionos-cloud/terraform-provider-ionoscloud

ionoscloud.KafkaClusterTopic

Explore with Pulumi AI

ionoscloud logo
ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud
ionos-cloud/terraform-provider-ionoscloud

    Create KafkaClusterTopic Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new KafkaClusterTopic(name: string, args: KafkaClusterTopicArgs, opts?: CustomResourceOptions);
    @overload
def KafkaClusterTopic(resource_name: str,
                      args: KafkaClusterTopicArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def KafkaClusterTopic(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cluster_id: Optional[str] = None,
                      location: Optional[str] = None,
                      name: Optional[str] = None,
                      number_of_partitions: Optional[float] = None,
                      replication_factor: Optional[float] = None,
                      retention_time: Optional[float] = None,
                      segment_bytes: Optional[float] = None,
                      timeouts: Optional[KafkaClusterTopicTimeoutsArgs] = None)
    func NewKafkaClusterTopic(ctx *Context, name string, args KafkaClusterTopicArgs, opts ...ResourceOption) (*KafkaClusterTopic, error)
    public KafkaClusterTopic(string name, KafkaClusterTopicArgs args, CustomResourceOptions? opts = null)
    public KafkaClusterTopic(String name, KafkaClusterTopicArgs args)
public KafkaClusterTopic(String name, KafkaClusterTopicArgs args, CustomResourceOptions options)

    type: ionoscloud:KafkaClusterTopic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args KafkaClusterTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args KafkaClusterTopicArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args KafkaClusterTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KafkaClusterTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KafkaClusterTopicArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var kafkaClusterTopicResource = new Ionoscloud.KafkaClusterTopic("kafkaClusterTopicResource", new()
{
    ClusterId = "string",
    Location = "string",
    Name = "string",
    NumberOfPartitions = 0,
    ReplicationFactor = 0,
    RetentionTime = 0,
    SegmentBytes = 0,
    Timeouts = new Ionoscloud.Inputs.KafkaClusterTopicTimeoutsArgs
    {
        Create = "string",
        Default = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ionoscloud.NewKafkaClusterTopic(ctx, "kafkaClusterTopicResource", &ionoscloud.KafkaClusterTopicArgs{
	ClusterId:          pulumi.String("string"),
	Location:           pulumi.String("string"),
	Name:               pulumi.String("string"),
	NumberOfPartitions: pulumi.Float64(0),
	ReplicationFactor:  pulumi.Float64(0),
	RetentionTime:      pulumi.Float64(0),
	SegmentBytes:       pulumi.Float64(0),
	Timeouts: &ionoscloud.KafkaClusterTopicTimeoutsArgs{
		Create:  pulumi.String("string"),
		Default: pulumi.String("string"),
		Delete:  pulumi.String("string"),
		Update:  pulumi.String("string"),
	},
})

    var kafkaClusterTopicResource = new KafkaClusterTopic("kafkaClusterTopicResource", KafkaClusterTopicArgs.builder()
    .clusterId("string")
    .location("string")
    .name("string")
    .numberOfPartitions(0)
    .replicationFactor(0)
    .retentionTime(0)
    .segmentBytes(0)
    .timeouts(KafkaClusterTopicTimeoutsArgs.builder()
        .create("string")
        .default_("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    kafka_cluster_topic_resource = ionoscloud.KafkaClusterTopic("kafkaClusterTopicResource",
    cluster_id="string",
    location="string",
    name="string",
    number_of_partitions=0,
    replication_factor=0,
    retention_time=0,
    segment_bytes=0,
    timeouts={
        "create": "string",
        "default": "string",
        "delete": "string",
        "update": "string",
    })

    const kafkaClusterTopicResource = new ionoscloud.KafkaClusterTopic("kafkaClusterTopicResource", {
    clusterId: "string",
    location: "string",
    name: "string",
    numberOfPartitions: 0,
    replicationFactor: 0,
    retentionTime: 0,
    segmentBytes: 0,
    timeouts: {
        create: "string",
        "default": "string",
        "delete": "string",
        update: "string",
    },
});

    type: ionoscloud:KafkaClusterTopic
properties:
    clusterId: string
    location: string
    name: string
    numberOfPartitions: 0
    replicationFactor: 0
    retentionTime: 0
    segmentBytes: 0
    timeouts:
        create: string
        default: string
        delete: string
        update: string

    KafkaClusterTopic Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The KafkaClusterTopic resource accepts the following input properties:

    ClusterId string
    The ID of the Kafka Cluster to which the topic belongs.
    Location string
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    Name string
    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.
    NumberOfPartitions double
    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.
    ReplicationFactor double
    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.
    RetentionTime double
    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.
    SegmentBytes double
    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.
    Timeouts KafkaClusterTopicTimeouts
    ClusterId string
    The ID of the Kafka Cluster to which the topic belongs.
    Location string
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    Name string
    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.
    NumberOfPartitions float64
    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.
    ReplicationFactor float64
    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.
    RetentionTime float64
    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.
    SegmentBytes float64
    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.
    Timeouts KafkaClusterTopicTimeoutsArgs
    clusterId String
    The ID of the Kafka Cluster to which the topic belongs.
    location String
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    name String
    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.
    numberOfPartitions Double
    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.
    replicationFactor Double
    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.
    retentionTime Double
    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.
    segmentBytes Double
    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.
    timeouts KafkaClusterTopicTimeouts
    clusterId string
    The ID of the Kafka Cluster to which the topic belongs.
    location string
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    name string
    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.
    numberOfPartitions number
    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.
    replicationFactor number
    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.
    retentionTime number
    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.
    segmentBytes number
    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.
    timeouts KafkaClusterTopicTimeouts
    cluster_id str
    The ID of the Kafka Cluster to which the topic belongs.
    location str
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    name 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.
    number_of_partitions 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.
    replication_factor 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.
    retention_time 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.
    segment_bytes 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.
    timeouts KafkaClusterTopicTimeoutsArgs
    clusterId String
    The ID of the Kafka Cluster to which the topic belongs.
    location String
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    name String
    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.
    numberOfPartitions Number
    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.
    replicationFactor Number
    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.
    retentionTime Number
    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.
    segmentBytes Number
    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.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the KafkaClusterTopic resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing KafkaClusterTopic Resource

    Get an existing KafkaClusterTopic resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: KafkaClusterTopicState, opts?: CustomResourceOptions): KafkaClusterTopic
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        number_of_partitions: Optional[float] = None,
        replication_factor: Optional[float] = None,
        retention_time: Optional[float] = None,
        segment_bytes: Optional[float] = None,
        timeouts: Optional[KafkaClusterTopicTimeoutsArgs] = None) -> KafkaClusterTopic
    func GetKafkaClusterTopic(ctx *Context, name string, id IDInput, state *KafkaClusterTopicState, opts ...ResourceOption) (*KafkaClusterTopic, error)
    public static KafkaClusterTopic Get(string name, Input<string> id, KafkaClusterTopicState? state, CustomResourceOptions? opts = null)
    public static KafkaClusterTopic get(String name, Output<String> id, KafkaClusterTopicState state, CustomResourceOptions options)
    resources:  _:    type: ionoscloud:KafkaClusterTopic    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClusterId string
    The ID of the Kafka Cluster to which the topic belongs.
    Location string
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    Name string
    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.
    NumberOfPartitions double
    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.
    ReplicationFactor double
    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.
    RetentionTime double
    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.
    SegmentBytes double
    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.
    Timeouts KafkaClusterTopicTimeouts
    ClusterId string
    The ID of the Kafka Cluster to which the topic belongs.
    Location string
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    Name string
    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.
    NumberOfPartitions float64
    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.
    ReplicationFactor float64
    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.
    RetentionTime float64
    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.
    SegmentBytes float64
    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.
    Timeouts KafkaClusterTopicTimeoutsArgs
    clusterId String
    The ID of the Kafka Cluster to which the topic belongs.
    location String
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    name String
    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.
    numberOfPartitions Double
    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.
    replicationFactor Double
    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.
    retentionTime Double
    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.
    segmentBytes Double
    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.
    timeouts KafkaClusterTopicTimeouts
    clusterId string
    The ID of the Kafka Cluster to which the topic belongs.
    location string
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    name string
    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.
    numberOfPartitions number
    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.
    replicationFactor number
    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.
    retentionTime number
    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.
    segmentBytes number
    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.
    timeouts KafkaClusterTopicTimeouts
    cluster_id str
    The ID of the Kafka Cluster to which the topic belongs.
    location str
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    name 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.
    number_of_partitions 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.
    replication_factor 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.
    retention_time 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.
    segment_bytes 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.
    timeouts KafkaClusterTopicTimeoutsArgs
    clusterId String
    The ID of the Kafka Cluster to which the topic belongs.
    location String
    The location of your Kafka Cluster Topic. Supported locations: de/fra, de/txl
    name String
    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.
    numberOfPartitions Number
    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.
    replicationFactor Number
    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.
    retentionTime Number
    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.
    segmentBytes Number
    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.
    timeouts Property Map

    Supporting Types

    KafkaClusterTopicTimeouts, KafkaClusterTopicTimeoutsArgs

    Create string
    Default string
    Delete string
    Update string
    Create string
    Default string
    Delete string
    Update string
    create String
    default_ String
    delete String
    update String
    create string
    default string
    delete string
    update string
    create String
    default String
    delete String
    update String

    Package Details

    Repository
    ionoscloud ionos-cloud/terraform-provider-ionoscloud
    License
    Notes
    This Pulumi package is based on the ionoscloud Terraform Provider.
    ionoscloud logo
    ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud
    ionos-cloud/terraform-provider-ionoscloud