import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * Data Source schema for Volcengine::MongoDB::Instance */ export declare function getInstance(args: GetInstanceArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getInstance. */ export interface GetInstanceArgs { /** * Uniquely identifies the resource. */ id: string; } /** * A collection of values returned by getInstance. */ export interface GetInstanceResult { /** * Allowlist ID list. New instances are bound to the specified allowlist. */ readonly allowListIds: string[]; /** * Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled. */ readonly autoRenew: boolean; /** * Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing. */ readonly chargeStatus: string; /** * Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid). */ readonly chargeType: string; /** * Scheduled shutdown time (UTC). */ readonly closedTime: string; /** * ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g. */ readonly configServerNodeSpec: string; /** * ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20. */ readonly configServerStorageSpaceGb: number; /** * ConfigServer information list. */ readonly configServers: outputs.mongodb.GetInstanceConfigServer[]; /** * ConfigServer ID */ readonly configServersId: string; /** * Instance creation time (UTC). */ readonly createdTime: string; /** * Database engine. The value is fixed as MongoDB */ readonly dbEngine: string; /** * Database engine version. Options: MongoDB*4*0 (default): MongoDB 4.0. MongoDB*4*2: MongoDB 4.2. MongoDB*4*4: MongoDB 4.4. MongoDB*5*0: MongoDB 5.0. MongoDB*6*0: MongoDB 6.0. MongoDB*7*0: MongoDB 7.0. */ readonly dbEngineVersion: string; /** * Database engine version string */ readonly dbEngineVersionStr: string; /** * Instance expiration time (UTC). */ readonly expiredTime: string; /** * Uniquely identifies the resource. */ readonly id: string; /** * Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1. */ readonly instanceCount: number; /** * Instance ID. */ readonly instanceId: string; /** * Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters. */ readonly instanceName: string; /** * Instance parameter list */ readonly instanceParameters: outputs.mongodb.GetInstanceInstanceParameter[]; /** * Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating. */ readonly instanceStatus: string; /** * MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster. */ readonly instanceType: string; /** * Mongos information list */ readonly mongos: outputs.mongodb.GetInstanceMongo[]; /** * Mongos ID. */ readonly mongosId: string; /** * Number of Mongos nodes in the sharded cluster. Range: 2~32. */ readonly mongosNodeNumber: number; /** * Specification code for Mongos nodes in a sharded cluster. */ readonly mongosNodeSpec: string; /** * Add read-only node information, including the availability zone and quantity of read-only nodes. */ readonly nodeAvailabilityZones: outputs.mongodb.GetInstanceNodeAvailabilityZone[]; /** * Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard. */ readonly nodeNumber: number; /** * Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes. */ readonly nodeSpec: string; /** * Information list for each node in the replica set instance or each node in the sharded cluster shard */ readonly nodes: outputs.mongodb.GetInstanceNode[]; /** * Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9. */ readonly period: number; /** * Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly. */ readonly periodUnit: string; /** * String information for the instance's private network connection address. */ readonly privateEndpoint: string; /** * Select the project for the instance. If left blank, the new instance will be added to the default project. */ readonly projectName: string; /** * Number of read-only nodes in the instance */ readonly readOnlyNodeNumber: number; /** * Scheduled recycle time for the instance (UTC) */ readonly reclaimTime: string; /** * Number of shards in the sharded cluster. Range: 2–32. */ readonly shardNumber: number; /** * Shard information list */ readonly shards: outputs.mongodb.GetInstanceShard[]; /** * Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10. */ readonly storageSpaceGb: number; /** * Instance storage type. Currently, only local SSD disks (LocalSSD) are supported. */ readonly storageType: string; /** * Subnet ID. */ readonly subnetId: string; /** * Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root. */ readonly superAccountName: string; /** * Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed. */ readonly superAccountPassword: string; /** * MongoDB instance tag information */ readonly tags: outputs.mongodb.GetInstanceTag[]; /** * Instance update time (UTC). */ readonly updatedTime: string; /** * Private network ID. */ readonly vpcId: string; /** * The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,). */ readonly zoneId: string; } /** * Data Source schema for Volcengine::MongoDB::Instance */ export declare function getInstanceOutput(args: GetInstanceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getInstance. */ export interface GetInstanceOutputArgs { /** * Uniquely identifies the resource. */ id: pulumi.Input; }