Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. fsx
  6. Backup

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.fsx.Backup

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    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.

    Create Backup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
    @overload
def Backup(resource_name: str,
           args: BackupArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           file_system_id: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

    type: aws-native:fsx:Backup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws-native_fsx_backup" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Backup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Backup resource accepts the following input properties:

    FileSystemId string
    The ID of the file system to back up.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to apply to the backup at backup creation.
    FileSystemId string
    The ID of the file system to back up.
    Tags TagArgs
    The tags to apply to the backup at backup creation.
    file_system_id string
    The ID of the file system to back up.
    tags list(object)
    The tags to apply to the backup at backup creation.
    fileSystemId String
    The ID of the file system to back up.
    tags List<Tag>
    The tags to apply to the backup at backup creation.
    fileSystemId string
    The ID of the file system to back up.
    tags Tag[]
    The tags to apply to the backup at backup creation.
    file_system_id str
    The ID of the file system to back up.
    tags Sequence[TagArgs]
    The tags to apply to the backup at backup creation.
    fileSystemId String
    The ID of the file system to back up.
    tags List<Property Map>
    The tags to apply to the backup at backup creation.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Backup resource produces the following output properties:

    BackupId string
    The ID of the backup.
    CreationTime string
    The time when the backup was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Lifecycle Pulumi.AwsNative.FSx.BackupLifecycle
    The lifecycle status of the backup.
    ResourceArn string
    The Amazon Resource Name (ARN) of the backup.
    Type Pulumi.AwsNative.FSx.BackupType
    The type of the backup.
    BackupId string
    The ID of the backup.
    CreationTime string
    The time when the backup was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Lifecycle BackupLifecycle
    The lifecycle status of the backup.
    ResourceArn string
    The Amazon Resource Name (ARN) of the backup.
    Type BackupType
    The type of the backup.
    backup_id string
    The ID of the backup.
    creation_time string
    The time when the backup was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycle "AVAILABLE" | "CREATING" | "TRANSFERRING" | "DELETED" | "FAILED" | "PENDING" | "COPYING"
    The lifecycle status of the backup.
    resource_arn string
    The Amazon Resource Name (ARN) of the backup.
    type "AUTOMATIC" | "USER_INITIATED" | "AWS_BACKUP"
    The type of the backup.
    backupId String
    The ID of the backup.
    creationTime String
    The time when the backup was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycle BackupLifecycle
    The lifecycle status of the backup.
    resourceArn String
    The Amazon Resource Name (ARN) of the backup.
    type BackupType
    The type of the backup.
    backupId string
    The ID of the backup.
    creationTime string
    The time when the backup was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycle BackupLifecycle
    The lifecycle status of the backup.
    resourceArn string
    The Amazon Resource Name (ARN) of the backup.
    type BackupType
    The type of the backup.
    backup_id str
    The ID of the backup.
    creation_time str
    The time when the backup was created.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle BackupLifecycle
    The lifecycle status of the backup.
    resource_arn str
    The Amazon Resource Name (ARN) of the backup.
    type BackupType
    The type of the backup.
    backupId String
    The ID of the backup.
    creationTime String
    The time when the backup was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycle "AVAILABLE" | "CREATING" | "TRANSFERRING" | "DELETED" | "FAILED" | "PENDING" | "COPYING"
    The lifecycle status of the backup.
    resourceArn String
    The Amazon Resource Name (ARN) of the backup.
    type "AUTOMATIC" | "USER_INITIATED" | "AWS_BACKUP"
    The type of the backup.

    Supporting Types

    BackupLifecycle, BackupLifecycleArgs

    Available
    AVAILABLE
    Creating
    CREATING
    Transferring
    TRANSFERRING
    Deleted
    DELETED
    Failed
    FAILED
    Pending
    PENDING
    Copying
    COPYING
    BackupLifecycleAvailable
    AVAILABLE
    BackupLifecycleCreating
    CREATING
    BackupLifecycleTransferring
    TRANSFERRING
    BackupLifecycleDeleted
    DELETED
    BackupLifecycleFailed
    FAILED
    BackupLifecyclePending
    PENDING
    BackupLifecycleCopying
    COPYING
    "AVAILABLE"
    AVAILABLE
    "CREATING"
    CREATING
    "TRANSFERRING"
    TRANSFERRING
    "DELETED"
    DELETED
    "FAILED"
    FAILED
    "PENDING"
    PENDING
    "COPYING"
    COPYING
    Available
    AVAILABLE
    Creating
    CREATING
    Transferring
    TRANSFERRING
    Deleted
    DELETED
    Failed
    FAILED
    Pending
    PENDING
    Copying
    COPYING
    Available
    AVAILABLE
    Creating
    CREATING
    Transferring
    TRANSFERRING
    Deleted
    DELETED
    Failed
    FAILED
    Pending
    PENDING
    Copying
    COPYING
    AVAILABLE
    AVAILABLE
    CREATING
    CREATING
    TRANSFERRING
    TRANSFERRING
    DELETED
    DELETED
    FAILED
    FAILED
    PENDING
    PENDING
    COPYING
    COPYING
    "AVAILABLE"
    AVAILABLE
    "CREATING"
    CREATING
    "TRANSFERRING"
    TRANSFERRING
    "DELETED"
    DELETED
    "FAILED"
    FAILED
    "PENDING"
    PENDING
    "COPYING"
    COPYING

    BackupType, BackupTypeArgs

    Automatic
    AUTOMATIC
    UserInitiated
    USER_INITIATED
    AwsBackup
    AWS_BACKUP
    BackupTypeAutomatic
    AUTOMATIC
    BackupTypeUserInitiated
    USER_INITIATED
    BackupTypeAwsBackup
    AWS_BACKUP
    "AUTOMATIC"
    AUTOMATIC
    "USER_INITIATED"
    USER_INITIATED
    "AWS_BACKUP"
    AWS_BACKUP
    Automatic
    AUTOMATIC
    UserInitiated
    USER_INITIATED
    AwsBackup
    AWS_BACKUP
    Automatic
    AUTOMATIC
    UserInitiated
    USER_INITIATED
    AwsBackup
    AWS_BACKUP
    AUTOMATIC
    AUTOMATIC
    USER_INITIATED
    USER_INITIATED
    AWS_BACKUP
    AWS_BACKUP
    "AUTOMATIC"
    AUTOMATIC
    "USER_INITIATED"
    USER_INITIATED
    "AWS_BACKUP"
    AWS_BACKUP

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial