Interface CreateDataSourceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>, QBusinessRequest.Builder, SdkBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDataSourceRequest
@Mutable @NotThreadSafe public static interface CreateDataSourceRequest.Builder extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

  • Method Details

    • applicationId

      CreateDataSourceRequest.Builder applicationId(String applicationId)

      The identifier of the Amazon Q Business application the data source will be attached to.

      Parameters:
      applicationId - The identifier of the Amazon Q Business application the data source will be attached to.
      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 that you want to use with the data source connector.

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

    • displayName

      CreateDataSourceRequest.Builder displayName(String displayName)

      A name for the data source connector.

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

    • configuration

      CreateDataSourceRequest.Builder configuration(Document configuration)

      Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

      Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

      You can find configuration templates for your specific data source using the following steps:

      1. Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.

      2. Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.

      Parameters:
      configuration - Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

      Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

      You can find configuration templates for your specific data source using the following steps:

      1. Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.

      2. Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.

      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 VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.

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

    • vpcConfiguration

      default CreateDataSourceRequest.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)

      Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.

      This is a convenience method that creates an instance of the DataSourceVpcConfiguration.Builder avoiding the need to create one manually via DataSourceVpcConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(DataSourceVpcConfiguration).

      Parameters:
      vpcConfiguration - a consumer that will call methods on DataSourceVpcConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

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

      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:

    • syncSchedule

      CreateDataSourceRequest.Builder syncSchedule(String syncSchedule)

      Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically 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:
      syncSchedule - Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically 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.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateDataSourceRequest.Builder clientToken(String clientToken)

      A token you provide to identify a 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 you provide to identify a 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.

    • documentEnrichmentConfiguration

      CreateDataSourceRequest.Builder documentEnrichmentConfiguration(DocumentEnrichmentConfiguration documentEnrichmentConfiguration)
      Sets the value of the DocumentEnrichmentConfiguration property for this object.
      Parameters:
      documentEnrichmentConfiguration - The new value for the DocumentEnrichmentConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentEnrichmentConfiguration

      default CreateDataSourceRequest.Builder documentEnrichmentConfiguration(Consumer<DocumentEnrichmentConfiguration.Builder> documentEnrichmentConfiguration)
      Sets the value of the DocumentEnrichmentConfiguration property for this object. This is a convenience method that creates an instance of the DocumentEnrichmentConfiguration.Builder avoiding the need to create one manually via DocumentEnrichmentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentEnrichmentConfiguration(DocumentEnrichmentConfiguration).

      Parameters:
      documentEnrichmentConfiguration - a consumer that will call methods on DocumentEnrichmentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mediaExtractionConfiguration

      CreateDataSourceRequest.Builder mediaExtractionConfiguration(MediaExtractionConfiguration mediaExtractionConfiguration)

      The configuration for extracting information from media in documents during ingestion.

      Parameters:
      mediaExtractionConfiguration - The configuration for extracting information from media in documents during ingestion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mediaExtractionConfiguration

      default CreateDataSourceRequest.Builder mediaExtractionConfiguration(Consumer<MediaExtractionConfiguration.Builder> mediaExtractionConfiguration)

      The configuration for extracting information from media in documents during ingestion.

      This is a convenience method that creates an instance of the MediaExtractionConfiguration.Builder avoiding the need to create one manually via MediaExtractionConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mediaExtractionConfiguration(MediaExtractionConfiguration).

      Parameters:
      mediaExtractionConfiguration - a consumer that will call methods on MediaExtractionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateDataSourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDataSourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.