@pulumi/kubernetes
Version:
[](https://github.com/pulumi/pulumi-kubernetes/actions) [](https://slack.pulumi.com) [ • 6.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
*
* StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.
*/
export declare class StorageClass extends pulumi.CustomResource {
/**
* Get an existing StorageClass 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): StorageClass;
/**
* Returns true if the given object is an instance of StorageClass. 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 StorageClass;
/**
* AllowVolumeExpansion shows whether the storage class allow volume expand
*/
readonly allowVolumeExpansion: pulumi.Output<boolean>;
/**
* Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
*/
readonly allowedTopologies: pulumi.Output<outputs.core.v1.TopologySelectorTerm[]>;
/**
* APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
*/
readonly apiVersion: pulumi.Output<"storage.k8s.io/v1beta1">;
/**
* Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
*/
readonly kind: pulumi.Output<"StorageClass">;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
readonly metadata: pulumi.Output<outputs.meta.v1.ObjectMeta>;
/**
* Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
*/
readonly mountOptions: pulumi.Output<string[]>;
/**
* Parameters holds the parameters for the provisioner that should create volumes of this storage class.
*/
readonly parameters: pulumi.Output<{
[key: string]: string;
}>;
/**
* Provisioner indicates the type of the provisioner.
*/
readonly provisioner: pulumi.Output<string>;
/**
* Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
*/
readonly reclaimPolicy: pulumi.Output<string>;
/**
* VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
*/
readonly volumeBindingMode: pulumi.Output<string>;
/**
* Create a StorageClass 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?: StorageClassArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a StorageClass resource.
*/
export interface StorageClassArgs {
/**
* AllowVolumeExpansion shows whether the storage class allow volume expand
*/
allowVolumeExpansion?: pulumi.Input<boolean>;
/**
* Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
*/
allowedTopologies?: pulumi.Input<pulumi.Input<inputs.core.v1.TopologySelectorTerm>[]>;
/**
* APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
*/
apiVersion?: pulumi.Input<"storage.k8s.io/v1beta1">;
/**
* Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
*/
kind?: pulumi.Input<"StorageClass">;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
metadata?: pulumi.Input<inputs.meta.v1.ObjectMeta>;
/**
* Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
*/
mountOptions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Parameters holds the parameters for the provisioner that should create volumes of this storage class.
*/
parameters?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Provisioner indicates the type of the provisioner.
*/
provisioner: pulumi.Input<string>;
/**
* Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
*/
reclaimPolicy?: pulumi.Input<string>;
/**
* VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
*/
volumeBindingMode?: pulumi.Input<string>;
}