Module alikafka

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.

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.

Others

ConsumerGroupArgs
ConsumerGroupState
InstanceArgs
InstanceState
SaslAclArgs
SaslAclState
SaslUserArgs
SaslUserState
TopicArgs
TopicState

Resources

Resource ConsumerGroup

class ConsumerGroup extends CustomResource

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]

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const consumerId = config.get("consumerId") || "CID-alikafkaGroupDatasourceName";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.alikafka.Instance("default", {
    deployType: 5,
    diskSize: 500,
    diskType: 1,
    ioMax: 20,
    topicQuota: 50,
    vswitchId: defaultSwitch.id,
});
const defaultConsumerGroup = new alicloud.alikafka.ConsumerGroup("default", {
    consumerId: consumerId,
    instanceId: defaultInstance.id,
});

constructor

new ConsumerGroup(name: string, args: ConsumerGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ConsumerGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConsumerGroupState, opts?: pulumi.CustomResourceOptions): ConsumerGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ConsumerGroup

Returns true if the given object is an instance of ConsumerGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property consumerId

public consumerId: pulumi.Output<string>;

ID of the consumer group. The length cannot exceed 64 characters.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

ID of the ALIKAFKA Instance that owns the groups.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Instance

class Instance extends CustomResource

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]
Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const instanceName = config.get("instanceName") || "alikafkaInstanceName";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.alikafka.Instance("default", {
    deployType: 4,
    diskSize: 500,
    diskType: 1,
    ioMax: 20,
    topicQuota: 50,
    vswitchId: defaultSwitch.id,
});

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property deployType

public deployType: pulumi.Output<number>;

The deploy type of the instance. Currently only support two deploy type, 4: eip/vpc instance, 5: vpc instance.

property diskSize

public diskSize: pulumi.Output<number>;

The disk size of the instance. When modify this value, it only support adjust to a greater value.

property diskType

public diskType: pulumi.Output<number>;

The disk type of the instance. 0: efficient cloud disk , 1: SSD.

property eipMax

public eipMax: pulumi.Output<number | undefined>;

The max bandwidth of the instance. When modify this value, it only support adjust to a greater value.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ioMax

public ioMax: pulumi.Output<number>;

The max value of io of the instance. When modify this value, it only support adjust to a greater value.

property name

public name: pulumi.Output<string>;

Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.

property paidType

public paidType: pulumi.Output<string | undefined>;

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.

property specType

public specType: pulumi.Output<string | undefined>;

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.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property topicQuota

public topicQuota: pulumi.Output<number>;

The max num of topic can be create of the instance. When modify this value, it only adjust to a greater value.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The ID of attaching VPC to instance.

property vswitchId

public vswitchId: pulumi.Output<string>;

The ID of attaching vswitch to instance.

property zoneId

public zoneId: pulumi.Output<string>;

The Zone to launch the kafka instance.

Resource SaslAcl

class SaslAcl extends CustomResource

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]

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const username = config.get("username") || "testusername";
const password = config.get("password") || "testpassword";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.alikafka.Instance("default", {
    deployType: 5,
    diskSize: 500,
    diskType: 1,
    ioMax: 20,
    topicQuota: 50,
    vswitchId: defaultSwitch.id,
});
const defaultTopic = new alicloud.alikafka.Topic("default", {
    instanceId: defaultInstance.id,
    remark: "topic-remark",
    topic: "test-topic",
});
const defaultSaslUser = new alicloud.alikafka.SaslUser("default", {
    instanceId: defaultInstance.id,
    password: password,
    username: username,
});
const defaultSaslAcl = new alicloud.alikafka.SaslAcl("default", {
    aclOperationType: "Write",
    aclResourceName: defaultTopic.topic,
    aclResourcePatternType: "LITERAL",
    aclResourceType: "Topic",
    instanceId: defaultInstance.id,
    username: defaultSaslUser.username,
});

constructor

new SaslAcl(name: string, args: SaslAclArgs, opts?: pulumi.CustomResourceOptions)

Create a SaslAcl resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SaslAclState, opts?: pulumi.CustomResourceOptions): SaslAcl

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SaslAcl

Returns true if the given object is an instance of SaslAcl. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property aclOperationType

public aclOperationType: pulumi.Output<string>;

Operation type for this acl. The operation type can only be “Write” and “Read”.

property aclResourceName

public aclResourceName: pulumi.Output<string>;

Resource name for this acl. The resource name should be a topic or consumer group name.

property aclResourcePatternType

public aclResourcePatternType: pulumi.Output<string>;

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.

property aclResourceType

public aclResourceType: pulumi.Output<string>;

Resource type for this acl. The resource type can only be “Topic” and “Group”.

property host

public host: pulumi.Output<string>;

The host of the acl.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

ID of the ALIKAFKA Instance that owns the groups.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

Username for the sasl user. The length should between 1 to 64 characters. The user should be an existed sasl user.

Resource SaslUser

class SaslUser extends CustomResource

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]

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const username = config.get("username") || "testusername";
const password = config.get("password") || "testpassword";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.alikafka.Instance("default", {
    deployType: 5,
    diskSize: 500,
    diskType: 1,
    ioMax: 20,
    topicQuota: 50,
    vswitchId: defaultSwitch.id,
});
const defaultSaslUser = new alicloud.alikafka.SaslUser("default", {
    instanceId: defaultInstance.id,
    password: password,
    username: username,
});

constructor

new SaslUser(name: string, args: SaslUserArgs, opts?: pulumi.CustomResourceOptions)

Create a SaslUser resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SaslUserState, opts?: pulumi.CustomResourceOptions): SaslUser

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SaslUser

Returns true if the given object is an instance of SaslUser. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

ID of the ALIKAFKA Instance that owns the groups.

property kmsEncryptedPassword

public kmsEncryptedPassword: pulumi.Output<string | undefined>;

An KMS encrypts password used to a db account. You have to specify one of password and kmsEncryptedPassword fields.

property kmsEncryptionContext

public kmsEncryptionContext: pulumi.Output<{[key: string]: any} | undefined>;

An KMS encryption context used to decrypt kmsEncryptedPassword before creating or updating a user with kmsEncryptedPassword. See Encryption Context. It is valid when kmsEncryptedPassword is set.

property password

public password: pulumi.Output<string | undefined>;

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 kmsEncryptedPassword fields.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

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 ‘-’.

Resource Topic

class Topic extends CustomResource

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]

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const topic = config.get("topic") || "alikafkaTopicName";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.alikafka.Instance("default", {
    deployType: 5,
    diskSize: 500,
    diskType: 1,
    ioMax: 20,
    topicQuota: 50,
    vswitchId: defaultSwitch.id,
});
const defaultTopic = new alicloud.alikafka.Topic("default", {
    compactTopic: false,
    instanceId: defaultInstance.id,
    localTopic: false,
    partitionNum: 12,
    remark: "dafaultKafkaTopicRemark",
    topic: topic,
});

constructor

new Topic(name: string, args: TopicArgs, opts?: pulumi.CustomResourceOptions)

Create a Topic resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TopicState, opts?: pulumi.CustomResourceOptions): Topic

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Topic

Returns true if the given object is an instance of Topic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property compactTopic

public compactTopic: pulumi.Output<boolean | undefined>;

Whether the topic is compactTopic or not. Compact topic must be a localTopic.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

InstanceId of your Kafka resource, the topic will create in this instance.

property localTopic

public localTopic: pulumi.Output<boolean | undefined>;

Whether the topic is localTopic or not.

property partitionNum

public partitionNum: pulumi.Output<number | undefined>;

The number of partitions of the topic. The number should between 1 and 48.

property remark

public remark: pulumi.Output<string>;

This attribute is a concise description of topic. The length cannot exceed 64.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property topic

public topic: pulumi.Output<string>;

Name of the topic. Two topics on a single instance cannot have the same name. The length cannot exceed 64 characters.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface ConsumerGroupArgs

interface ConsumerGroupArgs

The set of arguments for constructing a ConsumerGroup resource.

property consumerId

consumerId: pulumi.Input<string>;

ID of the consumer group. The length cannot exceed 64 characters.

property instanceId

instanceId: pulumi.Input<string>;

ID of the ALIKAFKA Instance that owns the groups.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface ConsumerGroupState

interface ConsumerGroupState

Input properties used for looking up and filtering ConsumerGroup resources.

property consumerId

consumerId?: pulumi.Input<string>;

ID of the consumer group. The length cannot exceed 64 characters.

property instanceId

instanceId?: pulumi.Input<string>;

ID of the ALIKAFKA Instance that owns the groups.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property deployType

deployType: pulumi.Input<number>;

The deploy type of the instance. Currently only support two deploy type, 4: eip/vpc instance, 5: vpc instance.

property diskSize

diskSize: pulumi.Input<number>;

The disk size of the instance. When modify this value, it only support adjust to a greater value.

property diskType

diskType: pulumi.Input<number>;

The disk type of the instance. 0: efficient cloud disk , 1: SSD.

property eipMax

eipMax?: pulumi.Input<number>;

The max bandwidth of the instance. When modify this value, it only support adjust to a greater value.

property ioMax

ioMax: pulumi.Input<number>;

The max value of io of the instance. When modify this value, it only support adjust to a greater value.

property name

name?: pulumi.Input<string>;

Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.

property paidType

paidType?: pulumi.Input<string>;

property specType

specType?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property topicQuota

topicQuota: pulumi.Input<number>;

The max num of topic can be create of the instance. When modify this value, it only adjust to a greater value.

property vswitchId

vswitchId: pulumi.Input<string>;

The ID of attaching vswitch to instance.

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property deployType

deployType?: pulumi.Input<number>;

The deploy type of the instance. Currently only support two deploy type, 4: eip/vpc instance, 5: vpc instance.

property diskSize

diskSize?: pulumi.Input<number>;

The disk size of the instance. When modify this value, it only support adjust to a greater value.

property diskType

diskType?: pulumi.Input<number>;

The disk type of the instance. 0: efficient cloud disk , 1: SSD.

property eipMax

eipMax?: pulumi.Input<number>;

The max bandwidth of the instance. When modify this value, it only support adjust to a greater value.

property ioMax

ioMax?: pulumi.Input<number>;

The max value of io of the instance. When modify this value, it only support adjust to a greater value.

property name

name?: pulumi.Input<string>;

Name of your Kafka instance. The length should between 3 and 64 characters. If not set, will use instance id as instance name.

property paidType

paidType?: pulumi.Input<string>;

property specType

specType?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property topicQuota

topicQuota?: pulumi.Input<number>;

The max num of topic can be create of the instance. When modify this value, it only adjust to a greater value.

property vpcId

vpcId?: pulumi.Input<string>;

The ID of attaching VPC to instance.

property vswitchId

vswitchId?: pulumi.Input<string>;

The ID of attaching vswitch to instance.

property zoneId

zoneId?: pulumi.Input<string>;

The Zone to launch the kafka instance.

interface SaslAclArgs

interface SaslAclArgs

The set of arguments for constructing a SaslAcl resource.

property aclOperationType

aclOperationType: pulumi.Input<string>;

Operation type for this acl. The operation type can only be “Write” and “Read”.

property aclResourceName

aclResourceName: pulumi.Input<string>;

Resource name for this acl. The resource name should be a topic or consumer group name.

property aclResourcePatternType

aclResourcePatternType: pulumi.Input<string>;

property aclResourceType

aclResourceType: pulumi.Input<string>;

Resource type for this acl. The resource type can only be “Topic” and “Group”.

property instanceId

instanceId: pulumi.Input<string>;

ID of the ALIKAFKA Instance that owns the groups.

property username

username: pulumi.Input<string>;

Username for the sasl user. The length should between 1 to 64 characters. The user should be an existed sasl user.

interface SaslAclState

interface SaslAclState

Input properties used for looking up and filtering SaslAcl resources.

property aclOperationType

aclOperationType?: pulumi.Input<string>;

Operation type for this acl. The operation type can only be “Write” and “Read”.

property aclResourceName

aclResourceName?: pulumi.Input<string>;

Resource name for this acl. The resource name should be a topic or consumer group name.

property aclResourcePatternType

aclResourcePatternType?: pulumi.Input<string>;

property aclResourceType

aclResourceType?: pulumi.Input<string>;

Resource type for this acl. The resource type can only be “Topic” and “Group”.

property host

host?: pulumi.Input<string>;

The host of the acl.

property instanceId

instanceId?: pulumi.Input<string>;

ID of the ALIKAFKA Instance that owns the groups.

property username

username?: pulumi.Input<string>;

Username for the sasl user. The length should between 1 to 64 characters. The user should be an existed sasl user.

interface SaslUserArgs

interface SaslUserArgs

The set of arguments for constructing a SaslUser resource.

property instanceId

instanceId: pulumi.Input<string>;

ID of the ALIKAFKA Instance that owns the groups.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a db account. You have to specify one of password and kmsEncryptedPassword fields.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

property password

password?: pulumi.Input<string>;

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 kmsEncryptedPassword fields.

property username

username: pulumi.Input<string>;

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 ‘-’.

interface SaslUserState

interface SaslUserState

Input properties used for looking up and filtering SaslUser resources.

property instanceId

instanceId?: pulumi.Input<string>;

ID of the ALIKAFKA Instance that owns the groups.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a db account. You have to specify one of password and kmsEncryptedPassword fields.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

property password

password?: pulumi.Input<string>;

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 kmsEncryptedPassword fields.

property username

username?: pulumi.Input<string>;

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 ‘-’.

interface TopicArgs

interface TopicArgs

The set of arguments for constructing a Topic resource.

property compactTopic

compactTopic?: pulumi.Input<boolean>;

Whether the topic is compactTopic or not. Compact topic must be a localTopic.

property instanceId

instanceId: pulumi.Input<string>;

InstanceId of your Kafka resource, the topic will create in this instance.

property localTopic

localTopic?: pulumi.Input<boolean>;

Whether the topic is localTopic or not.

property partitionNum

partitionNum?: pulumi.Input<number>;

The number of partitions of the topic. The number should between 1 and 48.

property remark

remark: pulumi.Input<string>;

This attribute is a concise description of topic. The length cannot exceed 64.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property topic

topic: pulumi.Input<string>;

Name of the topic. Two topics on a single instance cannot have the same name. The length cannot exceed 64 characters.

interface TopicState

interface TopicState

Input properties used for looking up and filtering Topic resources.

property compactTopic

compactTopic?: pulumi.Input<boolean>;

Whether the topic is compactTopic or not. Compact topic must be a localTopic.

property instanceId

instanceId?: pulumi.Input<string>;

InstanceId of your Kafka resource, the topic will create in this instance.

property localTopic

localTopic?: pulumi.Input<boolean>;

Whether the topic is localTopic or not.

property partitionNum

partitionNum?: pulumi.Input<number>;

The number of partitions of the topic. The number should between 1 and 48.

property remark

remark?: pulumi.Input<string>;

This attribute is a concise description of topic. The length cannot exceed 64.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property topic

topic?: pulumi.Input<string>;

Name of the topic. Two topics on a single instance cannot have the same name. The length cannot exceed 64 characters.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module alikafka

Resources

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Others