All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnKnowledgeBaseMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:56.605Z") @Stability(Stable) public interface CfnKnowledgeBaseMixinProps extends software.amazon.jsii.JsiiSerializable

Properties for CfnKnowledgeBasePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrock.*;
 CfnKnowledgeBaseMixinProps cfnKnowledgeBaseMixinProps = CfnKnowledgeBaseMixinProps.builder()
         .description("description")
         .knowledgeBaseConfiguration(KnowledgeBaseConfigurationProperty.builder()
                 .kendraKnowledgeBaseConfiguration(KendraKnowledgeBaseConfigurationProperty.builder()
                         .kendraIndexArn("kendraIndexArn")
                         .build())
                 .sqlKnowledgeBaseConfiguration(SqlKnowledgeBaseConfigurationProperty.builder()
                         .redshiftConfiguration(RedshiftConfigurationProperty.builder()
                                 .queryEngineConfiguration(RedshiftQueryEngineConfigurationProperty.builder()
                                         .provisionedConfiguration(RedshiftProvisionedConfigurationProperty.builder()
                                                 .authConfiguration(RedshiftProvisionedAuthConfigurationProperty.builder()
                                                         .databaseUser("databaseUser")
                                                         .type("type")
                                                         .usernamePasswordSecretArn("usernamePasswordSecretArn")
                                                         .build())
                                                 .clusterIdentifier("clusterIdentifier")
                                                 .build())
                                         .serverlessConfiguration(RedshiftServerlessConfigurationProperty.builder()
                                                 .authConfiguration(RedshiftServerlessAuthConfigurationProperty.builder()
                                                         .type("type")
                                                         .usernamePasswordSecretArn("usernamePasswordSecretArn")
                                                         .build())
                                                 .workgroupArn("workgroupArn")
                                                 .build())
                                         .type("type")
                                         .build())
                                 .queryGenerationConfiguration(QueryGenerationConfigurationProperty.builder()
                                         .executionTimeoutSeconds(123)
                                         .generationContext(QueryGenerationContextProperty.builder()
                                                 .curatedQueries(List.of(CuratedQueryProperty.builder()
                                                         .naturalLanguage("naturalLanguage")
                                                         .sql("sql")
                                                         .build()))
                                                 .tables(List.of(QueryGenerationTableProperty.builder()
                                                         .columns(List.of(QueryGenerationColumnProperty.builder()
                                                                 .description("description")
                                                                 .inclusion("inclusion")
                                                                 .name("name")
                                                                 .build()))
                                                         .description("description")
                                                         .inclusion("inclusion")
                                                         .name("name")
                                                         .build()))
                                                 .build())
                                         .build())
                                 .storageConfigurations(List.of(RedshiftQueryEngineStorageConfigurationProperty.builder()
                                         .awsDataCatalogConfiguration(RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty.builder()
                                                 .tableNames(List.of("tableNames"))
                                                 .build())
                                         .redshiftConfiguration(RedshiftQueryEngineRedshiftStorageConfigurationProperty.builder()
                                                 .databaseName("databaseName")
                                                 .build())
                                         .type("type")
                                         .build()))
                                 .build())
                         .type("type")
                         .build())
                 .type("type")
                 .vectorKnowledgeBaseConfiguration(VectorKnowledgeBaseConfigurationProperty.builder()
                         .embeddingModelArn("embeddingModelArn")
                         .embeddingModelConfiguration(EmbeddingModelConfigurationProperty.builder()
                                 .bedrockEmbeddingModelConfiguration(BedrockEmbeddingModelConfigurationProperty.builder()
                                         .audio(List.of(AudioConfigurationProperty.builder()
                                                 .segmentationConfiguration(AudioSegmentationConfigurationProperty.builder()
                                                         .fixedLengthDuration(123)
                                                         .build())
                                                 .build()))
                                         .dimensions(123)
                                         .embeddingDataType("embeddingDataType")
                                         .video(List.of(VideoConfigurationProperty.builder()
                                                 .segmentationConfiguration(VideoSegmentationConfigurationProperty.builder()
                                                         .fixedLengthDuration(123)
                                                         .build())
                                                 .build()))
                                         .build())
                                 .build())
                         .supplementalDataStorageConfiguration(SupplementalDataStorageConfigurationProperty.builder()
                                 .supplementalDataStorageLocations(List.of(SupplementalDataStorageLocationProperty.builder()
                                         .s3Location(S3LocationProperty.builder()
                                                 .uri("uri")
                                                 .build())
                                         .supplementalDataStorageLocationType("supplementalDataStorageLocationType")
                                         .build()))
                                 .build())
                         .build())
                 .build())
         .name("name")
         .roleArn("roleArn")
         .storageConfiguration(StorageConfigurationProperty.builder()
                 .mongoDbAtlasConfiguration(MongoDbAtlasConfigurationProperty.builder()
                         .collectionName("collectionName")
                         .credentialsSecretArn("credentialsSecretArn")
                         .databaseName("databaseName")
                         .endpoint("endpoint")
                         .endpointServiceName("endpointServiceName")
                         .fieldMapping(MongoDbAtlasFieldMappingProperty.builder()
                                 .metadataField("metadataField")
                                 .textField("textField")
                                 .vectorField("vectorField")
                                 .build())
                         .textIndexName("textIndexName")
                         .vectorIndexName("vectorIndexName")
                         .build())
                 .neptuneAnalyticsConfiguration(NeptuneAnalyticsConfigurationProperty.builder()
                         .fieldMapping(NeptuneAnalyticsFieldMappingProperty.builder()
                                 .metadataField("metadataField")
                                 .textField("textField")
                                 .build())
                         .graphArn("graphArn")
                         .build())
                 .opensearchManagedClusterConfiguration(OpenSearchManagedClusterConfigurationProperty.builder()
                         .domainArn("domainArn")
                         .domainEndpoint("domainEndpoint")
                         .fieldMapping(OpenSearchManagedClusterFieldMappingProperty.builder()
                                 .metadataField("metadataField")
                                 .textField("textField")
                                 .vectorField("vectorField")
                                 .build())
                         .vectorIndexName("vectorIndexName")
                         .build())
                 .opensearchServerlessConfiguration(OpenSearchServerlessConfigurationProperty.builder()
                         .collectionArn("collectionArn")
                         .fieldMapping(OpenSearchServerlessFieldMappingProperty.builder()
                                 .metadataField("metadataField")
                                 .textField("textField")
                                 .vectorField("vectorField")
                                 .build())
                         .vectorIndexName("vectorIndexName")
                         .build())
                 .pineconeConfiguration(PineconeConfigurationProperty.builder()
                         .connectionString("connectionString")
                         .credentialsSecretArn("credentialsSecretArn")
                         .fieldMapping(PineconeFieldMappingProperty.builder()
                                 .metadataField("metadataField")
                                 .textField("textField")
                                 .build())
                         .namespace("namespace")
                         .build())
                 .rdsConfiguration(RdsConfigurationProperty.builder()
                         .credentialsSecretArn("credentialsSecretArn")
                         .databaseName("databaseName")
                         .fieldMapping(RdsFieldMappingProperty.builder()
                                 .customMetadataField("customMetadataField")
                                 .metadataField("metadataField")
                                 .primaryKeyField("primaryKeyField")
                                 .textField("textField")
                                 .vectorField("vectorField")
                                 .build())
                         .resourceArn("resourceArn")
                         .tableName("tableName")
                         .build())
                 .s3VectorsConfiguration(S3VectorsConfigurationProperty.builder()
                         .indexArn("indexArn")
                         .indexName("indexName")
                         .vectorBucketArn("vectorBucketArn")
                         .build())
                 .type("type")
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnKnowledgeBaseMixinProps.Builder

A builder for CfnKnowledgeBaseMixinProps

static final class

CfnKnowledgeBaseMixinProps.Jsii$Proxy

An implementation for CfnKnowledgeBaseMixinProps
Method Summary

Modifier and Type

Method

Description

static CfnKnowledgeBaseMixinProps.Builder

builder()

default String

getDescription()

The description of the knowledge base associated with the inline agent.

default Object

getKnowledgeBaseConfiguration()

Contains details about the embeddings configuration of the knowledge base.

default String

getName()

The name of the knowledge base.

default String

getRoleArn()

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

default Object

getStorageConfiguration()

Contains details about the storage configuration of the knowledge base.

default Map<String,String>

getTags()

Metadata that you can assign to a resource as key-value pairs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  The description of the knowledge base associated with the inline agent.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-description
- getKnowledgeBaseConfiguration
  
  @Stability(Stable) @Nullable default Object getKnowledgeBaseConfiguration()
  
  Contains details about the embeddings configuration of the knowledge base.
  Returns union: either IResolvable or CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration
- getName
  
  @Stability(Stable) @Nullable default String getName()
  
  The name of the knowledge base.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-name
- getRoleArn
  
  @Stability(Stable) @Nullable default String getRoleArn()
  
  The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-rolearn
- getStorageConfiguration
  
  @Stability(Stable) @Nullable default Object getStorageConfiguration()
  
  Contains details about the storage configuration of the knowledge base.
  Returns union: either IResolvable or CfnKnowledgeBasePropsMixin.StorageConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-storageconfiguration
- getTags
  
  @Stability(Stable) @Nullable default Map<String,String> getTags()
  Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.
  
  Tag naming limits and requirements
  
  Tagging best practices
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-tags
- builder
  
  @Stability(Stable) static CfnKnowledgeBaseMixinProps.Builder builder()
  
  Returns:
  
  a CfnKnowledgeBaseMixinProps.Builder of CfnKnowledgeBaseMixinProps

Interface CfnKnowledgeBaseMixinProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getDescription

getKnowledgeBaseConfiguration

getName

getRoleArn

getStorageConfiguration

getTags

builder