@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
186 lines (185 loc) • 6.41 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Use this data source to query detailed information of mongodb instance parameters
* ## 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",
* });
* const fooInstanceParameters = volcengine.mongodb.getInstanceParametersOutput({
* instanceId: fooInstance.id,
* parameterNames: "cursorTimeoutMillis",
* parameterRole: "Node",
* });
* ```
*/
/** @deprecated volcengine.mongodb.InstanceParameters has been deprecated in favor of volcengine.mongodb.getInstanceParameters */
export declare function instanceParameters(args: InstanceParametersArgs, opts?: pulumi.InvokeOptions): Promise<InstanceParametersResult>;
/**
* A collection of arguments for invoking InstanceParameters.
*/
export interface InstanceParametersArgs {
/**
* The instance ID to query.
*/
instanceId: string;
/**
* File name where to save data source results.
*/
outputFile?: string;
/**
* The parameter names, support fuzzy query, case insensitive.
*/
parameterNames?: string;
/**
* The node type of instance parameter, valid value contains `Node`, `Shard`, `ConfigServer`, `Mongos`.
*/
parameterRole?: string;
}
/**
* A collection of values returned by InstanceParameters.
*/
export interface InstanceParametersResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The instance ID.
*/
readonly instanceId: string;
/**
* The list of parameters.
*/
readonly instanceParameters: outputs.mongodb.InstanceParametersInstanceParameter[];
readonly outputFile?: string;
readonly parameterNames?: string;
/**
* The node type to which the parameter belongs.
*/
readonly parameterRole?: string;
/**
* (**Deprecated**) This field has been deprecated and it is recommended to use instance_parameters. The collection of parameter query.
*
* @deprecated This field has been deprecated and it is recommended to use instance_parameters.
*/
readonly parameters: outputs.mongodb.InstanceParametersParameter[];
/**
* The total count of mongodb instance parameter query.
*/
readonly totalCount: number;
}
/**
* Use this data source to query detailed information of mongodb instance parameters
* ## 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",
* });
* const fooInstanceParameters = volcengine.mongodb.getInstanceParametersOutput({
* instanceId: fooInstance.id,
* parameterNames: "cursorTimeoutMillis",
* parameterRole: "Node",
* });
* ```
*/
/** @deprecated volcengine.mongodb.InstanceParameters has been deprecated in favor of volcengine.mongodb.getInstanceParameters */
export declare function instanceParametersOutput(args: InstanceParametersOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<InstanceParametersResult>;
/**
* A collection of arguments for invoking InstanceParameters.
*/
export interface InstanceParametersOutputArgs {
/**
* The instance ID to query.
*/
instanceId: pulumi.Input<string>;
/**
* File name where to save data source results.
*/
outputFile?: pulumi.Input<string>;
/**
* The parameter names, support fuzzy query, case insensitive.
*/
parameterNames?: pulumi.Input<string>;
/**
* The node type of instance parameter, valid value contains `Node`, `Shard`, `ConfigServer`, `Mongos`.
*/
parameterRole?: pulumi.Input<string>;
}