Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

KubernetesPersistentVolumeResource

Handle
📦 Aspire.Hosting.Kubernetes v13.6.5-preview.1.26559.7

Represents a Kubernetes PersistentVolumeClaim as a first-class resource in the Aspire application model. A persistent volume resource carries the storage class, capacity, access modes, and metadata annotations needed to render a v1.PersistentVolumeClaim at publish time. Workloads bind to it with WithPersistentVolume.

type KubernetesPersistentVolumeResource interface {
Resource
ResourceWithParent
}

Methods

methodWithAccessModebuilder
Adds an access mode to a persistent volume
WithAccessMode(accessMode PersistentVolumeAccessMode) KubernetesPersistentVolumeResource
accessModePersistentVolumeAccessModeThe access mode to add.
KubernetesPersistentVolumeResource

The same builder for chaining.

Returns a handle; failures surface later via Err().

methodWithCapacitybuilder
Sets the requested storage capacity for a persistent volume
WithCapacity(capacity string) KubernetesPersistentVolumeResource
capacitystringA Kubernetes quantity string (e.g. "10Gi", "500Mi").
KubernetesPersistentVolumeResource

The same builder for chaining.

Returns a handle; failures surface later via Err().

methodWithCapacityParambuilder
Sets a parameterized storage capacity for a persistent volume
WithCapacityParam(capacity ParameterResource) KubernetesPersistentVolumeResource
capacityParameterResourceA parameter resource builder for the capacity quantity string.
KubernetesPersistentVolumeResource

The same builder for chaining.

Returns a handle; failures surface later via Err().

methodWithStorageClassbuilder
Sets the storage class for a persistent volume
WithStorageClass(storageClassName string) KubernetesPersistentVolumeResource
storageClassNamestringThe storage class name (e.g. "managed-csi", "gp3").
KubernetesPersistentVolumeResource

The same builder for chaining.

Returns a handle; failures surface later via Err().

Sets a parameterized storage class for a persistent volume
WithStorageClassParam(storageClassName ParameterResource) KubernetesPersistentVolumeResource
storageClassNameParameterResourceA parameter resource builder for the storage class name.
KubernetesPersistentVolumeResource

The same builder for chaining.

Returns a handle; failures surface later via Err().

Adds a Kubernetes metadata annotation to a persistent volume
WithVolumeAnnotation(
key string,
value string,
) KubernetesPersistentVolumeResource
keystringThe annotation key (e.g. "volume.beta.kubernetes.io/storage-provisioner").
valuestringThe annotation value.
KubernetesPersistentVolumeResource

The same builder for chaining.

Returns a handle; failures surface later via Err().

Adds a parameterized Kubernetes metadata annotation to a persistent volume
WithVolumeAnnotationParam(
key string,
value ParameterResource,
) KubernetesPersistentVolumeResource
keystringThe annotation key.
valueParameterResourceA parameter resource builder for the annotation value.
KubernetesPersistentVolumeResource

The same builder for chaining.

Returns a handle; failures surface later via Err().