libZSservicesZSamazonka-efsZSamazonka-efs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.EFS.UpdateFileSystem

Description

Updates the throughput mode or the amount of provisioned throughput of an existing file system.

Synopsis

Creating a Request

data UpdateFileSystem Source #

See: newUpdateFileSystem smart constructor.

Constructors

UpdateFileSystem' 

Fields

  • provisionedThroughputInMibps :: Maybe Double

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

  • throughputMode :: Maybe 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.

  • fileSystemId :: Text

    The ID of the file system that you want to update.

Instances

Instances details
Eq UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

Read UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

Show UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

Generic UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

Associated Types

type Rep UpdateFileSystem :: Type -> Type #

NFData UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

Methods

rnf :: UpdateFileSystem -> () #

Hashable UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

ToJSON UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

AWSRequest UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

Associated Types

type AWSResponse UpdateFileSystem #

ToHeaders UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

ToPath UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

ToQuery UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

type Rep UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

type Rep UpdateFileSystem = D1 ('MetaData "UpdateFileSystem" "Amazonka.EFS.UpdateFileSystem" "libZSservicesZSamazonka-efsZSamazonka-efs" 'False) (C1 ('MetaCons "UpdateFileSystem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "provisionedThroughputInMibps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "throughputMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThroughputMode)) :*: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateFileSystem Source # 
Instance details

Defined in Amazonka.EFS.UpdateFileSystem

newUpdateFileSystem Source #

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.

Constructors

FileSystemDescription' 

Fields

  • availabilityZoneId :: Maybe Text

    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.

  • provisionedThroughputInMibps :: Maybe Double

    The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.

  • availabilityZoneName :: Maybe Text

    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.

  • fileSystemArn :: Maybe Text

    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

  • encrypted :: Maybe Bool

    A Boolean value that, if true, indicates that the file system is encrypted.

  • throughputMode :: Maybe ThroughputMode

    Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

  • kmsKeyId :: Maybe Text

    The ID of an Key Management Service customer master key (CMK) that was used to protect the encrypted file system.

  • name :: Maybe Text

    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.

  • ownerId :: Text

    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.

  • creationToken :: Text

    The opaque string specified in the request.

  • fileSystemId :: Text

    The ID of the file system, assigned by Amazon EFS.

  • creationTime :: POSIX

    The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

  • lifeCycleState :: LifeCycleState

    The lifecycle phase of the file system.

  • numberOfMountTargets :: Natural

    The current number of mount targets that the file system has. For more information, see CreateMountTarget.

  • sizeInBytes :: FileSystemSize

    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.

  • performanceMode :: PerformanceMode

    The performance mode of the file system.

  • tags :: [Tag]

    The tags associated with the file system, presented as an array of Tag objects.

Instances

Instances details
Eq FileSystemDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemDescription

Read FileSystemDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemDescription

Show FileSystemDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemDescription

Generic FileSystemDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemDescription

Associated Types

type Rep FileSystemDescription :: Type -> Type #

NFData FileSystemDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemDescription

Methods

rnf :: FileSystemDescription -> () #

Hashable FileSystemDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemDescription

FromJSON FileSystemDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemDescription

type Rep FileSystemDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemDescription

type Rep FileSystemDescription = D1 ('MetaData "FileSystemDescription" "Amazonka.EFS.Types.FileSystemDescription" "libZSservicesZSamazonka-efsZSamazonka-efs" 'False) (C1 ('MetaCons "FileSystemDescription'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "availabilityZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "provisionedThroughputInMibps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "availabilityZoneName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fileSystemArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "throughputMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThroughputMode))) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "creationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) :*: ((S1 ('MetaSel ('Just "lifeCycleState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LifeCycleState) :*: S1 ('MetaSel ('Just "numberOfMountTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "sizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FileSystemSize) :*: (S1 ('MetaSel ('Just "performanceMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PerformanceMode) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))))))

newFileSystemDescription Source #

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_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_tags :: Lens' FileSystemDescription [Tag] Source #

The tags associated with the file system, presented as an array of Tag objects.