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

Interface CreateDataSourceRequest.Builder

    • Method Detail

      • name

        CreateDataSourceRequest.Builder name​(String name)

        A name for the data source connector.

        Parameters:
        name - A name for the data source connector.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • indexId

        CreateDataSourceRequest.Builder indexId​(String indexId)

        The identifier of the index you want to use with the data source connector.

        Parameters:
        indexId - The identifier of the index you want to use with the data source connector.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • type

        CreateDataSourceRequest.Builder type​(String type)

        The type of data source repository. For example, SHAREPOINT.

        Parameters:
        type - The type of data source repository. For example, SHAREPOINT.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataSourceType, DataSourceType

      • configuration

        CreateDataSourceRequest.Builder configuration​(DataSourceConfiguration configuration)

        Configuration information to connect to your data source repository.

        You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

        The Configuration parameter is required for all other data sources.

        Parameters:
        configuration - Configuration information to connect to your data source repository.

        You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

        The Configuration parameter is required for all other data sources.

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

      • vpcConfiguration

        CreateDataSourceRequest.Builder vpcConfiguration​(DataSourceVpcConfiguration vpcConfiguration)

        Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

        Parameters:
        vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateDataSourceRequest.Builder description​(String description)

        A description for the data source connector.

        Parameters:
        description - A description for the data source connector.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schedule

        CreateDataSourceRequest.Builder schedule​(String schedule)

        Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

        Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

        You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

        Parameters:
        schedule - Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

        Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

        You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

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

      • roleArn

        CreateDataSourceRequest.Builder roleArn​(String roleArn)

        The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

        You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

        The RoleArn parameter is required for all other data sources.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

        You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

        The RoleArn parameter is required for all other data sources.

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

      • tags

        CreateDataSourceRequest.Builder tags​(Collection<Tag> tags)

        A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

        Parameters:
        tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDataSourceRequest.Builder tags​(Tag... tags)

        A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

        Parameters:
        tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDataSourceRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

        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:
        #tags(java.util.Collection)

      • clientToken

        CreateDataSourceRequest.Builder clientToken​(String clientToken)

        A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

        Parameters:
        clientToken - A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageCode

        CreateDataSourceRequest.Builder languageCode​(String languageCode)

        The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

        Parameters:
        languageCode - The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customDocumentEnrichmentConfiguration

        CreateDataSourceRequest.Builder customDocumentEnrichmentConfiguration​(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)

        Configuration information for altering document metadata and content during the document ingestion process.

        For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

        Parameters:
        customDocumentEnrichmentConfiguration - Configuration information for altering document metadata and content during the document ingestion process.

        For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

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