Package software.amazon.awscdk.cfnpropertymixins.services.fsx

Class CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.fsx.CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

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

A builder for CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	automaticBackupRetentionDays(Number automaticBackupRetentionDays)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getAutomaticBackupRetentionDays()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty	build()	Builds the configured instance.
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	copyTagsToBackups(Boolean copyTagsToBackups)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getCopyTagsToBackups()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	copyTagsToBackups(IResolvable copyTagsToBackups)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getCopyTagsToBackups()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	copyTagsToVolumes(Boolean copyTagsToVolumes)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getCopyTagsToVolumes()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	copyTagsToVolumes(IResolvable copyTagsToVolumes)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getCopyTagsToVolumes()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getDailyAutomaticBackupStartTime()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	deploymentType(String deploymentType)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getDeploymentType()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	diskIopsConfiguration(CfnFileSystemPropsMixin.DiskIopsConfigurationProperty diskIopsConfiguration)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getDiskIopsConfiguration()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	diskIopsConfiguration(IResolvable diskIopsConfiguration)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getDiskIopsConfiguration()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	endpointIpAddressRange(String endpointIpAddressRange)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getEndpointIpAddressRange()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	endpointIpv6AddressRange(String endpointIpv6AddressRange)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getEndpointIpv6AddressRange()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	options(List<String> options)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getOptions()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	preferredSubnetId(String preferredSubnetId)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getPreferredSubnetId()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	readCacheConfiguration(CfnFileSystemPropsMixin.ReadCacheConfigurationProperty readCacheConfiguration)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getReadCacheConfiguration()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	readCacheConfiguration(IResolvable readCacheConfiguration)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getReadCacheConfiguration()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	rootVolumeConfiguration(CfnFileSystemPropsMixin.RootVolumeConfigurationProperty rootVolumeConfiguration)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getRootVolumeConfiguration()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	rootVolumeConfiguration(IResolvable rootVolumeConfiguration)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getRootVolumeConfiguration()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	routeTableIds(List<String> routeTableIds)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getRouteTableIds()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	throughputCapacity(Number throughputCapacity)	Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getThroughputCapacity()
CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder	weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)	Sets the value of CfnFileSystemPropsMixin.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

automaticBackupRetentionDays

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

Sets the value of CfnFileSystemPropsMixin.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 30 .

Returns:

this

copyTagsToBackups

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

Sets the value of CfnFileSystemPropsMixin.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 CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder copyTagsToBackups(IResolvable copyTagsToBackups)

Sets the value of CfnFileSystemPropsMixin.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 CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder copyTagsToVolumes(Boolean copyTagsToVolumes)

Sets the value of CfnFileSystemPropsMixin.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 CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder copyTagsToVolumes(IResolvable copyTagsToVolumes)

Sets the value of CfnFileSystemPropsMixin.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 CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)

Sets the value of CfnFileSystemPropsMixin.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

deploymentType

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

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getDeploymentType()

Parameters:

deploymentType - Specifies the file system deployment type. Valid values are the following:.

• MULTI_AZ_1 - Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same AWS Region .
• SINGLE_AZ_HA_2 - Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.
• SINGLE_AZ_HA_1 - Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.
• SINGLE_AZ_2 - Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within a single Availability Zone.
• SINGLE_AZ_1 - Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.

For a list of which AWS Regions each deployment type is available in, see Deployment type availability . For more information on the differences in performance between deployment types, see File system performance in the Amazon FSx for OpenZFS User Guide .

Returns:

this

diskIopsConfiguration

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

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getDiskIopsConfiguration()

Parameters:

diskIopsConfiguration - The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, 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 CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder diskIopsConfiguration(CfnFileSystemPropsMixin.DiskIopsConfigurationProperty diskIopsConfiguration)

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getDiskIopsConfiguration()

Parameters:

diskIopsConfiguration - The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, 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

endpointIpAddressRange

@Stability(Stable)
public CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder endpointIpAddressRange(String endpointIpAddressRange)

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getEndpointIpAddressRange()

Parameters:

endpointIpAddressRange - (Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

Returns:

this

endpointIpv6AddressRange

@Stability(Stable)
public CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder endpointIpv6AddressRange(String endpointIpv6AddressRange)

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getEndpointIpv6AddressRange()

Parameters:

endpointIpv6AddressRange - (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

Returns:

this

options

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

Sets the value of CfnFileSystemPropsMixin.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

preferredSubnetId

@Stability(Stable)
public CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder preferredSubnetId(String preferredSubnetId)

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getPreferredSubnetId()

Parameters:

preferredSubnetId - Required when DeploymentType is set to MULTI_AZ_1 . This specifies the subnet in which you want the preferred file server to be located.

Returns:

this

readCacheConfiguration

@Stability(Stable)
public CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder readCacheConfiguration(IResolvable readCacheConfiguration)

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getReadCacheConfiguration()

Parameters:

readCacheConfiguration - Specifies the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.

Returns:

this

readCacheConfiguration

@Stability(Stable)
public CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder readCacheConfiguration(CfnFileSystemPropsMixin.ReadCacheConfigurationProperty readCacheConfiguration)

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getReadCacheConfiguration()

Parameters:

readCacheConfiguration - Specifies the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.

Returns:

this

rootVolumeConfiguration

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

Sets the value of CfnFileSystemPropsMixin.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 CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder rootVolumeConfiguration(CfnFileSystemPropsMixin.RootVolumeConfigurationProperty rootVolumeConfiguration)

Sets the value of CfnFileSystemPropsMixin.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

routeTableIds

@Stability(Stable)
public CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder routeTableIds(List<String> routeTableIds)

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getRouteTableIds()

Parameters:

routeTableIds - (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

Returns:

this

throughputCapacity

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

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getThroughputCapacity()

Parameters:

throughputCapacity - Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Required if you are creating a new file system.

Valid values depend on the DeploymentType that you choose, as follows:

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

You pay for additional throughput capacity that you provision.

Returns:

this

weeklyMaintenanceStartTime

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

Sets the value of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.getWeeklyMaintenanceStartTime()

Parameters:

weeklyMaintenanceStartTime - The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, 1:05:00 specifies maintenance at 5 AM Monday.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided