Package software.amazon.awscdk.services.fsx

Class CfnFileSystem.OpenZFSConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.fsx.CfnFileSystem.OpenZFSConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFileSystem.OpenZFSConfigurationProperty>

Enclosing interface:

CfnFileSystem.OpenZFSConfigurationProperty

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

A builder for CfnFileSystem.OpenZFSConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFileSystem.OpenZFSConfigurationProperty.Builder	automaticBackupRetentionDays(Number automaticBackupRetentionDays)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getAutomaticBackupRetentionDays()
CfnFileSystem.OpenZFSConfigurationProperty	build()	Builds the configured instance.
CfnFileSystem.OpenZFSConfigurationProperty.Builder	copyTagsToBackups(Boolean copyTagsToBackups)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getCopyTagsToBackups()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	copyTagsToBackups(IResolvable copyTagsToBackups)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getCopyTagsToBackups()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	copyTagsToVolumes(Boolean copyTagsToVolumes)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getCopyTagsToVolumes()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	copyTagsToVolumes(IResolvable copyTagsToVolumes)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getCopyTagsToVolumes()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getDailyAutomaticBackupStartTime()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	deploymentType(String deploymentType)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getDeploymentType()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	diskIopsConfiguration(IResolvable diskIopsConfiguration)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getDiskIopsConfiguration()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	diskIopsConfiguration(CfnFileSystem.DiskIopsConfigurationProperty diskIopsConfiguration)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getDiskIopsConfiguration()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	options(List<String> options)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getOptions()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	rootVolumeConfiguration(IResolvable rootVolumeConfiguration)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getRootVolumeConfiguration()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	rootVolumeConfiguration(CfnFileSystem.RootVolumeConfigurationProperty rootVolumeConfiguration)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getRootVolumeConfiguration()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	throughputCapacity(Number throughputCapacity)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getThroughputCapacity()
CfnFileSystem.OpenZFSConfigurationProperty.Builder	weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)	Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getWeeklyMaintenanceStartTime()

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

deploymentType

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder deploymentType(String deploymentType)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getDeploymentType()

Parameters:

deploymentType - Specifies the file system deployment type. This parameter is required. Single AZ deployment types are configured for redundancy within a single Availability Zone in an AWS Region . Valid values are the following:

• SINGLE_AZ_1 - (Default) Creates file systems with throughput capacities of 64 - 4,096 MBps. Single_AZ_1 is available in all AWS Regions where Amazon FSx for OpenZFS is available.
• SINGLE_AZ_2 - Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), and Europe (Ireland) AWS Regions .

For more information, see: Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide .

Returns:

this

automaticBackupRetentionDays

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder automaticBackupRetentionDays(Number automaticBackupRetentionDays)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getAutomaticBackupRetentionDays()

Parameters:

automaticBackupRetentionDays - The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0 .

Returns:

this

copyTagsToBackups

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder copyTagsToBackups(Boolean copyTagsToBackups)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getCopyTagsToBackups()

Parameters:

copyTagsToBackups - A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false . If it's set to true , all tags for the file system 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 file system, regardless of this value.

Returns:

this

copyTagsToBackups

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder copyTagsToBackups(IResolvable copyTagsToBackups)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getCopyTagsToBackups()

Parameters:

copyTagsToBackups - A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false . If it's set to true , all tags for the file system 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 file system, regardless of this value.

Returns:

this

copyTagsToVolumes

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder copyTagsToVolumes(Boolean copyTagsToVolumes)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getCopyTagsToVolumes()

Parameters:

copyTagsToVolumes - A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false . If it's set to true , all tags for the file system are copied to volumes 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 volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

Returns:

this

copyTagsToVolumes

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder copyTagsToVolumes(IResolvable copyTagsToVolumes)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getCopyTagsToVolumes()

Parameters:

copyTagsToVolumes - A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false . If it's set to true , all tags for the file system are copied to volumes 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 volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

Returns:

this

dailyAutomaticBackupStartTime

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getDailyAutomaticBackupStartTime()

Parameters:

dailyAutomaticBackupStartTime - A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

Returns:

this

diskIopsConfiguration

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder diskIopsConfiguration(IResolvable diskIopsConfiguration)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getDiskIopsConfiguration()

Parameters:

diskIopsConfiguration - The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

Returns:

this

diskIopsConfiguration

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder diskIopsConfiguration(CfnFileSystem.DiskIopsConfigurationProperty diskIopsConfiguration)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getDiskIopsConfiguration()

Parameters:

diskIopsConfiguration - The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

Returns:

this

options

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder options(List<String> options)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getOptions()

Parameters:

options - To delete a file system if there are child volumes present below the root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS . If your file system has child volumes and you don't use this option, the delete request will fail.

Returns:

this

rootVolumeConfiguration

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder rootVolumeConfiguration(IResolvable rootVolumeConfiguration)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getRootVolumeConfiguration()

Parameters:

rootVolumeConfiguration - The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.

Returns:

this

rootVolumeConfiguration

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder rootVolumeConfiguration(CfnFileSystem.RootVolumeConfigurationProperty rootVolumeConfiguration)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getRootVolumeConfiguration()

Parameters:

rootVolumeConfiguration - The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.

Returns:

this

throughputCapacity

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder throughputCapacity(Number throughputCapacity)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getThroughputCapacity()

Parameters:

throughputCapacity - Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:

• For SINGLE_AZ_1 , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.
• For SINGLE_AZ_2 , valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.

You pay for additional throughput capacity that you provision.

Returns:

this

weeklyMaintenanceStartTime

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty.Builder weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)

Sets the value of CfnFileSystem.OpenZFSConfigurationProperty.getWeeklyMaintenanceStartTime()

Parameters:

weeklyMaintenanceStartTime - A recurring weekly time, in the format D:HH:MM . D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

Returns:

this

build

@Stability(Stable)
public CfnFileSystem.OpenZFSConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnFileSystem.OpenZFSConfigurationProperty>

Returns:

a new instance of CfnFileSystem.OpenZFSConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided