Package software.amazon.awssdk.services.fsx.model

Interface CreateDataRepositoryAssociationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDataRepositoryAssociationRequest.Builder,CreateDataRepositoryAssociationRequest>, FSxRequest.Builder, SdkBuilder<CreateDataRepositoryAssociationRequest.Builder,CreateDataRepositoryAssociationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDataRepositoryAssociationRequest
public static interface CreateDataRepositoryAssociationRequest.Builder extends FSxRequest.Builder, SdkPojo, CopyableBuilder<CreateDataRepositoryAssociationRequest.Builder,CreateDataRepositoryAssociationRequest>

  • Method Details

    • fileSystemId

      CreateDataRepositoryAssociationRequest.Builder fileSystemId(String fileSystemId)
      Sets the value of the FileSystemId property for this object.
      Parameters:
      fileSystemId - The new value for the FileSystemId property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileSystemPath

      CreateDataRepositoryAssociationRequest.Builder fileSystemPath(String fileSystemPath)

      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 one 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.

      Parameters:
      fileSystemPath - 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 one 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:
      Returns a reference to this object so that method calls can be chained together.

    • dataRepositoryPath

      CreateDataRepositoryAssociationRequest.Builder dataRepositoryPath(String dataRepositoryPath)

      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.

      Parameters:
      dataRepositoryPath - 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:
      Returns a reference to this object so that method calls can be chained together.

    • batchImportMetaDataOnCreate

      CreateDataRepositoryAssociationRequest.Builder batchImportMetaDataOnCreate(Boolean batchImportMetaDataOnCreate)

      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.

      Parameters:
      batchImportMetaDataOnCreate - 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:
      Returns a reference to this object so that method calls can be chained together.

    • importedFileChunkSize

      CreateDataRepositoryAssociationRequest.Builder importedFileChunkSize(Integer importedFileChunkSize)

      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.

      Parameters:
      importedFileChunkSize - 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:
      Returns a reference to this object so that method calls can be chained together.

    • s3

      CreateDataRepositoryAssociationRequest.Builder s3(S3DataRepositoryConfiguration s3)

      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.

      Parameters:
      s3 - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3

      default CreateDataRepositoryAssociationRequest.Builder s3(Consumer<S3DataRepositoryConfiguration.Builder> s3)

      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.

      This is a convenience method that creates an instance of the S3DataRepositoryConfiguration.Builder avoiding the need to create one manually via S3DataRepositoryConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3(S3DataRepositoryConfiguration).

      Parameters:
      s3 - a consumer that will call methods on S3DataRepositoryConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientRequestToken

      CreateDataRepositoryAssociationRequest.Builder clientRequestToken(String clientRequestToken)
      Sets the value of the ClientRequestToken property for this object.
      Parameters:
      clientRequestToken - The new value for the ClientRequestToken property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDataRepositoryAssociationRequest.Builder tags(Collection<Tag> tags)
      Sets the value of the Tags property for this object.
      Parameters:
      tags - The new value for the Tags property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDataRepositoryAssociationRequest.Builder tags(Tag... tags)
      Sets the value of the Tags property for this object.
      Parameters:
      tags - The new value for the Tags property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDataRepositoryAssociationRequest.Builder tags(Consumer<Tag.Builder>... tags)
      Sets the value of the Tags property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateDataRepositoryAssociationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDataRepositoryAssociationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.