Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Interface CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBasePropsMixin

@Stability(Stable)
public static interface CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains details about the storage configuration of the knowledge base in Amazon Neptune Analytics.

For more information, see Create a vector index in Amazon Neptune Analytics .

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.*;
 NeptuneAnalyticsConfigurationProperty neptuneAnalyticsConfigurationProperty = NeptuneAnalyticsConfigurationProperty.builder()
         .fieldMapping(NeptuneAnalyticsFieldMappingProperty.builder()
                 .metadataField("metadataField")
                 .textField("textField")
                 .build())
         .graphArn("graphArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty.Builder	A builder for CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty
static final class	CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty.Jsii$Proxy	An implementation for CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty.Builder	builder()
default Object	getFieldMapping()	Contains the names of the fields to which to map information about the vector store.
default String	getGraphArn()	The Amazon Resource Name (ARN) of the Neptune Analytics vector store.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFieldMapping

@Stability(Stable)
@Nullable
default Object getFieldMapping()

Contains the names of the fields to which to map information about the vector store.

Returns union: either IResolvable or CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsconfiguration.html#cfn-bedrock-knowledgebase-neptuneanalyticsconfiguration-fieldmapping

getGraphArn

@Stability(Stable)
@Nullable
default String getGraphArn()

The Amazon Resource Name (ARN) of the Neptune Analytics vector store.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsconfiguration.html#cfn-bedrock-knowledgebase-neptuneanalyticsconfiguration-grapharn

builder

@Stability(Stable)
static CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty.Builder builder()

Returns:

a CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty.Builder of CfnKnowledgeBasePropsMixin.NeptuneAnalyticsConfigurationProperty