Package software.amazon.awscdk.services.fsx

Interface CfnVolumeProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnVolumeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:40.557Z") @Stability(Stable) public interface CfnVolumeProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnVolume.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.fsx.*;
 CfnVolumeProps cfnVolumeProps = CfnVolumeProps.builder()
         .name("name")
         // the properties below are optional
         .backupId("backupId")
         .ontapConfiguration(OntapConfigurationProperty.builder()
                 .storageVirtualMachineId("storageVirtualMachineId")
                 // the properties below are optional
                 .aggregateConfiguration(AggregateConfigurationProperty.builder()
                         .aggregates(List.of("aggregates"))
                         .constituentsPerAggregate(123)
                         .build())
                 .copyTagsToBackups("copyTagsToBackups")
                 .junctionPath("junctionPath")
                 .ontapVolumeType("ontapVolumeType")
                 .securityStyle("securityStyle")
                 .sizeInBytes("sizeInBytes")
                 .sizeInMegabytes("sizeInMegabytes")
                 .snaplockConfiguration(SnaplockConfigurationProperty.builder()
                         .snaplockType("snaplockType")
                         // the properties below are optional
                         .auditLogVolume("auditLogVolume")
                         .autocommitPeriod(AutocommitPeriodProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .value(123)
                                 .build())
                         .privilegedDelete("privilegedDelete")
                         .retentionPeriod(SnaplockRetentionPeriodProperty.builder()
                                 .defaultRetention(RetentionPeriodProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .value(123)
                                         .build())
                                 .maximumRetention(RetentionPeriodProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .value(123)
                                         .build())
                                 .minimumRetention(RetentionPeriodProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .value(123)
                                         .build())
                                 .build())
                         .volumeAppendModeEnabled("volumeAppendModeEnabled")
                         .build())
                 .snapshotPolicy("snapshotPolicy")
                 .storageEfficiencyEnabled("storageEfficiencyEnabled")
                 .tieringPolicy(TieringPolicyProperty.builder()
                         .coolingPeriod(123)
                         .name("name")
                         .build())
                 .volumeStyle("volumeStyle")
                 .build())
         .openZfsConfiguration(OpenZFSConfigurationProperty.builder()
                 .parentVolumeId("parentVolumeId")
                 // the properties below are optional
                 .copyTagsToSnapshots(false)
                 .dataCompressionType("dataCompressionType")
                 .nfsExports(List.of(NfsExportsProperty.builder()
                         .clientConfigurations(List.of(ClientConfigurationsProperty.builder()
                                 .clients("clients")
                                 .options(List.of("options"))
                                 .build()))
                         .build()))
                 .options(List.of("options"))
                 .originSnapshot(OriginSnapshotProperty.builder()
                         .copyStrategy("copyStrategy")
                         .snapshotArn("snapshotArn")
                         .build())
                 .readOnly(false)
                 .recordSizeKiB(123)
                 .storageCapacityQuotaGiB(123)
                 .storageCapacityReservationGiB(123)
                 .userAndGroupQuotas(List.of(UserAndGroupQuotasProperty.builder()
                         .id(123)
                         .storageCapacityQuotaGiB(123)
                         .type("type")
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .volumeType("volumeType")
         .build();

See Also: