/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kendra.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Provides the configuration information to connect to Amazon FSx as your data source. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class FsxConfiguration implements Serializable, Cloneable, StructuredPojo { /** ** 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. *
*/ private String fileSystemId; /** ** The Amazon FSx file system type. Windows is currently the only supported type. *
*/ private String fileSystemType; /** ** Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx * instance must reside inside your VPC. *
*/ private DataSourceVpcConfiguration vpcConfiguration; /** ** 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. *
** 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. *
*/ private java.util.List* 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. *
*/ private java.util.List
* 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.
*
* 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. *
* * @param 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. */ public void setFileSystemId(String fileSystemId) { this.fileSystemId = 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. *
* * @return 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. */ public String getFileSystemId() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public FsxConfiguration withFileSystemId(String fileSystemId) { setFileSystemId(fileSystemId); return this; } /** *
* The Amazon FSx file system type. Windows is currently the only supported type. *
* * @param fileSystemType * The Amazon FSx file system type. Windows is currently the only supported type. * @see FsxFileSystemType */ public void setFileSystemType(String fileSystemType) { this.fileSystemType = fileSystemType; } /** ** The Amazon FSx file system type. Windows is currently the only supported type. *
* * @return The Amazon FSx file system type. Windows is currently the only supported type. * @see FsxFileSystemType */ public String getFileSystemType() { return this.fileSystemType; } /** ** The Amazon FSx file system type. Windows is currently the only supported type. *
* * @param fileSystemType * The Amazon FSx file system type. Windows is currently the only supported type. * @return Returns a reference to this object so that method calls can be chained together. * @see FsxFileSystemType */ public FsxConfiguration withFileSystemType(String fileSystemType) { setFileSystemType(fileSystemType); return this; } /** ** The Amazon FSx file system type. Windows is currently the only supported type. *
* * @param fileSystemType * The Amazon FSx file system type. Windows is currently the only supported type. * @return Returns a reference to this object so that method calls can be chained together. * @see FsxFileSystemType */ public FsxConfiguration withFileSystemType(FsxFileSystemType fileSystemType) { this.fileSystemType = fileSystemType.toString(); return this; } /** ** Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx * instance must reside inside your VPC. *
* * @param vpcConfiguration * Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon * FSx instance must reside inside your VPC. */ public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) { this.vpcConfiguration = vpcConfiguration; } /** ** Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx * instance must reside inside your VPC. *
* * @return Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon * FSx instance must reside inside your VPC. */ public DataSourceVpcConfiguration getVpcConfiguration() { return this.vpcConfiguration; } /** ** Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx * instance must reside inside your VPC. *
* * @param vpcConfiguration * Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon * FSx instance must reside inside your VPC. * @return Returns a reference to this object so that method calls can be chained together. */ public FsxConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration) { setVpcConfiguration(vpcConfiguration); return this; } /** ** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setInclusionPatterns(java.util.Collection* 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 * {@link #setInclusionPatterns(java.util.Collection)} or {@link #withInclusionPatterns(java.util.Collection)} if * you want to override the existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public FsxConfiguration withInclusionPatterns(String... inclusionPatterns) { if (this.inclusionPatterns == null) { setInclusionPatterns(new java.util.ArrayList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public FsxConfiguration withInclusionPatterns(java.util.Collection* 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setExclusionPatterns(java.util.Collection* 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 * {@link #setExclusionPatterns(java.util.Collection)} or {@link #withExclusionPatterns(java.util.Collection)} if * you want to override the existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public FsxConfiguration withExclusionPatterns(String... exclusionPatterns) { if (this.exclusionPatterns == null) { setExclusionPatterns(new java.util.ArrayList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public FsxConfiguration withExclusionPatterns(java.util.Collection
* 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.
*
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.
*/
public java.util.List
* 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.
*
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.
*/
public void setFieldMappings(java.util.Collection
* 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 * {@link #setFieldMappings(java.util.Collection)} or {@link #withFieldMappings(java.util.Collection)} if you want * to override the existing values. *
* * @param fieldMappings * A list ofDataSourceToIndexFieldMapping
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FsxConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings) {
if (this.fieldMappings == null) {
setFieldMappings(new java.util.ArrayList
* 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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FsxConfiguration withFieldMappings(java.util.Collection