@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
122 lines (121 loc) • 4.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage tls consumer group
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.tls.ConsumerGroup("foo", {
* consumerGroupName: "tf-consumer-group-t",
* heartbeatTtl: 120,
* orderedConsume: false,
* projectId: "7a8ac13e-8e3e-4392-ae77-aea8efa49bbf",
* topicIdLists: ["33124cc3-15c4-4cdc-9a8a-cc64a9d593dd"],
* });
* ```
*
* ## Import
*
* ConsumerGroup can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:tls/consumerGroup:ConsumerGroup default resource_id
* ```
*/
export declare class ConsumerGroup extends pulumi.CustomResource {
/**
* Get an existing ConsumerGroup 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<pulumi.ID>, state?: ConsumerGroupState, opts?: pulumi.CustomResourceOptions): 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.
*/
static isInstance(obj: any): obj is ConsumerGroup;
/**
* The name of the consumer group.
*/
readonly consumerGroupName: pulumi.Output<string>;
/**
* The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
*/
readonly heartbeatTtl: pulumi.Output<number>;
/**
* Whether to consume in sequence.
*/
readonly orderedConsume: pulumi.Output<boolean>;
/**
* The log project ID to which the consumption group belongs.
*/
readonly projectId: pulumi.Output<string>;
/**
* The list of log topic ids to be consumed by the consumer group.
*/
readonly topicIdLists: pulumi.Output<string[]>;
/**
* Create a ConsumerGroup 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: ConsumerGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ConsumerGroup resources.
*/
export interface ConsumerGroupState {
/**
* The name of the consumer group.
*/
consumerGroupName?: pulumi.Input<string>;
/**
* The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
*/
heartbeatTtl?: pulumi.Input<number>;
/**
* Whether to consume in sequence.
*/
orderedConsume?: pulumi.Input<boolean>;
/**
* The log project ID to which the consumption group belongs.
*/
projectId?: pulumi.Input<string>;
/**
* The list of log topic ids to be consumed by the consumer group.
*/
topicIdLists?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a ConsumerGroup resource.
*/
export interface ConsumerGroupArgs {
/**
* The name of the consumer group.
*/
consumerGroupName: pulumi.Input<string>;
/**
* The time of heart rate expiration, measured in seconds, has a value range of 1 to 300.
*/
heartbeatTtl: pulumi.Input<number>;
/**
* Whether to consume in sequence.
*/
orderedConsume: pulumi.Input<boolean>;
/**
* The log project ID to which the consumption group belongs.
*/
projectId: pulumi.Input<string>;
/**
* The list of log topic ids to be consumed by the consumer group.
*/
topicIdLists: pulumi.Input<pulumi.Input<string>[]>;
}