AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#file_share_arnString

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

Returns:

  • (String)


2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2626

class DeleteFileShareInput < Struct.new(
  :file_share_arn,
  :force_delete)
  SENSITIVE = []
  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 Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

Valid Values: true | false

Returns:

  • (Boolean)


2626
2627
2628
2629
2630
2631
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2626

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