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

Class CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnFileSystemPropsMixin.RootVolumeConfigurationProperty

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

A builder for CfnFileSystemPropsMixin.RootVolumeConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty	build()	Builds the configured instance.
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	copyTagsToSnapshots(Boolean copyTagsToSnapshots)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getCopyTagsToSnapshots()
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	copyTagsToSnapshots(IResolvable copyTagsToSnapshots)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getCopyTagsToSnapshots()
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	dataCompressionType(String dataCompressionType)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getDataCompressionType()
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	nfsExports(List<? extends Object> nfsExports)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getNfsExports()
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	nfsExports(IResolvable nfsExports)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getNfsExports()
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	readOnly(Boolean readOnly)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getReadOnly()
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	readOnly(IResolvable readOnly)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getReadOnly()
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	recordSizeKiB(Number recordSizeKiB)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getRecordSizeKiB()
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	userAndGroupQuotas(List<? extends Object> userAndGroupQuotas)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getUserAndGroupQuotas()
CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder	userAndGroupQuotas(IResolvable userAndGroupQuotas)	Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getUserAndGroupQuotas()

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

copyTagsToSnapshots

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder copyTagsToSnapshots(Boolean copyTagsToSnapshots)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getCopyTagsToSnapshots()

Parameters:

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

Returns:

this

copyTagsToSnapshots

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder copyTagsToSnapshots(IResolvable copyTagsToSnapshots)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getCopyTagsToSnapshots()

Parameters:

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

Returns:

this

dataCompressionType

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder dataCompressionType(String dataCompressionType)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getDataCompressionType()

Parameters:

dataCompressionType - Specifies the method used to compress the data on the volume. The compression type is NONE by default.

• NONE - Doesn't compress the data on the volume. NONE is the default.
• ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

Returns:

this

nfsExports

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder nfsExports(IResolvable nfsExports)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getNfsExports()

Parameters:

nfsExports - The configuration object for mounting a file system.

Returns:

this

nfsExports

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder nfsExports(List<? extends Object> nfsExports)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getNfsExports()

Parameters:

nfsExports - The configuration object for mounting a file system.

Returns:

this

readOnly

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder readOnly(Boolean readOnly)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getReadOnly()

Parameters:

readOnly - A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

Returns:

this

readOnly

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder readOnly(IResolvable readOnly)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getReadOnly()

Parameters:

readOnly - A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

Returns:

this

recordSizeKiB

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder recordSizeKiB(Number recordSizeKiB)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getRecordSizeKiB()

Parameters:

recordSizeKiB - Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide .

Returns:

this

userAndGroupQuotas

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder userAndGroupQuotas(IResolvable userAndGroupQuotas)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getUserAndGroupQuotas()

Parameters:

userAndGroupQuotas - An object specifying how much storage users or groups can use on the volume.

Returns:

this

userAndGroupQuotas

@Stability(Stable)
public CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.Builder userAndGroupQuotas(List<? extends Object> userAndGroupQuotas)

Sets the value of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty.getUserAndGroupQuotas()

Parameters:

userAndGroupQuotas - An object specifying how much storage users or groups can use on the volume.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnFileSystemPropsMixin.RootVolumeConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided