Package software.amazon.awscdk.services.fsx

Class CfnVolume.OntapConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.fsx.CfnVolume.OntapConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVolume.OntapConfigurationProperty>

Enclosing interface:

CfnVolume.OntapConfigurationProperty

@Stability(Stable)
public static final class CfnVolume.OntapConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnVolume.OntapConfigurationProperty>

A builder for CfnVolume.OntapConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnVolume.OntapConfigurationProperty.Builder	aggregateConfiguration(IResolvable aggregateConfiguration)	Sets the value of CfnVolume.OntapConfigurationProperty.getAggregateConfiguration()
CfnVolume.OntapConfigurationProperty.Builder	aggregateConfiguration(CfnVolume.AggregateConfigurationProperty aggregateConfiguration)	Sets the value of CfnVolume.OntapConfigurationProperty.getAggregateConfiguration()
CfnVolume.OntapConfigurationProperty	build()	Builds the configured instance.
CfnVolume.OntapConfigurationProperty.Builder	copyTagsToBackups(String copyTagsToBackups)	Sets the value of CfnVolume.OntapConfigurationProperty.getCopyTagsToBackups()
CfnVolume.OntapConfigurationProperty.Builder	junctionPath(String junctionPath)	Sets the value of CfnVolume.OntapConfigurationProperty.getJunctionPath()
CfnVolume.OntapConfigurationProperty.Builder	ontapVolumeType(String ontapVolumeType)	Sets the value of CfnVolume.OntapConfigurationProperty.getOntapVolumeType()
CfnVolume.OntapConfigurationProperty.Builder	securityStyle(String securityStyle)	Sets the value of CfnVolume.OntapConfigurationProperty.getSecurityStyle()
CfnVolume.OntapConfigurationProperty.Builder	sizeInBytes(String sizeInBytes)	Sets the value of CfnVolume.OntapConfigurationProperty.getSizeInBytes()
CfnVolume.OntapConfigurationProperty.Builder	sizeInMegabytes(String sizeInMegabytes)	Sets the value of CfnVolume.OntapConfigurationProperty.getSizeInMegabytes()
CfnVolume.OntapConfigurationProperty.Builder	snaplockConfiguration(IResolvable snaplockConfiguration)	Sets the value of CfnVolume.OntapConfigurationProperty.getSnaplockConfiguration()
CfnVolume.OntapConfigurationProperty.Builder	snaplockConfiguration(CfnVolume.SnaplockConfigurationProperty snaplockConfiguration)	Sets the value of CfnVolume.OntapConfigurationProperty.getSnaplockConfiguration()
CfnVolume.OntapConfigurationProperty.Builder	snapshotPolicy(String snapshotPolicy)	Sets the value of CfnVolume.OntapConfigurationProperty.getSnapshotPolicy()
CfnVolume.OntapConfigurationProperty.Builder	storageEfficiencyEnabled(String storageEfficiencyEnabled)	Sets the value of CfnVolume.OntapConfigurationProperty.getStorageEfficiencyEnabled()
CfnVolume.OntapConfigurationProperty.Builder	storageVirtualMachineId(String storageVirtualMachineId)	Sets the value of CfnVolume.OntapConfigurationProperty.getStorageVirtualMachineId()
CfnVolume.OntapConfigurationProperty.Builder	tieringPolicy(IResolvable tieringPolicy)	Sets the value of CfnVolume.OntapConfigurationProperty.getTieringPolicy()
CfnVolume.OntapConfigurationProperty.Builder	tieringPolicy(CfnVolume.TieringPolicyProperty tieringPolicy)	Sets the value of CfnVolume.OntapConfigurationProperty.getTieringPolicy()
CfnVolume.OntapConfigurationProperty.Builder	volumeStyle(String volumeStyle)	Sets the value of CfnVolume.OntapConfigurationProperty.getVolumeStyle()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

storageVirtualMachineId

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder storageVirtualMachineId(String storageVirtualMachineId)

Sets the value of CfnVolume.OntapConfigurationProperty.getStorageVirtualMachineId()

Parameters:

storageVirtualMachineId - Specifies the ONTAP SVM in which to create the volume. This parameter is required.

Returns:

this

aggregateConfiguration

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder aggregateConfiguration(IResolvable aggregateConfiguration)

Sets the value of CfnVolume.OntapConfigurationProperty.getAggregateConfiguration()

Parameters:

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

Returns:

this

aggregateConfiguration

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder aggregateConfiguration(CfnVolume.AggregateConfigurationProperty aggregateConfiguration)

Sets the value of CfnVolume.OntapConfigurationProperty.getAggregateConfiguration()

Parameters:

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

Returns:

this

copyTagsToBackups

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder copyTagsToBackups(String copyTagsToBackups)

Sets the value of CfnVolume.OntapConfigurationProperty.getCopyTagsToBackups()

Parameters:

copyTagsToBackups - 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.

Returns:

this

junctionPath

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder junctionPath(String junctionPath)

Sets the value of CfnVolume.OntapConfigurationProperty.getJunctionPath()

Parameters:

junctionPath - 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 .

Returns:

this

ontapVolumeType

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder ontapVolumeType(String ontapVolumeType)

Sets the value of CfnVolume.OntapConfigurationProperty.getOntapVolumeType()

Parameters:

ontapVolumeType - 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.

Returns:

this

securityStyle

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder securityStyle(String securityStyle)

Sets the value of CfnVolume.OntapConfigurationProperty.getSecurityStyle()

Parameters:

securityStyle - 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. 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.

Returns:

this

sizeInBytes

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder sizeInBytes(String sizeInBytes)

Sets the value of CfnVolume.OntapConfigurationProperty.getSizeInBytes()

Parameters:

sizeInBytes - Specifies the configured size of the volume, in bytes.

Returns:

this

sizeInMegabytes

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder sizeInMegabytes(String sizeInMegabytes)

Sets the value of CfnVolume.OntapConfigurationProperty.getSizeInMegabytes()

Parameters:

sizeInMegabytes - Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.

Returns:

this

snaplockConfiguration

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder snaplockConfiguration(IResolvable snaplockConfiguration)

Sets the value of CfnVolume.OntapConfigurationProperty.getSnaplockConfiguration()

Parameters:

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

Returns:

this

snaplockConfiguration

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder snaplockConfiguration(CfnVolume.SnaplockConfigurationProperty snaplockConfiguration)

Sets the value of CfnVolume.OntapConfigurationProperty.getSnaplockConfiguration()

Parameters:

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

Returns:

this

snapshotPolicy

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder snapshotPolicy(String snapshotPolicy)

Sets the value of CfnVolume.OntapConfigurationProperty.getSnapshotPolicy()

Parameters:

snapshotPolicy - 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.

Returns:

this

storageEfficiencyEnabled

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder storageEfficiencyEnabled(String storageEfficiencyEnabled)

Sets the value of CfnVolume.OntapConfigurationProperty.getStorageEfficiencyEnabled()

Parameters:

storageEfficiencyEnabled - 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 ).

Returns:

this

tieringPolicy

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder tieringPolicy(IResolvable tieringPolicy)

Sets the value of CfnVolume.OntapConfigurationProperty.getTieringPolicy()

Parameters:

tieringPolicy - 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.

Returns:

this

tieringPolicy

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder tieringPolicy(CfnVolume.TieringPolicyProperty tieringPolicy)

Sets the value of CfnVolume.OntapConfigurationProperty.getTieringPolicy()

Parameters:

tieringPolicy - 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.

Returns:

this

volumeStyle

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty.Builder volumeStyle(String volumeStyle)

Sets the value of CfnVolume.OntapConfigurationProperty.getVolumeStyle()

Parameters:

volumeStyle - 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.

Returns:

this

build

@Stability(Stable)
public CfnVolume.OntapConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnVolume.OntapConfigurationProperty>

Returns:

a new instance of CfnVolume.OntapConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided