1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. kafka
  5. getInstance
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.kafka.getInstance

bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::Kafka::Instance

    Using getInstance

    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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
    def get_instance(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
    func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

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

    public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:kafka/getInstance:getInstance
  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.

    getInstance Result

    The following output properties are available:

    AccountId string
    Main account ID for creating the instance.
    ChargeInfo Byteplus.GetInstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    ComputeSpec string
    Instance compute specification.
    ConnectionInfos List<Byteplus.GetInstanceConnectionInfo>
    Connection information for the Kafka instance.
    CreatedTime string
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    EipId string
    EIP ID.
    Id string
    Uniquely identifies the resource.
    InstanceDescription string
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    InstanceId string
    Kafka instance ID.
    InstanceName string
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    InstanceStatus string
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    IpWhiteLists List<string>
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    NeedRebalance bool
    Whether to enable rebalancing.
    Parameters string
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    PartitionNumber int
    Number of partitions.
    PrivateDomainOnPublic bool
    Whether to enable public network domain resolution.
    ProjectName string
    IAM project to which the currently created Kafka instance belongs.
    StorageSpace int
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    StorageType string
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    SubnetId string
    VPC subnet ID where the instance is located.
    Tags List<Byteplus.GetInstanceTag>
    Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation.
    Topics List<string>
    List of topics under a Kafka instance
    UsableGroupNumber int
    The remaining number of available consumer groups for the current instance.
    UsablePartitionNumber int
    Number of available partitions remaining for the current instance.
    UsedGroupNumber int
    Number of consumer groups (Group) currently created in the instance.
    UsedPartitionNumber int
    Number of partitions currently used by the instance.
    UsedStorageSpace int
    Used storage space of the instance, measured in GiB.
    UsedTopicNumber int
    Number of topics created in the current instance.
    UserName string
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    UserPassword string
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    Version string
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    VpcId string
    Private network (VPC) ID where the instance is located.
    ZoneId string
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    AccountId string
    Main account ID for creating the instance.
    ChargeInfo GetInstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    ComputeSpec string
    Instance compute specification.
    ConnectionInfos []GetInstanceConnectionInfo
    Connection information for the Kafka instance.
    CreatedTime string
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    EipId string
    EIP ID.
    Id string
    Uniquely identifies the resource.
    InstanceDescription string
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    InstanceId string
    Kafka instance ID.
    InstanceName string
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    InstanceStatus string
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    IpWhiteLists []string
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    NeedRebalance bool
    Whether to enable rebalancing.
    Parameters string
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    PartitionNumber int
    Number of partitions.
    PrivateDomainOnPublic bool
    Whether to enable public network domain resolution.
    ProjectName string
    IAM project to which the currently created Kafka instance belongs.
    StorageSpace int
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    StorageType string
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    SubnetId string
    VPC subnet ID where the instance is located.
    Tags []GetInstanceTag
    Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation.
    Topics []string
    List of topics under a Kafka instance
    UsableGroupNumber int
    The remaining number of available consumer groups for the current instance.
    UsablePartitionNumber int
    Number of available partitions remaining for the current instance.
    UsedGroupNumber int
    Number of consumer groups (Group) currently created in the instance.
    UsedPartitionNumber int
    Number of partitions currently used by the instance.
    UsedStorageSpace int
    Used storage space of the instance, measured in GiB.
    UsedTopicNumber int
    Number of topics created in the current instance.
    UserName string
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    UserPassword string
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    Version string
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    VpcId string
    Private network (VPC) ID where the instance is located.
    ZoneId string
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    accountId String
    Main account ID for creating the instance.
    chargeInfo GetInstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    computeSpec String
    Instance compute specification.
    connectionInfos List<GetInstanceConnectionInfo>
    Connection information for the Kafka instance.
    createdTime String
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    eipId String
    EIP ID.
    id String
    Uniquely identifies the resource.
    instanceDescription String
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instanceId String
    Kafka instance ID.
    instanceName String
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    instanceStatus String
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    ipWhiteLists List<String>
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    needRebalance Boolean
    Whether to enable rebalancing.
    parameters String
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partitionNumber Integer
    Number of partitions.
    privateDomainOnPublic Boolean
    Whether to enable public network domain resolution.
    projectName String
    IAM project to which the currently created Kafka instance belongs.
    storageSpace Integer
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storageType String
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    subnetId String
    VPC subnet ID where the instance is located.
    tags List<GetInstanceTag>
    Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation.
    topics List<String>
    List of topics under a Kafka instance
    usableGroupNumber Integer
    The remaining number of available consumer groups for the current instance.
    usablePartitionNumber Integer
    Number of available partitions remaining for the current instance.
    usedGroupNumber Integer
    Number of consumer groups (Group) currently created in the instance.
    usedPartitionNumber Integer
    Number of partitions currently used by the instance.
    usedStorageSpace Integer
    Used storage space of the instance, measured in GiB.
    usedTopicNumber Integer
    Number of topics created in the current instance.
    userName String
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    userPassword String
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    version String
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpcId String
    Private network (VPC) ID where the instance is located.
    zoneId String
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    accountId string
    Main account ID for creating the instance.
    chargeInfo GetInstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    computeSpec string
    Instance compute specification.
    connectionInfos GetInstanceConnectionInfo[]
    Connection information for the Kafka instance.
    createdTime string
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    eipId string
    EIP ID.
    id string
    Uniquely identifies the resource.
    instanceDescription string
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instanceId string
    Kafka instance ID.
    instanceName string
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    instanceStatus string
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    ipWhiteLists string[]
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    needRebalance boolean
    Whether to enable rebalancing.
    parameters string
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partitionNumber number
    Number of partitions.
    privateDomainOnPublic boolean
    Whether to enable public network domain resolution.
    projectName string
    IAM project to which the currently created Kafka instance belongs.
    storageSpace number
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storageType string
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    subnetId string
    VPC subnet ID where the instance is located.
    tags GetInstanceTag[]
    Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation.
    topics string[]
    List of topics under a Kafka instance
    usableGroupNumber number
    The remaining number of available consumer groups for the current instance.
    usablePartitionNumber number
    Number of available partitions remaining for the current instance.
    usedGroupNumber number
    Number of consumer groups (Group) currently created in the instance.
    usedPartitionNumber number
    Number of partitions currently used by the instance.
    usedStorageSpace number
    Used storage space of the instance, measured in GiB.
    usedTopicNumber number
    Number of topics created in the current instance.
    userName string
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    userPassword string
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    version string
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpcId string
    Private network (VPC) ID where the instance is located.
    zoneId string
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    account_id str
    Main account ID for creating the instance.
    charge_info GetInstanceChargeInfo
    Billing type and related billing information for the Kafka instance.
    compute_spec str
    Instance compute specification.
    connection_infos Sequence[GetInstanceConnectionInfo]
    Connection information for the Kafka instance.
    created_time str
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    eip_id str
    EIP ID.
    id str
    Uniquely identifies the resource.
    instance_description str
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instance_id str
    Kafka instance ID.
    instance_name str
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    instance_status str
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    ip_white_lists Sequence[str]
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    need_rebalance bool
    Whether to enable rebalancing.
    parameters str
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partition_number int
    Number of partitions.
    private_domain_on_public bool
    Whether to enable public network domain resolution.
    project_name str
    IAM project to which the currently created Kafka instance belongs.
    storage_space int
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storage_type str
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    subnet_id str
    VPC subnet ID where the instance is located.
    tags Sequence[GetInstanceTag]
    Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation.
    topics Sequence[str]
    List of topics under a Kafka instance
    usable_group_number int
    The remaining number of available consumer groups for the current instance.
    usable_partition_number int
    Number of available partitions remaining for the current instance.
    used_group_number int
    Number of consumer groups (Group) currently created in the instance.
    used_partition_number int
    Number of partitions currently used by the instance.
    used_storage_space int
    Used storage space of the instance, measured in GiB.
    used_topic_number int
    Number of topics created in the current instance.
    user_name str
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    user_password str
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    version str
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpc_id str
    Private network (VPC) ID where the instance is located.
    zone_id str
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.
    accountId String
    Main account ID for creating the instance.
    chargeInfo Property Map
    Billing type and related billing information for the Kafka instance.
    computeSpec String
    Instance compute specification.
    connectionInfos List<Property Map>
    Connection information for the Kafka instance.
    createdTime String
    Instance creation time. Time format: YYYY-MM-DD'T'HH:MM:SS'Z'.
    eipId String
    EIP ID.
    id String
    Uniquely identifies the resource.
    instanceDescription String
    Brief description of the Kafka instance. Length must be between 1 and 128 characters.
    instanceId String
    Kafka instance ID.
    instanceName String
    Name of the Kafka instance. Only Chinese characters, letters, numbers, underscores (_), and hyphens (-) are allowed. Cannot start with a number or hyphen (-). Length must be between 1 and 128 characters.
    instanceStatus String
    Status of the Kafka instance. Error: error, Deleting: deleting, Creating: deploying, Upgrading: upgrading, Updating: updating, Running: running, Scaling: scaling, Rebuilding: rebuilding, Destroying: destroying, Restarting: restarting, Migrating: migrating, Restoring: restoring, Importing: importing, NetCreating: applying for public network, NetReleasing: releasing public network, Rollingback: rolling back, CreateFailed: creation failed, UpgradeFailed: upgrade failed, ScaleFailed: scaling failed, RestartFailed: restart failed
    ipWhiteLists List<String>
    List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and ranges configured in the allowlist can access this instance. If this parameter is not set, the new Kafka instance will bind the allowlist 'default', with IP address 0.0.0.0, allowing all addresses to access the Kafka instance.
    needRebalance Boolean
    Whether to enable rebalancing.
    parameters String
    Initial parameter configuration for Kafka instances, formatted as JSON. Parameter list: Maximum message size (MessageMaxByte) 1–12 MB, default 10; message retention time (LogRetentionHours) 0–2160 hours, default 72; offset retention duration (OffsetRetentionMinutes) 1–10080 minutes, default 4320; message timestamp type (MessageTimestampType) LogAppendTime/CreateTime—time when the message is written to the server or when the producer creates the message.
    partitionNumber Number
    Number of partitions.
    privateDomainOnPublic Boolean
    Whether to enable public network domain resolution.
    projectName String
    IAM project to which the currently created Kafka instance belongs.
    storageSpace Number
    Instance storage space, measured in GiB, must be specified as a multiple of 100.
    storageType String
    Cloud disk type for Kafka instance data storage. Can be set to ESSDFlexPL or ESSDPL0; default is ESSD_FlexPL.
    subnetId String
    VPC subnet ID where the instance is located.
    tags List<Property Map>
    Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation.
    topics List<String>
    List of topics under a Kafka instance
    usableGroupNumber Number
    The remaining number of available consumer groups for the current instance.
    usablePartitionNumber Number
    Number of available partitions remaining for the current instance.
    usedGroupNumber Number
    Number of consumer groups (Group) currently created in the instance.
    usedPartitionNumber Number
    Number of partitions currently used by the instance.
    usedStorageSpace Number
    Used storage space of the instance, measured in GiB.
    usedTopicNumber Number
    Number of topics created in the current instance.
    userName String
    SASL/PLAIN username. Requirements: 1. Consists of lowercase letters, numbers, hyphens (-), or underscores. 2. Length: 3–64 characters. 3. Username cannot be set to admin or monitor, and must be unique within the instance.
    userPassword String
    Password for SASL/PLAIN users. Must meet the following requirements: 1. Length between 8 and 32 characters 2. Must contain any three of the following: uppercase letters, lowercase letters, numbers, special characters 3. Supported special characters: !@#$%^&*()_+-=
    version String
    Supported Kafka versions. Currently supported versions include 2.2.2 and 2.8.2.
    vpcId String
    Private network (VPC) ID where the instance is located.
    zoneId String
    Availability zone ID where the instance is located. Message Queue for Kafka instances support cross-AZ deployment; separate multiple availability zone IDs with commas.

    Supporting Types

    GetInstanceChargeInfo

    AutoRenew bool
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    ChargeExpireTime string
    Expiration time for the subscription instance.
    ChargeStartTime string
    Instance billing start time.
    ChargeStatus string
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    ChargeType string
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    OverdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment.
    OverdueTime string
    Instance suspension time due to overdue payment.
    Period int
    Purchase duration for subscription-based instances.
    PeriodUnit string
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    AutoRenew bool
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    ChargeExpireTime string
    Expiration time for the subscription instance.
    ChargeStartTime string
    Instance billing start time.
    ChargeStatus string
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    ChargeType string
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    OverdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment.
    OverdueTime string
    Instance suspension time due to overdue payment.
    Period int
    Purchase duration for subscription-based instances.
    PeriodUnit string
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    autoRenew Boolean
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    chargeExpireTime String
    Expiration time for the subscription instance.
    chargeStartTime String
    Instance billing start time.
    chargeStatus String
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    chargeType String
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    overdueReclaimTime String
    Estimated release time after the instance is stopped due to overdue payment.
    overdueTime String
    Instance suspension time due to overdue payment.
    period Integer
    Purchase duration for subscription-based instances.
    periodUnit String
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    autoRenew boolean
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    chargeExpireTime string
    Expiration time for the subscription instance.
    chargeStartTime string
    Instance billing start time.
    chargeStatus string
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    chargeType string
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    overdueReclaimTime string
    Estimated release time after the instance is stopped due to overdue payment.
    overdueTime string
    Instance suspension time due to overdue payment.
    period number
    Purchase duration for subscription-based instances.
    periodUnit string
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    auto_renew bool
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    charge_expire_time str
    Expiration time for the subscription instance.
    charge_start_time str
    Instance billing start time.
    charge_status str
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    charge_type str
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    overdue_reclaim_time str
    Estimated release time after the instance is stopped due to overdue payment.
    overdue_time str
    Instance suspension time due to overdue payment.
    period int
    Purchase duration for subscription-based instances.
    period_unit str
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).
    autoRenew Boolean
    Whether to automatically renew the subscription instance after expiration. true - auto renewal; false (default) - no auto renewal, instance will be stopped upon expiration.
    chargeExpireTime String
    Expiration time for the subscription instance.
    chargeStartTime String
    Instance billing start time.
    chargeStatus String
    Billing status of the instance. Supported types: Normal - normal, Overdue - pay-as-you-go overdue, Expired - subscription expired
    chargeType String
    Billing type for the instance. Supported types: PostPaid - pay-as-you-go, PrePaid - subscription.
    overdueReclaimTime String
    Estimated release time after the instance is stopped due to overdue payment.
    overdueTime String
    Instance suspension time due to overdue payment.
    period Number
    Purchase duration for subscription-based instances.
    periodUnit String
    The lifecycle unit for subscription-based instances, specifying purchase by month (Month/Monthly) or by year (Year/Yearly).

    GetInstanceConnectionInfo

    EndpointType string
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    InternalEndpoint string
    Instance private network access domain name.
    NetworkType string
    Network type for the access point. Unified as PrivateNetwork.
    PublicEndpoint string
    Public access domain name for the instance.
    EndpointType string
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    InternalEndpoint string
    Instance private network access domain name.
    NetworkType string
    Network type for the access point. Unified as PrivateNetwork.
    PublicEndpoint string
    Public access domain name for the instance.
    endpointType String
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    internalEndpoint String
    Instance private network access domain name.
    networkType String
    Network type for the access point. Unified as PrivateNetwork.
    publicEndpoint String
    Public access domain name for the instance.
    endpointType string
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    internalEndpoint string
    Instance private network access domain name.
    networkType string
    Network type for the access point. Unified as PrivateNetwork.
    publicEndpoint string
    Public access domain name for the instance.
    endpoint_type str
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    internal_endpoint str
    Instance private network access domain name.
    network_type str
    Network type for the access point. Unified as PrivateNetwork.
    public_endpoint str
    Public access domain name for the instance.
    endpointType String
    Instance endpoint type. PLAINTEXT: default endpoint. SASLPLAINTEXT: SASL endpoint (private network). SASLSSL: SASL endpoint (public network). If public access is not enabled, this endpoint is not provided.
    internalEndpoint String
    Instance private network access domain name.
    networkType String
    Network type for the access point. Unified as PrivateNetwork.
    publicEndpoint String
    Public access domain name for the instance.

    GetInstanceTag

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.21
    published on Thursday, Apr 2, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.