All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-11T15:55:54.116Z") @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
                         .bedrockFoundationModelConfiguration(BedrockFoundationModelConfigurationProperty.builder()
                                 .modelArn("modelArn")
                                 // the properties below are optional
                                 .parsingPrompt(ParsingPromptProperty.builder()
                                         .parsingPromptText("parsingPromptText")
                                         .build())
                                 .build())
                         .build())
                 .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()

default String

getDataDeletionPolicy()

The data deletion policy for the data source.

Object

getDataSourceConfiguration()

The connection configuration for the data source.

default String

getDescription()

The description of the data source.

String

getKnowledgeBaseId()

The unique identifier of the knowledge base to which the data source belongs.

String

getName()

The name of the data source.

default Object

getServerSideEncryptionConfiguration()

Contains details about the configuration of the server-side encryption.

default Object

getVectorIngestionConfiguration()

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
  
  @Stability(Stable) @NotNull Object getDataSourceConfiguration()
  
  The connection configuration for the data source.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-datasourceconfiguration
- getKnowledgeBaseId
  
  @Stability(Stable) @NotNull String getKnowledgeBaseId()
  
  The unique identifier of the knowledge base to which the data source belongs.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-knowledgebaseid
- getName
  
  @Stability(Stable) @NotNull String getName()
  
  The name of the data source.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-name
- getDataDeletionPolicy
  
  @Stability(Stable) @Nullable default String getDataDeletionPolicy()
  
  The data deletion policy for the data source.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-datadeletionpolicy
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  The description of the data source.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-description
- getServerSideEncryptionConfiguration
  
  @Stability(Stable) @Nullable default Object getServerSideEncryptionConfiguration()
  
  Contains details about the configuration of the server-side encryption.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-serversideencryptionconfiguration
- getVectorIngestionConfiguration
  
  @Stability(Stable) @Nullable default Object getVectorIngestionConfiguration()
  
  Contains details about how to ingest the documents in the data source.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html#cfn-bedrock-datasource-vectoringestionconfiguration
- 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

getDataSourceConfiguration

getKnowledgeBaseId

getName

getDataDeletionPolicy

getDescription

getServerSideEncryptionConfiguration

getVectorIngestionConfiguration

builder