1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kafka
  6. getTopic
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.kafka.getTopic

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::Kafka::Topic

    Using getTopic

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTopic(args: GetTopicArgs, opts?: InvokeOptions): Promise<GetTopicResult>
function getTopicOutput(args: GetTopicOutputArgs, opts?: InvokeOptions): Output<GetTopicResult>
    def get_topic(id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTopicResult
def get_topic_output(id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTopicResult]
    func LookupTopic(ctx *Context, args *LookupTopicArgs, opts ...InvokeOption) (*LookupTopicResult, error)
func LookupTopicOutput(ctx *Context, args *LookupTopicOutputArgs, opts ...InvokeOption) LookupTopicResultOutput

    > Note: This function is named LookupTopic in the Go SDK.

    public static class GetTopic 
{
    public static Task<GetTopicResult> InvokeAsync(GetTopicArgs args, InvokeOptions? opts = null)
    public static Output<GetTopicResult> Invoke(GetTopicInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)
public static Output<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:kafka/getTopic:getTopic
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getTopic Result

    The following output properties are available:

    AccessPolicies List<Volcengine.GetTopicAccessPolicy>
    Custom permission configuration, which sets custom permissions for certain users on this Topic. Only required when AllAuthority is False.
    AllAuthority bool
    Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.
    CleanupPolicies List<string>
    Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.
    CreatedTime string
    Topic creation time.
    Description string
    Topic description. Maximum length: 128 characters.
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID.
    LogRetentionHours int
    Message retention period, in hours. The retention period at the Topic level ranges from 1 to 2160 hours (90 days).
    Parameters string
    Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.
    PartitionNumber int
    Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.
    ReplicaNumber int
    Number of Topic replicas. Can be set to 2 or 3; the default is 3.
    Status string
    Topic status.
    Tags List<Volcengine.GetTopicTag>
    Topic label information
    TopicName string
    Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).
    UsedStoragePercentageInInstance double
    The current Topic data size as a percentage of the instance's total storage space. Displayed on the console as a percentage with two decimal places.
    UsedStorageSpaceInBytes int
    Total storage space currently used by the Topic.
    AccessPolicies []GetTopicAccessPolicy
    Custom permission configuration, which sets custom permissions for certain users on this Topic. Only required when AllAuthority is False.
    AllAuthority bool
    Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.
    CleanupPolicies []string
    Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.
    CreatedTime string
    Topic creation time.
    Description string
    Topic description. Maximum length: 128 characters.
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID.
    LogRetentionHours int
    Message retention period, in hours. The retention period at the Topic level ranges from 1 to 2160 hours (90 days).
    Parameters string
    Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.
    PartitionNumber int
    Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.
    ReplicaNumber int
    Number of Topic replicas. Can be set to 2 or 3; the default is 3.
    Status string
    Topic status.
    Tags []GetTopicTag
    Topic label information
    TopicName string
    Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).
    UsedStoragePercentageInInstance float64
    The current Topic data size as a percentage of the instance's total storage space. Displayed on the console as a percentage with two decimal places.
    UsedStorageSpaceInBytes int
    Total storage space currently used by the Topic.
    accessPolicies List<GetTopicAccessPolicy>
    Custom permission configuration, which sets custom permissions for certain users on this Topic. Only required when AllAuthority is False.
    allAuthority Boolean
    Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.
    cleanupPolicies List<String>
    Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.
    createdTime String
    Topic creation time.
    description String
    Topic description. Maximum length: 128 characters.
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID.
    logRetentionHours Integer
    Message retention period, in hours. The retention period at the Topic level ranges from 1 to 2160 hours (90 days).
    parameters String
    Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.
    partitionNumber Integer
    Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.
    replicaNumber Integer
    Number of Topic replicas. Can be set to 2 or 3; the default is 3.
    status String
    Topic status.
    tags List<GetTopicTag>
    Topic label information
    topicName String
    Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).
    usedStoragePercentageInInstance Double
    The current Topic data size as a percentage of the instance's total storage space. Displayed on the console as a percentage with two decimal places.
    usedStorageSpaceInBytes Integer
    Total storage space currently used by the Topic.
    accessPolicies GetTopicAccessPolicy[]
    Custom permission configuration, which sets custom permissions for certain users on this Topic. Only required when AllAuthority is False.
    allAuthority boolean
    Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.
    cleanupPolicies string[]
    Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.
    createdTime string
    Topic creation time.
    description string
    Topic description. Maximum length: 128 characters.
    id string
    Uniquely identifies the resource.
    instanceId string
    Instance ID.
    logRetentionHours number
    Message retention period, in hours. The retention period at the Topic level ranges from 1 to 2160 hours (90 days).
    parameters string
    Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.
    partitionNumber number
    Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.
    replicaNumber number
    Number of Topic replicas. Can be set to 2 or 3; the default is 3.
    status string
    Topic status.
    tags GetTopicTag[]
    Topic label information
    topicName string
    Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).
    usedStoragePercentageInInstance number
    The current Topic data size as a percentage of the instance's total storage space. Displayed on the console as a percentage with two decimal places.
    usedStorageSpaceInBytes number
    Total storage space currently used by the Topic.
    access_policies Sequence[GetTopicAccessPolicy]
    Custom permission configuration, which sets custom permissions for certain users on this Topic. Only required when AllAuthority is False.
    all_authority bool
    Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.
    cleanup_policies Sequence[str]
    Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.
    created_time str
    Topic creation time.
    description str
    Topic description. Maximum length: 128 characters.
    id str
    Uniquely identifies the resource.
    instance_id str
    Instance ID.
    log_retention_hours int
    Message retention period, in hours. The retention period at the Topic level ranges from 1 to 2160 hours (90 days).
    parameters str
    Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.
    partition_number int
    Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.
    replica_number int
    Number of Topic replicas. Can be set to 2 or 3; the default is 3.
    status str
    Topic status.
    tags Sequence[GetTopicTag]
    Topic label information
    topic_name str
    Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).
    used_storage_percentage_in_instance float
    The current Topic data size as a percentage of the instance's total storage space. Displayed on the console as a percentage with two decimal places.
    used_storage_space_in_bytes int
    Total storage space currently used by the Topic.
    accessPolicies List<Property Map>
    Custom permission configuration, which sets custom permissions for certain users on this Topic. Only required when AllAuthority is False.
    allAuthority Boolean
    Whether read/write permissions are enabled by default for all users on the Topic to be created. true: (default) All users have read/write permissions for this Topic. false: Not all users have read/write permissions for this Topic. By default, users inherit their default permissions for this Topic. If the default permissions do not meet your requirements, you can specify custom permissions for a user on this Topic through AccessPolicies.
    cleanupPolicies List<String>
    Topic message cleanup policy supports the following three options: [delete]: The default message cleanup policy. When disk space is sufficient, messages are retained within the maximum retention period; when disk space is insufficient, old messages are deleted early to ensure service availability. [compact]: The COMPACT message cleanup policy consolidates messages by Key, retaining only the latest value for messages with the same Key, and removing older records. [delete,compact]: Configures both DELETE and COMPACT message cleanup policies. Messages will be deleted as soon as they meet any of the cleanup criteria.
    createdTime String
    Topic creation time.
    description String
    Topic description. Maximum length: 128 characters.
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID.
    logRetentionHours Number
    Message retention period, in hours. The retention period at the Topic level ranges from 1 to 2160 hours (90 days).
    parameters String
    Topic-level parameter configuration. Parameters description MinInsyncReplicaNumber:2: Minimum number of in-sync replicas. If the number of in-sync replicas is less than the configured value, messages cannot be written to the Topic. Higher values increase data reliability but reduce availability. The default is replica count minus 1. For Topic availability, it is recommended to set this to replica count minus 1. MessageMaxByte:12: Maximum message size, in MB, range 1–12. By default, inherits the instance's maximum message size setting. LogRetentionHours:72: Message retention period, in hours, range 0–2160 (up to 90 days). By default, inherits the instance's message retention period setting.
    partitionNumber Number
    Number of Topic partitions. The range is 1–300. If other Topics have already been created in the instance, the total number of partitions across all Topics must not exceed the partition limit of the instance. If the number of partitions does not meet your business needs, you can purchase more partitions to increase the partition limit of the instance.
    replicaNumber Number
    Number of Topic replicas. Can be set to 2 or 3; the default is 3.
    status String
    Topic status.
    tags List<Property Map>
    Topic label information
    topicName String
    Name of the Topic to be created. 3–64 characters. Must start with a letter or number. Supported characters include letters, numbers, hyphens (-), underscores (_), and periods (.).
    usedStoragePercentageInInstance Number
    The current Topic data size as a percentage of the instance's total storage space. Displayed on the console as a percentage with two decimal places.
    usedStorageSpaceInBytes Number
    Total storage space currently used by the Topic.

    Supporting Types

    GetTopicAccessPolicy

    AccessPolicy string
    SASL user access permissions for the current Topic. PubSub: publish and subscribe permissions. Pub: publish permission. Sub: subscribe permission.
    UserName string
    SASL username.
    AccessPolicy string
    SASL user access permissions for the current Topic. PubSub: publish and subscribe permissions. Pub: publish permission. Sub: subscribe permission.
    UserName string
    SASL username.
    accessPolicy String
    SASL user access permissions for the current Topic. PubSub: publish and subscribe permissions. Pub: publish permission. Sub: subscribe permission.
    userName String
    SASL username.
    accessPolicy string
    SASL user access permissions for the current Topic. PubSub: publish and subscribe permissions. Pub: publish permission. Sub: subscribe permission.
    userName string
    SASL username.
    access_policy str
    SASL user access permissions for the current Topic. PubSub: publish and subscribe permissions. Pub: publish permission. Sub: subscribe permission.
    user_name str
    SASL username.
    accessPolicy String
    SASL user access permissions for the current Topic. PubSub: publish and subscribe permissions. Pub: publish permission. Sub: subscribe permission.
    userName String
    SASL username.

    GetTopicTag

    Key string
    Label key.
    Value string
    Tag value.
    Key string
    Label key.
    Value string
    Tag value.
    key String
    Label key.
    value String
    Tag value.
    key string
    Label key.
    value string
    Tag value.
    key str
    Label key.
    value str
    Tag value.
    key String
    Label key.
    value String
    Tag value.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.