@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
143 lines (142 loc) • 4.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage kafka 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 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",
* });
* ```
*
* ## Import
*
* KafkaGroup can be imported using the instance_id:group_id, e.g.
*
* ```sh
* $ pulumi import volcengine:kafka/group:Group default kafka-****x:groupId
* ```
*/
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<pulumi.ID>, 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;
/**
* The description of kafka group.
*/
readonly description: pulumi.Output<string>;
/**
* The id of kafka group.
*/
readonly groupId: pulumi.Output<string>;
/**
* The instance id of kafka group.
*/
readonly instanceId: pulumi.Output<string>;
/**
* The state of kafka group.
*/
readonly state: pulumi.Output<string>;
/**
* 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 {
/**
* The description of kafka group.
*/
description?: pulumi.Input<string>;
/**
* The id of kafka group.
*/
groupId?: pulumi.Input<string>;
/**
* The instance id of kafka group.
*/
instanceId?: pulumi.Input<string>;
/**
* The state of kafka group.
*/
state?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Group resource.
*/
export interface GroupArgs {
/**
* The description of kafka group.
*/
description?: pulumi.Input<string>;
/**
* The id of kafka group.
*/
groupId: pulumi.Input<string>;
/**
* The instance id of kafka group.
*/
instanceId: pulumi.Input<string>;
}