StatefulSetPersistentVolumeClaimRetentionPolicy (org.cdk8s:cdk8s-plus-25 2.22.9 API)

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StatefulSetPersistentVolumeClaimRetentionPolicy.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.821Z")
@Stability(Stable)
public interface StatefulSetPersistentVolumeClaimRetentionPolicy
extends software.amazon.jsii.JsiiSerializable
```
StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`StatefulSetPersistentVolumeClaimRetentionPolicy.Builder`	A builder for `StatefulSetPersistentVolumeClaimRetentionPolicy`
`static class`	`StatefulSetPersistentVolumeClaimRetentionPolicy.Jsii$Proxy`	An implementation for `StatefulSetPersistentVolumeClaimRetentionPolicy`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`static StatefulSetPersistentVolumeClaimRetentionPolicy.Builder`	`builder()`
`default String`	`getWhenDeleted()`	WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted.
`default String`	`getWhenScaled()`	WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getWhenDeleted
```
@Stability(Stable)
@Nullable
default String getWhenDeleted()
```
    WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted.
    The default policy of Retain causes PVCs to not be affected by StatefulSet deletion. The Delete policy causes those PVCs to be deleted.
  - getWhenScaled
```
@Stability(Stable)
@Nullable
default String getWhenScaled()
```
    WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down.
    The default policy of Retain causes PVCs to not be affected by a scaledown. The Delete policy causes the associated PVCs for any excess pods above the replica count to be deleted.
  - builder
```
@Stability(Stable)
static StatefulSetPersistentVolumeClaimRetentionPolicy.Builder builder()
```
    Returns:
    
    a StatefulSetPersistentVolumeClaimRetentionPolicy.Builder of StatefulSetPersistentVolumeClaimRetentionPolicy