@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
352 lines (351 loc) • 10.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Creates and manages Scaleway MongoDB® instance.
* For more information refer to the [product documentation](https://www.scaleway.com/en/docs/managed-mongodb-databases/).
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.mongodb.Instance("main", {
* name: "test-mongodb-basic1",
* version: "7.0.12",
* nodeType: "MGDB-PLAY2-NANO",
* nodeNumber: 1,
* userName: "my_initial_user",
* password: "thiZ_is_v&ry_s3cret",
* volumeSizeInGb: 5,
* });
* ```
*
* ### Private Network
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "my_private_network",
* region: "fr-par",
* });
* const main = new scaleway.mongodb.Instance("main", {
* name: "test-mongodb-basic1",
* version: "7.0.12",
* nodeType: "MGDB-PLAY2-NANO",
* nodeNumber: 1,
* userName: "my_initial_user",
* password: "thiZ_is_v&ry_s3cret",
* volumeSizeInGb: 5,
* privateNetwork: {
* pnId: pn02.id,
* },
* });
* ```
*
* ### Private Network and Public Network
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "my_private_network",
* region: "fr-par",
* });
* const main = new scaleway.mongodb.Instance("main", {
* name: "test-mongodb-basic1",
* version: "7.0.12",
* nodeType: "MGDB-PLAY2-NANO",
* nodeNumber: 1,
* userName: "my_initial_user",
* password: "thiZ_is_v&ry_s3cret",
* volumeSizeInGb: 5,
* privateNetwork: {
* pnId: pn02.id,
* },
* publicNetwork: {},
* });
* ```
*
* ### Restore From Snapshot
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const restoredInstance = new scaleway.mongodb.Instance("restored_instance", {
* snapshotId: pn.idscalewayMongodbSnapshot.mainSnapshot.id,
* name: "restored-mongodb-from-snapshot",
* nodeType: "MGDB-PLAY2-NANO",
* nodeNumber: 1,
* });
* ```
*
* ## Import
*
* MongoDB® instance can be imported using the `id`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:mongodb/instance:Instance main fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*/
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 date and time of the creation of the MongoDB® instance.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Name of the MongoDB® instance.
*/
readonly name: pulumi.Output<string>;
/**
* Number of nodes in the instance
*/
readonly nodeNumber: pulumi.Output<number>;
/**
* The type of MongoDB® intance to create.
*/
readonly nodeType: pulumi.Output<string>;
/**
* Password of the user.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* The private IPv4 address associated with the instance.
*/
readonly privateIps: pulumi.Output<outputs.mongodb.InstancePrivateIp[]>;
/**
* Private Network endpoints of the Database Instance.
*/
readonly privateNetwork: pulumi.Output<outputs.mongodb.InstancePrivateNetwork | undefined>;
/**
* The projectId you want to attach the resource to
*/
readonly projectId: pulumi.Output<string>;
/**
* Public network endpoint configuration (no arguments).
* > **Important** If neither privateNetwork nor publicNetwork is specified, a public network endpoint is created by default.
*/
readonly publicNetwork: pulumi.Output<outputs.mongodb.InstancePublicNetwork>;
/**
* The region you want to attach the resource to
*/
readonly region: pulumi.Output<string>;
/**
* Map of settings to define for the instance.
*/
readonly settings: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Snapshot ID to restore the MongoDB® instance from.
*/
readonly snapshotId: pulumi.Output<string | undefined>;
/**
* List of tags attached to the MongoDB® instance.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The date and time of the last update of the MongoDB® instance.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Name of the user created when the intance is created.
*/
readonly userName: pulumi.Output<string | undefined>;
/**
* MongoDB® version of the instance.
*/
readonly version: pulumi.Output<string>;
/**
* Volume size in GB.
*/
readonly volumeSizeInGb: pulumi.Output<number>;
/**
* Volume type of the instance.
*/
readonly volumeType: pulumi.Output<string | undefined>;
/**
* 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 date and time of the creation of the MongoDB® instance.
*/
createdAt?: pulumi.Input<string>;
/**
* Name of the MongoDB® instance.
*/
name?: pulumi.Input<string>;
/**
* Number of nodes in the instance
*/
nodeNumber?: pulumi.Input<number>;
/**
* The type of MongoDB® intance to create.
*/
nodeType?: pulumi.Input<string>;
/**
* Password of the user.
*/
password?: pulumi.Input<string>;
/**
* The private IPv4 address associated with the instance.
*/
privateIps?: pulumi.Input<pulumi.Input<inputs.mongodb.InstancePrivateIp>[]>;
/**
* Private Network endpoints of the Database Instance.
*/
privateNetwork?: pulumi.Input<inputs.mongodb.InstancePrivateNetwork>;
/**
* The projectId you want to attach the resource to
*/
projectId?: pulumi.Input<string>;
/**
* Public network endpoint configuration (no arguments).
* > **Important** If neither privateNetwork nor publicNetwork is specified, a public network endpoint is created by default.
*/
publicNetwork?: pulumi.Input<inputs.mongodb.InstancePublicNetwork>;
/**
* The region you want to attach the resource to
*/
region?: pulumi.Input<string>;
/**
* Map of settings to define for the instance.
*/
settings?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Snapshot ID to restore the MongoDB® instance from.
*/
snapshotId?: pulumi.Input<string>;
/**
* List of tags attached to the MongoDB® instance.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The date and time of the last update of the MongoDB® instance.
*/
updatedAt?: pulumi.Input<string>;
/**
* Name of the user created when the intance is created.
*/
userName?: pulumi.Input<string>;
/**
* MongoDB® version of the instance.
*/
version?: pulumi.Input<string>;
/**
* Volume size in GB.
*/
volumeSizeInGb?: pulumi.Input<number>;
/**
* Volume type of the instance.
*/
volumeType?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Instance resource.
*/
export interface InstanceArgs {
/**
* Name of the MongoDB® instance.
*/
name?: pulumi.Input<string>;
/**
* Number of nodes in the instance
*/
nodeNumber: pulumi.Input<number>;
/**
* The type of MongoDB® intance to create.
*/
nodeType: pulumi.Input<string>;
/**
* Password of the user.
*/
password?: pulumi.Input<string>;
/**
* The private IPv4 address associated with the instance.
*/
privateIps?: pulumi.Input<pulumi.Input<inputs.mongodb.InstancePrivateIp>[]>;
/**
* Private Network endpoints of the Database Instance.
*/
privateNetwork?: pulumi.Input<inputs.mongodb.InstancePrivateNetwork>;
/**
* The projectId you want to attach the resource to
*/
projectId?: pulumi.Input<string>;
/**
* Public network endpoint configuration (no arguments).
* > **Important** If neither privateNetwork nor publicNetwork is specified, a public network endpoint is created by default.
*/
publicNetwork?: pulumi.Input<inputs.mongodb.InstancePublicNetwork>;
/**
* The region you want to attach the resource to
*/
region?: pulumi.Input<string>;
/**
* Map of settings to define for the instance.
*/
settings?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Snapshot ID to restore the MongoDB® instance from.
*/
snapshotId?: pulumi.Input<string>;
/**
* List of tags attached to the MongoDB® instance.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the user created when the intance is created.
*/
userName?: pulumi.Input<string>;
/**
* MongoDB® version of the instance.
*/
version?: pulumi.Input<string>;
/**
* Volume size in GB.
*/
volumeSizeInGb?: pulumi.Input<number>;
/**
* Volume type of the instance.
*/
volumeType?: pulumi.Input<string>;
}