@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
360 lines (359 loc) • 11.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## 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({});
* // create vpc
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc",
* cidrBlock: "172.16.0.0/16",
* dnsServers: [
* "8.8.8.8",
* "114.114.114.114",
* ],
* projectName: "default",
* });
* // create subnet
* 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,
* });
* // create kafka instance
* 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",
* },
* {
* parameterName: "MessageTimestampType",
* parameterValue: "CreateTime",
* },
* {
* parameterName: "OffsetRetentionMinutes",
* parameterValue: "10080",
* },
* {
* parameterName: "AutoDeleteGroup",
* parameterValue: "false",
* },
* ],
* });
* const fooAddress = new volcengine.eip.Address("fooAddress", {
* billingType: "PostPaidByBandwidth",
* bandwidth: 1,
* isp: "BGP",
* description: "tf-test",
* projectName: "default",
* });
* const fooPublicAddress = new volcengine.kafka.PublicAddress("fooPublicAddress", {
* instanceId: fooInstance.id,
* eipId: fooAddress.id,
* });
* const fooGroup = new volcengine.kafka.Group("fooGroup", {
* instanceId: fooInstance.id,
* groupId: "acc-test-group",
* description: "tf-test",
* });
* const fooTopic = new volcengine.kafka.Topic("fooTopic", {
* topicName: "acc-test-topic",
* instanceId: fooInstance.id,
* description: "tf-test",
* partitionNumber: 15,
* replicaNumber: 3,
* parameters: {
* minInsyncReplicaNumber: 2,
* messageMaxByte: 10,
* logRetentionHours: 96,
* },
* allAuthority: false,
* });
* ```
*
* ## Import
*
* KafkaInstance can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:kafka/instance:Instance default kafka-insbjwbbwb
* ```
*/
export declare class Instance extends pulumi.CustomResource {
/**
* Get an existing Instance 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?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance;
/**
* Returns true if the given object is an instance of Instance. 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 Instance;
/**
* The auto renew flag of instance. Only effective when instanceChargeType is PrePaid. Default is false.
*/
readonly autoRenew: pulumi.Output<boolean | undefined>;
/**
* The charge type of instance, the value can be `PrePaid` or `PostPaid`.
*/
readonly chargeType: pulumi.Output<string>;
/**
* The compute spec of instance.
*/
readonly computeSpec: pulumi.Output<string>;
/**
* The description of instance.
*/
readonly instanceDescription: pulumi.Output<string>;
/**
* The name of instance.
*/
readonly instanceName: pulumi.Output<string>;
/**
* Whether enable rebalance. Only effected in modify when computeSpec field is changed.
*/
readonly needRebalance: pulumi.Output<boolean | undefined>;
/**
* Parameter of the instance.
*/
readonly parameters: pulumi.Output<outputs.kafka.InstanceParameter[] | undefined>;
/**
* The partition number of instance.
*/
readonly partitionNumber: pulumi.Output<number>;
/**
* The period of instance. Only effective when instanceChargeType is PrePaid. Unit is Month.
*/
readonly period: pulumi.Output<number | undefined>;
/**
* The project name of instance.
*/
readonly projectName: pulumi.Output<string>;
/**
* The rebalance time.
*/
readonly rebalanceTime: pulumi.Output<string | undefined>;
/**
* The storage space of instance.
*/
readonly storageSpace: pulumi.Output<number>;
/**
* The storage type of instance. The value can be ESSD_FlexPL or ESSD_PL0.
*/
readonly storageType: pulumi.Output<string | undefined>;
/**
* The subnet id of instance.
*/
readonly subnetId: pulumi.Output<string>;
/**
* The tags of instance.
*/
readonly tags: pulumi.Output<outputs.kafka.InstanceTag[] | undefined>;
/**
* The user name of instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly userName: pulumi.Output<string>;
/**
* The user password of instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly userPassword: pulumi.Output<string>;
/**
* The version of instance, the value can be `2.2.2` or `2.8.2`.
*/
readonly version: pulumi.Output<string>;
/**
* Create a Instance 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: InstanceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Instance resources.
*/
export interface InstanceState {
/**
* The auto renew flag of instance. Only effective when instanceChargeType is PrePaid. Default is false.
*/
autoRenew?: pulumi.Input<boolean>;
/**
* The charge type of instance, the value can be `PrePaid` or `PostPaid`.
*/
chargeType?: pulumi.Input<string>;
/**
* The compute spec of instance.
*/
computeSpec?: pulumi.Input<string>;
/**
* The description of instance.
*/
instanceDescription?: pulumi.Input<string>;
/**
* The name of instance.
*/
instanceName?: pulumi.Input<string>;
/**
* Whether enable rebalance. Only effected in modify when computeSpec field is changed.
*/
needRebalance?: pulumi.Input<boolean>;
/**
* Parameter of the instance.
*/
parameters?: pulumi.Input<pulumi.Input<inputs.kafka.InstanceParameter>[]>;
/**
* The partition number of instance.
*/
partitionNumber?: pulumi.Input<number>;
/**
* The period of instance. Only effective when instanceChargeType is PrePaid. Unit is Month.
*/
period?: pulumi.Input<number>;
/**
* The project name of instance.
*/
projectName?: pulumi.Input<string>;
/**
* The rebalance time.
*/
rebalanceTime?: pulumi.Input<string>;
/**
* The storage space of instance.
*/
storageSpace?: pulumi.Input<number>;
/**
* The storage type of instance. The value can be ESSD_FlexPL or ESSD_PL0.
*/
storageType?: pulumi.Input<string>;
/**
* The subnet id of instance.
*/
subnetId?: pulumi.Input<string>;
/**
* The tags of instance.
*/
tags?: pulumi.Input<pulumi.Input<inputs.kafka.InstanceTag>[]>;
/**
* The user name of instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
userName?: pulumi.Input<string>;
/**
* The user password of instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
userPassword?: pulumi.Input<string>;
/**
* The version of instance, the value can be `2.2.2` or `2.8.2`.
*/
version?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Instance resource.
*/
export interface InstanceArgs {
/**
* The auto renew flag of instance. Only effective when instanceChargeType is PrePaid. Default is false.
*/
autoRenew?: pulumi.Input<boolean>;
/**
* The charge type of instance, the value can be `PrePaid` or `PostPaid`.
*/
chargeType: pulumi.Input<string>;
/**
* The compute spec of instance.
*/
computeSpec: pulumi.Input<string>;
/**
* The description of instance.
*/
instanceDescription?: pulumi.Input<string>;
/**
* The name of instance.
*/
instanceName?: pulumi.Input<string>;
/**
* Whether enable rebalance. Only effected in modify when computeSpec field is changed.
*/
needRebalance?: pulumi.Input<boolean>;
/**
* Parameter of the instance.
*/
parameters?: pulumi.Input<pulumi.Input<inputs.kafka.InstanceParameter>[]>;
/**
* The partition number of instance.
*/
partitionNumber?: pulumi.Input<number>;
/**
* The period of instance. Only effective when instanceChargeType is PrePaid. Unit is Month.
*/
period?: pulumi.Input<number>;
/**
* The project name of instance.
*/
projectName?: pulumi.Input<string>;
/**
* The rebalance time.
*/
rebalanceTime?: pulumi.Input<string>;
/**
* The storage space of instance.
*/
storageSpace?: pulumi.Input<number>;
/**
* The storage type of instance. The value can be ESSD_FlexPL or ESSD_PL0.
*/
storageType?: pulumi.Input<string>;
/**
* The subnet id of instance.
*/
subnetId: pulumi.Input<string>;
/**
* The tags of instance.
*/
tags?: pulumi.Input<pulumi.Input<inputs.kafka.InstanceTag>[]>;
/**
* The user name of instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
userName: pulumi.Input<string>;
/**
* The user password of instance. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
userPassword: pulumi.Input<string>;
/**
* The version of instance, the value can be `2.2.2` or `2.8.2`.
*/
version: pulumi.Input<string>;
}