Module storage/v1beta1

@pulumi/kubernetes > storage > v1beta1

class CSIDriver

extends CustomResource

CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.

constructor

new CSIDriver(name: string, args?: inputApi.storage.v1beta1.CSIDriver, opts?: pulumi.CustomResourceOptions)

Create a storage.v1beta1.CSIDriver resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CSIDriver

Get the state of an existing CSIDriver resource, as identified by id. Typically this ID is of the form /; if is omitted, then (per Kubernetes convention) the ID becomes default/.

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of CSIDriver. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<“storage.k8s.io/v1beta1”>;

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/api-conventions.md#resources

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<“CSIDriver”>;

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/api-conventions.md#types-kinds

property metadata

public metadata: pulumi.Output<outputApi.meta.v1.ObjectMeta>;

Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

public spec: pulumi.Output<outputApi.storage.v1beta1.CSIDriverSpec>;

Specification of the CSI Driver.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class CSIDriverList

extends CustomResource

CSIDriverList is a collection of CSIDriver objects.

constructor

new CSIDriverList(name: string, args?: inputApi.storage.v1beta1.CSIDriverList, opts?: pulumi.CustomResourceOptions)

Create a storage.v1beta1.CSIDriverList resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CSIDriverList

Get the state of an existing CSIDriverList resource, as identified by id. Typically this ID is of the form /; if is omitted, then (per Kubernetes convention) the ID becomes default/.

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of CSIDriverList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<“storage.k8s.io/v1beta1”>;

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/api-conventions.md#resources

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property items

public items: pulumi.Output<outputApi.storage.v1beta1.CSIDriver[]>;

items is the list of CSIDriver

property kind

public kind: pulumi.Output<“CSIDriverList”>;

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/api-conventions.md#types-kinds

property metadata

public metadata: pulumi.Output<outputApi.meta.v1.ListMeta>;

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class CSINode

extends CustomResource

CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn’t create this object. CSINode has an OwnerReference that points to the corresponding node object.

constructor

new CSINode(name: string, args?: inputApi.storage.v1beta1.CSINode, opts?: pulumi.CustomResourceOptions)

Create a storage.v1beta1.CSINode resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CSINode

Get the state of an existing CSINode resource, as identified by id. Typically this ID is of the form /; if is omitted, then (per Kubernetes convention) the ID becomes default/.

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of CSINode. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<“storage.k8s.io/v1beta1”>;

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/api-conventions.md#resources

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<“CSINode”>;

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/api-conventions.md#types-kinds

property metadata

public metadata: pulumi.Output<outputApi.meta.v1.ObjectMeta>;

metadata.name must be the Kubernetes node name.

property spec

public spec: pulumi.Output<outputApi.storage.v1beta1.CSINodeSpec>;

spec is the specification of CSINode

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class CSINodeList

extends CustomResource

CSINodeList is a collection of CSINode objects.

constructor

new CSINodeList(name: string, args?: inputApi.storage.v1beta1.CSINodeList, opts?: pulumi.CustomResourceOptions)

Create a storage.v1beta1.CSINodeList resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CSINodeList

Get the state of an existing CSINodeList resource, as identified by id. Typically this ID is of the form /; if is omitted, then (per Kubernetes convention) the ID becomes default/.

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of CSINodeList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<“storage.k8s.io/v1beta1”>;

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/api-conventions.md#resources

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property items

public items: pulumi.Output<outputApi.storage.v1beta1.CSINode[]>;

items is the list of CSINode

property kind

public kind: pulumi.Output<“CSINodeList”>;

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/api-conventions.md#types-kinds

property metadata

public metadata: pulumi.Output<outputApi.meta.v1.ListMeta>;

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class StorageClass

extends CustomResource

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.

constructor

new StorageClass(name: string, args?: inputApi.storage.v1beta1.StorageClass, opts?: pulumi.CustomResourceOptions)

Create a storage.v1beta1.StorageClass resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): StorageClass

Get the state of an existing StorageClass resource, as identified by id. Typically this ID is of the form /; if is omitted, then (per Kubernetes convention) the ID becomes default/.

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

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.

property allowVolumeExpansion

public allowVolumeExpansion: pulumi.Output<boolean>;

AllowVolumeExpansion shows whether the storage class allow volume expand

property allowedTopologies

public allowedTopologies: pulumi.Output<outputApi.core.v1.TopologySelectorTerm[]>;

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.

property apiVersion

public apiVersion: pulumi.Output<“storage.k8s.io/v1beta1”>;

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/api-conventions.md#resources

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<“StorageClass”>;

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/api-conventions.md#types-kinds

property metadata

public metadata: pulumi.Output<outputApi.meta.v1.ObjectMeta>;

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property mountOptions

public mountOptions: pulumi.Output<string[]>;

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.

property parameters

public parameters: pulumi.Output<{[key: string]: pulumi.Output<string>}>;

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

property provisioner

public provisioner: pulumi.Output<string>;

Provisioner indicates the type of the provisioner.

property reclaimPolicy

public reclaimPolicy: pulumi.Output<string>;

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumeBindingMode

public volumeBindingMode: 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.

class StorageClassList

extends CustomResource

StorageClassList is a collection of storage classes.

constructor

new StorageClassList(name: string, args?: inputApi.storage.v1beta1.StorageClassList, opts?: pulumi.CustomResourceOptions)

Create a storage.v1beta1.StorageClassList resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): StorageClassList

Get the state of an existing StorageClassList resource, as identified by id. Typically this ID is of the form /; if is omitted, then (per Kubernetes convention) the ID becomes default/.

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of StorageClassList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<“storage.k8s.io/v1beta1”>;

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/api-conventions.md#resources

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property items

public items: pulumi.Output<outputApi.storage.v1beta1.StorageClass[]>;

Items is the list of StorageClasses

property kind

public kind: pulumi.Output<“StorageClassList”>;

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/api-conventions.md#types-kinds

property metadata

public metadata: pulumi.Output<outputApi.meta.v1.ListMeta>;

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class VolumeAttachment

extends CustomResource

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

VolumeAttachment objects are non-namespaced.

constructor

new VolumeAttachment(name: string, args?: inputApi.storage.v1beta1.VolumeAttachment, opts?: pulumi.CustomResourceOptions)

Create a storage.v1beta1.VolumeAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): VolumeAttachment

Get the state of an existing VolumeAttachment resource, as identified by id. Typically this ID is of the form /; if is omitted, then (per Kubernetes convention) the ID becomes default/.

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of VolumeAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<“storage.k8s.io/v1beta1”>;

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/api-conventions.md#resources

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<“VolumeAttachment”>;

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/api-conventions.md#types-kinds

property metadata

public metadata: pulumi.Output<outputApi.meta.v1.ObjectMeta>;

Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property spec

public spec: pulumi.Output<outputApi.storage.v1beta1.VolumeAttachmentSpec>;

Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.

property status

public status: pulumi.Output<outputApi.storage.v1beta1.VolumeAttachmentStatus>;

Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class VolumeAttachmentList

extends CustomResource

VolumeAttachmentList is a collection of VolumeAttachment objects.

constructor

new VolumeAttachmentList(name: string, args?: inputApi.storage.v1beta1.VolumeAttachmentList, opts?: pulumi.CustomResourceOptions)

Create a storage.v1beta1.VolumeAttachmentList resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): VolumeAttachmentList

Get the state of an existing VolumeAttachmentList resource, as identified by id. Typically this ID is of the form /; if is omitted, then (per Kubernetes convention) the ID becomes default/.

Pulumi will keep track of this resource using name as the Pulumi ID.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of VolumeAttachmentList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<“storage.k8s.io/v1beta1”>;

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/api-conventions.md#resources

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property items

public items: pulumi.Output<outputApi.storage.v1beta1.VolumeAttachment[]>;

Items is the list of VolumeAttachments

property kind

public kind: pulumi.Output<“VolumeAttachmentList”>;

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/api-conventions.md#types-kinds

property metadata

public metadata: pulumi.Output<outputApi.meta.v1.ListMeta>;

Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.