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

Description

Synopsis

data Volume = Volume' {
- administrativeActions :: Maybe [AdministrativeAction]
- creationTime :: Maybe POSIX
- fileSystemId :: Maybe Text
- lifecycle :: Maybe VolumeLifecycle
- lifecycleTransitionReason :: Maybe LifecycleTransitionReason
- name :: Maybe Text
- ontapConfiguration :: Maybe OntapVolumeConfiguration
- openZFSConfiguration :: Maybe OpenZFSVolumeConfiguration
- resourceARN :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- volumeId :: Maybe Text
- volumeType :: Maybe VolumeType
}
newVolume :: Volume
volume_administrativeActions :: Lens' Volume (Maybe [AdministrativeAction])
volume_creationTime :: Lens' Volume (Maybe UTCTime)
volume_fileSystemId :: Lens' Volume (Maybe Text)
volume_lifecycle :: Lens' Volume (Maybe VolumeLifecycle)
volume_lifecycleTransitionReason :: Lens' Volume (Maybe LifecycleTransitionReason)
volume_name :: Lens' Volume (Maybe Text)
volume_ontapConfiguration :: Lens' Volume (Maybe OntapVolumeConfiguration)
volume_openZFSConfiguration :: Lens' Volume (Maybe OpenZFSVolumeConfiguration)
volume_resourceARN :: Lens' Volume (Maybe Text)
volume_tags :: Lens' Volume (Maybe (NonEmpty Tag))
volume_volumeId :: Lens' Volume (Maybe Text)
volume_volumeType :: Lens' Volume (Maybe VolumeType)

Documentation

data Volume Source #

Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

See: newVolume smart constructor.

Constructors

Volume'

Fields

administrativeActions :: Maybe [AdministrativeAction]
A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
creationTime :: Maybe POSIX
fileSystemId :: Maybe Text
lifecycle :: Maybe VolumeLifecycle
The lifecycle status of the volume.
- AVAILABLE - The volume is fully available for use.
- CREATED - The volume has been created.
- CREATING - Amazon FSx is creating the new volume.
- DELETING - Amazon FSx is deleting an existing volume.
- FAILED - Amazon FSx was unable to create the volume.
- MISCONFIGURED - The volume is in a failed but recoverable state.
- PENDING - Amazon FSx hasn't started creating the volume.
lifecycleTransitionReason :: Maybe LifecycleTransitionReason
The reason why the volume lifecycle status changed.
name :: Maybe Text
The name of the volume.
ontapConfiguration :: Maybe OntapVolumeConfiguration
openZFSConfiguration :: Maybe OpenZFSVolumeConfiguration
The configuration of an Amazon FSx for OpenZFS volume.
resourceARN :: Maybe Text
tags :: Maybe (NonEmpty Tag)
volumeId :: Maybe Text
The system-generated, unique ID of the volume.
volumeType :: Maybe VolumeType
The type of the volume.

Instances

Instances details

FromJSON Volume Source #
Instance details Defined in Amazonka.FSx.Types.Volume Methods parseJSON :: Value -> Parser Volume # parseJSONList :: Value -> Parser [Volume] #
Generic Volume Source #
Instance details Defined in Amazonka.FSx.Types.Volume Associated Types type Rep Volume :: Type -> Type # Methods from :: Volume -> Rep Volume x # to :: Rep Volume x -> Volume #
Read Volume Source #
Instance details Defined in Amazonka.FSx.Types.Volume Methods readsPrec :: Int -> ReadS Volume # readList :: ReadS [Volume] # readPrec :: ReadPrec Volume # readListPrec :: ReadPrec [Volume] #
Show Volume Source #
Instance details Defined in Amazonka.FSx.Types.Volume Methods showsPrec :: Int -> Volume -> ShowS # show :: Volume -> String # showList :: [Volume] -> ShowS #
NFData Volume Source #
Instance details Defined in Amazonka.FSx.Types.Volume Methods rnf :: Volume -> () #
Eq Volume Source #
Instance details Defined in Amazonka.FSx.Types.Volume Methods (==) :: Volume -> Volume -> Bool # (/=) :: Volume -> Volume -> Bool #
Hashable Volume Source #
Instance details Defined in Amazonka.FSx.Types.Volume Methods hashWithSalt :: Int -> Volume -> Int # hash :: Volume -> Int #
type Rep Volume Source #
Instance details Defined in Amazonka.FSx.Types.Volume type Rep Volume = D1 ('MetaData "Volume" "Amazonka.FSx.Types.Volume" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "Volume'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "administrativeActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdministrativeAction])) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeLifecycle)) :: (S1 ('MetaSel ('Just "lifecycleTransitionReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LifecycleTransitionReason)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "ontapConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OntapVolumeConfiguration)) :: (S1 ('MetaSel ('Just "openZFSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenZFSVolumeConfiguration)) :: S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: (S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeType)))))))

newVolume :: Volume Source #

Create a value of Volume 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:administrativeActions:Volume', volume_administrativeActions - A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

$sel:creationTime:Volume', volume_creationTime - Undocumented member.

$sel:fileSystemId:Volume', volume_fileSystemId - Undocumented member.

$sel:lifecycle:Volume', volume_lifecycle - The lifecycle status of the volume.

AVAILABLE - The volume is fully available for use.
CREATED - The volume has been created.
CREATING - Amazon FSx is creating the new volume.
DELETING - Amazon FSx is deleting an existing volume.
FAILED - Amazon FSx was unable to create the volume.
MISCONFIGURED - The volume is in a failed but recoverable state.
PENDING - Amazon FSx hasn't started creating the volume.

$sel:lifecycleTransitionReason:Volume', volume_lifecycleTransitionReason - The reason why the volume lifecycle status changed.

$sel:name:Volume', volume_name - The name of the volume.

$sel:ontapConfiguration:Volume', volume_ontapConfiguration - Undocumented member.

$sel:openZFSConfiguration:Volume', volume_openZFSConfiguration - The configuration of an Amazon FSx for OpenZFS volume.

$sel:resourceARN:Volume', volume_resourceARN - Undocumented member.

$sel:tags:Volume', volume_tags - Undocumented member.

$sel:volumeId:Volume', volume_volumeId - The system-generated, unique ID of the volume.

$sel:volumeType:Volume', volume_volumeType - The type of the volume.

volume_administrativeActions :: Lens' Volume (Maybe [AdministrativeAction]) Source #

A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

volume_creationTime :: Lens' Volume (Maybe UTCTime) Source #

Undocumented member.

volume_fileSystemId :: Lens' Volume (Maybe Text) Source #

Undocumented member.

volume_lifecycle :: Lens' Volume (Maybe VolumeLifecycle) Source #

The lifecycle status of the volume.