Delete Volume

fsx_delete_volume

R Documentation

Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume

Description

Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

Usage

fsx_delete_volume(ClientRequestToken, VolumeId, OntapConfiguration,
  OpenZFSConfiguration)

Arguments

ClientRequestToken

VolumeId

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

OntapConfiguration

For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the fsx:TagResource permission.

OpenZFSConfiguration

For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.

Value

A list with the following syntax:

list(
  VolumeId = "string",
  Lifecycle = "CREATING"|"CREATED"|"DELETING"|"FAILED"|"MISCONFIGURED"|"PENDING"|"AVAILABLE",
  OntapResponse = list(
    FinalBackupId = "string",
    FinalBackupTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$delete_volume(
  ClientRequestToken = "string",
  VolumeId = "string",
  OntapConfiguration = list(
    SkipFinalBackup = TRUE|FALSE,
    FinalBackupTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    BypassSnaplockEnterpriseRetention = TRUE|FALSE
  ),
  OpenZFSConfiguration = list(
    Options = list(
      "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"
    )
  )
)