Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.Types.FileCache

Description

Synopsis

data FileCache = FileCache' {
- creationTime :: Maybe POSIX
- dNSName :: Maybe Text
- dataRepositoryAssociationIds :: Maybe [Text]
- failureDetails :: Maybe FileCacheFailureDetails
- fileCacheId :: Maybe Text
- fileCacheType :: Maybe FileCacheType
- fileCacheTypeVersion :: Maybe Text
- kmsKeyId :: Maybe Text
- lifecycle :: Maybe FileCacheLifecycle
- lustreConfiguration :: Maybe FileCacheLustreConfiguration
- networkInterfaceIds :: Maybe [Text]
- ownerId :: Maybe Text
- resourceARN :: Maybe Text
- storageCapacity :: Maybe Natural
- subnetIds :: Maybe [Text]
- vpcId :: Maybe Text
}
newFileCache :: FileCache
fileCache_creationTime :: Lens' FileCache (Maybe UTCTime)
fileCache_dNSName :: Lens' FileCache (Maybe Text)
fileCache_dataRepositoryAssociationIds :: Lens' FileCache (Maybe [Text])
fileCache_failureDetails :: Lens' FileCache (Maybe FileCacheFailureDetails)
fileCache_fileCacheId :: Lens' FileCache (Maybe Text)
fileCache_fileCacheType :: Lens' FileCache (Maybe FileCacheType)
fileCache_fileCacheTypeVersion :: Lens' FileCache (Maybe Text)
fileCache_kmsKeyId :: Lens' FileCache (Maybe Text)
fileCache_lifecycle :: Lens' FileCache (Maybe FileCacheLifecycle)
fileCache_lustreConfiguration :: Lens' FileCache (Maybe FileCacheLustreConfiguration)
fileCache_networkInterfaceIds :: Lens' FileCache (Maybe [Text])
fileCache_ownerId :: Lens' FileCache (Maybe Text)
fileCache_resourceARN :: Lens' FileCache (Maybe Text)
fileCache_storageCapacity :: Lens' FileCache (Maybe Natural)
fileCache_subnetIds :: Lens' FileCache (Maybe [Text])
fileCache_vpcId :: Lens' FileCache (Maybe Text)

Documentation

data FileCache Source #

A description of a specific Amazon File Cache resource, which is a response object from the DescribeFileCaches operation.

See: newFileCache smart constructor.

Constructors

FileCache'

Fields

creationTime :: Maybe POSIX
dNSName :: Maybe Text
The Domain Name System (DNS) name for the cache.
dataRepositoryAssociationIds :: Maybe [Text]
A list of IDs of data repository associations that are associated with this cache.
failureDetails :: Maybe FileCacheFailureDetails
A structure providing details of any failures that occurred.
fileCacheId :: Maybe Text
The system-generated, unique ID of the cache.
fileCacheType :: Maybe FileCacheType
The type of cache, which must be LUSTRE.
fileCacheTypeVersion :: Maybe Text
The Lustre version of the cache, which must be 2.12.
kmsKeyId :: Maybe Text
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
lifecycle :: Maybe FileCacheLifecycle
The lifecycle status of the cache. The following are the possible values and what they mean:
- AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
- CREATING - The new cache is being created.
- DELETING - An existing cache is being deleted.
- UPDATING - The cache is undergoing a customer-initiated update.
- FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
lustreConfiguration :: Maybe FileCacheLustreConfiguration
The configuration for the Amazon File Cache resource.
networkInterfaceIds :: Maybe [Text]
ownerId :: Maybe Text
resourceARN :: Maybe Text
storageCapacity :: Maybe Natural
The storage capacity of the cache in gibibytes (GiB).
subnetIds :: Maybe [Text]
vpcId :: Maybe Text

Instances

Instances details

FromJSON FileCache Source #
Instance details Defined in Amazonka.FSx.Types.FileCache Methods parseJSON :: Value -> Parser FileCache # parseJSONList :: Value -> Parser [FileCache] #
Generic FileCache Source #
Instance details Defined in Amazonka.FSx.Types.FileCache Associated Types type Rep FileCache :: Type -> Type # Methods from :: FileCache -> Rep FileCache x # to :: Rep FileCache x -> FileCache #
Read FileCache Source #
Instance details Defined in Amazonka.FSx.Types.FileCache Methods readsPrec :: Int -> ReadS FileCache # readList :: ReadS [FileCache] # readPrec :: ReadPrec FileCache # readListPrec :: ReadPrec [FileCache] #
Show FileCache Source #
Instance details Defined in Amazonka.FSx.Types.FileCache Methods showsPrec :: Int -> FileCache -> ShowS # show :: FileCache -> String # showList :: [FileCache] -> ShowS #
NFData FileCache Source #
Instance details Defined in Amazonka.FSx.Types.FileCache Methods rnf :: FileCache -> () #
Eq FileCache Source #
Instance details Defined in Amazonka.FSx.Types.FileCache Methods (==) :: FileCache -> FileCache -> Bool # (/=) :: FileCache -> FileCache -> Bool #
Hashable FileCache Source #
Instance details Defined in Amazonka.FSx.Types.FileCache Methods hashWithSalt :: Int -> FileCache -> Int # hash :: FileCache -> Int #
type Rep FileCache Source #
Instance details Defined in Amazonka.FSx.Types.FileCache type Rep FileCache = D1 ('MetaData "FileCache" "Amazonka.FSx.Types.FileCache" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "FileCache'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "dNSName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dataRepositoryAssociationIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "failureDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileCacheFailureDetails)))) :: ((S1 ('MetaSel ('Just "fileCacheId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fileCacheType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileCacheType))) :: (S1 ('MetaSel ('Just "fileCacheTypeVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileCacheLifecycle)) :: S1 ('MetaSel ('Just "lustreConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileCacheLustreConfiguration))) :: (S1 ('MetaSel ('Just "networkInterfaceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "storageCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newFileCache :: FileCache Source #

Create a value of FileCache with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:FileCache', fileCache_creationTime - Undocumented member.

$sel:dNSName:FileCache', fileCache_dNSName - The Domain Name System (DNS) name for the cache.

$sel:dataRepositoryAssociationIds:FileCache', fileCache_dataRepositoryAssociationIds - A list of IDs of data repository associations that are associated with this cache.

$sel:failureDetails:FileCache', fileCache_failureDetails - A structure providing details of any failures that occurred.

$sel:fileCacheId:FileCache', fileCache_fileCacheId - The system-generated, unique ID of the cache.

$sel:fileCacheType:FileCache', fileCache_fileCacheType - The type of cache, which must be LUSTRE.

$sel:fileCacheTypeVersion:FileCache', fileCache_fileCacheTypeVersion - The Lustre version of the cache, which must be 2.12.

$sel:kmsKeyId:FileCache', fileCache_kmsKeyId - Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

$sel:lifecycle:FileCache', fileCache_lifecycle - The lifecycle status of the cache. The following are the possible values and what they mean:

AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
CREATING - The new cache is being created.
DELETING - An existing cache is being deleted.
UPDATING - The cache is undergoing a customer-initiated update.
FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

$sel:lustreConfiguration:FileCache', fileCache_lustreConfiguration - The configuration for the Amazon File Cache resource.

$sel:networkInterfaceIds:FileCache', fileCache_networkInterfaceIds - Undocumented member.

$sel:ownerId:FileCache', fileCache_ownerId - Undocumented member.

$sel:resourceARN:FileCache', fileCache_resourceARN - Undocumented member.

$sel:storageCapacity:FileCache', fileCache_storageCapacity - The storage capacity of the cache in gibibytes (GiB).

$sel:subnetIds:FileCache', fileCache_subnetIds - Undocumented member.

$sel:vpcId:FileCache', fileCache_vpcId - Undocumented member.

fileCache_creationTime :: Lens' FileCache (Maybe UTCTime) Source #

Undocumented member.

fileCache_dNSName :: Lens' FileCache (Maybe Text) Source #

The Domain Name System (DNS) name for the cache.

fileCache_dataRepositoryAssociationIds :: Lens' FileCache (Maybe [Text]) Source #

A list of IDs of data repository associations that are associated with this cache.

fileCache_failureDetails :: Lens' FileCache (Maybe FileCacheFailureDetails) Source #

A structure providing details of any failures that occurred.

fileCache_fileCacheId :: Lens' FileCache (Maybe Text) Source #

The system-generated, unique ID of the cache.

fileCache_fileCacheType :: Lens' FileCache (Maybe FileCacheType) Source #

The type of cache, which must be LUSTRE.

fileCache_fileCacheTypeVersion :: Lens' FileCache (Maybe Text) Source #

The Lustre version of the cache, which must be 2.12.

fileCache_kmsKeyId :: Lens' FileCache (Maybe Text) Source #

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

fileCache_lifecycle :: Lens' FileCache (Maybe FileCacheLifecycle) Source #

The lifecycle status of the cache. The following are the possible values and what they mean:

AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
CREATING - The new cache is being created.
DELETING - An existing cache is being deleted.
UPDATING - The cache is undergoing a customer-initiated update.
FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

fileCache_lustreConfiguration :: Lens' FileCache (Maybe FileCacheLustreConfiguration) Source #

The configuration for the Amazon File Cache resource.

fileCache_networkInterfaceIds :: Lens' FileCache (Maybe [Text]) Source #

Undocumented member.

fileCache_ownerId :: Lens' FileCache (Maybe Text) Source #

Undocumented member.

fileCache_resourceARN :: Lens' FileCache (Maybe Text) Source #

Undocumented member.

fileCache_storageCapacity :: Lens' FileCache (Maybe Natural) Source #

The storage capacity of the cache in gibibytes (GiB).

fileCache_subnetIds :: Lens' FileCache (Maybe [Text]) Source #

Undocumented member.

fileCache_vpcId :: Lens' FileCache (Maybe Text) Source #

Undocumented member.