FsxConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.FsxConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FsxConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the configuration information to connect to Amazon FSx as your data source.

Amazon Kendra now supports an upgraded Amazon FSx Windows connector.

You must now use the TemplateConfiguration object instead of the FsxConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FsxConfiguration()

Constructors
Constructor and Description
`FsxConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FsxConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getExclusionPatterns()` A list of regular expression patterns to exclude certain files in your Amazon FSx file system.
`List<DataSourceToIndexFieldMapping>`	`getFieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names.
`String`	`getFileSystemId()` The identifier of the Amazon FSx file system.
`String`	`getFileSystemType()` The Amazon FSx file system type.
`List<String>`	`getInclusionPatterns()` A list of regular expression patterns to include certain files in your Amazon FSx file system.
`String`	`getSecretArn()` 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.
`DataSourceVpcConfiguration`	`getVpcConfiguration()` Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setExclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns to exclude certain files in your Amazon FSx file system.
`void`	`setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names.
`void`	`setFileSystemId(String fileSystemId)` The identifier of the Amazon FSx file system.
`void`	`setFileSystemType(String fileSystemType)` The Amazon FSx file system type.
`void`	`setInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns to include certain files in your Amazon FSx file system.
`void`	`setSecretArn(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.
`void`	`setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)` Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx.
`String`	`toString()` Returns a string representation of this object.
`FsxConfiguration`	`withExclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns to exclude certain files in your Amazon FSx file system.
`FsxConfiguration`	`withExclusionPatterns(String... exclusionPatterns)` A list of regular expression patterns to exclude certain files in your Amazon FSx file system.
`FsxConfiguration`	`withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names.
`FsxConfiguration`	`withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)` A list of `DataSourceToIndexFieldMapping` objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names.
`FsxConfiguration`	`withFileSystemId(String fileSystemId)` The identifier of the Amazon FSx file system.
`FsxConfiguration`	`withFileSystemType(FsxFileSystemType fileSystemType)` The Amazon FSx file system type.
`FsxConfiguration`	`withFileSystemType(String fileSystemType)` The Amazon FSx file system type.
`FsxConfiguration`	`withInclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns to include certain files in your Amazon FSx file system.
`FsxConfiguration`	`withInclusionPatterns(String... inclusionPatterns)` A list of regular expression patterns to include certain files in your Amazon FSx file system.
`FsxConfiguration`	`withSecretArn(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.
`FsxConfiguration`	`withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)` Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FsxConfiguration
```
public FsxConfiguration()
```
- Method Detail
  - setFileSystemId
```
public void setFileSystemId(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.
  - getFileSystemId
```
public String getFileSystemId()
```
    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:
    
    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.
  - withFileSystemId
```
public FsxConfiguration withFileSystemId(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.
  - setFileSystemType
```
public void setFileSystemType(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.
    
    See Also:
    
    FsxFileSystemType
  - getFileSystemType
```
public String getFileSystemType()
```
    The Amazon FSx file system type. Windows is currently the only supported type.
    
    Returns:
    
    The Amazon FSx file system type. Windows is currently the only supported type.
    
    See Also:
    
    FsxFileSystemType
  - withFileSystemType
```
public FsxConfiguration withFileSystemType(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:
    
    FsxFileSystemType
  - withFileSystemType
```
public FsxConfiguration withFileSystemType(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:
    
    FsxFileSystemType
  - setVpcConfiguration
```
public void setVpcConfiguration(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.
  - getVpcConfiguration
```
public DataSourceVpcConfiguration getVpcConfiguration()
```
    Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
    
    Returns:
    
    Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
  - withVpcConfiguration
```
public FsxConfiguration withVpcConfiguration(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.
  - setSecretArn
```
public void setSecretArn(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.
  - getSecretArn
```
public String getSecretArn()
```
    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:
    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.
  - withSecretArn
```
public FsxConfiguration withSecretArn(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.
  - getInclusionPatterns
```
public List<String> getInclusionPatterns()
```
    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:
    
    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.
  - setInclusionPatterns
```
public void setInclusionPatterns(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.
  - withInclusionPatterns
```
public FsxConfiguration withInclusionPatterns(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setInclusionPatterns(java.util.Collection) or withInclusionPatterns(java.util.Collection) if you want to override the existing values.
    
    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.
  - withInclusionPatterns
```
public FsxConfiguration withInclusionPatterns(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.
  - getExclusionPatterns
```
public List<String> getExclusionPatterns()
```
    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:
    
    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.
  - setExclusionPatterns
```
public void setExclusionPatterns(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.
  - withExclusionPatterns
```
public FsxConfiguration withExclusionPatterns(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setExclusionPatterns(java.util.Collection) or withExclusionPatterns(java.util.Collection) if you want to override the existing values.
    
    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.
  - withExclusionPatterns
```
public FsxConfiguration withExclusionPatterns(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.
  - getFieldMappings
```
public List<DataSourceToIndexFieldMapping> getFieldMappings()
```
    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:
    
    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.
  - setFieldMappings
```
public void setFieldMappings(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.
  - withFieldMappings
```
public FsxConfiguration withFieldMappings(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setFieldMappings(java.util.Collection) or withFieldMappings(java.util.Collection) if you want to override the existing values.
    
    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.
  - withFieldMappings
```
public FsxConfiguration withFieldMappings(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FsxConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.781

Class FsxConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FsxConfiguration

Method Detail

setFileSystemId

getFileSystemId

withFileSystemId

setFileSystemType

getFileSystemType

withFileSystemType

withFileSystemType

setVpcConfiguration

getVpcConfiguration

withVpcConfiguration

setSecretArn

getSecretArn

withSecretArn

getInclusionPatterns

setInclusionPatterns

withInclusionPatterns

withInclusionPatterns

getExclusionPatterns

setExclusionPatterns

withExclusionPatterns

withExclusionPatterns

getFieldMappings

setFieldMappings

withFieldMappings

withFieldMappings

toString

equals

hashCode

clone

marshall