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

Class: Aws::StorageGateway::Types::RefreshCacheInput

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 RefreshCacheInput data as a hash:

{
  file_share_arn: "FileShareARN", # required
  folder_list: ["Folder"],
  recursive: false,
}

RefreshCacheInput

Instance Attribute Summary collapse

Instance Attribute Details

#file_share_arnString

The Amazon Resource Name (ARN) of the file share you want to refresh.

Returns:

  • (String)


4321
4322
4323
4324
4325
4326
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4321

class RefreshCacheInput < Struct.new(
  :file_share_arn,
  :folder_list,
  :recursive)
  include Aws::Structure
end

#folder_listArray<String>

A comma-separated list of the paths of folders to refresh in the cache. The default is ["/"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to "true", the entire S3 bucket that the file share has access to is refreshed.

Returns:

  • (Array<String>)


4321
4322
4323
4324
4325
4326
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4321

class RefreshCacheInput < Struct.new(
  :file_share_arn,
  :folder_list,
  :recursive)
  include Aws::Structure
end

#recursiveBoolean

A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to "true", each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is "true".

Returns:

  • (Boolean)


4321
4322
4323
4324
4325
4326
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4321

class RefreshCacheInput < Struct.new(
  :file_share_arn,
  :folder_list,
  :recursive)
  include Aws::Structure
end