All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:11.949Z") @Stability(Stable) public interface CfnDataSourceProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a 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())
         .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 Classes

Modifier and Type

Interface

Description

static final class

CfnDataSourceProps.Builder

A builder for CfnDataSourceProps

static final class

CfnDataSourceProps.Jsii$Proxy

An implementation for CfnDataSourceProps
Method Summary

Modifier and Type

Method

Description

static CfnDataSourceProps.Builder

builder()

String

getApplicationId()

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

Object

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 .

default String

getDescription()

A description for the data source connector.

String

getDisplayName()

The name of the Amazon Q Business data source.

default Object

getDocumentEnrichmentConfiguration()

Provides the configuration information for altering document metadata and content during the document ingestion process.

String

getIndexId()

The identifier of the index the data source is attached to.

default String

getRoleArn()

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

default String

getSyncSchedule()

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.

default List<CfnTag>

getTags()

A list of key-value pairs that identify or categorize the data source connector.

default Object

getVpcConfiguration()

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
  
  @Stability(Stable) @NotNull String getApplicationId()
  
  The identifier of the Amazon Q Business application the data source will be attached to.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-applicationid
- getConfiguration
  
  @Stability(Stable) @NotNull Object 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:
  
  Amazon Simple Storage Service
  
  Amazon Q Web Crawler
  
  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:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-configuration
- getDisplayName
  
  @Stability(Stable) @NotNull String getDisplayName()
  
  The name of the Amazon Q Business data source.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-displayname
- getIndexId
  
  @Stability(Stable) @NotNull String getIndexId()
  
  The identifier of the index the data source is attached to.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-indexid
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  A description for the data source connector.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-description
- getDocumentEnrichmentConfiguration
  
  @Stability(Stable) @Nullable default Object 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:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-documentenrichmentconfiguration
- getRoleArn
  
  @Stability(Stable) @Nullable default String getRoleArn()
  
  The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-rolearn
- getSyncSchedule
  
  @Stability(Stable) @Nullable default String 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 the Schedule parameter when the Type parameter is set to CUSTOM . If you do, you receive a ValidationException exception.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-syncschedule
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> 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:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-tags
- getVpcConfiguration
  
  @Stability(Stable) @Nullable default Object 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:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-vpcconfiguration
- builder
  
  @Stability(Stable) static CfnDataSourceProps.Builder builder()
  
  Returns:
  
  a CfnDataSourceProps.Builder of CfnDataSourceProps

Interface CfnDataSourceProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getApplicationId

getConfiguration

getDisplayName

getIndexId

getDescription

getDocumentEnrichmentConfiguration

getRoleArn

getSyncSchedule

getTags

getVpcConfiguration

builder