Class: Aws::FSx::Types::CreateDataRepositoryAssociationRequest

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

Overview

Note:

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

{
  file_system_id: "FileSystemId", # required
  file_system_path: "Namespace", # required
  data_repository_path: "ArchivePath", # required
  batch_import_meta_data_on_create: false,
  imported_file_chunk_size: 1,
  s3: {
    auto_import_policy: {
      events: ["NEW"], # accepts NEW, CHANGED, DELETED
    },
    auto_export_policy: {
      events: ["NEW"], # accepts NEW, CHANGED, DELETED
    },
  },
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_import_meta_data_on_createBoolean

Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.

Returns:

  • (Boolean)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1037

class CreateDataRepositoryAssociationRequest < Struct.new(
  :file_system_id,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_tokenString

(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)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1037

class CreateDataRepositoryAssociationRequest < Struct.new(
  :file_system_id,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_repository_pathString

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.

Returns:

  • (String)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1037

class CreateDataRepositoryAssociationRequest < Struct.new(
  :file_system_id,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_idString

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

Returns:

  • (String)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1037

class CreateDataRepositoryAssociationRequest < Struct.new(
  :file_system_id,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_pathString

A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

If you specify only a forward slash (/) as the file system path, you can link only 1 data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.

Returns:

  • (String)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1037

class CreateDataRepositoryAssociationRequest < Struct.new(
  :file_system_id,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#imported_file_chunk_sizeInteger

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

Returns:

  • (Integer)


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1037

class CreateDataRepositoryAssociationRequest < Struct.new(
  :file_system_id,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#s3Types::S3DataRepositoryConfiguration

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1037

class CreateDataRepositoryAssociationRequest < Struct.new(
  :file_system_id,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1037

class CreateDataRepositoryAssociationRequest < Struct.new(
  :file_system_id,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end