Class CfnDataSourceProps.Builder
java.lang.Object
software.amazon.awscdk.services.qbusiness.CfnDataSourceProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDataSourceProps>
- Enclosing interface:
CfnDataSourceProps
@Stability(Stable)
public static final class CfnDataSourceProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSourceProps>
A builder for
CfnDataSourceProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) Sets the value ofCfnDataSourceProps.getApplicationId()
build()
Builds the configured instance.configuration
(Object configuration) Sets the value ofCfnDataSourceProps.getConfiguration()
description
(String description) Sets the value ofCfnDataSourceProps.getDescription()
displayName
(String displayName) Sets the value ofCfnDataSourceProps.getDisplayName()
documentEnrichmentConfiguration
(IResolvable documentEnrichmentConfiguration) Sets the value ofCfnDataSourceProps.getDocumentEnrichmentConfiguration()
documentEnrichmentConfiguration
(CfnDataSource.DocumentEnrichmentConfigurationProperty documentEnrichmentConfiguration) Sets the value ofCfnDataSourceProps.getDocumentEnrichmentConfiguration()
Sets the value ofCfnDataSourceProps.getIndexId()
mediaExtractionConfiguration
(IResolvable mediaExtractionConfiguration) Sets the value ofCfnDataSourceProps.getMediaExtractionConfiguration()
mediaExtractionConfiguration
(CfnDataSource.MediaExtractionConfigurationProperty mediaExtractionConfiguration) Sets the value ofCfnDataSourceProps.getMediaExtractionConfiguration()
Sets the value ofCfnDataSourceProps.getRoleArn()
syncSchedule
(String syncSchedule) Sets the value ofCfnDataSourceProps.getSyncSchedule()
Sets the value ofCfnDataSourceProps.getTags()
vpcConfiguration
(IResolvable vpcConfiguration) Sets the value ofCfnDataSourceProps.getVpcConfiguration()
vpcConfiguration
(CfnDataSource.DataSourceVpcConfigurationProperty vpcConfiguration) Sets the value ofCfnDataSourceProps.getVpcConfiguration()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
applicationId
Sets the value ofCfnDataSourceProps.getApplicationId()
- Parameters:
applicationId
- The identifier of the Amazon Q Business application the data source will be attached to. This parameter is required.- Returns:
this
-
configuration
Sets the value ofCfnDataSourceProps.getConfiguration()
- Parameters:
configuration
- Use this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business . This parameter is required. You must use the JSON or YAML schema provided by Amazon Q .The following links have the configuration properties and schemas for AWS CloudFormation for the following connectors:
Similarly, you can find configuration templates and properties for your specific data source using the following steps:
- Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.
- Then, from that specific data source connector's page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.
- Returns:
this
-
displayName
Sets the value ofCfnDataSourceProps.getDisplayName()
- Parameters:
displayName
- The name of the Amazon Q Business data source. This parameter is required.- Returns:
this
-
indexId
Sets the value ofCfnDataSourceProps.getIndexId()
- Parameters:
indexId
- The identifier of the index the data source is attached to. This parameter is required.- Returns:
this
-
description
Sets the value ofCfnDataSourceProps.getDescription()
- Parameters:
description
- A description for the data source connector.- Returns:
this
-
documentEnrichmentConfiguration
@Stability(Stable) public CfnDataSourceProps.Builder documentEnrichmentConfiguration(IResolvable documentEnrichmentConfiguration) Sets the value ofCfnDataSourceProps.getDocumentEnrichmentConfiguration()
- Parameters:
documentEnrichmentConfiguration
- Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment .- Returns:
this
-
documentEnrichmentConfiguration
@Stability(Stable) public CfnDataSourceProps.Builder documentEnrichmentConfiguration(CfnDataSource.DocumentEnrichmentConfigurationProperty documentEnrichmentConfiguration) Sets the value ofCfnDataSourceProps.getDocumentEnrichmentConfiguration()
- Parameters:
documentEnrichmentConfiguration
- Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment .- Returns:
this
-
mediaExtractionConfiguration
@Stability(Stable) public CfnDataSourceProps.Builder mediaExtractionConfiguration(IResolvable mediaExtractionConfiguration) Sets the value ofCfnDataSourceProps.getMediaExtractionConfiguration()
- Parameters:
mediaExtractionConfiguration
- The configuration for extracting information from media in documents.- Returns:
this
-
mediaExtractionConfiguration
@Stability(Stable) public CfnDataSourceProps.Builder mediaExtractionConfiguration(CfnDataSource.MediaExtractionConfigurationProperty mediaExtractionConfiguration) Sets the value ofCfnDataSourceProps.getMediaExtractionConfiguration()
- Parameters:
mediaExtractionConfiguration
- The configuration for extracting information from media in documents.- Returns:
this
-
roleArn
Sets the value ofCfnDataSourceProps.getRoleArn()
- Parameters:
roleArn
- The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.- Returns:
this
-
syncSchedule
Sets the value ofCfnDataSourceProps.getSyncSchedule()
- 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 theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.- Returns:
this
-
tags
Sets the value ofCfnDataSourceProps.getTags()
- 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:
this
-
vpcConfiguration
Sets the value ofCfnDataSourceProps.getVpcConfiguration()
- 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:
this
-
vpcConfiguration
@Stability(Stable) public CfnDataSourceProps.Builder vpcConfiguration(CfnDataSource.DataSourceVpcConfigurationProperty vpcConfiguration) Sets the value ofCfnDataSourceProps.getVpcConfiguration()
- 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:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDataSourceProps>
- Returns:
- a new instance of
CfnDataSourceProps
- Throws:
NullPointerException
- if any required attribute was not provided
-