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

Class CreateDataSourceRequest

    • Method Detail

      • name

        public final String name()

        A name for the data source connector.

        Returns:
        A name for the data source connector.

      • indexId

        public final String indexId()

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

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

      • type

        public final DataSourceType type()

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

        If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The type of data source repository. For example, SHAREPOINT.
        See Also:
        DataSourceType

      • typeAsString

        public final String typeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The type of data source repository. For example, SHAREPOINT.
        See Also:
        DataSourceType

      • configuration

        public final 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.

        Returns:
        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.

      • vpcConfiguration

        public final DataSourceVpcConfiguration vpcConfiguration()

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

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

      • description

        public final String description()

        A description for the data source connector.

        Returns:
        A description for the data source connector.

      • schedule

        public final 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.

        Returns:
        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.

      • roleArn

        public final 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.

        Returns:
        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.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.

      • tags

        public final List<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: _ . : / = + - @.

        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 hasTags() method.

        Returns:
        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: _ . : / = + - @.

      • clientToken

        public final 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.

        Returns:
        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.

      • languageCode

        public final 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.

        Returns:
        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.

      • customDocumentEnrichmentConfiguration

        public final 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.

        Returns:
        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.

      • 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