@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
324 lines (323 loc) • 10.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage rabbitmq instance
* ## 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.rabbitmq.Instance("fooInstance", {
* zoneIds: [
* fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* fooZones.then(fooZones => fooZones.zones?.[1]?.id),
* fooZones.then(fooZones => fooZones.zones?.[2]?.id),
* ],
* subnetId: fooSubnet.id,
* version: "3.8.18",
* userName: "acc-test-user",
* userPassword: "93f0cb0614Aab12",
* computeSpec: "rabbitmq.n3.x2.small",
* storageSpace: 300,
* instanceName: "acc-test-rabbitmq",
* instanceDescription: "acc-test",
* chargeInfo: {
* chargeType: "PostPaid",
* },
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* ```
*
* ## Import
*
* RabbitmqInstance can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:rabbitmq/instance:Instance default resource_id
* ```
*/
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 account id of the rabbitmq instance.
*/
readonly accountId: pulumi.Output<string>;
/**
* Whether enable the public network parsing function of the rabbitmq instance.
*/
readonly applyPrivateDnsToPublic: pulumi.Output<boolean>;
/**
* The type of the rabbitmq instance.
*/
readonly archType: pulumi.Output<string>;
/**
* The charge information of the rocketmq instance.
*/
readonly chargeInfo: pulumi.Output<outputs.rabbitmq.InstanceChargeInfo>;
/**
* The compute specification of the rabbitmq instance.
*/
readonly computeSpec: pulumi.Output<string>;
/**
* The create time of the rabbitmq instance.
*/
readonly createTime: pulumi.Output<string>;
/**
* The eip id of the rabbitmq instance.
*/
readonly eipId: pulumi.Output<string>;
/**
* The endpoint info of the rabbitmq instance.
*/
readonly endpoints: pulumi.Output<outputs.rabbitmq.InstanceEndpoint[]>;
/**
* The WebUI admin user name of the rabbitmq instance.
*/
readonly initUserName: pulumi.Output<string>;
/**
* The description of the rabbitmq instance.
*/
readonly instanceDescription: pulumi.Output<string | undefined>;
/**
* The name of the rabbitmq instance.
*/
readonly instanceName: pulumi.Output<string>;
/**
* The status of the rabbitmq instance.
*/
readonly instanceStatus: pulumi.Output<string>;
/**
* The IAM project name where the rabbitmq instance resides.
*/
readonly projectName: pulumi.Output<string>;
/**
* The region id of the rabbitmq instance.
*/
readonly regionId: pulumi.Output<string>;
/**
* The storage space of the rabbitmq instance. Unit: GiB. The valid value must be specified as a multiple of 100.
*/
readonly storageSpace: pulumi.Output<number>;
/**
* The subnet id of the rabbitmq instance.
*/
readonly subnetId: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.rabbitmq.InstanceTag[] | undefined>;
/**
* The used storage space of the rabbitmq instance. Unit: GiB.
*/
readonly usedStorageSpace: pulumi.Output<number>;
/**
* The administrator name of the rabbitmq instance.
*/
readonly userName: pulumi.Output<string>;
/**
* The administrator password. 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 the rabbitmq instance. Valid values: `3.8.18`, `3.12`.
*/
readonly version: pulumi.Output<string>;
/**
* The vpc id of the rabbitmq instance.
*/
readonly vpcId: pulumi.Output<string>;
/**
* The zone id of the rabbitmq instance. Support specifying multiple availability zones.
*/
readonly zoneIds: 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 account id of the rabbitmq instance.
*/
accountId?: pulumi.Input<string>;
/**
* Whether enable the public network parsing function of the rabbitmq instance.
*/
applyPrivateDnsToPublic?: pulumi.Input<boolean>;
/**
* The type of the rabbitmq instance.
*/
archType?: pulumi.Input<string>;
/**
* The charge information of the rocketmq instance.
*/
chargeInfo?: pulumi.Input<inputs.rabbitmq.InstanceChargeInfo>;
/**
* The compute specification of the rabbitmq instance.
*/
computeSpec?: pulumi.Input<string>;
/**
* The create time of the rabbitmq instance.
*/
createTime?: pulumi.Input<string>;
/**
* The eip id of the rabbitmq instance.
*/
eipId?: pulumi.Input<string>;
/**
* The endpoint info of the rabbitmq instance.
*/
endpoints?: pulumi.Input<pulumi.Input<inputs.rabbitmq.InstanceEndpoint>[]>;
/**
* The WebUI admin user name of the rabbitmq instance.
*/
initUserName?: pulumi.Input<string>;
/**
* The description of the rabbitmq instance.
*/
instanceDescription?: pulumi.Input<string>;
/**
* The name of the rabbitmq instance.
*/
instanceName?: pulumi.Input<string>;
/**
* The status of the rabbitmq instance.
*/
instanceStatus?: pulumi.Input<string>;
/**
* The IAM project name where the rabbitmq instance resides.
*/
projectName?: pulumi.Input<string>;
/**
* The region id of the rabbitmq instance.
*/
regionId?: pulumi.Input<string>;
/**
* The storage space of the rabbitmq instance. Unit: GiB. The valid value must be specified as a multiple of 100.
*/
storageSpace?: pulumi.Input<number>;
/**
* The subnet id of the rabbitmq instance.
*/
subnetId?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.rabbitmq.InstanceTag>[]>;
/**
* The used storage space of the rabbitmq instance. Unit: GiB.
*/
usedStorageSpace?: pulumi.Input<number>;
/**
* The administrator name of the rabbitmq instance.
*/
userName?: pulumi.Input<string>;
/**
* The administrator password. 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 the rabbitmq instance. Valid values: `3.8.18`, `3.12`.
*/
version?: pulumi.Input<string>;
/**
* The vpc id of the rabbitmq instance.
*/
vpcId?: pulumi.Input<string>;
/**
* The zone id of the rabbitmq instance. Support specifying multiple availability zones.
*/
zoneIds?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a Instance resource.
*/
export interface InstanceArgs {
/**
* The charge information of the rocketmq instance.
*/
chargeInfo: pulumi.Input<inputs.rabbitmq.InstanceChargeInfo>;
/**
* The compute specification of the rabbitmq instance.
*/
computeSpec: pulumi.Input<string>;
/**
* The description of the rabbitmq instance.
*/
instanceDescription?: pulumi.Input<string>;
/**
* The name of the rabbitmq instance.
*/
instanceName?: pulumi.Input<string>;
/**
* The IAM project name where the rabbitmq instance resides.
*/
projectName?: pulumi.Input<string>;
/**
* The storage space of the rabbitmq instance. Unit: GiB. The valid value must be specified as a multiple of 100.
*/
storageSpace: pulumi.Input<number>;
/**
* The subnet id of the rabbitmq instance.
*/
subnetId: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.rabbitmq.InstanceTag>[]>;
/**
* The administrator name of the rabbitmq instance.
*/
userName: pulumi.Input<string>;
/**
* The administrator password. 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 the rabbitmq instance. Valid values: `3.8.18`, `3.12`.
*/
version: pulumi.Input<string>;
/**
* The zone id of the rabbitmq instance. Support specifying multiple availability zones.
*/
zoneIds: pulumi.Input<pulumi.Input<string>[]>;
}