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)


2136
2137
2138
2139
2140
2141
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2136

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 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.

Valid Values: true | false

Returns:

  • (Boolean)


2136
2137
2138
2139
2140
2141
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2136

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