Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
Synopsis
- data UpdateFileSystem = UpdateFileSystem' {}
- newUpdateFileSystem :: Text -> UpdateFileSystem
- updateFileSystem_provisionedThroughputInMibps :: Lens' UpdateFileSystem (Maybe Double)
- updateFileSystem_throughputMode :: Lens' UpdateFileSystem (Maybe ThroughputMode)
- updateFileSystem_fileSystemId :: Lens' UpdateFileSystem Text
- data FileSystemDescription = FileSystemDescription' {
- availabilityZoneId :: Maybe Text
- provisionedThroughputInMibps :: Maybe Double
- availabilityZoneName :: Maybe Text
- fileSystemArn :: Maybe Text
- encrypted :: Maybe Bool
- throughputMode :: Maybe ThroughputMode
- kmsKeyId :: Maybe Text
- name :: Maybe Text
- ownerId :: Text
- creationToken :: Text
- fileSystemId :: Text
- creationTime :: POSIX
- lifeCycleState :: LifeCycleState
- numberOfMountTargets :: Natural
- sizeInBytes :: FileSystemSize
- performanceMode :: PerformanceMode
- tags :: [Tag]
- newFileSystemDescription :: Text -> Text -> Text -> UTCTime -> LifeCycleState -> Natural -> FileSystemSize -> PerformanceMode -> FileSystemDescription
- fileSystemDescription_availabilityZoneId :: Lens' FileSystemDescription (Maybe Text)
- fileSystemDescription_provisionedThroughputInMibps :: Lens' FileSystemDescription (Maybe Double)
- fileSystemDescription_availabilityZoneName :: Lens' FileSystemDescription (Maybe Text)
- fileSystemDescription_fileSystemArn :: Lens' FileSystemDescription (Maybe Text)
- fileSystemDescription_encrypted :: Lens' FileSystemDescription (Maybe Bool)
- fileSystemDescription_throughputMode :: Lens' FileSystemDescription (Maybe ThroughputMode)
- fileSystemDescription_kmsKeyId :: Lens' FileSystemDescription (Maybe Text)
- fileSystemDescription_name :: Lens' FileSystemDescription (Maybe Text)
- fileSystemDescription_ownerId :: Lens' FileSystemDescription Text
- fileSystemDescription_creationToken :: Lens' FileSystemDescription Text
- fileSystemDescription_fileSystemId :: Lens' FileSystemDescription Text
- fileSystemDescription_creationTime :: Lens' FileSystemDescription UTCTime
- fileSystemDescription_lifeCycleState :: Lens' FileSystemDescription LifeCycleState
- fileSystemDescription_numberOfMountTargets :: Lens' FileSystemDescription Natural
- fileSystemDescription_sizeInBytes :: Lens' FileSystemDescription FileSystemSize
- fileSystemDescription_performanceMode :: Lens' FileSystemDescription PerformanceMode
- fileSystemDescription_tags :: Lens' FileSystemDescription [Tag]
Creating a Request
data UpdateFileSystem Source #
See: newUpdateFileSystem
smart constructor.
UpdateFileSystem' | |
|
Instances
Create a value of UpdateFileSystem
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:provisionedThroughputInMibps:UpdateFileSystem'
, updateFileSystem_provisionedThroughputInMibps
- (Optional) Sets the amount of provisioned throughput, in MiB/s, for the
file system. Valid values are 1-1024. If you are changing the throughput
mode to provisioned, you must also provide the amount of provisioned
throughput. Required if ThroughputMode
is changed to provisioned
on
update.
$sel:throughputMode:UpdateFileSystem'
, updateFileSystem_throughputMode
- (Optional) Updates the file system's throughput mode. If you're not
updating your throughput mode, you don't need to provide this value in
your request. If you are changing the ThroughputMode
to provisioned
,
you must also set a value for ProvisionedThroughputInMibps
.
$sel:fileSystemId:UpdateFileSystem'
, updateFileSystem_fileSystemId
- The ID of the file system that you want to update.
Request Lenses
updateFileSystem_provisionedThroughputInMibps :: Lens' UpdateFileSystem (Maybe Double) Source #
(Optional) Sets the amount of provisioned throughput, in MiB/s, for the
file system. Valid values are 1-1024. If you are changing the throughput
mode to provisioned, you must also provide the amount of provisioned
throughput. Required if ThroughputMode
is changed to provisioned
on
update.
updateFileSystem_throughputMode :: Lens' UpdateFileSystem (Maybe ThroughputMode) Source #
(Optional) Updates the file system's throughput mode. If you're not
updating your throughput mode, you don't need to provide this value in
your request. If you are changing the ThroughputMode
to provisioned
,
you must also set a value for ProvisionedThroughputInMibps
.
updateFileSystem_fileSystemId :: Lens' UpdateFileSystem Text Source #
The ID of the file system that you want to update.
Destructuring the Response
data FileSystemDescription Source #
A description of the file system.
See: newFileSystemDescription
smart constructor.
FileSystemDescription' | |
|
Instances
newFileSystemDescription Source #
:: Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> LifeCycleState | |
-> Natural | |
-> FileSystemSize | |
-> PerformanceMode | |
-> FileSystemDescription |
Create a value of FileSystemDescription
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:availabilityZoneId:FileSystemDescription'
, fileSystemDescription_availabilityZoneId
- The unique and consistent identifier of the Availability Zone in which
the file system's One Zone storage classes exist. For example,
use1-az1
is an Availability Zone ID for the us-east-1 Amazon Web
Services Region, and it has the same location in every Amazon Web
Services account.
$sel:provisionedThroughputInMibps:FileSystemDescription'
, fileSystemDescription_provisionedThroughputInMibps
- The amount of provisioned throughput, measured in MiB/s, for the file
system. Valid for file systems using ThroughputMode
set to
provisioned
.
$sel:availabilityZoneName:FileSystemDescription'
, fileSystemDescription_availabilityZoneName
- Describes the Amazon Web Services Availability Zone in which the file
system is located, and is valid only for file systems using One Zone
storage classes. For more information, see
Using EFS storage classes
in the Amazon EFS User Guide.
$sel:fileSystemArn:FileSystemDescription'
, fileSystemDescription_fileSystemArn
- The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
.
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
$sel:encrypted:FileSystemDescription'
, fileSystemDescription_encrypted
- A Boolean value that, if true, indicates that the file system is
encrypted.
$sel:throughputMode:FileSystemDescription'
, fileSystemDescription_throughputMode
- Displays the file system's throughput mode. For more information, see
Throughput modes
in the Amazon EFS User Guide.
$sel:kmsKeyId:FileSystemDescription'
, fileSystemDescription_kmsKeyId
- The ID of an Key Management Service customer master key (CMK) that was
used to protect the encrypted file system.
$sel:name:FileSystemDescription'
, fileSystemDescription_name
- You can add tags to a file system, including a Name
tag. For more
information, see CreateFileSystem. If the file system has a Name
tag,
Amazon EFS returns the value in this field.
$sel:ownerId:FileSystemDescription'
, fileSystemDescription_ownerId
- The Amazon Web Services account that created the file system. If the
file system was created by an IAM user, the parent account to which the
user belongs is the owner.
$sel:creationToken:FileSystemDescription'
, fileSystemDescription_creationToken
- The opaque string specified in the request.
$sel:fileSystemId:FileSystemDescription'
, fileSystemDescription_fileSystemId
- The ID of the file system, assigned by Amazon EFS.
$sel:creationTime:FileSystemDescription'
, fileSystemDescription_creationTime
- The time that the file system was created, in seconds (since
1970-01-01T00:00:00Z).
$sel:lifeCycleState:FileSystemDescription'
, fileSystemDescription_lifeCycleState
- The lifecycle phase of the file system.
$sel:numberOfMountTargets:FileSystemDescription'
, fileSystemDescription_numberOfMountTargets
- The current number of mount targets that the file system has. For more
information, see CreateMountTarget.
$sel:sizeInBytes:FileSystemDescription'
, fileSystemDescription_sizeInBytes
- The latest known metered size (in bytes) of data stored in the file
system, in its Value
field, and the time at which that size was
determined in its Timestamp
field. The Timestamp
value is the
integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes
value doesn't represent the size of a consistent snapshot of the file
system, but it is eventually consistent when there are no writes to the
file system. That is, SizeInBytes
represents actual size only if the
file system is not modified for a period longer than a couple of hours.
Otherwise, the value is not the exact size that the file system was at
any point in time.
$sel:performanceMode:FileSystemDescription'
, fileSystemDescription_performanceMode
- The performance mode of the file system.
$sel:tags:FileSystemDescription'
, fileSystemDescription_tags
- The tags associated with the file system, presented as an array of Tag
objects.
Response Lenses
fileSystemDescription_availabilityZoneId :: Lens' FileSystemDescription (Maybe Text) Source #
The unique and consistent identifier of the Availability Zone in which
the file system's One Zone storage classes exist. For example,
use1-az1
is an Availability Zone ID for the us-east-1 Amazon Web
Services Region, and it has the same location in every Amazon Web
Services account.
fileSystemDescription_provisionedThroughputInMibps :: Lens' FileSystemDescription (Maybe Double) Source #
The amount of provisioned throughput, measured in MiB/s, for the file
system. Valid for file systems using ThroughputMode
set to
provisioned
.
fileSystemDescription_availabilityZoneName :: Lens' FileSystemDescription (Maybe Text) Source #
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
fileSystemDescription_fileSystemArn :: Lens' FileSystemDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
.
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
fileSystemDescription_encrypted :: Lens' FileSystemDescription (Maybe Bool) Source #
A Boolean value that, if true, indicates that the file system is encrypted.
fileSystemDescription_throughputMode :: Lens' FileSystemDescription (Maybe ThroughputMode) Source #
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
fileSystemDescription_kmsKeyId :: Lens' FileSystemDescription (Maybe Text) Source #
The ID of an Key Management Service customer master key (CMK) that was used to protect the encrypted file system.
fileSystemDescription_name :: Lens' FileSystemDescription (Maybe Text) Source #
You can add tags to a file system, including a Name
tag. For more
information, see CreateFileSystem. If the file system has a Name
tag,
Amazon EFS returns the value in this field.
fileSystemDescription_ownerId :: Lens' FileSystemDescription Text Source #
The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
fileSystemDescription_creationToken :: Lens' FileSystemDescription Text Source #
The opaque string specified in the request.
fileSystemDescription_fileSystemId :: Lens' FileSystemDescription Text Source #
The ID of the file system, assigned by Amazon EFS.
fileSystemDescription_creationTime :: Lens' FileSystemDescription UTCTime Source #
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
fileSystemDescription_lifeCycleState :: Lens' FileSystemDescription LifeCycleState Source #
The lifecycle phase of the file system.
fileSystemDescription_numberOfMountTargets :: Lens' FileSystemDescription Natural Source #
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
fileSystemDescription_sizeInBytes :: Lens' FileSystemDescription FileSystemSize Source #
The latest known metered size (in bytes) of data stored in the file
system, in its Value
field, and the time at which that size was
determined in its Timestamp
field. The Timestamp
value is the
integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes
value doesn't represent the size of a consistent snapshot of the file
system, but it is eventually consistent when there are no writes to the
file system. That is, SizeInBytes
represents actual size only if the
file system is not modified for a period longer than a couple of hours.
Otherwise, the value is not the exact size that the file system was at
any point in time.
fileSystemDescription_performanceMode :: Lens' FileSystemDescription PerformanceMode Source #
The performance mode of the file system.
fileSystemDescription_tags :: Lens' FileSystemDescription [Tag] Source #
The tags associated with the file system, presented as an array of Tag
objects.