@volcengine/pulumi/tls/consumerGroups.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to query detailed information of tls consumer groups
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const all = volcengine.tls.getConsumerGroups({});
 * export const allConsumerGroups = all.then(all => all.consumerGroups);
 * const byName = volcengine.tls.getConsumerGroups({
 *     consumerGroupName: "test-consumer-group",
 * });
 * export const byNameConsumerGroups = byName.then(byName => byName.consumerGroups);
 * const byProject = volcengine.tls.getConsumerGroups({
 *     projectId: "project-123456",
 * });
 * export const byProjectConsumerGroups = byProject.then(byProject => byProject.consumerGroups);
 * const byTopic = volcengine.tls.getConsumerGroups({
 *     topicId: "topic-123456",
 * });
 * export const byTopicConsumerGroups = byTopic.then(byTopic => byTopic.consumerGroups);
 * const withMultipleFilters = volcengine.tls.getConsumerGroups({
 *     projectId: "project-123456",
 *     consumerGroupName: "test",
 * });
 * export const multipleFiltersConsumerGroups = withMultipleFilters.then(withMultipleFilters => withMultipleFilters.consumerGroups);
 * ```
 */
/** @deprecated volcengine.tls.ConsumerGroups has been deprecated in favor of volcengine.tls.getConsumerGroups */
export declare function consumerGroups(args?: ConsumerGroupsArgs, opts?: pulumi.InvokeOptions): Promise<ConsumerGroupsResult>;
/**
 * A collection of arguments for invoking ConsumerGroups.
 */
export interface ConsumerGroupsArgs {
    /**
     * The name of the consumer group.
     */
    consumerGroupName?: string;
    /**
     * IAM log project name.
     */
    iamProjectName?: string;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: string;
    /**
     * File name where to save data source results.
     */
    outputFile?: string;
    /**
     * The log project ID to which the consumption group belongs.
     */
    projectId?: string;
    /**
     * The name of the log item to which the consumption group belongs.
     */
    projectName?: string;
    /**
     * The log topic ID to which the consumer belongs.
     */
    topicId?: string;
    /**
     * The name of the log topic to which the consumption group belongs.
     */
    topicName?: string;
}
/**
 * A collection of values returned by ConsumerGroups.
 */
export interface ConsumerGroupsResult {
    /**
     * The name of the consumer group.
     */
    readonly consumerGroupName?: string;
    /**
     * List of log service consumption groups.
     */
    readonly consumerGroups: outputs.tls.ConsumerGroupsConsumerGroup[];
    readonly iamProjectName?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly nameRegex?: string;
    readonly outputFile?: string;
    /**
     * The log project ID to which the consumption group belongs.
     */
    readonly projectId?: string;
    /**
     * The name of the log item to which the consumption group belongs.
     */
    readonly projectName?: string;
    /**
     * The list of log topic ids to be consumed by the consumer group.
     */
    readonly topicId?: string;
    readonly topicName?: string;
    /**
     * The total count of query.
     */
    readonly totalCount: number;
}
/**
 * Use this data source to query detailed information of tls consumer groups
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const all = volcengine.tls.getConsumerGroups({});
 * export const allConsumerGroups = all.then(all => all.consumerGroups);
 * const byName = volcengine.tls.getConsumerGroups({
 *     consumerGroupName: "test-consumer-group",
 * });
 * export const byNameConsumerGroups = byName.then(byName => byName.consumerGroups);
 * const byProject = volcengine.tls.getConsumerGroups({
 *     projectId: "project-123456",
 * });
 * export const byProjectConsumerGroups = byProject.then(byProject => byProject.consumerGroups);
 * const byTopic = volcengine.tls.getConsumerGroups({
 *     topicId: "topic-123456",
 * });
 * export const byTopicConsumerGroups = byTopic.then(byTopic => byTopic.consumerGroups);
 * const withMultipleFilters = volcengine.tls.getConsumerGroups({
 *     projectId: "project-123456",
 *     consumerGroupName: "test",
 * });
 * export const multipleFiltersConsumerGroups = withMultipleFilters.then(withMultipleFilters => withMultipleFilters.consumerGroups);
 * ```
 */
/** @deprecated volcengine.tls.ConsumerGroups has been deprecated in favor of volcengine.tls.getConsumerGroups */
export declare function consumerGroupsOutput(args?: ConsumerGroupsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<ConsumerGroupsResult>;
/**
 * A collection of arguments for invoking ConsumerGroups.
 */
export interface ConsumerGroupsOutputArgs {
    /**
     * The name of the consumer group.
     */
    consumerGroupName?: pulumi.Input<string>;
    /**
     * IAM log project name.
     */
    iamProjectName?: pulumi.Input<string>;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: pulumi.Input<string>;
    /**
     * File name where to save data source results.
     */
    outputFile?: pulumi.Input<string>;
    /**
     * The log project ID to which the consumption group belongs.
     */
    projectId?: pulumi.Input<string>;
    /**
     * The name of the log item to which the consumption group belongs.
     */
    projectName?: pulumi.Input<string>;
    /**
     * The log topic ID to which the consumer belongs.
     */
    topicId?: pulumi.Input<string>;
    /**
     * The name of the log topic to which the consumption group belongs.
     */
    topicName?: pulumi.Input<string>;
}