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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.

For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:

A Persistent deployment type
Are not linked to a data repository

For more information about backups, see the following:

For Amazon FSx for Lustre, see Working with FSx for Lustre backups.
For Amazon FSx for Windows, see Working with FSx for Windows backups.
For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups.

If a backup with the specified client request token exists and the parameters match, this operation returns the description of the existing backup. If a backup with the specified client request token exists and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

Synopsis

Creating a Request

data CreateBackup Source #

The request object for the CreateBackup operation.

See: newCreateBackup smart constructor.

Constructors

CreateBackup'

Fields

clientRequestToken :: Maybe Text
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
fileSystemId :: Maybe Text
The ID of the file system to back up.
tags :: Maybe (NonEmpty Tag)
(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.
volumeId :: Maybe Text
(Optional) The ID of the FSx for ONTAP volume to back up.

Instances

Instances details

ToJSON CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods toJSON :: CreateBackup -> Value # toEncoding :: CreateBackup -> Encoding # toJSONList :: [CreateBackup] -> Value # toEncodingList :: [CreateBackup] -> Encoding #
ToHeaders CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods toHeaders :: CreateBackup -> [Header] #
ToPath CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods toPath :: CreateBackup -> ByteString #
ToQuery CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods toQuery :: CreateBackup -> QueryString #
AWSRequest CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Associated Types type AWSResponse CreateBackup # Methods request :: (Service -> Service) -> CreateBackup -> Request CreateBackup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBackup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBackup))) #
Generic CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Associated Types type Rep CreateBackup :: Type -> Type # Methods from :: CreateBackup -> Rep CreateBackup x # to :: Rep CreateBackup x -> CreateBackup #
Read CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods readsPrec :: Int -> ReadS CreateBackup # readList :: ReadS [CreateBackup] # readPrec :: ReadPrec CreateBackup # readListPrec :: ReadPrec [CreateBackup] #
Show CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods showsPrec :: Int -> CreateBackup -> ShowS # show :: CreateBackup -> String # showList :: [CreateBackup] -> ShowS #
NFData CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods rnf :: CreateBackup -> () #
Eq CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods (==) :: CreateBackup -> CreateBackup -> Bool # (/=) :: CreateBackup -> CreateBackup -> Bool #
Hashable CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods hashWithSalt :: Int -> CreateBackup -> Int # hash :: CreateBackup -> Int #
type AWSResponse CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup type AWSResponse CreateBackup = CreateBackupResponse
type Rep CreateBackup Source #
Instance details Defined in Amazonka.FSx.CreateBackup type Rep CreateBackup = D1 ('MetaData "CreateBackup" "Amazonka.FSx.CreateBackup" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateBackup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fileSystemId") '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)))))

newCreateBackup :: CreateBackup Source #

Create a value of CreateBackup 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:clientRequestToken:CreateBackup', createBackup_clientRequestToken - (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

CreateBackup, createBackup_fileSystemId - The ID of the file system to back up.

CreateBackup, createBackup_tags - (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.

CreateBackup, createBackup_volumeId - (Optional) The ID of the FSx for ONTAP volume to back up.

Request Lenses

createBackup_clientRequestToken :: Lens' CreateBackup (Maybe Text) Source #

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

createBackup_fileSystemId :: Lens' CreateBackup (Maybe Text) Source #

The ID of the file system to back up.

createBackup_tags :: Lens' CreateBackup (Maybe (NonEmpty Tag)) Source #

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.

createBackup_volumeId :: Lens' CreateBackup (Maybe Text) Source #

(Optional) The ID of the FSx for ONTAP volume to back up.

Destructuring the Response

data CreateBackupResponse Source #

The response object for the CreateBackup operation.

See: newCreateBackupResponse smart constructor.

Constructors

CreateBackupResponse'
Fields backup :: Maybe Backup A description of the backup. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateBackup Associated Types type Rep CreateBackupResponse :: Type -> Type # Methods from :: CreateBackupResponse -> Rep CreateBackupResponse x # to :: Rep CreateBackupResponse x -> CreateBackupResponse #
Read CreateBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods readsPrec :: Int -> ReadS CreateBackupResponse # readList :: ReadS [CreateBackupResponse] # readPrec :: ReadPrec CreateBackupResponse # readListPrec :: ReadPrec [CreateBackupResponse] #
Show CreateBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods showsPrec :: Int -> CreateBackupResponse -> ShowS # show :: CreateBackupResponse -> String # showList :: [CreateBackupResponse] -> ShowS #
NFData CreateBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods rnf :: CreateBackupResponse -> () #
Eq CreateBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateBackup Methods (==) :: CreateBackupResponse -> CreateBackupResponse -> Bool # (/=) :: CreateBackupResponse -> CreateBackupResponse -> Bool #
type Rep CreateBackupResponse Source #
Instance details Defined in Amazonka.FSx.CreateBackup type Rep CreateBackupResponse = D1 ('MetaData "CreateBackupResponse" "Amazonka.FSx.CreateBackup" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateBackupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Backup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateBackupResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateBackupResponse'`
-> CreateBackupResponse

Create a value of CreateBackupResponse 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:backup:CreateBackupResponse', createBackupResponse_backup - A description of the backup.

$sel:httpStatus:CreateBackupResponse', createBackupResponse_httpStatus - The response's http status code.

Response Lenses

createBackupResponse_backup :: Lens' CreateBackupResponse (Maybe Backup) Source #

A description of the backup.

createBackupResponse_httpStatus :: Lens' CreateBackupResponse Int Source #

The response's http status code.