Restore Volume From Snapshot

fsx_restore_volume_from_snapshot

R Documentation

Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot

Description

Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.

Usage

fsx_restore_volume_from_snapshot(ClientRequestToken, VolumeId,
  SnapshotId, Options)

Arguments

ClientRequestToken

VolumeId

[required] The ID of the volume that you are restoring.

SnapshotId

[required] The ID of the source snapshot. Specifies the snapshot that you are restoring from.

Options

The settings used when restoring the specified volume from snapshot.

• DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, restore_volume_from_snapshot fails.

• DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, restore_volume_from_snapshot fails.

Value

A list with the following syntax:

list(
  VolumeId = "string",
  Lifecycle = "CREATING"|"CREATED"|"DELETING"|"FAILED"|"MISCONFIGURED"|"PENDING"|"AVAILABLE",
  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(
        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
    )
  )
)

Request syntax

svc$restore_volume_from_snapshot(
  ClientRequestToken = "string",
  VolumeId = "string",
  SnapshotId = "string",
  Options = list(
    "DELETE_INTERMEDIATE_SNAPSHOTS"|"DELETE_CLONED_VOLUMES"
  )
)