Skip to content

Create Backup

fsx_create_backup R Documentation

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

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:

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, create_backup 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 create_backup 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 create_backup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the describe_backups operation, which returns the backup state along with other information.

Usage

fsx_create_backup(FileSystemId, ClientRequestToken, Tags, VolumeId)

Arguments

FileSystemId

The ID of the file system to back up.

ClientRequestToken

(Optional) A string of up to 63 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.

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 create_backup operation, no existing file system tags are copied from the file system to the backup.

VolumeId

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

Value

A list with the following syntax:

list(
  Backup = list(
    BackupId = "string",
    Lifecycle = "AVAILABLE"|"CREATING"|"TRANSFERRING"|"DELETED"|"FAILED"|"PENDING"|"COPYING",
    FailureDetails = list(
      Message = "string"
    ),
    Type = "AUTOMATIC"|"USER_INITIATED"|"AWS_BACKUP",
    ProgressPercent = 123,
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    KmsKeyId = "string",
    ResourceARN = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    FileSystem = list(
      OwnerId = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      FileSystemId = "string",
      FileSystemType = "WINDOWS"|"LUSTRE"|"ONTAP"|"OPENZFS",
      Lifecycle = "AVAILABLE"|"CREATING"|"FAILED"|"DELETING"|"MISCONFIGURED"|"UPDATING"|"MISCONFIGURED_UNAVAILABLE",
      FailureDetails = list(
        Message = "string"
      ),
      StorageCapacity = 123,
      StorageType = "SSD"|"HDD",
      VpcId = "string",
      SubnetIds = list(
        "string"
      ),
      NetworkInterfaceIds = list(
        "string"
      ),
      DNSName = "string",
      KmsKeyId = "string",
      ResourceARN = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      WindowsConfiguration = list(
        ActiveDirectoryId = "string",
        SelfManagedActiveDirectoryConfiguration = list(
          DomainName = "string",
          OrganizationalUnitDistinguishedName = "string",
          FileSystemAdministratorsGroup = "string",
          UserName = "string",
          DnsIps = list(
            "string"
          )
        ),
        DeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2",
        RemoteAdministrationEndpoint = "string",
        PreferredSubnetId = "string",
        PreferredFileServerIp = "string",
        ThroughputCapacity = 123,
        MaintenanceOperationsInProgress = list(
          "PATCHING"|"BACKING_UP"
        ),
        WeeklyMaintenanceStartTime = "string",
        DailyAutomaticBackupStartTime = "string",
        AutomaticBackupRetentionDays = 123,
        CopyTagsToBackups = TRUE|FALSE,
        Aliases = list(
          list(
            Name = "string",
            Lifecycle = "AVAILABLE"|"CREATING"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED"
          )
        ),
        AuditLogConfiguration = list(
          FileAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
          FileShareAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
          AuditLogDestination = "string"
        ),
        DiskIopsConfiguration = list(
          Mode = "AUTOMATIC"|"USER_PROVISIONED",
          Iops = 123
        )
      ),
      LustreConfiguration = list(
        WeeklyMaintenanceStartTime = "string",
        DataRepositoryConfiguration = list(
          Lifecycle = "CREATING"|"AVAILABLE"|"MISCONFIGURED"|"UPDATING"|"DELETING"|"FAILED",
          ImportPath = "string",
          ExportPath = "string",
          ImportedFileChunkSize = 123,
          AutoImportPolicy = "NONE"|"NEW"|"NEW_CHANGED"|"NEW_CHANGED_DELETED",
          FailureDetails = list(
            Message = "string"
          )
        ),
        DeploymentType = "SCRATCH_1"|"SCRATCH_2"|"PERSISTENT_1"|"PERSISTENT_2",
        PerUnitStorageThroughput = 123,
        MountName = "string",
        DailyAutomaticBackupStartTime = "string",
        AutomaticBackupRetentionDays = 123,
        CopyTagsToBackups = TRUE|FALSE,
        DriveCacheType = "NONE"|"READ",
        DataCompressionType = "NONE"|"LZ4",
        LogConfiguration = list(
          Level = "DISABLED"|"WARN_ONLY"|"ERROR_ONLY"|"WARN_ERROR",
          Destination = "string"
        ),
        RootSquashConfiguration = list(
          RootSquash = "string",
          NoSquashNids = list(
            "string"
          )
        ),
        MetadataConfiguration = list(
          Iops = 123,
          Mode = "AUTOMATIC"|"USER_PROVISIONED"
        )
      ),
      AdministrativeActions = list(
        list(
          AdministrativeActionType = "FILE_SYSTEM_UPDATE"|"STORAGE_OPTIMIZATION"|"FILE_SYSTEM_ALIAS_ASSOCIATION"|"FILE_SYSTEM_ALIAS_DISASSOCIATION"|"VOLUME_UPDATE"|"SNAPSHOT_UPDATE"|"RELEASE_NFS_V3_LOCKS"|"VOLUME_RESTORE"|"THROUGHPUT_OPTIMIZATION"|"IOPS_OPTIMIZATION"|"STORAGE_TYPE_OPTIMIZATION"|"MISCONFIGURED_STATE_RECOVERY"|"VOLUME_UPDATE_WITH_SNAPSHOT"|"VOLUME_INITIALIZE_WITH_SNAPSHOT"|"DOWNLOAD_DATA_FROM_BACKUP",
          ProgressPercent = 123,
          RequestTime = as.POSIXct(
            "2015-01-01"
          ),
          Status = "FAILED"|"IN_PROGRESS"|"PENDING"|"COMPLETED"|"UPDATED_OPTIMIZING"|"OPTIMIZING",
          TargetFileSystemValues = list(),
          FailureDetails = list(
            Message = "string"
          ),
          TargetVolumeValues = list(
            CreationTime = as.POSIXct(
              "2015-01-01"
            ),
            FileSystemId = "string",
            Lifecycle = "CREATING"|"CREATED"|"DELETING"|"FAILED"|"MISCONFIGURED"|"PENDING"|"AVAILABLE",
            Name = "string",
            OntapConfiguration = list(
              FlexCacheEndpointType = "NONE"|"ORIGIN"|"CACHE",
              JunctionPath = "string",
              SecurityStyle = "UNIX"|"NTFS"|"MIXED",
              SizeInMegabytes = 123,
              StorageEfficiencyEnabled = TRUE|FALSE,
              StorageVirtualMachineId = "string",
              StorageVirtualMachineRoot = TRUE|FALSE,
              TieringPolicy = list(
                CoolingPeriod = 123,
                Name = "SNAPSHOT_ONLY"|"AUTO"|"ALL"|"NONE"
              ),
              UUID = "string",
              OntapVolumeType = "RW"|"DP"|"LS",
              SnapshotPolicy = "string",
              CopyTagsToBackups = TRUE|FALSE,
              SnaplockConfiguration = list(
                AuditLogVolume = TRUE|FALSE,
                AutocommitPeriod = list(
                  Type = "MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"NONE",
                  Value = 123
                ),
                PrivilegedDelete = "DISABLED"|"ENABLED"|"PERMANENTLY_DISABLED",
                RetentionPeriod = list(
                  DefaultRetention = list(
                    Type = "SECONDS"|"MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"INFINITE"|"UNSPECIFIED",
                    Value = 123
                  ),
                  MinimumRetention = list(
                    Type = "SECONDS"|"MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"INFINITE"|"UNSPECIFIED",
                    Value = 123
                  ),
                  MaximumRetention = list(
                    Type = "SECONDS"|"MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"INFINITE"|"UNSPECIFIED",
                    Value = 123
                  )
                ),
                SnaplockType = "COMPLIANCE"|"ENTERPRISE",
                VolumeAppendModeEnabled = TRUE|FALSE
              ),
              VolumeStyle = "FLEXVOL"|"FLEXGROUP",
              AggregateConfiguration = list(
                Aggregates = list(
                  "string"
                ),
                TotalConstituents = 123
              ),
              SizeInBytes = 123
            ),
            ResourceARN = "string",
            Tags = list(
              list(
                Key = "string",
                Value = "string"
              )
            ),
            VolumeId = "string",
            VolumeType = "ONTAP"|"OPENZFS",
            LifecycleTransitionReason = list(
              Message = "string"
            ),
            AdministrativeActions = list(),
            OpenZFSConfiguration = list(
              ParentVolumeId = "string",
              VolumePath = "string",
              StorageCapacityReservationGiB = 123,
              StorageCapacityQuotaGiB = 123,
              RecordSizeKiB = 123,
              DataCompressionType = "NONE"|"ZSTD"|"LZ4",
              CopyTagsToSnapshots = TRUE|FALSE,
              OriginSnapshot = list(
                SnapshotARN = "string",
                CopyStrategy = "CLONE"|"FULL_COPY"|"INCREMENTAL_COPY"
              ),
              ReadOnly = TRUE|FALSE,
              NfsExports = list(
                list(
                  ClientConfigurations = list(
                    list(
                      Clients = "string",
                      Options = list(
                        "string"
                      )
                    )
                  )
                )
              ),
              UserAndGroupQuotas = list(
                list(
                  Type = "USER"|"GROUP",
                  Id = 123,
                  StorageCapacityQuotaGiB = 123
                )
              ),
              RestoreToSnapshot = "string",
              DeleteIntermediateSnaphots = TRUE|FALSE,
              DeleteClonedVolumes = TRUE|FALSE,
              DeleteIntermediateData = TRUE|FALSE,
              SourceSnapshotARN = "string",
              DestinationSnapshot = "string",
              CopyStrategy = "CLONE"|"FULL_COPY"|"INCREMENTAL_COPY"
            )
          ),
          TargetSnapshotValues = list(
            ResourceARN = "string",
            SnapshotId = "string",
            Name = "string",
            VolumeId = "string",
            CreationTime = as.POSIXct(
              "2015-01-01"
            ),
            Lifecycle = "PENDING"|"CREATING"|"DELETING"|"AVAILABLE",
            LifecycleTransitionReason = list(
              Message = "string"
            ),
            Tags = list(
              list(
                Key = "string",
                Value = "string"
              )
            ),
            AdministrativeActions = list()
          ),
          TotalTransferBytes = 123,
          RemainingTransferBytes = 123
        )
      ),
      OntapConfiguration = list(
        AutomaticBackupRetentionDays = 123,
        DailyAutomaticBackupStartTime = "string",
        DeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2"|"MULTI_AZ_2",
        EndpointIpAddressRange = "string",
        Endpoints = list(
          Intercluster = list(
            DNSName = "string",
            IpAddresses = list(
              "string"
            )
          ),
          Management = list(
            DNSName = "string",
            IpAddresses = list(
              "string"
            )
          )
        ),
        DiskIopsConfiguration = list(
          Mode = "AUTOMATIC"|"USER_PROVISIONED",
          Iops = 123
        ),
        PreferredSubnetId = "string",
        RouteTableIds = list(
          "string"
        ),
        ThroughputCapacity = 123,
        WeeklyMaintenanceStartTime = "string",
        FsxAdminPassword = "string",
        HAPairs = 123,
        ThroughputCapacityPerHAPair = 123
      ),
      FileSystemTypeVersion = "string",
      OpenZFSConfiguration = list(
        AutomaticBackupRetentionDays = 123,
        CopyTagsToBackups = TRUE|FALSE,
        CopyTagsToVolumes = TRUE|FALSE,
        DailyAutomaticBackupStartTime = "string",
        DeploymentType = "SINGLE_AZ_1"|"SINGLE_AZ_2"|"SINGLE_AZ_HA_1"|"SINGLE_AZ_HA_2"|"MULTI_AZ_1",
        ThroughputCapacity = 123,
        WeeklyMaintenanceStartTime = "string",
        DiskIopsConfiguration = list(
          Mode = "AUTOMATIC"|"USER_PROVISIONED",
          Iops = 123
        ),
        RootVolumeId = "string",
        PreferredSubnetId = "string",
        EndpointIpAddressRange = "string",
        RouteTableIds = list(
          "string"
        ),
        EndpointIpAddress = "string"
      )
    ),
    DirectoryInformation = list(
      DomainName = "string",
      ActiveDirectoryId = "string",
      ResourceARN = "string"
    ),
    OwnerId = "string",
    SourceBackupId = "string",
    SourceBackupRegion = "string",
    ResourceType = "FILE_SYSTEM"|"VOLUME",
    Volume = list(
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      FileSystemId = "string",
      Lifecycle = "CREATING"|"CREATED"|"DELETING"|"FAILED"|"MISCONFIGURED"|"PENDING"|"AVAILABLE",
      Name = "string",
      OntapConfiguration = list(
        FlexCacheEndpointType = "NONE"|"ORIGIN"|"CACHE",
        JunctionPath = "string",
        SecurityStyle = "UNIX"|"NTFS"|"MIXED",
        SizeInMegabytes = 123,
        StorageEfficiencyEnabled = TRUE|FALSE,
        StorageVirtualMachineId = "string",
        StorageVirtualMachineRoot = TRUE|FALSE,
        TieringPolicy = list(
          CoolingPeriod = 123,
          Name = "SNAPSHOT_ONLY"|"AUTO"|"ALL"|"NONE"
        ),
        UUID = "string",
        OntapVolumeType = "RW"|"DP"|"LS",
        SnapshotPolicy = "string",
        CopyTagsToBackups = TRUE|FALSE,
        SnaplockConfiguration = list(
          AuditLogVolume = TRUE|FALSE,
          AutocommitPeriod = list(
            Type = "MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"NONE",
            Value = 123
          ),
          PrivilegedDelete = "DISABLED"|"ENABLED"|"PERMANENTLY_DISABLED",
          RetentionPeriod = list(
            DefaultRetention = list(
              Type = "SECONDS"|"MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"INFINITE"|"UNSPECIFIED",
              Value = 123
            ),
            MinimumRetention = list(
              Type = "SECONDS"|"MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"INFINITE"|"UNSPECIFIED",
              Value = 123
            ),
            MaximumRetention = list(
              Type = "SECONDS"|"MINUTES"|"HOURS"|"DAYS"|"MONTHS"|"YEARS"|"INFINITE"|"UNSPECIFIED",
              Value = 123
            )
          ),
          SnaplockType = "COMPLIANCE"|"ENTERPRISE",
          VolumeAppendModeEnabled = TRUE|FALSE
        ),
        VolumeStyle = "FLEXVOL"|"FLEXGROUP",
        AggregateConfiguration = list(
          Aggregates = list(
            "string"
          ),
          TotalConstituents = 123
        ),
        SizeInBytes = 123
      ),
      ResourceARN = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      VolumeId = "string",
      VolumeType = "ONTAP"|"OPENZFS",
      LifecycleTransitionReason = list(
        Message = "string"
      ),
      AdministrativeActions = list(
        list(
          AdministrativeActionType = "FILE_SYSTEM_UPDATE"|"STORAGE_OPTIMIZATION"|"FILE_SYSTEM_ALIAS_ASSOCIATION"|"FILE_SYSTEM_ALIAS_DISASSOCIATION"|"VOLUME_UPDATE"|"SNAPSHOT_UPDATE"|"RELEASE_NFS_V3_LOCKS"|"VOLUME_RESTORE"|"THROUGHPUT_OPTIMIZATION"|"IOPS_OPTIMIZATION"|"STORAGE_TYPE_OPTIMIZATION"|"MISCONFIGURED_STATE_RECOVERY"|"VOLUME_UPDATE_WITH_SNAPSHOT"|"VOLUME_INITIALIZE_WITH_SNAPSHOT"|"DOWNLOAD_DATA_FROM_BACKUP",
          ProgressPercent = 123,
          RequestTime = as.POSIXct(
            "2015-01-01"
          ),
          Status = "FAILED"|"IN_PROGRESS"|"PENDING"|"COMPLETED"|"UPDATED_OPTIMIZING"|"OPTIMIZING",
          TargetFileSystemValues = list(
            OwnerId = "string",
            CreationTime = as.POSIXct(
              "2015-01-01"
            ),
            FileSystemId = "string",
            FileSystemType = "WINDOWS"|"LUSTRE"|"ONTAP"|"OPENZFS",
            Lifecycle = "AVAILABLE"|"CREATING"|"FAILED"|"DELETING"|"MISCONFIGURED"|"UPDATING"|"MISCONFIGURED_UNAVAILABLE",
            FailureDetails = list(
              Message = "string"
            ),
            StorageCapacity = 123,
            StorageType = "SSD"|"HDD",
            VpcId = "string",
            SubnetIds = list(
              "string"
            ),
            NetworkInterfaceIds = list(
              "string"
            ),
            DNSName = "string",
            KmsKeyId = "string",
            ResourceARN = "string",
            Tags = list(
              list(
                Key = "string",
                Value = "string"
              )
            ),
            WindowsConfiguration = list(
              ActiveDirectoryId = "string",
              SelfManagedActiveDirectoryConfiguration = list(
                DomainName = "string",
                OrganizationalUnitDistinguishedName = "string",
                FileSystemAdministratorsGroup = "string",
                UserName = "string",
                DnsIps = list(
                  "string"
                )
              ),
              DeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2",
              RemoteAdministrationEndpoint = "string",
              PreferredSubnetId = "string",
              PreferredFileServerIp = "string",
              ThroughputCapacity = 123,
              MaintenanceOperationsInProgress = list(
                "PATCHING"|"BACKING_UP"
              ),
              WeeklyMaintenanceStartTime = "string",
              DailyAutomaticBackupStartTime = "string",
              AutomaticBackupRetentionDays = 123,
              CopyTagsToBackups = TRUE|FALSE,
              Aliases = list(
                list(
                  Name = "string",
                  Lifecycle = "AVAILABLE"|"CREATING"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED"
                )
              ),
              AuditLogConfiguration = list(
                FileAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
                FileShareAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE",
                AuditLogDestination = "string"
              ),
              DiskIopsConfiguration = list(
                Mode = "AUTOMATIC"|"USER_PROVISIONED",
                Iops = 123
              )
            ),
            LustreConfiguration = list(
              WeeklyMaintenanceStartTime = "string",
              DataRepositoryConfiguration = list(
                Lifecycle = "CREATING"|"AVAILABLE"|"MISCONFIGURED"|"UPDATING"|"DELETING"|"FAILED",
                ImportPath = "string",
                ExportPath = "string",
                ImportedFileChunkSize = 123,
                AutoImportPolicy = "NONE"|"NEW"|"NEW_CHANGED"|"NEW_CHANGED_DELETED",
                FailureDetails = list(
                  Message = "string"
                )
              ),
              DeploymentType = "SCRATCH_1"|"SCRATCH_2"|"PERSISTENT_1"|"PERSISTENT_2",
              PerUnitStorageThroughput = 123,
              MountName = "string",
              DailyAutomaticBackupStartTime = "string",
              AutomaticBackupRetentionDays = 123,
              CopyTagsToBackups = TRUE|FALSE,
              DriveCacheType = "NONE"|"READ",
              DataCompressionType = "NONE"|"LZ4",
              LogConfiguration = list(
                Level = "DISABLED"|"WARN_ONLY"|"ERROR_ONLY"|"WARN_ERROR",
                Destination = "string"
              ),
              RootSquashConfiguration = list(
                RootSquash = "string",
                NoSquashNids = list(
                  "string"
                )
              ),
              MetadataConfiguration = list(
                Iops = 123,
                Mode = "AUTOMATIC"|"USER_PROVISIONED"
              )
            ),
            AdministrativeActions = list(),
            OntapConfiguration = list(
              AutomaticBackupRetentionDays = 123,
              DailyAutomaticBackupStartTime = "string",
              DeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2"|"MULTI_AZ_2",
              EndpointIpAddressRange = "string",
              Endpoints = list(
                Intercluster = list(
                  DNSName = "string",
                  IpAddresses = list(
                    "string"
                  )
                ),
                Management = list(
                  DNSName = "string",
                  IpAddresses = list(
                    "string"
                  )
                )
              ),
              DiskIopsConfiguration = list(
                Mode = "AUTOMATIC"|"USER_PROVISIONED",
                Iops = 123
              ),
              PreferredSubnetId = "string",
              RouteTableIds = list(
                "string"
              ),
              ThroughputCapacity = 123,
              WeeklyMaintenanceStartTime = "string",
              FsxAdminPassword = "string",
              HAPairs = 123,
              ThroughputCapacityPerHAPair = 123
            ),
            FileSystemTypeVersion = "string",
            OpenZFSConfiguration = list(
              AutomaticBackupRetentionDays = 123,
              CopyTagsToBackups = TRUE|FALSE,
              CopyTagsToVolumes = TRUE|FALSE,
              DailyAutomaticBackupStartTime = "string",
              DeploymentType = "SINGLE_AZ_1"|"SINGLE_AZ_2"|"SINGLE_AZ_HA_1"|"SINGLE_AZ_HA_2"|"MULTI_AZ_1",
              ThroughputCapacity = 123,
              WeeklyMaintenanceStartTime = "string",
              DiskIopsConfiguration = list(
                Mode = "AUTOMATIC"|"USER_PROVISIONED",
                Iops = 123
              ),
              RootVolumeId = "string",
              PreferredSubnetId = "string",
              EndpointIpAddressRange = "string",
              RouteTableIds = list(
                "string"
              ),
              EndpointIpAddress = "string"
            )
          ),
          FailureDetails = list(
            Message = "string"
          ),
          TargetVolumeValues = list(),
          TargetSnapshotValues = list(
            ResourceARN = "string",
            SnapshotId = "string",
            Name = "string",
            VolumeId = "string",
            CreationTime = as.POSIXct(
              "2015-01-01"
            ),
            Lifecycle = "PENDING"|"CREATING"|"DELETING"|"AVAILABLE",
            LifecycleTransitionReason = list(
              Message = "string"
            ),
            Tags = list(
              list(
                Key = "string",
                Value = "string"
              )
            ),
            AdministrativeActions = list()
          ),
          TotalTransferBytes = 123,
          RemainingTransferBytes = 123
        )
      ),
      OpenZFSConfiguration = list(
        ParentVolumeId = "string",
        VolumePath = "string",
        StorageCapacityReservationGiB = 123,
        StorageCapacityQuotaGiB = 123,
        RecordSizeKiB = 123,
        DataCompressionType = "NONE"|"ZSTD"|"LZ4",
        CopyTagsToSnapshots = TRUE|FALSE,
        OriginSnapshot = list(
          SnapshotARN = "string",
          CopyStrategy = "CLONE"|"FULL_COPY"|"INCREMENTAL_COPY"
        ),
        ReadOnly = TRUE|FALSE,
        NfsExports = list(
          list(
            ClientConfigurations = list(
              list(
                Clients = "string",
                Options = list(
                  "string"
                )
              )
            )
          )
        ),
        UserAndGroupQuotas = list(
          list(
            Type = "USER"|"GROUP",
            Id = 123,
            StorageCapacityQuotaGiB = 123
          )
        ),
        RestoreToSnapshot = "string",
        DeleteIntermediateSnaphots = TRUE|FALSE,
        DeleteClonedVolumes = TRUE|FALSE,
        DeleteIntermediateData = TRUE|FALSE,
        SourceSnapshotARN = "string",
        DestinationSnapshot = "string",
        CopyStrategy = "CLONE"|"FULL_COPY"|"INCREMENTAL_COPY"
      )
    )
  )
)

Request syntax

svc$create_backup(
  FileSystemId = "string",
  ClientRequestToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  VolumeId = "string"
)

Examples

## Not run: 
# This operation creates a new backup.
svc$create_backup(
  FileSystemId = "fs-0498eed5fe91001ec",
  Tags = list(
    list(
      Key = "Name",
      Value = "MyBackup"
    )
  )
)

## End(Not run)