View a markdown version of this page

AWS::FSx::Backup - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::FSx::Backup

A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::FSx::Backup",
  "Properties" : {
      "FileSystemId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::FSx::Backup
Properties:
  FileSystemId: String
  Tags: 
    - Tag

Properties

FileSystemId

The ID of the file system to back up.

Required: Yes

Type: String

Pattern: ^(fs-[0-9a-f]{8,})$

Minimum: 11

Maximum: 21

Update requires: Replacement

Tags

The tags associated with a particular file system.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

BackupId

The ID of the backup.

CreationTime

The time when a particular backup was created.

Lifecycle

The lifecycle status of the backup.

  • AVAILABLE - The backup is fully available.

  • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.

  • CREATING - Amazon FSx is creating the backup.

  • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.

  • COPYING - Amazon FSx is copying the backup.

  • DELETED - Amazon FSx deleted the backup and it's no longer available.

  • FAILED - Amazon FSx couldn't finish the backup.

ResourceARN

The Amazon Resource Name (ARN) for the backup resource.

Type

The type of the file-system backup.