Package software.amazon.awscdk.services.fsx

Interface CfnFileSystem.ReadCacheConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystem.ReadCacheConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

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

The configuration for the optional provisioned SSD read cache on Amazon FSx for OpenZFS file systems that use the Intelligent-Tiering storage class.

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.*;
 ReadCacheConfigurationProperty readCacheConfigurationProperty = ReadCacheConfigurationProperty.builder()
         .sizeGiB(123)
         .sizingMode("sizingMode")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFileSystem.ReadCacheConfigurationProperty.Builder	builder()
default Number	getSizeGiB()	Required if SizingMode is set to USER_PROVISIONED .
default String	getSizingMode()	Specifies how the provisioned SSD read cache is sized, as follows:.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSizeGiB

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

Required if SizingMode is set to USER_PROVISIONED .

Specifies the size of the file system's SSD read cache, in gibibytes (GiB).

See Also:

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

getSizingMode

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

Specifies how the provisioned SSD read cache is sized, as follows:.

• Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.
• Set to USER_PROVISIONED to specify the exact size of your SSD read cache.
• Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

See Also:

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

builder

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

Returns:

a CfnFileSystem.ReadCacheConfigurationProperty.Builder of CfnFileSystem.ReadCacheConfigurationProperty