@upcloud/pulumi-upcloud
Version:
A Pulumi package for creating and managing UpCloud resources.
154 lines (153 loc) • 4.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages an on-demand storage backup.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as upcloud from "@upcloud/pulumi-upcloud";
*
* const backup1 = new upcloud.StorageBackup("backup_1", {
* title: "backup",
* sourceStorage: "01185ec5-1b0b-4cbc-a968-eb920ac7572d",
* });
* ```
*/
export declare class StorageBackup extends pulumi.CustomResource {
/**
* Get an existing StorageBackup 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?: StorageBackupState, opts?: pulumi.CustomResourceOptions): StorageBackup;
/**
* Returns true if the given object is an instance of StorageBackup. 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 StorageBackup;
/**
* Timestamp of the backup creation.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Sets if the storage is encrypted at rest.
*/
readonly encrypt: pulumi.Output<boolean>;
/**
* User defined key-value pairs to classify the storage.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The size of the storage in gigabytes.
*/
readonly size: pulumi.Output<number>;
/**
* The UUID of the storage to back up.
*/
readonly sourceStorage: pulumi.Output<string>;
/**
* System defined key-value pairs to classify the storage. The keys of system defined labels are prefixed with underscore and can not be modified by the user.
*/
readonly systemLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The tier of the storage.
*/
readonly tier: pulumi.Output<string>;
/**
* Title of the backup.
*/
readonly title: pulumi.Output<string>;
/**
* The type of the storage.
*/
readonly type: pulumi.Output<string>;
/**
* The zone the storage is in, e.g. `de-fra1`.
*/
readonly zone: pulumi.Output<string>;
/**
* Create a StorageBackup 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: StorageBackupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering StorageBackup resources.
*/
export interface StorageBackupState {
/**
* Timestamp of the backup creation.
*/
createdAt?: pulumi.Input<string>;
/**
* Sets if the storage is encrypted at rest.
*/
encrypt?: pulumi.Input<boolean>;
/**
* User defined key-value pairs to classify the storage.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The size of the storage in gigabytes.
*/
size?: pulumi.Input<number>;
/**
* The UUID of the storage to back up.
*/
sourceStorage?: pulumi.Input<string>;
/**
* System defined key-value pairs to classify the storage. The keys of system defined labels are prefixed with underscore and can not be modified by the user.
*/
systemLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The tier of the storage.
*/
tier?: pulumi.Input<string>;
/**
* Title of the backup.
*/
title?: pulumi.Input<string>;
/**
* The type of the storage.
*/
type?: pulumi.Input<string>;
/**
* The zone the storage is in, e.g. `de-fra1`.
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a StorageBackup resource.
*/
export interface StorageBackupArgs {
/**
* User defined key-value pairs to classify the storage.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The UUID of the storage to back up.
*/
sourceStorage: pulumi.Input<string>;
/**
* Title of the backup.
*/
title: pulumi.Input<string>;
}