This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

alikafka¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.alikafka.ConsumerGroup(resource_name, opts=None, consumer_id=None, instance_id=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides an ALIKAFKA consumer group resource.

NOTE: Available in 1.56.0+
NOTE: Only the following regions support create alikafka consumer group. [cn-hangzhou,cn-beijing,cn-shenzhen,cn-shanghai,cn-qingdao,cn-hongkong,cn-huhehaote,cn-zhangjiakou,ap-southeast-1,ap-south-1,ap-southeast-5]

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
consumer_id = config.get("consumerId")
if consumer_id is None:
    consumer_id = "CID-alikafkaGroupDatasourceName"
default_zones = alicloud.get_zones(available_resource_creation="VSwitch")
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/12")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.alikafka.Instance("defaultInstance",
    deploy_type="5",
    disk_size="500",
    disk_type="1",
    io_max="20",
    topic_quota="50",
    vswitch_id=default_switch.id)
default_consumer_group = alicloud.alikafka.ConsumerGroup("defaultConsumerGroup",
    consumer_id=consumer_id,
    instance_id=default_instance.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
consumer_id (pulumi.Input[str]) – ID of the consumer group. The length cannot exceed 64 characters.
instance_id (pulumi.Input[str]) – ID of the ALIKAFKA Instance that owns the groups.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

consumer_id: pulumi.Output[str] = None¶: ID of the consumer group. The length cannot exceed 64 characters.

instance_id: pulumi.Output[str] = None¶: ID of the ALIKAFKA Instance that owns the groups.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, consumer_id=None, instance_id=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
consumer_id (pulumi.Input[str]) – ID of the consumer group. The length cannot exceed 64 characters.
instance_id (pulumi.Input[str]) – ID of the ALIKAFKA Instance that owns the groups.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.alikafka.Instance(resource_name, opts=None, deploy_type=None, disk_size=None, disk_type=None, eip_max=None, io_max=None, name=None, paid_type=None, spec_type=None, tags=None, topic_quota=None, vswitch_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides an ALIKAFKA instance resource.

NOTE: Available in 1.59.0+
NOTE: ALIKAFKA instance resource only support create post pay instance. Creation or modification may took about 10-40 minutes.
NOTE: Only the following regions support create alikafka pre paid instance. [cn-hangzhou,cn-beijing,cn-shenzhen,cn-shanghai,cn-qingdao,cn-hongkong,cn-huhehaote,cn-zhangjiakou,ap-southeast-1,ap-south-1,ap-southeast-5]
NOTE: Only the following regions support create alikafka post paid instance. [cn-hangzhou,cn-beijing,cn-shenzhen,cn-shanghai,cn-qingdao,cn-hongkong,cn-huhehaote,cn-zhangjiakou,ap-southeast-1]

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
instance_name = config.get("instanceName")
if instance_name is None:
    instance_name = "alikafkaInstanceName"
default_zones = alicloud.get_zones(available_resource_creation="VSwitch")
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/12")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.alikafka.Instance("defaultInstance",
    deploy_type="4",
    disk_size="500",
    disk_type="1",
    io_max="20",
    topic_quota="50",
    vswitch_id=default_switch.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
deploy_type (pulumi.Input[float]) – The deploy type of the instance. Currently only support two deploy type, 4: eip/vpc instance, 5: vpc instance.
disk_size (pulumi.Input[float]) – The disk size of the instance. When modify this value, it only support adjust to a greater value.
disk_type (pulumi.Input[float]) – The disk type of the instance. 0: efficient cloud disk , 1: SSD.
eip_max (pulumi.Input[float]) – The max bandwidth of the instance. When modify this value, it only support adjust to a greater value.
io_max (pulumi.Input[float]) – The max value of io of the instance. When modify this value, it only support adjust to a greater value.
name (pulumi.Input[str]) – Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
paid_type (pulumi.Input[str]) – The paid type of the instance. Support two type, “PrePaid”: pre paid type instance, “PostPaid”: post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
spec_type (pulumi.Input[str]) – The spec type of the instance. Support two type, “normal”: normal version instance, “professional”: professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
topic_quota (pulumi.Input[float]) – The max num of topic can be create of the instance. When modify this value, it only adjust to a greater value.
vswitch_id (pulumi.Input[str]) – The ID of attaching vswitch to instance.

deploy_type: pulumi.Output[float] = None¶: The deploy type of the instance. Currently only support two deploy type, 4: eip/vpc instance, 5: vpc instance.

disk_size: pulumi.Output[float] = None¶: The disk size of the instance. When modify this value, it only support adjust to a greater value.

disk_type: pulumi.Output[float] = None¶: The disk type of the instance. 0: efficient cloud disk , 1: SSD.

eip_max: pulumi.Output[float] = None¶: The max bandwidth of the instance. When modify this value, it only support adjust to a greater value.

io_max: pulumi.Output[float] = None¶: The max value of io of the instance. When modify this value, it only support adjust to a greater value.

name: pulumi.Output[str] = None¶: Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.

paid_type: pulumi.Output[str] = None¶: The paid type of the instance. Support two type, “PrePaid”: pre paid type instance, “PostPaid”: post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.

spec_type: pulumi.Output[str] = None¶: The spec type of the instance. Support two type, “normal”: normal version instance, “professional”: professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

topic_quota: pulumi.Output[float] = None¶: The max num of topic can be create of the instance. When modify this value, it only adjust to a greater value.

vpc_id: pulumi.Output[str] = None¶: The ID of attaching VPC to instance.

vswitch_id: pulumi.Output[str] = None¶: The ID of attaching vswitch to instance.

zone_id: pulumi.Output[str] = None¶: The Zone to launch the kafka instance.

static get(resource_name, id, opts=None, deploy_type=None, disk_size=None, disk_type=None, eip_max=None, io_max=None, name=None, paid_type=None, spec_type=None, tags=None, topic_quota=None, vpc_id=None, vswitch_id=None, zone_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
deploy_type (pulumi.Input[float]) – The deploy type of the instance. Currently only support two deploy type, 4: eip/vpc instance, 5: vpc instance.
disk_size (pulumi.Input[float]) – The disk size of the instance. When modify this value, it only support adjust to a greater value.
disk_type (pulumi.Input[float]) – The disk type of the instance. 0: efficient cloud disk , 1: SSD.
eip_max (pulumi.Input[float]) – The max bandwidth of the instance. When modify this value, it only support adjust to a greater value.
io_max (pulumi.Input[float]) – The max value of io of the instance. When modify this value, it only support adjust to a greater value.
name (pulumi.Input[str]) – Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.
paid_type (pulumi.Input[str]) – The paid type of the instance. Support two type, “PrePaid”: pre paid type instance, “PostPaid”: post paid type instance. Default is PostPaid. When modify this value, it only support adjust from post pay to pre pay.
spec_type (pulumi.Input[str]) – The spec type of the instance. Support two type, “normal”: normal version instance, “professional”: professional version instance. Default is normal. When modify this value, it only support adjust from normal to professional. Note only pre paid type instance support professional specific type.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
topic_quota (pulumi.Input[float]) – The max num of topic can be create of the instance. When modify this value, it only adjust to a greater value.
vpc_id (pulumi.Input[str]) – The ID of attaching VPC to instance.
vswitch_id (pulumi.Input[str]) – The ID of attaching vswitch to instance.
zone_id (pulumi.Input[str]) – The Zone to launch the kafka instance.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.alikafka.SaslAcl(resource_name, opts=None, acl_operation_type=None, acl_resource_name=None, acl_resource_pattern_type=None, acl_resource_type=None, instance_id=None, username=None, __props__=None, __name__=None, __opts__=None)¶

Provides an ALIKAFKA sasl acl resource.

NOTE: Available in 1.66.0+
NOTE: Only the following regions support create alikafka sasl user. [cn-hangzhou,cn-beijing,cn-shenzhen,cn-shanghai,cn-qingdao,cn-hongkong,cn-huhehaote,cn-zhangjiakou,ap-southeast-1,ap-south-1,ap-southeast-5]

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
username = config.get("username")
if username is None:
    username = "testusername"
password = config.get("password")
if password is None:
    password = "testpassword"
default_zones = alicloud.get_zones(available_resource_creation="VSwitch")
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/12")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.alikafka.Instance("defaultInstance",
    deploy_type="5",
    disk_size="500",
    disk_type="1",
    io_max="20",
    topic_quota="50",
    vswitch_id=default_switch.id)
default_topic = alicloud.alikafka.Topic("defaultTopic",
    instance_id=default_instance.id,
    remark="topic-remark",
    topic="test-topic")
default_sasl_user = alicloud.alikafka.SaslUser("defaultSaslUser",
    instance_id=default_instance.id,
    password=password,
    username=username)
default_sasl_acl = alicloud.alikafka.SaslAcl("defaultSaslAcl",
    acl_operation_type="Write",
    acl_resource_name=default_topic.topic,
    acl_resource_pattern_type="LITERAL",
    acl_resource_type="Topic",
    instance_id=default_instance.id,
    username=default_sasl_user.username)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
acl_operation_type (pulumi.Input[str]) – Operation type for this acl. The operation type can only be “Write” and “Read”.
acl_resource_name (pulumi.Input[str]) – Resource name for this acl. The resource name should be a topic or consumer group name.
acl_resource_pattern_type (pulumi.Input[str]) – Resource pattern type for this acl. The resource pattern support two types “LITERAL” and “PREFIXED”. “LITERAL”: A literal name defines the full name of a resource. The special wildcard character “*” can be used to represent a resource with any name. “PREFIXED”: A prefixed name defines a prefix for a resource.
acl_resource_type (pulumi.Input[str]) – Resource type for this acl. The resource type can only be “Topic” and “Group”.
instance_id (pulumi.Input[str]) – ID of the ALIKAFKA Instance that owns the groups.
username (pulumi.Input[str]) – Username for the sasl user. The length should between 1 to 64 characters. The user should be an existed sasl user.

acl_operation_type: pulumi.Output[str] = None¶: Operation type for this acl. The operation type can only be “Write” and “Read”.

acl_resource_name: pulumi.Output[str] = None¶: Resource name for this acl. The resource name should be a topic or consumer group name.

acl_resource_pattern_type: pulumi.Output[str] = None¶: Resource pattern type for this acl. The resource pattern support two types “LITERAL” and “PREFIXED”. “LITERAL”: A literal name defines the full name of a resource. The special wildcard character “*” can be used to represent a resource with any name. “PREFIXED”: A prefixed name defines a prefix for a resource.

acl_resource_type: pulumi.Output[str] = None¶: Resource type for this acl. The resource type can only be “Topic” and “Group”.

host: pulumi.Output[str] = None¶: The host of the acl.

instance_id: pulumi.Output[str] = None¶: ID of the ALIKAFKA Instance that owns the groups.

username: pulumi.Output[str] = None¶: Username for the sasl user. The length should between 1 to 64 characters. The user should be an existed sasl user.

static get(resource_name, id, opts=None, acl_operation_type=None, acl_resource_name=None, acl_resource_pattern_type=None, acl_resource_type=None, host=None, instance_id=None, username=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
acl_operation_type (pulumi.Input[str]) – Operation type for this acl. The operation type can only be “Write” and “Read”.
acl_resource_name (pulumi.Input[str]) – Resource name for this acl. The resource name should be a topic or consumer group name.
acl_resource_pattern_type (pulumi.Input[str]) – Resource pattern type for this acl. The resource pattern support two types “LITERAL” and “PREFIXED”. “LITERAL”: A literal name defines the full name of a resource. The special wildcard character “*” can be used to represent a resource with any name. “PREFIXED”: A prefixed name defines a prefix for a resource.
acl_resource_type (pulumi.Input[str]) – Resource type for this acl. The resource type can only be “Topic” and “Group”.
host (pulumi.Input[str]) – The host of the acl.
instance_id (pulumi.Input[str]) – ID of the ALIKAFKA Instance that owns the groups.
username (pulumi.Input[str]) – Username for the sasl user. The length should between 1 to 64 characters. The user should be an existed sasl user.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.alikafka.SaslUser(resource_name, opts=None, instance_id=None, kms_encrypted_password=None, kms_encryption_context=None, password=None, username=None, __props__=None, __name__=None, __opts__=None)¶

Provides an ALIKAFKA sasl user resource.

NOTE: Available in 1.66.0+
NOTE: Only the following regions support create alikafka sasl user. [cn-hangzhou,cn-beijing,cn-shenzhen,cn-shanghai,cn-qingdao,cn-hongkong,cn-huhehaote,cn-zhangjiakou,ap-southeast-1,ap-south-1,ap-southeast-5]

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
username = config.get("username")
if username is None:
    username = "testusername"
password = config.get("password")
if password is None:
    password = "testpassword"
default_zones = alicloud.get_zones(available_resource_creation="VSwitch")
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/12")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.alikafka.Instance("defaultInstance",
    deploy_type="5",
    disk_size="500",
    disk_type="1",
    io_max="20",
    topic_quota="50",
    vswitch_id=default_switch.id)
default_sasl_user = alicloud.alikafka.SaslUser("defaultSaslUser",
    instance_id=default_instance.id,
    password=password,
    username=username)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_id (pulumi.Input[str]) – ID of the ALIKAFKA Instance that owns the groups.
kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a db account. You have to specify one of password and kms_encrypted_password fields.
kms_encryption_context (pulumi.Input[dict]) – An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a user with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
password (pulumi.Input[str]) – Operation password. It may consist of letters, digits, or underlines, with a length of 1 to 64 characters. You have to specify one of password and kms_encrypted_password fields.
username (pulumi.Input[str]) – Username for the sasl user. The length should between 1 to 64 characters. The characters can only contain ‘a’-‘z’, ‘A’-‘Z’, ‘0’-‘9’, ‘_’ and ‘-‘.

instance_id: pulumi.Output[str] = None¶: ID of the ALIKAFKA Instance that owns the groups.

kms_encrypted_password: pulumi.Output[str] = None¶: An KMS encrypts password used to a db account. You have to specify one of password and kms_encrypted_password fields.

kms_encryption_context: pulumi.Output[dict] = None¶: An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a user with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

password: pulumi.Output[str] = None¶: Operation password. It may consist of letters, digits, or underlines, with a length of 1 to 64 characters. You have to specify one of password and kms_encrypted_password fields.

username: pulumi.Output[str] = None¶: Username for the sasl user. The length should between 1 to 64 characters. The characters can only contain ‘a’-‘z’, ‘A’-‘Z’, ‘0’-‘9’, ‘_’ and ‘-‘.

static get(resource_name, id, opts=None, instance_id=None, kms_encrypted_password=None, kms_encryption_context=None, password=None, username=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_id (pulumi.Input[str]) – ID of the ALIKAFKA Instance that owns the groups.
kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a db account. You have to specify one of password and kms_encrypted_password fields.
kms_encryption_context (pulumi.Input[dict]) –
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating a user with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
password (pulumi.Input[str]) – Operation password. It may consist of letters, digits, or underlines, with a length of 1 to 64 characters. You have to specify one of password and kms_encrypted_password fields.
username (pulumi.Input[str]) – Username for the sasl user. The length should between 1 to 64 characters. The characters can only contain ‘a’-‘z’, ‘A’-‘Z’, ‘0’-‘9’, ‘_’ and ‘-‘.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.alikafka.Topic(resource_name, opts=None, compact_topic=None, instance_id=None, local_topic=None, partition_num=None, remark=None, tags=None, topic=None, __props__=None, __name__=None, __opts__=None)¶

Provides an ALIKAFKA topic resource.

NOTE: Available in 1.56.0+
NOTE: Only the following regions support create alikafka topic. [cn-hangzhou,cn-beijing,cn-shenzhen,cn-shanghai,cn-qingdao,cn-hongkong,cn-huhehaote,cn-zhangjiakou,ap-southeast-1,ap-south-1,ap-southeast-5]

import pulumi
import pulumi_alicloud as alicloud

default_zones = alicloud.get_zones(available_resource_creation="VSwitch")
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/12")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_instance = alicloud.alikafka.Instance("defaultInstance",
    deploy_type="5",
    disk_size="500",
    disk_type="1",
    io_max="20",
    topic_quota="50",
    vswitch_id=default_switch.id)
config = pulumi.Config()
topic = config.get("topic")
if topic is None:
    topic = "alikafkaTopicName"
default_topic = alicloud.alikafka.Topic("defaultTopic",
    compact_topic="false",
    instance_id=default_instance.id,
    local_topic="false",
    partition_num="12",
    remark="dafault_kafka_topic_remark",
    topic=topic)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
compact_topic (pulumi.Input[bool]) – Whether the topic is compactTopic or not. Compact topic must be a localTopic.
instance_id (pulumi.Input[str]) – InstanceId of your Kafka resource, the topic will create in this instance.
local_topic (pulumi.Input[bool]) – Whether the topic is localTopic or not.
partition_num (pulumi.Input[float]) – The number of partitions of the topic. The number should between 1 and 48.
remark (pulumi.Input[str]) – This attribute is a concise description of topic. The length cannot exceed 64.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
topic (pulumi.Input[str]) – Name of the topic. Two topics on a single instance cannot have the same name. The length cannot exceed 64 characters.

compact_topic: pulumi.Output[bool] = None¶: Whether the topic is compactTopic or not. Compact topic must be a localTopic.

instance_id: pulumi.Output[str] = None¶: InstanceId of your Kafka resource, the topic will create in this instance.

local_topic: pulumi.Output[bool] = None¶: Whether the topic is localTopic or not.

partition_num: pulumi.Output[float] = None¶: The number of partitions of the topic. The number should between 1 and 48.

remark: pulumi.Output[str] = None¶: This attribute is a concise description of topic. The length cannot exceed 64.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

topic: pulumi.Output[str] = None¶: Name of the topic. Two topics on a single instance cannot have the same name. The length cannot exceed 64 characters.

static get(resource_name, id, opts=None, compact_topic=None, instance_id=None, local_topic=None, partition_num=None, remark=None, tags=None, topic=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
compact_topic (pulumi.Input[bool]) – Whether the topic is compactTopic or not. Compact topic must be a localTopic.
instance_id (pulumi.Input[str]) – InstanceId of your Kafka resource, the topic will create in this instance.
local_topic (pulumi.Input[bool]) – Whether the topic is localTopic or not.
partition_num (pulumi.Input[float]) – The number of partitions of the topic. The number should between 1 and 48.
remark (pulumi.Input[str]) – This attribute is a concise description of topic. The length cannot exceed 64.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
topic (pulumi.Input[str]) – Name of the topic. Two topics on a single instance cannot have the same name. The length cannot exceed 64 characters.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

alikafka¶

On This Page