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

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

Inherits:

Struct

Object
Struct
Aws::StorageGateway::Types::DeleteFileShareInput

show all

Defined in:: (unknown)

Overview

Note:

When passing DeleteFileShareInput as input to an Aws::Client method, you can use a vanilla Hash:

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

DeleteFileShareInput

Instance Attribute Summary collapse

#file_share_arn ⇒ String
The Amazon Resource Name (ARN) of the file share to be deleted.
#force_delete ⇒ Boolean
If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS.

Instance Attribute Details

#file_share_arn ⇒ `String`

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

Returns:

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

#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