Interface CfnDataSourceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSourceProps.Jsii$Proxy
CfnDataSource
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.qbusiness.*; Object configuration; CfnDataSourceProps cfnDataSourceProps = CfnDataSourceProps.builder() .applicationId("applicationId") .configuration(configuration) .displayName("displayName") .indexId("indexId") // the properties below are optional .description("description") .documentEnrichmentConfiguration(DocumentEnrichmentConfigurationProperty.builder() .inlineConfigurations(List.of(InlineDocumentEnrichmentConfigurationProperty.builder() .condition(DocumentAttributeConditionProperty.builder() .key("key") .operator("operator") // the properties below are optional .value(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .documentContentOperator("documentContentOperator") .target(DocumentAttributeTargetProperty.builder() .key("key") // the properties below are optional .attributeValueOperator("attributeValueOperator") .value(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .build())) .postExtractionHookConfiguration(HookConfigurationProperty.builder() .invocationCondition(DocumentAttributeConditionProperty.builder() .key("key") .operator("operator") // the properties below are optional .value(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .lambdaArn("lambdaArn") .roleArn("roleArn") .s3BucketName("s3BucketName") .build()) .preExtractionHookConfiguration(HookConfigurationProperty.builder() .invocationCondition(DocumentAttributeConditionProperty.builder() .key("key") .operator("operator") // the properties below are optional .value(DocumentAttributeValueProperty.builder() .dateValue("dateValue") .longValue(123) .stringListValue(List.of("stringListValue")) .stringValue("stringValue") .build()) .build()) .lambdaArn("lambdaArn") .roleArn("roleArn") .s3BucketName("s3BucketName") .build()) .build()) .mediaExtractionConfiguration(MediaExtractionConfigurationProperty.builder() .imageExtractionConfiguration(ImageExtractionConfigurationProperty.builder() .imageExtractionStatus("imageExtractionStatus") .build()) .build()) .roleArn("roleArn") .syncSchedule("syncSchedule") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .vpcConfiguration(DataSourceVpcConfigurationProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataSourceProps
static final class
An implementation forCfnDataSourceProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDataSourceProps.Builder
builder()
The identifier of the Amazon Q Business application the data source will be attached to.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 .default String
A description for the data source connector.The name of the Amazon Q Business data source.default Object
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.default Object
The configuration for extracting information from media in documents.default String
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.default String
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.getTags()
A list of key-value pairs that identify or categorize the data source connector.default Object
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationId
The identifier of the Amazon Q Business application the data source will be attached to.- See Also:
-
getConfiguration
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.
- See Also:
-
getDisplayName
The name of the Amazon Q Business data source.- See Also:
-
getIndexId
The identifier of the index the data source is attached to.- See Also:
-
getDescription
A description for the data source connector.- See Also:
-
getDocumentEnrichmentConfiguration
Provides the configuration information for altering document metadata and content during the document ingestion process.For more information, see Custom document enrichment .
- See Also:
-
getMediaExtractionConfiguration
The configuration for extracting information from media in documents.- See Also:
-
getRoleArn
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.- See Also:
-
getSyncSchedule
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.- See Also:
-
getTags
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: _ . : / = + -
- See Also:
-
getVpcConfiguration
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 .
- See Also:
-
builder
- Returns:
- a
CfnDataSourceProps.Builder
ofCfnDataSourceProps
-