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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:40.272Z")
@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()
                 .sizeInMegabytes("sizeInMegabytes")
                 .storageVirtualMachineId("storageVirtualMachineId")
                 // the properties below are optional
                 .copyTagsToBackups("copyTagsToBackups")
                 .junctionPath("junctionPath")
                 .ontapVolumeType("ontapVolumeType")
                 .securityStyle("securityStyle")
                 .snapshotPolicy("snapshotPolicy")
                 .storageEfficiencyEnabled("storageEfficiencyEnabled")
                 .tieringPolicy(TieringPolicyProperty.builder()
                         .coolingPeriod(123)
                         .name("name")
                         .build())
                 .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVolumeProps.Builder	A builder for CfnVolumeProps
static final class	CfnVolumeProps.Jsii$Proxy	An implementation for CfnVolumeProps

Method Summary

Modifier and Type	Method	Description
static CfnVolumeProps.Builder	builder()
default String	getBackupId()	Specifies the ID of the volume backup to use to create a new volume.
String	getName()	The name of the volume.
default Object	getOntapConfiguration()	The configuration of an Amazon FSx for NetApp ONTAP volume.
default Object	getOpenZfsConfiguration()	The configuration of an Amazon FSx for OpenZFS volume.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default String	getVolumeType()	The type of the volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the volume.

getBackupId

@Stability(Stable)
@Nullable
default String getBackupId()

Specifies the ID of the volume backup to use to create a new volume.

getOntapConfiguration

@Stability(Stable)
@Nullable
default Object getOntapConfiguration()

The configuration of an Amazon FSx for NetApp ONTAP volume.

getOpenZfsConfiguration

@Stability(Stable)
@Nullable
default Object getOpenZfsConfiguration()

The configuration of an Amazon FSx for OpenZFS volume.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getVolumeType

@Stability(Stable)
@Nullable
default String getVolumeType()

The type of the volume.

builder

@Stability(Stable)
static CfnVolumeProps.Builder builder()

Returns:

a CfnVolumeProps.Builder of CfnVolumeProps