Package software.amazon.awscdk.services.fsx

Interface CfnFileSystem.DiskIopsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystem.DiskIopsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

@Stability(Stable)
public static interface CfnFileSystem.DiskIopsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

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.*;
 DiskIopsConfigurationProperty diskIopsConfigurationProperty = DiskIopsConfigurationProperty.builder()
         .iops(123)
         .mode("mode")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFileSystem.DiskIopsConfigurationProperty.Builder	builder()
default Number	getIops()	The total number of SSD IOPS provisioned for the file system.
default String	getMode()	Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIops

@Stability(Stable)
@Nullable
default Number getIops()

The total number of SSD IOPS provisioned for the file system.

The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity . The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity ). The maximum value is calculated as 200,000 * HAPairs .

Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-diskiopsconfiguration.html#cfn-fsx-filesystem-diskiopsconfiguration-iops

getMode

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

Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-diskiopsconfiguration.html#cfn-fsx-filesystem-diskiopsconfiguration-mode

builder

@Stability(Stable)
static CfnFileSystem.DiskIopsConfigurationProperty.Builder builder()

Returns:

a CfnFileSystem.DiskIopsConfigurationProperty.Builder of CfnFileSystem.DiskIopsConfigurationProperty