Package software.amazon.awscdk.services.fsx

Interface CfnVolume.OntapConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolume.OntapConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnVolume

@Stability(Stable)
public static interface CfnVolume.OntapConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the configuration of the ONTAP volume that you are creating.

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.*;
 OntapConfigurationProperty ontapConfigurationProperty = 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnVolume.OntapConfigurationProperty.Builder	builder()
default Object	getAggregateConfiguration()	Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
default String	getCopyTagsToBackups()	A boolean flag indicating whether tags for the volume should be copied to backups.
default String	getJunctionPath()	Specifies the location in the SVM's namespace where the volume is mounted.
default String	getOntapVolumeType()	Specifies the type of volume you are creating.
default String	getSecurityStyle()	Specifies the security style for the volume.
default String	getSizeInBytes()	Specifies the configured size of the volume, in bytes.
default String	getSizeInMegabytes()	Use SizeInBytes instead.
default Object	getSnaplockConfiguration()	The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
default String	getSnapshotPolicy()	Specifies the snapshot policy for the volume.
default String	getStorageEfficiencyEnabled()	Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
String	getStorageVirtualMachineId()	Specifies the ONTAP SVM in which to create the volume.
default Object	getTieringPolicy()	Describes the data tiering policy for an ONTAP volume.
default String	getVolumeStyle()	Use to specify the style of an ONTAP volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStorageVirtualMachineId

@Stability(Stable)
@NotNull
String getStorageVirtualMachineId()

Specifies the ONTAP SVM in which to create the volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-storagevirtualmachineid

getAggregateConfiguration

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

Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-aggregateconfiguration

getCopyTagsToBackups

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

A boolean flag indicating whether tags for the volume should be copied to backups.

This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-copytagstobackups

getJunctionPath

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

Specifies the location in the SVM's namespace where the volume is mounted.

This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-junctionpath

getOntapVolumeType

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

Specifies the type of volume you are creating. Valid values are the following:.

• RW specifies a read/write volume. RW is the default.
• DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-ontapvolumetype

getSecurityStyle

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

Specifies the security style for the volume.

If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide . Specify one of the following values:

• UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
• NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
• MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

For more information, see Volume security style in the FSx for ONTAP User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-securitystyle

getSizeInBytes

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

Specifies the configured size of the volume, in bytes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-sizeinbytes

getSizeInMegabytes

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

Use SizeInBytes instead.

Specifies the size of the volume, in megabytes (MB), that you are creating.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-sizeinmegabytes

getSnaplockConfiguration

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

The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration

getSnapshotPolicy

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

Specifies the snapshot policy for the volume. There are three built-in snapshot policies:.

• default : This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
• default-1weekly : This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
• none : This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-snapshotpolicy

getStorageEfficiencyEnabled

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

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType set to RW ).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-storageefficiencyenabled

getTieringPolicy

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

Describes the data tiering policy for an ONTAP volume.

When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:

• SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.
• AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
• ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
• NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-tieringpolicy

getVolumeStyle

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

Use to specify the style of an ONTAP volume.

FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-volumestyle

builder

@Stability(Stable)
static CfnVolume.OntapConfigurationProperty.Builder builder()

Returns:

a CfnVolume.OntapConfigurationProperty.Builder of CfnVolume.OntapConfigurationProperty