@pulumiverse/cpln
Version:
A Pulumi package for creating and managing Control Plane (cpln) resources.
221 lines (220 loc) • 8.19 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class VolumeSet extends pulumi.CustomResource {
/**
* Get an existing VolumeSet 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?: VolumeSetState, opts?: pulumi.CustomResourceOptions): VolumeSet;
/**
* Returns true if the given object is an instance of VolumeSet. 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 VolumeSet;
/**
* Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
*/
readonly autoscaling: pulumi.Output<outputs.VolumeSetAutoscaling | undefined>;
/**
* The ID, in GUID format, of the volume set.
*/
readonly cplnId: pulumi.Output<string>;
/**
* Description of the volume set.
*/
readonly description: pulumi.Output<string>;
/**
* Each volume set has a single, immutable file system. Valid types: `xfs` or `ext4`.
*/
readonly fileSystemType: pulumi.Output<string>;
/**
* Name of the associated GVC.
*/
readonly gvc: pulumi.Output<string>;
/**
* The initial volume size in this set, specified in GB. The minimum size for the performance class `general-purpose-ssd`
* is `10 GB`, while `high-throughput-ssd` requires at least `200 GB`.
*/
readonly initialCapacity: pulumi.Output<number>;
/**
* A list of mount options to use when mounting volumes in this set.
*/
readonly mountOptions: pulumi.Output<outputs.VolumeSetMountOptions | undefined>;
/**
* Name of the volume set.
*/
readonly name: pulumi.Output<string>;
/**
* Each volume set has a single, immutable, performance class. Valid classes: `general-purpose-ssd` or
* `high-throughput-ssd`.
*/
readonly performanceClass: pulumi.Output<string>;
/**
* Full link to this resource. Can be referenced by other resources.
*/
readonly selfLink: pulumi.Output<string>;
/**
* Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
*/
readonly snapshots: pulumi.Output<outputs.VolumeSetSnapshots | undefined>;
/**
* Status of the Volume Set.
*/
readonly statuses: pulumi.Output<outputs.VolumeSetStatus[]>;
/**
* For self-hosted locations only. The storage class used for volumes in this set will be
* {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be
* {performanceClass}-{fileSystemType}
*/
readonly storageClassSuffix: pulumi.Output<string | undefined>;
/**
* Key-value map of resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
}>;
/**
* Output used when linking a volume set to a workload.
*/
readonly volumesetLink: pulumi.Output<string>;
/**
* Create a VolumeSet 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: VolumeSetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VolumeSet resources.
*/
export interface VolumeSetState {
/**
* Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
*/
autoscaling?: pulumi.Input<inputs.VolumeSetAutoscaling>;
/**
* The ID, in GUID format, of the volume set.
*/
cplnId?: pulumi.Input<string>;
/**
* Description of the volume set.
*/
description?: pulumi.Input<string>;
/**
* Each volume set has a single, immutable file system. Valid types: `xfs` or `ext4`.
*/
fileSystemType?: pulumi.Input<string>;
/**
* Name of the associated GVC.
*/
gvc?: pulumi.Input<string>;
/**
* The initial volume size in this set, specified in GB. The minimum size for the performance class `general-purpose-ssd`
* is `10 GB`, while `high-throughput-ssd` requires at least `200 GB`.
*/
initialCapacity?: pulumi.Input<number>;
/**
* A list of mount options to use when mounting volumes in this set.
*/
mountOptions?: pulumi.Input<inputs.VolumeSetMountOptions>;
/**
* Name of the volume set.
*/
name?: pulumi.Input<string>;
/**
* Each volume set has a single, immutable, performance class. Valid classes: `general-purpose-ssd` or
* `high-throughput-ssd`.
*/
performanceClass?: pulumi.Input<string>;
/**
* Full link to this resource. Can be referenced by other resources.
*/
selfLink?: pulumi.Input<string>;
/**
* Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
*/
snapshots?: pulumi.Input<inputs.VolumeSetSnapshots>;
/**
* Status of the Volume Set.
*/
statuses?: pulumi.Input<pulumi.Input<inputs.VolumeSetStatus>[]>;
/**
* For self-hosted locations only. The storage class used for volumes in this set will be
* {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be
* {performanceClass}-{fileSystemType}
*/
storageClassSuffix?: pulumi.Input<string>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Output used when linking a volume set to a workload.
*/
volumesetLink?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VolumeSet resource.
*/
export interface VolumeSetArgs {
/**
* Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
*/
autoscaling?: pulumi.Input<inputs.VolumeSetAutoscaling>;
/**
* Description of the volume set.
*/
description?: pulumi.Input<string>;
/**
* Each volume set has a single, immutable file system. Valid types: `xfs` or `ext4`.
*/
fileSystemType?: pulumi.Input<string>;
/**
* Name of the associated GVC.
*/
gvc: pulumi.Input<string>;
/**
* The initial volume size in this set, specified in GB. The minimum size for the performance class `general-purpose-ssd`
* is `10 GB`, while `high-throughput-ssd` requires at least `200 GB`.
*/
initialCapacity: pulumi.Input<number>;
/**
* A list of mount options to use when mounting volumes in this set.
*/
mountOptions?: pulumi.Input<inputs.VolumeSetMountOptions>;
/**
* Name of the volume set.
*/
name?: pulumi.Input<string>;
/**
* Each volume set has a single, immutable, performance class. Valid classes: `general-purpose-ssd` or
* `high-throughput-ssd`.
*/
performanceClass: pulumi.Input<string>;
/**
* Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
*/
snapshots?: pulumi.Input<inputs.VolumeSetSnapshots>;
/**
* For self-hosted locations only. The storage class used for volumes in this set will be
* {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be
* {performanceClass}-{fileSystemType}
*/
storageClassSuffix?: pulumi.Input<string>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}