@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
140 lines (139 loc) • 5.19 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage mongodb instance parameter
* ## 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.mongodb.Instance("fooInstance", {
* dbEngineVersion: "MongoDB_4_0",
* instanceType: "ReplicaSet",
* superAccountPassword: "@acc-test-123",
* nodeSpec: "mongo.2c4g",
* mongosNodeSpec: "mongo.mongos.2c4g",
* instanceName: "acc-test-mongo-replica",
* chargeType: "PostPaid",
* projectName: "default",
* mongosNodeNumber: 32,
* shardNumber: 3,
* storageSpaceGb: 20,
* subnetId: fooSubnet.id,
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const fooInstanceParameter = new volcengine.mongodb.InstanceParameter("fooInstanceParameter", {
* instanceId: fooInstance.id,
* parameterName: "cursorTimeoutMillis",
* parameterRole: "Node",
* parameterValue: "600111",
* });
* ```
*
* ## Import
*
* mongodb parameter can be imported using the param:instanceId:parameterName:parameterRole, e.g.
*
* ```sh
* $ pulumi import volcengine:mongodb/instanceParameter:InstanceParameter default param:mongo-replica-e405f8e2****:connPoolMaxConnsPerHost
* ```
*/
export declare class InstanceParameter extends pulumi.CustomResource {
/**
* Get an existing InstanceParameter 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?: InstanceParameterState, opts?: pulumi.CustomResourceOptions): InstanceParameter;
/**
* Returns true if the given object is an instance of InstanceParameter. 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 InstanceParameter;
/**
* The instance ID.
*/
readonly instanceId: pulumi.Output<string>;
/**
* The name of parameter. The parameter resource can only be added or modified, deleting this resource will not actually execute any operation.
*/
readonly parameterName: pulumi.Output<string>;
/**
* The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
*/
readonly parameterRole: pulumi.Output<string>;
/**
* The value of parameter.
*/
readonly parameterValue: pulumi.Output<string>;
/**
* Create a InstanceParameter 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: InstanceParameterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InstanceParameter resources.
*/
export interface InstanceParameterState {
/**
* The instance ID.
*/
instanceId?: pulumi.Input<string>;
/**
* The name of parameter. The parameter resource can only be added or modified, deleting this resource will not actually execute any operation.
*/
parameterName?: pulumi.Input<string>;
/**
* The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
*/
parameterRole?: pulumi.Input<string>;
/**
* The value of parameter.
*/
parameterValue?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a InstanceParameter resource.
*/
export interface InstanceParameterArgs {
/**
* The instance ID.
*/
instanceId: pulumi.Input<string>;
/**
* The name of parameter. The parameter resource can only be added or modified, deleting this resource will not actually execute any operation.
*/
parameterName: pulumi.Input<string>;
/**
* The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
*/
parameterRole: pulumi.Input<string>;
/**
* The value of parameter.
*/
parameterValue: pulumi.Input<string>;
}