You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::StorageGateway::Types::DeleteFileShareInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

Note:

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

{
  file_share_arn: "FileShareARN", # required
  force_delete: false,
}

DeleteFileShareInput

Instance Attribute Summary collapse

Instance Attribute Details

#file_share_arnString

The Amazon Resource Name (ARN) of the file share to be deleted.

Returns:

  • (String)


1396
1397
1398
1399
1400
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1396

class DeleteFileShareInput < Struct.new(
  :file_share_arn,
  :force_delete)
  include Aws::Structure
end

#force_deleteBoolean

If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

Returns:

  • (Boolean)


1396
1397
1398
1399
1400
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1396

class DeleteFileShareInput < Struct.new(
  :file_share_arn,
  :force_delete)
  include Aws::Structure
end