Class: Aws::FSx::Types::DeleteVolumeRequest

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::DeleteVolumeRequest

Defined in:

gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass DeleteVolumeRequest data as a hash:

{
  client_request_token: "ClientRequestToken",
  volume_id: "VolumeId", # required
  ontap_configuration: {
    skip_final_backup: false,
    final_backup_tags: [
      {
        key: "TagKey", # required
        value: "TagValue", # required
      },
    ],
  },
  open_zfs_configuration: {
    options: ["DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"], # accepts DELETE_CHILD_VOLUMES_AND_SNAPSHOTS
  },
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  (Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters.

• #ontap_configuration ⇒ Types::DeleteVolumeOntapConfiguration

  For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup.

• #open_zfs_configuration ⇒ Types::DeleteVolumeOpenZFSConfiguration

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

• #volume_id ⇒ String

  The ID of the volume that you are deleting.

Instance Attribute Details

#client_request_token ⇒ String

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4255

class DeleteVolumeRequest < Struct.new(
  :client_request_token,
  :volume_id,
  :ontap_configuration,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ontap_configuration ⇒ Types::DeleteVolumeOntapConfiguration

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.

Returns:

• (Types::DeleteVolumeOntapConfiguration)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4255

class DeleteVolumeRequest < Struct.new(
  :client_request_token,
  :volume_id,
  :ontap_configuration,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#open_zfs_configuration ⇒ Types::DeleteVolumeOpenZFSConfiguration

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

Returns:

• (Types::DeleteVolumeOpenZFSConfiguration)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4255

class DeleteVolumeRequest < Struct.new(
  :client_request_token,
  :volume_id,
  :ontap_configuration,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#volume_id ⇒ String

The ID of the volume that you are deleting.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 4255

class DeleteVolumeRequest < Struct.new(
  :client_request_token,
  :volume_id,
  :ontap_configuration,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end