Package software.amazon.awscdk.services.bedrock

Class CfnDataSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.bedrock.CfnDataSource

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:05.065Z")
@Stability(Stable)
public class CfnDataSource
extends CfnResource
implements IInspectable

Specifies a data source as a resource in a top-level template. Minimally, you must specify the following properties:.

• Name – Specify a name for the data source.
• KnowledgeBaseId – Specify the ID of the knowledge base for the data source to belong to.
• DataSourceConfiguration – Specify information about the Amazon S3 bucket containing the data source. The following sub-properties are required:
• Type – Specify the value S3 .

For more information about setting up data sources in Amazon Bedrock , see Set up a data source for your knowledge base .

See the Properties section below for descriptions of both the required and optional properties.

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.*;
 CfnDataSource cfnDataSource = CfnDataSource.Builder.create(this, "MyCfnDataSource")
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDataSource.BedrockFoundationModelConfigurationProperty	Settings for a foundation model or inference profile used to parse documents for a data source.
static final class	CfnDataSource.Builder	A fluent builder for CfnDataSource.
static interface	CfnDataSource.ChunkingConfigurationProperty	Details about how to chunk the documents in the data source.
static interface	CfnDataSource.ConfluenceCrawlerConfigurationProperty	The configuration of the Confluence content.
static interface	CfnDataSource.ConfluenceDataSourceConfigurationProperty	The configuration information to connect to Confluence as your data source.
static interface	CfnDataSource.ConfluenceSourceConfigurationProperty	The endpoint information to connect to your Confluence data source.
static interface	CfnDataSource.CrawlFilterConfigurationProperty	The configuration of filtering the data source content.
static interface	CfnDataSource.CustomTransformationConfigurationProperty	Settings for customizing steps in the data source content ingestion pipeline.
static interface	CfnDataSource.DataSourceConfigurationProperty	The connection configuration for the data source.
static interface	CfnDataSource.FixedSizeChunkingConfigurationProperty	Configurations for when you choose fixed-size chunking.
static interface	CfnDataSource.HierarchicalChunkingConfigurationProperty	Settings for hierarchical document chunking for a data source.
static interface	CfnDataSource.HierarchicalChunkingLevelConfigurationProperty	Token settings for a layer in a hierarchical chunking configuration.
static interface	CfnDataSource.IntermediateStorageProperty	A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.
static interface	CfnDataSource.ParsingConfigurationProperty	Settings for parsing document contents.
static interface	CfnDataSource.ParsingPromptProperty	Instructions for interpreting the contents of a document.
static interface	CfnDataSource.PatternObjectFilterConfigurationProperty	The configuration of filtering certain objects or content types of the data source.
static interface	CfnDataSource.PatternObjectFilterProperty	The specific filters applied to your data source content.
static interface	CfnDataSource.S3DataSourceConfigurationProperty	The configuration information to connect to Amazon S3 as your data source.
static interface	CfnDataSource.S3LocationProperty	An Amazon S3 location.
static interface	CfnDataSource.SalesforceCrawlerConfigurationProperty	The configuration of the Salesforce content.
static interface	CfnDataSource.SalesforceDataSourceConfigurationProperty	The configuration information to connect to Salesforce as your data source.
static interface	CfnDataSource.SalesforceSourceConfigurationProperty	The endpoint information to connect to your Salesforce data source.
static interface	CfnDataSource.SeedUrlProperty	The seed or starting point URL.
static interface	CfnDataSource.SemanticChunkingConfigurationProperty	Settings for semantic document chunking for a data source.
static interface	CfnDataSource.ServerSideEncryptionConfigurationProperty	Contains the configuration for server-side encryption.
static interface	CfnDataSource.SharePointCrawlerConfigurationProperty	The configuration of the SharePoint content.
static interface	CfnDataSource.SharePointDataSourceConfigurationProperty	The configuration information to connect to SharePoint as your data source.
static interface	CfnDataSource.SharePointSourceConfigurationProperty	The endpoint information to connect to your SharePoint data source.
static interface	CfnDataSource.TransformationFunctionProperty	A Lambda function that processes documents.
static interface	CfnDataSource.TransformationLambdaConfigurationProperty	A Lambda function that processes documents.
static interface	CfnDataSource.TransformationProperty	A custom processing step for documents moving through a data source ingestion pipeline.
static interface	CfnDataSource.UrlConfigurationProperty	The configuration of web URLs that you want to crawl.
static interface	CfnDataSource.VectorIngestionConfigurationProperty	Contains details about how to ingest the documents in a data source.
static interface	CfnDataSource.WebCrawlerConfigurationProperty	The configuration of web URLs that you want to crawl.
static interface	CfnDataSource.WebCrawlerLimitsProperty	The rate limits for the URLs that you want to crawl.
static interface	CfnDataSource.WebDataSourceConfigurationProperty	The configuration details for the web data source.
static interface	CfnDataSource.WebSourceConfigurationProperty	The configuration of the URL/URLs for the web content that you want to crawl.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataSource(software.constructs.Construct scope, String id, CfnDataSourceProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreatedAt()	The time at which the data source was created.
String	getAttrDataSourceId()	The unique identifier of the data source.
String	getAttrDataSourceStatus()	The status of the data source.
List<String>	getAttrFailureReasons()	The detailed reasons on the failure to delete a data source.
String	getAttrUpdatedAt()	The time at which the data source was last updated.
protected Map<String,Object>	getCfnProperties()
String	getDataDeletionPolicy()	The data deletion policy for the data source.
Object	getDataSourceConfiguration()	The connection configuration for the data source.
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.
Object	getServerSideEncryptionConfiguration()	Contains details about the configuration of the server-side encryption.
Object	getVectorIngestionConfiguration()	Contains details about how to ingest the documents in the data source.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataDeletionPolicy(String value)	The data deletion policy for the data source.
void	setDataSourceConfiguration(IResolvable value)	The connection configuration for the data source.
void	setDataSourceConfiguration(CfnDataSource.DataSourceConfigurationProperty value)	The connection configuration for the data source.
void	setDescription(String value)	The description of the data source.
void	setKnowledgeBaseId(String value)	The unique identifier of the knowledge base to which the data source belongs.
void	setName(String value)	The name of the data source.
void	setServerSideEncryptionConfiguration(IResolvable value)	Contains details about the configuration of the server-side encryption.
void	setServerSideEncryptionConfiguration(CfnDataSource.ServerSideEncryptionConfigurationProperty value)	Contains details about the configuration of the server-side encryption.
void	setVectorIngestionConfiguration(IResolvable value)	Contains details about how to ingest the documents in the data source.
void	setVectorIngestionConfiguration(CfnDataSource.VectorIngestionConfigurationProperty value)	Contains details about how to ingest the documents in the data source.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDataSource

protected CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataSource

protected CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataSource

@Stability(Stable)
public CfnDataSource(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDataSourceProps props)

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.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The time at which the data source was created.

getAttrDataSourceId

@Stability(Stable)
@NotNull
public String getAttrDataSourceId()

The unique identifier of the data source.

getAttrDataSourceStatus

@Stability(Stable)
@NotNull
public String getAttrDataSourceStatus()

The status of the data source. The following statuses are possible:.

• Available – The data source has been created and is ready for ingestion into the knowledge base.
• Deleting – The data source is being deleted.

getAttrFailureReasons

@Stability(Stable)
@NotNull
public List<String> getAttrFailureReasons()

The detailed reasons on the failure to delete a data source.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The time at which the data source was last updated.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataSourceConfiguration

@Stability(Stable)
@NotNull
public Object getDataSourceConfiguration()

The connection configuration for the data source.

setDataSourceConfiguration

@Stability(Stable)
public void setDataSourceConfiguration(@NotNull
 IResolvable value)

The connection configuration for the data source.

setDataSourceConfiguration

@Stability(Stable)
public void setDataSourceConfiguration(@NotNull
 CfnDataSource.DataSourceConfigurationProperty value)

The connection configuration for the data source.

getKnowledgeBaseId

@Stability(Stable)
@NotNull
public String getKnowledgeBaseId()

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

setKnowledgeBaseId

@Stability(Stable)
public void setKnowledgeBaseId(@NotNull
 String value)

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

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the data source.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the data source.

getDataDeletionPolicy

@Stability(Stable)
@Nullable
public String getDataDeletionPolicy()

The data deletion policy for the data source.

setDataDeletionPolicy

@Stability(Stable)
public void setDataDeletionPolicy(@Nullable
 String value)

The data deletion policy for the data source.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the data source.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the data source.

getServerSideEncryptionConfiguration

@Stability(Stable)
@Nullable
public Object getServerSideEncryptionConfiguration()

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

setServerSideEncryptionConfiguration

@Stability(Stable)
public void setServerSideEncryptionConfiguration(@Nullable
 IResolvable value)

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

setServerSideEncryptionConfiguration

@Stability(Stable)
public void setServerSideEncryptionConfiguration(@Nullable
 CfnDataSource.ServerSideEncryptionConfigurationProperty value)

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

getVectorIngestionConfiguration

@Stability(Stable)
@Nullable
public Object getVectorIngestionConfiguration()

Contains details about how to ingest the documents in the data source.

setVectorIngestionConfiguration

@Stability(Stable)
public void setVectorIngestionConfiguration(@Nullable
 IResolvable value)

Contains details about how to ingest the documents in the data source.

setVectorIngestionConfiguration

@Stability(Stable)
public void setVectorIngestionConfiguration(@Nullable
 CfnDataSource.VectorIngestionConfigurationProperty value)

Contains details about how to ingest the documents in the data source.