Interface CfnDataSourceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-17T19:20:24.271Z")
@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.bedrock.*; CfnDataSourceProps cfnDataSourceProps = CfnDataSourceProps.builder() .dataSourceConfiguration(DataSourceConfigurationProperty.builder() .type("type") // the properties below are optional .confluenceConfiguration(ConfluenceDataSourceConfigurationProperty.builder() .sourceConfiguration(ConfluenceSourceConfigurationProperty.builder() .authType("authType") .credentialsSecretArn("credentialsSecretArn") .hostType("hostType") .hostUrl("hostUrl") .build()) // the properties below are optional .crawlerConfiguration(ConfluenceCrawlerConfigurationProperty.builder() .filterConfiguration(CrawlFilterConfigurationProperty.builder() .type("type") // the properties below are optional .patternObjectFilter(PatternObjectFilterConfigurationProperty.builder() .filters(List.of(PatternObjectFilterProperty.builder() .objectType("objectType") // the properties below are optional .exclusionFilters(List.of("exclusionFilters")) .inclusionFilters(List.of("inclusionFilters")) .build())) .build()) .build()) .build()) .build()) .s3Configuration(S3DataSourceConfigurationProperty.builder() .bucketArn("bucketArn") // the properties below are optional .bucketOwnerAccountId("bucketOwnerAccountId") .inclusionPrefixes(List.of("inclusionPrefixes")) .build()) .salesforceConfiguration(SalesforceDataSourceConfigurationProperty.builder() .sourceConfiguration(SalesforceSourceConfigurationProperty.builder() .authType("authType") .credentialsSecretArn("credentialsSecretArn") .hostUrl("hostUrl") .build()) // the properties below are optional .crawlerConfiguration(SalesforceCrawlerConfigurationProperty.builder() .filterConfiguration(CrawlFilterConfigurationProperty.builder() .type("type") // the properties below are optional .patternObjectFilter(PatternObjectFilterConfigurationProperty.builder() .filters(List.of(PatternObjectFilterProperty.builder() .objectType("objectType") // the properties below are optional .exclusionFilters(List.of("exclusionFilters")) .inclusionFilters(List.of("inclusionFilters")) .build())) .build()) .build()) .build()) .build()) .sharePointConfiguration(SharePointDataSourceConfigurationProperty.builder() .sourceConfiguration(SharePointSourceConfigurationProperty.builder() .authType("authType") .credentialsSecretArn("credentialsSecretArn") .domain("domain") .hostType("hostType") .siteUrls(List.of("siteUrls")) // the properties below are optional .tenantId("tenantId") .build()) // the properties below are optional .crawlerConfiguration(SharePointCrawlerConfigurationProperty.builder() .filterConfiguration(CrawlFilterConfigurationProperty.builder() .type("type") // the properties below are optional .patternObjectFilter(PatternObjectFilterConfigurationProperty.builder() .filters(List.of(PatternObjectFilterProperty.builder() .objectType("objectType") // the properties below are optional .exclusionFilters(List.of("exclusionFilters")) .inclusionFilters(List.of("inclusionFilters")) .build())) .build()) .build()) .build()) .build()) .webConfiguration(WebDataSourceConfigurationProperty.builder() .sourceConfiguration(WebSourceConfigurationProperty.builder() .urlConfiguration(UrlConfigurationProperty.builder() .seedUrls(List.of(SeedUrlProperty.builder() .url("url") .build())) .build()) .build()) // the properties below are optional .crawlerConfiguration(WebCrawlerConfigurationProperty.builder() .crawlerLimits(WebCrawlerLimitsProperty.builder() .rateLimit(123) .build()) .exclusionFilters(List.of("exclusionFilters")) .inclusionFilters(List.of("inclusionFilters")) .scope("scope") .build()) .build()) .build()) .knowledgeBaseId("knowledgeBaseId") .name("name") // the properties below are optional .dataDeletionPolicy("dataDeletionPolicy") .description("description") .serverSideEncryptionConfiguration(ServerSideEncryptionConfigurationProperty.builder() .kmsKeyArn("kmsKeyArn") .build()) .vectorIngestionConfiguration(VectorIngestionConfigurationProperty.builder() .chunkingConfiguration(ChunkingConfigurationProperty.builder() .chunkingStrategy("chunkingStrategy") // the properties below are optional .fixedSizeChunkingConfiguration(FixedSizeChunkingConfigurationProperty.builder() .maxTokens(123) .overlapPercentage(123) .build()) .hierarchicalChunkingConfiguration(HierarchicalChunkingConfigurationProperty.builder() .levelConfigurations(List.of(HierarchicalChunkingLevelConfigurationProperty.builder() .maxTokens(123) .build())) .overlapTokens(123) .build()) .semanticChunkingConfiguration(SemanticChunkingConfigurationProperty.builder() .breakpointPercentileThreshold(123) .bufferSize(123) .maxTokens(123) .build()) .build()) .customTransformationConfiguration(CustomTransformationConfigurationProperty.builder() .intermediateStorage(IntermediateStorageProperty.builder() .s3Location(S3LocationProperty.builder() .uri("uri") .build()) .build()) .transformations(List.of(TransformationProperty.builder() .stepToApply("stepToApply") .transformationFunction(TransformationFunctionProperty.builder() .transformationLambdaConfiguration(TransformationLambdaConfigurationProperty.builder() .lambdaArn("lambdaArn") .build()) .build()) .build())) .build()) .parsingConfiguration(ParsingConfigurationProperty.builder() .parsingStrategy("parsingStrategy") // the properties below are optional .bedrockDataAutomationConfiguration(BedrockDataAutomationConfigurationProperty.builder() .parsingModality("parsingModality") .build()) .bedrockFoundationModelConfiguration(BedrockFoundationModelConfigurationProperty.builder() .modelArn("modelArn") // the properties below are optional .parsingModality("parsingModality") .parsingPrompt(ParsingPromptProperty.builder() .parsingPromptText("parsingPromptText") .build()) .build()) .build()) .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()
default String
The data deletion policy for the data source.The connection configuration for the data source.default String
The description of the data source.The unique identifier of the knowledge base to which the data source belongs.getName()
The name of the data source.default Object
Contains details about the configuration of the server-side encryption.default Object
Contains details about how to ingest the documents in the data source.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDataSourceConfiguration
The connection configuration for the data source.- See Also:
-
getKnowledgeBaseId
The unique identifier of the knowledge base to which the data source belongs.- See Also:
-
getName
The name of the data source.- See Also:
-
getDataDeletionPolicy
The data deletion policy for the data source.- See Also:
-
getDescription
The description of the data source.- See Also:
-
getServerSideEncryptionConfiguration
Contains details about the configuration of the server-side encryption.- See Also:
-
getVectorIngestionConfiguration
Contains details about how to ingest the documents in the data source.- See Also:
-
builder
- Returns:
- a
CfnDataSourceProps.Builder
ofCfnDataSourceProps
-