FsxConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.kendra.model.FsxConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FsxConfiguration.Builder,FsxConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class FsxConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FsxConfiguration.Builder,FsxConfiguration>
```
Provides the configuration information to connect to Amazon FSx as your data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FsxConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FsxConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FsxConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`exclusionPatterns()` A list of regular expression patterns to exclude certain files in your Amazon FSx file system.
`List<DataSourceToIndexFieldMapping>`	`fieldMappings()` A list of `DataSourceToIndexFieldMapping` objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names.
`String`	`fileSystemId()` The identifier of the Amazon FSx file system.
`FsxFileSystemType`	`fileSystemType()` The Amazon FSx file system type.
`String`	`fileSystemTypeAsString()` The Amazon FSx file system type.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExclusionPatterns()` For responses, this returns true if the service returned a value for the ExclusionPatterns property.
`boolean`	`hasFieldMappings()` For responses, this returns true if the service returned a value for the FieldMappings property.
`int`	`hashCode()`
`boolean`	`hasInclusionPatterns()` For responses, this returns true if the service returned a value for the InclusionPatterns property.
`List<String>`	`inclusionPatterns()` A list of regular expression patterns to include certain files in your Amazon FSx file system.
`List<SdkField<?>>`	`sdkFields()`
`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.
`static Class<? extends FsxConfiguration.Builder>`	`serializableBuilderClass()`
`FsxConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`DataSourceVpcConfiguration`	`vpcConfiguration()` Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - fileSystemId
```
public final 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.
    
    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.
  - fileSystemType
```
public final FsxFileSystemType fileSystemType()
```
    The Amazon FSx file system type. Windows is currently the only supported type.
    
    If the service returns an enum value that is not available in the current SDK version, fileSystemType will return FsxFileSystemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileSystemTypeAsString().
    
    Returns:
    
    The Amazon FSx file system type. Windows is currently the only supported type.
    
    See Also:
    
    FsxFileSystemType
  - fileSystemTypeAsString
```
public final String fileSystemTypeAsString()
```
    The Amazon FSx file system type. Windows is currently the only supported type.
    
    If the service returns an enum value that is not available in the current SDK version, fileSystemType will return FsxFileSystemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileSystemTypeAsString().
    
    Returns:
    
    The Amazon FSx file system type. Windows is currently the only supported type.
    
    See Also:
    
    FsxFileSystemType
  - vpcConfiguration
```
public final 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.
    
    Returns:
    
    Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
  - secretArn
```
public final 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.
    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.
  - hasInclusionPatterns
```
public final boolean hasInclusionPatterns()
```
    For responses, this returns true if the service returned a value for the InclusionPatterns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - inclusionPatterns
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInclusionPatterns() method.
    
    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.
  - hasExclusionPatterns
```
public final boolean hasExclusionPatterns()
```
    For responses, this returns true if the service returned a value for the ExclusionPatterns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - exclusionPatterns
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExclusionPatterns() method.
    
    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.
  - hasFieldMappings
```
public final boolean hasFieldMappings()
```
    For responses, this returns true if the service returned a value for the FieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - fieldMappings
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFieldMappings() method.
    
    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.
  - toBuilder
```
public FsxConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FsxConfiguration.Builder,FsxConfiguration>
  - builder
```
public static FsxConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FsxConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class FsxConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

fileSystemId

fileSystemType

fileSystemTypeAsString

vpcConfiguration

secretArn

hasInclusionPatterns

inclusionPatterns

hasExclusionPatterns

exclusionPatterns

hasFieldMappings

fieldMappings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields