Package software.amazon.awscdk.services.bedrock

Interface CfnDataSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-22T22:42:48.145Z")
@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()
                 .s3Configuration(S3DataSourceConfigurationProperty.builder()
                         .bucketArn("bucketArn")
                         // the properties below are optional
                         .bucketOwnerAccountId("bucketOwnerAccountId")
                         .inclusionPrefixes(List.of("inclusionPrefixes"))
                         .build())
                 .type("type")
                 .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())
                         .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	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