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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#file_share_arn ⇒ String

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

Returns:

  • (String) 


2352
2353
2354
2355
2356
2357
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 2352

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

#force_delete ⇒ Boolean

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) 


2352
2353
2354
2355
2356
2357
 
# File 'lib/aws-sdk-storagegateway/types.rb', line 2352

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