import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Group, also known as Consumer Group, is a collection of consumers with similar consumption behavior, used to categorize and manage different consumers. Each consumer group consumes different types of messages. Within each consumer group, the logic for publishing or subscribing to messages is consistent. In RocketMQ Message Queue, you need to create a Group and use the Group ID to identify different types of producers or consumers. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcenginecc from "@volcengine/pulumi-volcenginecc"; * * const rocketMQGroupDemo = new volcenginecc.rocketmq.Group("RocketMQGroupDemo", { * instanceId: "rocketmq-cnnxxxxxc2d", * groupId: "ccapi-test-test-1", * consumeMessageOrderly: true, * description: "test", * groupType: "TCP", * retryMaxTimes: 2, * }); * ``` * * ## Import * * ```sh * $ pulumi import volcenginecc:rocketmq/group:Group example "instance_id|group_id" * ``` */ export declare class Group extends pulumi.CustomResource { /** * Get an existing Group resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group; /** * Returns true if the given object is an instance of Group. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Group; /** * Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent. */ readonly consumeMessageOrderly: pulumi.Output; readonly consumedClients: pulumi.Output; readonly consumedTopics: pulumi.Output; /** * Group creation time. */ readonly createdTime: pulumi.Output; /** * Brief description of the Group. */ readonly description: pulumi.Output; /** * Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (*). It is recommended to start with GID - or GID*. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters. */ readonly groupId: pulumi.Output; /** * Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP. */ readonly groupType: pulumi.Output; /** * Instance ID. */ readonly instanceId: pulumi.Output; /** * Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent. */ readonly isSubSame: pulumi.Output; /** * Whether consumption is sequential. */ readonly lastUpdateTimestamp: pulumi.Output; /** * Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds. */ readonly messageDelayTime: pulumi.Output; /** * Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode. */ readonly messageModel: pulumi.Output; /** * Maximum number of consumption retries. */ readonly retryMaxTimes: pulumi.Output; /** * RocketMQ version. */ readonly rocketmqVersion: pulumi.Output; /** * Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated. */ readonly serviceStatus: pulumi.Output; /** * Consumer group status. Online: Consuming, Offline: Not consuming. */ readonly status: pulumi.Output; /** * Total TPS of consumer instance groups under this Group, measured in messages per second. */ readonly totalConsumedRate: pulumi.Output; /** * Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic. */ readonly totalDiff: pulumi.Output; /** * Create a Group resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: GroupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Group resources. */ export interface GroupState { /** * Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent. */ consumeMessageOrderly?: pulumi.Input; consumedClients?: pulumi.Input[]>; consumedTopics?: pulumi.Input[]>; /** * Group creation time. */ createdTime?: pulumi.Input; /** * Brief description of the Group. */ description?: pulumi.Input; /** * Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (*). It is recommended to start with GID - or GID*. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters. */ groupId?: pulumi.Input; /** * Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP. */ groupType?: pulumi.Input; /** * Instance ID. */ instanceId?: pulumi.Input; /** * Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent. */ isSubSame?: pulumi.Input; /** * Whether consumption is sequential. */ lastUpdateTimestamp?: pulumi.Input; /** * Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds. */ messageDelayTime?: pulumi.Input; /** * Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode. */ messageModel?: pulumi.Input; /** * Maximum number of consumption retries. */ retryMaxTimes?: pulumi.Input; /** * RocketMQ version. */ rocketmqVersion?: pulumi.Input; /** * Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated. */ serviceStatus?: pulumi.Input; /** * Consumer group status. Online: Consuming, Offline: Not consuming. */ status?: pulumi.Input; /** * Total TPS of consumer instance groups under this Group, measured in messages per second. */ totalConsumedRate?: pulumi.Input; /** * Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic. */ totalDiff?: pulumi.Input; } /** * The set of arguments for constructing a Group resource. */ export interface GroupArgs { /** * Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent. */ consumeMessageOrderly?: pulumi.Input; /** * Brief description of the Group. */ description?: pulumi.Input; /** * Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (*). It is recommended to start with GID - or GID*. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters. */ groupId: pulumi.Input; /** * Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP. */ groupType: pulumi.Input; /** * Instance ID. */ instanceId: pulumi.Input; /** * Maximum number of consumption retries. */ retryMaxTimes?: pulumi.Input; }