@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
243 lines (242 loc) • 7.43 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Use this data source to query detailed information of kafka topic partitions
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-test-subnet",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooInstance = new volcengine.kafka.Instance("fooInstance", {
* instanceName: "acc-test-kafka",
* instanceDescription: "tf-test",
* version: "2.2.2",
* computeSpec: "kafka.20xrate.hw",
* subnetId: fooSubnet.id,
* userName: "tf-user",
* userPassword: "tf-pass!@q1",
* chargeType: "PostPaid",
* storageSpace: 300,
* partitionNumber: 350,
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* parameters: [
* {
* parameterName: "MessageMaxByte",
* parameterValue: "12",
* },
* {
* parameterName: "LogRetentionHours",
* parameterValue: "70",
* },
* ],
* });
* const fooSaslUser = new volcengine.kafka.SaslUser("fooSaslUser", {
* userName: "acc-test-user",
* instanceId: fooInstance.id,
* userPassword: "suqsnis123!",
* description: "tf-test",
* allAuthority: true,
* passwordType: "Scram",
* });
* const fooTopic = new volcengine.kafka.Topic("fooTopic", {
* topicName: "acc-test-topic",
* instanceId: fooInstance.id,
* description: "tf-test",
* partitionNumber: 15,
* replicaNumber: 3,
* parameters: {
* minInsyncReplicaNumber: 2,
* messageMaxByte: 10,
* logRetentionHours: 96,
* },
* allAuthority: false,
* accessPolicies: [{
* userName: fooSaslUser.userName,
* accessPolicy: "Pub",
* }],
* });
* const default = pulumi.all([fooInstance.id, fooTopic.topicName]).apply(([id, topicName]) => volcengine.kafka.getTopicPartitionsOutput({
* instanceId: id,
* topicName: topicName,
* partitionIds: [
* 1,
* 2,
* ],
* }));
* ```
*/
/** @deprecated volcengine.kafka.TopicPartitions has been deprecated in favor of volcengine.kafka.getTopicPartitions */
export declare function topicPartitions(args: TopicPartitionsArgs, opts?: pulumi.InvokeOptions): Promise<TopicPartitionsResult>;
/**
* A collection of arguments for invoking TopicPartitions.
*/
export interface TopicPartitionsArgs {
/**
* The id of kafka instance.
*/
instanceId: string;
/**
* File name where to save data source results.
*/
outputFile?: string;
/**
* The index number of partition.
*/
partitionIds?: number[];
/**
* The name of kafka topic.
*/
topicName: string;
/**
* Whether to only query the list of partitions that have out-of-sync replicas, the default value is false.
*/
underInsyncOnly?: boolean;
}
/**
* A collection of values returned by TopicPartitions.
*/
export interface TopicPartitionsResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly instanceId: string;
readonly outputFile?: string;
readonly partitionIds?: number[];
/**
* The collection of query.
*/
readonly partitions: outputs.kafka.TopicPartitionsPartition[];
readonly topicName: string;
/**
* The total count of query.
*/
readonly totalCount: number;
readonly underInsyncOnly?: boolean;
}
/**
* Use this data source to query detailed information of kafka topic partitions
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-test-subnet",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooInstance = new volcengine.kafka.Instance("fooInstance", {
* instanceName: "acc-test-kafka",
* instanceDescription: "tf-test",
* version: "2.2.2",
* computeSpec: "kafka.20xrate.hw",
* subnetId: fooSubnet.id,
* userName: "tf-user",
* userPassword: "tf-pass!@q1",
* chargeType: "PostPaid",
* storageSpace: 300,
* partitionNumber: 350,
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* parameters: [
* {
* parameterName: "MessageMaxByte",
* parameterValue: "12",
* },
* {
* parameterName: "LogRetentionHours",
* parameterValue: "70",
* },
* ],
* });
* const fooSaslUser = new volcengine.kafka.SaslUser("fooSaslUser", {
* userName: "acc-test-user",
* instanceId: fooInstance.id,
* userPassword: "suqsnis123!",
* description: "tf-test",
* allAuthority: true,
* passwordType: "Scram",
* });
* const fooTopic = new volcengine.kafka.Topic("fooTopic", {
* topicName: "acc-test-topic",
* instanceId: fooInstance.id,
* description: "tf-test",
* partitionNumber: 15,
* replicaNumber: 3,
* parameters: {
* minInsyncReplicaNumber: 2,
* messageMaxByte: 10,
* logRetentionHours: 96,
* },
* allAuthority: false,
* accessPolicies: [{
* userName: fooSaslUser.userName,
* accessPolicy: "Pub",
* }],
* });
* const default = pulumi.all([fooInstance.id, fooTopic.topicName]).apply(([id, topicName]) => volcengine.kafka.getTopicPartitionsOutput({
* instanceId: id,
* topicName: topicName,
* partitionIds: [
* 1,
* 2,
* ],
* }));
* ```
*/
/** @deprecated volcengine.kafka.TopicPartitions has been deprecated in favor of volcengine.kafka.getTopicPartitions */
export declare function topicPartitionsOutput(args: TopicPartitionsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<TopicPartitionsResult>;
/**
* A collection of arguments for invoking TopicPartitions.
*/
export interface TopicPartitionsOutputArgs {
/**
* The id of kafka instance.
*/
instanceId: pulumi.Input<string>;
/**
* File name where to save data source results.
*/
outputFile?: pulumi.Input<string>;
/**
* The index number of partition.
*/
partitionIds?: pulumi.Input<pulumi.Input<number>[]>;
/**
* The name of kafka topic.
*/
topicName: pulumi.Input<string>;
/**
* Whether to only query the list of partitions that have out-of-sync replicas, the default value is false.
*/
underInsyncOnly?: pulumi.Input<boolean>;
}