Class: AWSCDK::FSX::CfnFileSystem::DiskIopsConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::FSX::CfnFileSystem::DiskIopsConfigurationProperty

Defined in:

fsx/cfn_file_system.rb

Overview

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

See Also:

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

Instance Attribute Summary

• #iops ⇒ Numeric^? readonly

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

• #mode ⇒ String^? readonly

  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.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(iops: nil, mode: nil) ⇒ DiskIopsConfigurationProperty constructor

  A new instance of DiskIopsConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(iops: nil, mode: nil) ⇒ DiskIopsConfigurationProperty

Returns a new instance of DiskIopsConfigurationProperty.

Parameters:

• iops (Numeric, nil) (defaults to: nil) —

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

• mode (String, nil) (defaults to: nil) —

  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.

# File 'fsx/cfn_file_system.rb', line 901

def initialize(iops: nil, mode: nil)
  @iops = iops
  Jsii::Type.check_type(@iops, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "iops") unless @iops.nil?
  @mode = mode
  Jsii::Type.check_type(@mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mode") unless @mode.nil?
end

Instance Attribute Details

#iops ⇒ Numeric^? (readonly)

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.

Returns:

• (Numeric, nil)

See Also:

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

# File 'fsx/cfn_file_system.rb', line 916

def iops
  @iops
end

#mode ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

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

# File 'fsx/cfn_file_system.rb', line 921

def mode
  @mode
end

Class Method Details

.jsii_properties ⇒ Object

# File 'fsx/cfn_file_system.rb', line 923

def self.jsii_properties
  {
    :iops => "iops",
    :mode => "mode",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'fsx/cfn_file_system.rb', line 930

def to_jsii
  result = {}
  result.merge!({
    "iops" => @iops,
    "mode" => @mode,
  })
  result.compact
end