Class CfnDataSource.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDataSource>
- Enclosing class:
CfnDataSource
CfnDataSource
.-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The identifier of the Amazon Q Business application the data source will be attached to.build()
configuration
(Object 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 .static CfnDataSource.Builder
description
(String description) A description for the data source connector.displayName
(String displayName) The name of the Amazon Q Business data source.documentEnrichmentConfiguration
(IResolvable documentEnrichmentConfiguration) Provides the configuration information for altering document metadata and content during the document ingestion process.documentEnrichmentConfiguration
(CfnDataSource.DocumentEnrichmentConfigurationProperty documentEnrichmentConfiguration) Provides the configuration information for altering document metadata and content during the document ingestion process.The identifier of the index the data source is attached to.mediaExtractionConfiguration
(IResolvable mediaExtractionConfiguration) The configuration for extracting information from media in documents.mediaExtractionConfiguration
(CfnDataSource.MediaExtractionConfigurationProperty mediaExtractionConfiguration) The configuration for extracting information from media in documents.The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.syncSchedule
(String syncSchedule) Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.A list of key-value pairs that identify or categorize the data source connector.vpcConfiguration
(IResolvable vpcConfiguration) Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.vpcConfiguration
(CfnDataSource.DataSourceVpcConfigurationProperty vpcConfiguration) Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
-
Method Details
-
create
@Stability(Stable) public static CfnDataSource.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnDataSource.Builder
.
-
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. This parameter is required.- Returns:
this
- See Also:
-
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 .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.
- 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.- Returns:
this
- See Also:
-
displayName
The name of the Amazon Q Business data source.- Parameters:
displayName
- The name of the Amazon Q Business data source. This parameter is required.- Returns:
this
- See Also:
-
indexId
The identifier of the index the data source is attached to.- Parameters:
indexId
- The identifier of the index the data source is attached to. This parameter is required.- Returns:
this
- See Also:
-
description
A description for the data source connector.- Parameters:
description
- A description for the data source connector. This parameter is required.- Returns:
this
- See Also:
-
documentEnrichmentConfiguration
@Stability(Stable) public CfnDataSource.Builder documentEnrichmentConfiguration(IResolvable documentEnrichmentConfiguration) Provides the configuration information for altering document metadata and content during the document ingestion process.For more information, see Custom document enrichment .
- Parameters:
documentEnrichmentConfiguration
- Provides the configuration information for altering document metadata and content during the document ingestion process. This parameter is required.- Returns:
this
- See Also:
-
documentEnrichmentConfiguration
@Stability(Stable) public CfnDataSource.Builder documentEnrichmentConfiguration(CfnDataSource.DocumentEnrichmentConfigurationProperty documentEnrichmentConfiguration) Provides the configuration information for altering document metadata and content during the document ingestion process.For more information, see Custom document enrichment .
- Parameters:
documentEnrichmentConfiguration
- Provides the configuration information for altering document metadata and content during the document ingestion process. This parameter is required.- Returns:
this
- See Also:
-
mediaExtractionConfiguration
@Stability(Stable) public CfnDataSource.Builder mediaExtractionConfiguration(IResolvable mediaExtractionConfiguration) The configuration for extracting information from media in documents.- Parameters:
mediaExtractionConfiguration
- The configuration for extracting information from media in documents. This parameter is required.- Returns:
this
- See Also:
-
mediaExtractionConfiguration
@Stability(Stable) public CfnDataSource.Builder mediaExtractionConfiguration(CfnDataSource.MediaExtractionConfigurationProperty mediaExtractionConfiguration) The configuration for extracting information from media in documents.- Parameters:
mediaExtractionConfiguration
- The configuration for extracting information from media in documents. This parameter is required.- Returns:
this
- See Also:
-
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. This parameter is required.- Returns:
this
- See Also:
-
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.- Parameters:
syncSchedule
- Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. This parameter is required.- Returns:
this
- See Also:
-
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. This parameter is required.- Returns:
this
- See Also:
-
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. This parameter is required.- Returns:
this
- See Also:
-
vpcConfiguration
@Stability(Stable) public CfnDataSource.Builder vpcConfiguration(CfnDataSource.DataSourceVpcConfigurationProperty 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. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDataSource>
- Returns:
- a newly built instance of
CfnDataSource
.
-