Table of Contents

Class CopyBackupRequest

Namespace
Amazon.FSx.Model
Assembly
AWSSDK.FSx.dll

Container for the parameters to the CopyBackup operation. 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.

public class CopyBackupRequest : AmazonFSxRequest
Inheritance
CopyBackupRequest

Constructors

CopyBackupRequest()

public CopyBackupRequest()

Properties

ClientRequestToken

Gets and sets the property ClientRequestToken.

public string ClientRequestToken { get; set; }

Property Value

string

CopyTags

Gets and sets the property 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.

public bool CopyTags { get; set; }

Property Value

bool

KmsKeyId

Gets and sets the property KmsKeyId.

public string KmsKeyId { get; set; }

Property Value

string

SourceBackupId

Gets and sets the property SourceBackupId.

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

public string SourceBackupId { get; set; }

Property Value

string

SourceRegion

Gets and sets the property 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).

public string SourceRegion { get; set; }

Property Value

string

Tags

Gets and sets the property Tags.

public List<Tag> Tags { get; set; }

Property Value

List<Tag>