Interface CfnVolumeProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnVolumeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:43.935Z")
@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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnVolumeProps
static final class
An implementation forCfnVolumeProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnVolumeProps.Builder
builder()
default String
Specifies the ID of the volume backup to use to create a new volume.getName()
The name of the volume.default Object
The configuration of an Amazon FSx for NetApp ONTAP volume.default Object
The configuration of an Amazon FSx for OpenZFS volume.getTags()
An array of key-value pairs to apply to this resource.default String
The type of the volume.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The name of the volume.- See Also:
-
getBackupId
Specifies the ID of the volume backup to use to create a new volume.- See Also:
-
getOntapConfiguration
The configuration of an Amazon FSx for NetApp ONTAP volume.- See Also:
-
getOpenZfsConfiguration
The configuration of an Amazon FSx for OpenZFS volume.- See Also:
-
getTags
An array of key-value pairs to apply to this resource.For more information, see Tag .
- See Also:
-
getVolumeType
The type of the volume.- See Also:
-
builder
- Returns:
- a
CfnVolumeProps.Builder
ofCfnVolumeProps
-