@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
187 lines (186 loc) • 5.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 groups
* ## 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 fooGroup = new volcengine.kafka.Group("fooGroup", {
* instanceId: fooInstance.id,
* groupId: "acc-test-group",
* description: "tf-test",
* });
* const default = volcengine.kafka.getGroupsOutput({
* instanceId: fooGroup.instanceId,
* });
* ```
*/
/** @deprecated volcengine.kafka.Groups has been deprecated in favor of volcengine.kafka.getGroups */
export declare function groups(args: GroupsArgs, opts?: pulumi.InvokeOptions): Promise<GroupsResult>;
/**
* A collection of arguments for invoking Groups.
*/
export interface GroupsArgs {
/**
* The id of kafka group, support fuzzy matching.
*/
groupId?: string;
/**
* The instance id of kafka group.
*/
instanceId: string;
/**
* A Name Regex of kafka group.
*/
nameRegex?: string;
/**
* File name where to save data source results.
*/
outputFile?: string;
}
/**
* A collection of values returned by Groups.
*/
export interface GroupsResult {
/**
* The id of kafka group.
*/
readonly groupId?: string;
/**
* The collection of query.
*/
readonly groups: outputs.kafka.GroupsGroup[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly instanceId: string;
readonly nameRegex?: string;
readonly outputFile?: string;
/**
* The total count of query.
*/
readonly totalCount: number;
}
/**
* Use this data source to query detailed information of kafka groups
* ## 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 fooGroup = new volcengine.kafka.Group("fooGroup", {
* instanceId: fooInstance.id,
* groupId: "acc-test-group",
* description: "tf-test",
* });
* const default = volcengine.kafka.getGroupsOutput({
* instanceId: fooGroup.instanceId,
* });
* ```
*/
/** @deprecated volcengine.kafka.Groups has been deprecated in favor of volcengine.kafka.getGroups */
export declare function groupsOutput(args: GroupsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GroupsResult>;
/**
* A collection of arguments for invoking Groups.
*/
export interface GroupsOutputArgs {
/**
* The id of kafka group, support fuzzy matching.
*/
groupId?: pulumi.Input<string>;
/**
* The instance id of kafka group.
*/
instanceId: pulumi.Input<string>;
/**
* A Name Regex of kafka group.
*/
nameRegex?: pulumi.Input<string>;
/**
* File name where to save data source results.
*/
outputFile?: pulumi.Input<string>;
}