@upcloud/pulumi-upcloud
Version:
A Pulumi package for creating and managing UpCloud resources.
181 lines (180 loc) • 6.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* This resource represents an UpCloud Managed Object Storage instance, which provides S3 compatible storage.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as upcloud from "@upcloud/pulumi-upcloud";
*
* // Create router for the network
* const _this = new upcloud.Router("this", {name: "object-storage-example-router"});
* // Create network for the Managed Object Storage
* const thisNetwork = new upcloud.Network("this", {
* name: "object-storage-example-net",
* zone: "fi-hel1",
* ipNetwork: {
* address: "172.16.2.0/24",
* dhcp: true,
* family: "IPv4",
* },
* router: _this.id,
* });
* const thisManagedObjectStorage = new upcloud.ManagedObjectStorage("this", {
* name: "example",
* region: "europe-1",
* configuredStatus: "started",
* networks: [{
* family: "IPv4",
* name: "example-private-net",
* type: "private",
* uuid: thisNetwork.id,
* }],
* labels: {
* "managed-by": "terraform",
* },
* });
* ```
*/
export declare class ManagedObjectStorage extends pulumi.CustomResource {
/**
* Get an existing ManagedObjectStorage 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?: ManagedObjectStorageState, opts?: pulumi.CustomResourceOptions): ManagedObjectStorage;
/**
* Returns true if the given object is an instance of ManagedObjectStorage. 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 ManagedObjectStorage;
/**
* Service status managed by the end user.
*/
readonly configuredStatus: pulumi.Output<string>;
/**
* Creation time.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Endpoints for accessing the Managed Object Storage service.
*/
readonly endpoints: pulumi.Output<outputs.ManagedObjectStorageEndpoint[]>;
/**
* User defined key-value pairs to classify the managed object storage.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Name of the Managed Object Storage service. Must be unique within account.
*/
readonly name: pulumi.Output<string>;
/**
* Attached networks from where object storage can be used. Private networks must reside in object storage region. To gain
* access from multiple private networks that might reside in different zones, create the networks and a corresponding
* router for each network.
*/
readonly networks: pulumi.Output<outputs.ManagedObjectStorageNetwork[] | undefined>;
/**
* Operational state of the Managed Object Storage service.
*/
readonly operationalState: pulumi.Output<string>;
/**
* Region in which the service will be hosted, see `upcloud.getManagedObjectStorageRegions` data source.
*/
readonly region: pulumi.Output<string>;
/**
* Creation time.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a ManagedObjectStorage 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: ManagedObjectStorageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ManagedObjectStorage resources.
*/
export interface ManagedObjectStorageState {
/**
* Service status managed by the end user.
*/
configuredStatus?: pulumi.Input<string>;
/**
* Creation time.
*/
createdAt?: pulumi.Input<string>;
/**
* Endpoints for accessing the Managed Object Storage service.
*/
endpoints?: pulumi.Input<pulumi.Input<inputs.ManagedObjectStorageEndpoint>[]>;
/**
* User defined key-value pairs to classify the managed object storage.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the Managed Object Storage service. Must be unique within account.
*/
name?: pulumi.Input<string>;
/**
* Attached networks from where object storage can be used. Private networks must reside in object storage region. To gain
* access from multiple private networks that might reside in different zones, create the networks and a corresponding
* router for each network.
*/
networks?: pulumi.Input<pulumi.Input<inputs.ManagedObjectStorageNetwork>[]>;
/**
* Operational state of the Managed Object Storage service.
*/
operationalState?: pulumi.Input<string>;
/**
* Region in which the service will be hosted, see `upcloud.getManagedObjectStorageRegions` data source.
*/
region?: pulumi.Input<string>;
/**
* Creation time.
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ManagedObjectStorage resource.
*/
export interface ManagedObjectStorageArgs {
/**
* Service status managed by the end user.
*/
configuredStatus: pulumi.Input<string>;
/**
* User defined key-value pairs to classify the managed object storage.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the Managed Object Storage service. Must be unique within account.
*/
name?: pulumi.Input<string>;
/**
* Attached networks from where object storage can be used. Private networks must reside in object storage region. To gain
* access from multiple private networks that might reside in different zones, create the networks and a corresponding
* router for each network.
*/
networks?: pulumi.Input<pulumi.Input<inputs.ManagedObjectStorageNetwork>[]>;
/**
* Region in which the service will be hosted, see `upcloud.getManagedObjectStorageRegions` data source.
*/
region: pulumi.Input<string>;
}