Class: Aws::FSx::Types::CreateDataRepositoryTaskRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_to_release ⇒ Integer

Specifies the amount of data to release, in GiB, by an Amazon File Cache ‘AUTO_RELEASE_DATA` task that automatically releases files from the cache.

Returns:

  • (Integer) 


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/aws-sdk-fsx/types.rb', line 1341

class CreateDataRepositoryTaskRequest < Struct.new(
  :type,
  :paths,
  :file_system_id,
  :report,
  :client_request_token,
  :tags,
  :capacity_to_release,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/aws-sdk-fsx/types.rb', line 1341

class CreateDataRepositoryTaskRequest < Struct.new(
  :type,
  :paths,
  :file_system_id,
  :report,
  :client_request_token,
  :tags,
  :capacity_to_release,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ String

The globally unique ID of the file system, assigned by Amazon FSx.

Returns:

  • (String) 


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/aws-sdk-fsx/types.rb', line 1341

class CreateDataRepositoryTaskRequest < Struct.new(
  :type,
  :paths,
  :file_system_id,
  :report,
  :client_request_token,
  :tags,
  :capacity_to_release,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#paths ⇒ Array<String>

A list of paths for the data repository task to use when the task is processed. If a path that you provide isn’t valid, the task fails. If you don’t provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).

  • For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is ‘/mnt/fsx` and `/mnt/fsx/path1` is a directory or file on the file system you want to export, then the path to provide is `path1`.

  • For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format ‘s3://bucket-name/prefix` (where `prefix` is optional).

  • For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.

    <note markdown=“1”> A file must also meet the last accessed time criteria specified in for the file to be released.

    </note>

Returns:

  • (Array<String>) 


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/aws-sdk-fsx/types.rb', line 1341

class CreateDataRepositoryTaskRequest < Struct.new(
  :type,
  :paths,
  :file_system_id,
  :report,
  :client_request_token,
  :tags,
  :capacity_to_release,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#release_configuration ⇒ Types::ReleaseConfiguration

The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.

Returns:



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/aws-sdk-fsx/types.rb', line 1341

class CreateDataRepositoryTaskRequest < Struct.new(
  :type,
  :paths,
  :file_system_id,
  :report,
  :client_request_token,
  :tags,
  :capacity_to_release,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#report ⇒ Types::CompletionReport

Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the ‘Scope` parameter. For more information, see [Working with Task Completion Reports].

[1]: docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html

Returns:



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/aws-sdk-fsx/types.rb', line 1341

class CreateDataRepositoryTaskRequest < Struct.new(
  :type,
  :paths,
  :file_system_id,
  :report,
  :client_request_token,
  :tags,
  :capacity_to_release,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of ‘Tag` values, with a maximum of 50 elements.

Returns:



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/aws-sdk-fsx/types.rb', line 1341

class CreateDataRepositoryTaskRequest < Struct.new(
  :type,
  :paths,
  :file_system_id,
  :report,
  :client_request_token,
  :tags,
  :capacity_to_release,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Specifies the type of data repository task to create.

  • ‘EXPORT_TO_REPOSITORY` tasks export from your Amazon FSx for Lustre file system to a linked data repository.

  • ‘IMPORT_METADATA_FROM_REPOSITORY` tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.

  • ‘RELEASE_DATA_FROM_FILESYSTEM` tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.

  • ‘AUTO_RELEASE_DATA` tasks automatically release files from an Amazon File Cache resource.

Returns:

  • (String) 


1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/aws-sdk-fsx/types.rb', line 1341

class CreateDataRepositoryTaskRequest < Struct.new(
  :type,
  :paths,
  :file_system_id,
  :report,
  :client_request_token,
  :tags,
  :capacity_to_release,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end