@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
169 lines (168 loc) • 5.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway MongoDB® snapshots.
* For more information refer to the [product documentation](https://www.scaleway.com/en/docs/managed-mongodb-databases/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.mongodb.Snapshot("main", {
* instanceId: mainScalewayMongodbInstance.id,
* name: "name-snapshot",
* expiresAt: "2024-12-31T23:59:59Z",
* });
* ```
*
* ## Import
*
* MongoDB® snapshots can be imported using the `{region}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/mongoDbSnapshot:MongoDbSnapshot main fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/mongodbsnapshot.MongoDbSnapshot has been deprecated in favor of scaleway.mongodb/snapshot.Snapshot
*/
export declare class MongoDbSnapshot extends pulumi.CustomResource {
/**
* Get an existing MongoDbSnapshot 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?: MongoDbSnapshotState, opts?: pulumi.CustomResourceOptions): MongoDbSnapshot;
/**
* Returns true if the given object is an instance of MongoDbSnapshot. 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 MongoDbSnapshot;
/**
* The date and time when the MongoDB® snapshot was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The expiration date of the MongoDB® snapshot in ISO 8601 format (e.g. `2024-12-31T23:59:59Z`).
*
* > **Important:** Once set, `expiresAt` cannot be removed.
*/
readonly expiresAt: pulumi.Output<string>;
/**
* The ID of the MongoDB® instance from which the snapshot was created.
*/
readonly instanceId: pulumi.Output<string>;
/**
* The name of the MongoDB® instance from which the snapshot was created.
*/
readonly instanceName: pulumi.Output<string>;
/**
* The name of the MongoDB® snapshot.
*/
readonly name: pulumi.Output<string>;
/**
* The type of node associated with the MongoDB® snapshot.
*/
readonly nodeType: pulumi.Output<string>;
/**
* `region`) The region in which the MongoDB® snapshot should be created.
*/
readonly region: pulumi.Output<string>;
/**
* The size of the MongoDB® snapshot in bytes.
*/
readonly size: pulumi.Output<number>;
/**
* The date and time of the last update of the MongoDB® snapshot.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The type of volume used for the MongoDB® snapshot.
*/
readonly volumeType: pulumi.Output<string>;
/**
* Create a MongoDbSnapshot 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.
*/
/** @deprecated scaleway.index/mongodbsnapshot.MongoDbSnapshot has been deprecated in favor of scaleway.mongodb/snapshot.Snapshot */
constructor(name: string, args: MongoDbSnapshotArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MongoDbSnapshot resources.
*/
export interface MongoDbSnapshotState {
/**
* The date and time when the MongoDB® snapshot was created.
*/
createdAt?: pulumi.Input<string>;
/**
* The expiration date of the MongoDB® snapshot in ISO 8601 format (e.g. `2024-12-31T23:59:59Z`).
*
* > **Important:** Once set, `expiresAt` cannot be removed.
*/
expiresAt?: pulumi.Input<string>;
/**
* The ID of the MongoDB® instance from which the snapshot was created.
*/
instanceId?: pulumi.Input<string>;
/**
* The name of the MongoDB® instance from which the snapshot was created.
*/
instanceName?: pulumi.Input<string>;
/**
* The name of the MongoDB® snapshot.
*/
name?: pulumi.Input<string>;
/**
* The type of node associated with the MongoDB® snapshot.
*/
nodeType?: pulumi.Input<string>;
/**
* `region`) The region in which the MongoDB® snapshot should be created.
*/
region?: pulumi.Input<string>;
/**
* The size of the MongoDB® snapshot in bytes.
*/
size?: pulumi.Input<number>;
/**
* The date and time of the last update of the MongoDB® snapshot.
*/
updatedAt?: pulumi.Input<string>;
/**
* The type of volume used for the MongoDB® snapshot.
*/
volumeType?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MongoDbSnapshot resource.
*/
export interface MongoDbSnapshotArgs {
/**
* The expiration date of the MongoDB® snapshot in ISO 8601 format (e.g. `2024-12-31T23:59:59Z`).
*
* > **Important:** Once set, `expiresAt` cannot be removed.
*/
expiresAt: pulumi.Input<string>;
/**
* The ID of the MongoDB® instance from which the snapshot was created.
*/
instanceId: pulumi.Input<string>;
/**
* The name of the MongoDB® snapshot.
*/
name?: pulumi.Input<string>;
/**
* `region`) The region in which the MongoDB® snapshot should be created.
*/
region?: pulumi.Input<string>;
}