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

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::CreateDataRepositoryTaskRequest

Defined in:

gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass CreateDataRepositoryTaskRequest data as a hash:

{
  type: "EXPORT_TO_REPOSITORY", # required, accepts EXPORT_TO_REPOSITORY, IMPORT_METADATA_FROM_REPOSITORY
  paths: ["DataRepositoryTaskPath"],
  file_system_id: "FileSystemId", # required
  report: { # required
    enabled: false, # required
    path: "ArchivePath",
    format: "REPORT_CSV_20191124", # accepts REPORT_CSV_20191124
    scope: "FAILED_FILES_ONLY", # accepts FAILED_FILES_ONLY
  },
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  (Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters.

• #file_system_id ⇒ String

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

• #paths ⇒ Array<String>

  (Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed.

• #report ⇒ Types::CompletionReport

  Defines whether or not Amazon FSx provides a CompletionReport once the task has completed.

• #tags ⇒ Array<Types::Tag>

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

• #type ⇒ String

  Specifies the type of data repository task to create.

Instance Attribute Details

#client_request_token ⇒ String

(Optional) An idempotency token for resource creation, in a string of up to 64 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)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1131

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

#file_system_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1131

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

#paths ⇒ Array<String>

(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. 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. If a path that you provide isn't valid, the task fails.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1131

class CreateDataRepositoryTaskRequest < Struct.new(
  :type,
  :paths,
  :file_system_id,
  :report,
  :client_request_token,
  :tags)
  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.

Returns:

• (Types::CompletionReport)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1131

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

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1131

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

#type ⇒ String

Specifies the type of data repository task to create.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1131

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