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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.

You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).

You can also use backup copies to clone your file dataset to another Region or within the same Region.

You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).

For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.

Synopsis

data CopyBackup = CopyBackup' {
- clientRequestToken :: Maybe Text
- copyTags :: Maybe Bool
- kmsKeyId :: Maybe Text
- sourceRegion :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- sourceBackupId :: Text
}
newCopyBackup :: Text -> CopyBackup
copyBackup_clientRequestToken :: Lens' CopyBackup (Maybe Text)
copyBackup_copyTags :: Lens' CopyBackup (Maybe Bool)
copyBackup_kmsKeyId :: Lens' CopyBackup (Maybe Text)
copyBackup_sourceRegion :: Lens' CopyBackup (Maybe Text)
copyBackup_tags :: Lens' CopyBackup (Maybe (NonEmpty Tag))
copyBackup_sourceBackupId :: Lens' CopyBackup Text
data CopyBackupResponse = CopyBackupResponse' {
- backup :: Maybe Backup
- httpStatus :: Int
}
newCopyBackupResponse :: Int -> CopyBackupResponse
copyBackupResponse_backup :: Lens' CopyBackupResponse (Maybe Backup)
copyBackupResponse_httpStatus :: Lens' CopyBackupResponse Int

Creating a Request

data CopyBackup Source #

See: newCopyBackup smart constructor.

Constructors

CopyBackup'

Fields

clientRequestToken :: Maybe Text
copyTags :: Maybe Bool
A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.
If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.
kmsKeyId :: Maybe Text
sourceRegion :: Maybe Text
The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).
tags :: Maybe (NonEmpty Tag)
sourceBackupId :: Text
The ID of the source backup. Specifies the ID of the backup that's being copied.

Instances

Instances details

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

newCopyBackup Source #

Arguments

:: Text	`CopyBackup`
-> CopyBackup

Create a value of CopyBackup 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:CopyBackup', copyBackup_clientRequestToken - Undocumented member.

$sel:copyTags:CopyBackup', copyBackup_copyTags - A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

CopyBackup, copyBackup_kmsKeyId - Undocumented member.

$sel:sourceRegion:CopyBackup', copyBackup_sourceRegion - The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).

CopyBackup, copyBackup_tags - Undocumented member.

CopyBackup, copyBackup_sourceBackupId - The ID of the source backup. Specifies the ID of the backup that's being copied.

Request Lenses

copyBackup_clientRequestToken :: Lens' CopyBackup (Maybe Text) Source #

Undocumented member.

copyBackup_copyTags :: Lens' CopyBackup (Maybe Bool) Source #

A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

copyBackup_kmsKeyId :: Lens' CopyBackup (Maybe Text) Source #

Undocumented member.

copyBackup_sourceRegion :: Lens' CopyBackup (Maybe Text) Source #

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).

copyBackup_tags :: Lens' CopyBackup (Maybe (NonEmpty Tag)) Source #

Undocumented member.

copyBackup_sourceBackupId :: Lens' CopyBackup Text Source #

The ID of the source backup. Specifies the ID of the backup that's being copied.

Destructuring the Response

data CopyBackupResponse Source #

See: newCopyBackupResponse smart constructor.

Constructors

CopyBackupResponse'
Fields backup :: Maybe Backup httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCopyBackupResponse Source #

Arguments

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

Create a value of CopyBackupResponse 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:CopyBackupResponse', copyBackupResponse_backup - Undocumented member.

$sel:httpStatus:CopyBackupResponse', copyBackupResponse_httpStatus - The response's http status code.

Response Lenses

copyBackupResponse_backup :: Lens' CopyBackupResponse (Maybe Backup) Source #

Undocumented member.

copyBackupResponse_httpStatus :: Lens' CopyBackupResponse Int Source #

The response's http status code.