Package software.amazon.awssdk.services.kendra.model

Interface FsxConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FsxConfiguration.Builder,FsxConfiguration>, SdkBuilder<FsxConfiguration.Builder,FsxConfiguration>, SdkPojo
Enclosing class:
FsxConfiguration
public static interface FsxConfiguration.Builder extends SdkPojo, CopyableBuilder<FsxConfiguration.Builder,FsxConfiguration>

  • Method Details

    • fileSystemId

      FsxConfiguration.Builder fileSystemId(String fileSystemId)

      The identifier of the Amazon FSx file system.

      You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.

      Parameters:
      fileSystemId - The identifier of the Amazon FSx file system.

      You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileSystemType

      FsxConfiguration.Builder fileSystemType(String fileSystemType)

      The Amazon FSx file system type. Windows is currently the only supported type.

      Parameters:
      fileSystemType - The Amazon FSx file system type. Windows is currently the only supported type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileSystemType

      FsxConfiguration.Builder fileSystemType(FsxFileSystemType fileSystemType)

      The Amazon FSx file system type. Windows is currently the only supported type.

      Parameters:
      fileSystemType - The Amazon FSx file system type. Windows is currently the only supported type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcConfiguration

      FsxConfiguration.Builder vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

      Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.

      Parameters:
      vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

      default FsxConfiguration.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)

      Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.

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

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

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

    • secretArn

      FsxConfiguration.Builder secretArn(String secretArn)

      The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:

      • username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.

      • password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.

      Parameters:
      secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:

      • username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.

      • password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inclusionPatterns

      FsxConfiguration.Builder inclusionPatterns(Collection<String> inclusionPatterns)

      A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

      Parameters:
      inclusionPatterns - A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inclusionPatterns

      FsxConfiguration.Builder inclusionPatterns(String... inclusionPatterns)

      A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

      Parameters:
      inclusionPatterns - A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionPatterns

      FsxConfiguration.Builder exclusionPatterns(Collection<String> exclusionPatterns)

      A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

      Parameters:
      exclusionPatterns - A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionPatterns

      FsxConfiguration.Builder exclusionPatterns(String... exclusionPatterns)

      A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

      Parameters:
      exclusionPatterns - A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      FsxConfiguration.Builder fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)

      A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.

      Parameters:
      fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      FsxConfiguration.Builder fieldMappings(DataSourceToIndexFieldMapping... fieldMappings)

      A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.

      Parameters:
      fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      FsxConfiguration.Builder fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings)

      A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.

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

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

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