@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
191 lines (190 loc) • 6.09 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage rocketmq group
* ## 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 fooRocketMQInstance = new volcengine.rocketmq.RocketMQInstance("fooRocketMQInstance", {
* zoneIds: [fooZones.then(fooZones => fooZones.zones?.[0]?.id)],
* subnetId: fooSubnet.id,
* version: "4.8",
* computeSpec: "rocketmq.n1.x2.micro",
* storageSpace: 300,
* autoScaleQueue: true,
* fileReservedTime: 10,
* instanceName: "acc-test-rocketmq",
* instanceDescription: "acc-test",
* projectName: "default",
* chargeInfo: {
* chargeType: "PostPaid",
* },
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const fooRocketMQGroup = new volcengine.rocketmq.RocketMQGroup("fooRocketMQGroup", {
* instanceId: fooRocketMQInstance.id,
* groupId: "acc-test-rocketmq-group",
* description: "acc-test",
* });
* ```
*
* ## Import
*
* RocketmqGroup can be imported using the instance_id:group_id, e.g.
*
* ```sh
* $ pulumi import volcengine:rocketmq/rocketMQGroup:RocketMQGroup default resource_id
* ```
*/
export declare class RocketMQGroup extends pulumi.CustomResource {
/**
* Get an existing RocketMQGroup 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?: RocketMQGroupState, opts?: pulumi.CustomResourceOptions): RocketMQGroup;
/**
* Returns true if the given object is an instance of RocketMQGroup. 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 RocketMQGroup;
/**
* The create time of the rocketmq group.
*/
readonly createTime: pulumi.Output<string>;
/**
* The description of rocketmq group.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The id of rocketmq group.
*/
readonly groupId: pulumi.Output<string>;
/**
* The type of the rocketmq group.
*/
readonly groupType: pulumi.Output<string>;
/**
* The id of rocketmq instance.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Whether the subscription relationship of consumer instance groups within the group is consistent.
*/
readonly isSubSame: pulumi.Output<boolean>;
/**
* The message delay time of the rocketmq group. The unit is milliseconds.
*/
readonly messageDelayTime: pulumi.Output<string>;
/**
* The message model of the rocketmq group.
*/
readonly messageModel: pulumi.Output<string>;
/**
* The status of the rocketmq group.
*/
readonly status: pulumi.Output<string>;
/**
* The total consume rate of the rocketmq group. The unit is per second.
*/
readonly totalConsumeRate: pulumi.Output<string>;
/**
* The total amount of unconsumed messages.
*/
readonly totalDiff: pulumi.Output<number>;
/**
* Create a RocketMQGroup 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: RocketMQGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RocketMQGroup resources.
*/
export interface RocketMQGroupState {
/**
* The create time of the rocketmq group.
*/
createTime?: pulumi.Input<string>;
/**
* The description of rocketmq group.
*/
description?: pulumi.Input<string>;
/**
* The id of rocketmq group.
*/
groupId?: pulumi.Input<string>;
/**
* The type of the rocketmq group.
*/
groupType?: pulumi.Input<string>;
/**
* The id of rocketmq instance.
*/
instanceId?: pulumi.Input<string>;
/**
* Whether the subscription relationship of consumer instance groups within the group is consistent.
*/
isSubSame?: pulumi.Input<boolean>;
/**
* The message delay time of the rocketmq group. The unit is milliseconds.
*/
messageDelayTime?: pulumi.Input<string>;
/**
* The message model of the rocketmq group.
*/
messageModel?: pulumi.Input<string>;
/**
* The status of the rocketmq group.
*/
status?: pulumi.Input<string>;
/**
* The total consume rate of the rocketmq group. The unit is per second.
*/
totalConsumeRate?: pulumi.Input<string>;
/**
* The total amount of unconsumed messages.
*/
totalDiff?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a RocketMQGroup resource.
*/
export interface RocketMQGroupArgs {
/**
* The description of rocketmq group.
*/
description?: pulumi.Input<string>;
/**
* The id of rocketmq group.
*/
groupId: pulumi.Input<string>;
/**
* The id of rocketmq instance.
*/
instanceId: pulumi.Input<string>;
}