@ediri/vultr
Version:
A Pulumi package for creating and managing Vultr cloud resources.
155 lines (154 loc) • 4.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a Vultr private object storage resource. This can be used to create, read, update and delete object storage resources on your Vultr account.
*
* ## Example Usage
*
* Create a new object storage subscription.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vultr from "@ediri/vultr";
*
* const tf = new vultr.ObjectStorage("tf", {
* clusterId: 9,
* label: "vultr-object-storage",
* tierId: 4,
* });
* ```
*
* ## Import
*
* Object Storage can be imported using the object storage `ID`, e.g.
*
* ```sh
* $ pulumi import vultr:index/objectStorage:ObjectStorage my_s3 0e04f918-575e-41cb-86f6-d729b354a5a1
* ```
*/
export declare class ObjectStorage extends pulumi.CustomResource {
/**
* Get an existing ObjectStorage 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?: ObjectStorageState, opts?: pulumi.CustomResourceOptions): ObjectStorage;
/**
* Returns true if the given object is an instance of ObjectStorage. 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 ObjectStorage;
/**
* The ID of the region that you want the object storage to be deployed in.
*/
readonly clusterId: pulumi.Output<number>;
/**
* Date of creation for the object storage subscription.
*/
readonly dateCreated: pulumi.Output<string>;
/**
* The description you want to give your object storage.
*/
readonly label: pulumi.Output<string | undefined>;
/**
* The location which this subscription resides in.
*/
readonly location: pulumi.Output<string>;
/**
* The region ID of the object storage subscription.
*/
readonly region: pulumi.Output<string>;
/**
* Your access key.
*/
readonly s3AccessKey: pulumi.Output<string>;
/**
* The hostname for this subscription.
*/
readonly s3Hostname: pulumi.Output<string>;
/**
* Your secret key.
*/
readonly s3SecretKey: pulumi.Output<string>;
/**
* Current status of this object storage subscription.
*/
readonly status: pulumi.Output<string>;
/**
* The ID of the tier to deploy the storage under.
*/
readonly tierId: pulumi.Output<number>;
/**
* Create a ObjectStorage 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: ObjectStorageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ObjectStorage resources.
*/
export interface ObjectStorageState {
/**
* The ID of the region that you want the object storage to be deployed in.
*/
clusterId?: pulumi.Input<number>;
/**
* Date of creation for the object storage subscription.
*/
dateCreated?: pulumi.Input<string>;
/**
* The description you want to give your object storage.
*/
label?: pulumi.Input<string>;
/**
* The location which this subscription resides in.
*/
location?: pulumi.Input<string>;
/**
* The region ID of the object storage subscription.
*/
region?: pulumi.Input<string>;
/**
* Your access key.
*/
s3AccessKey?: pulumi.Input<string>;
/**
* The hostname for this subscription.
*/
s3Hostname?: pulumi.Input<string>;
/**
* Your secret key.
*/
s3SecretKey?: pulumi.Input<string>;
/**
* Current status of this object storage subscription.
*/
status?: pulumi.Input<string>;
/**
* The ID of the tier to deploy the storage under.
*/
tierId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a ObjectStorage resource.
*/
export interface ObjectStorageArgs {
/**
* The ID of the region that you want the object storage to be deployed in.
*/
clusterId: pulumi.Input<number>;
/**
* The description you want to give your object storage.
*/
label?: pulumi.Input<string>;
/**
* The ID of the tier to deploy the storage under.
*/
tierId: pulumi.Input<number>;
}