AWS::Bedrock::KnowledgeBase PineconeConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Bedrock::KnowledgeBase PineconeConfiguration

Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "ConnectionString" : String,
  "CredentialsSecretArn" : String,
  "FieldMapping" : PineconeFieldMapping,
  "Namespace" : String
}

Properties

ConnectionString

The endpoint URL for your index management page.

Required: Yes

Type: String

Pattern: ^.*$

Maximum: 2048

Update requires: Replacement

CredentialsSecretArn

The Amazon Resource Name (ARN) of the secret that you created in Amazon Secrets Manager that is linked to your Pinecone API key.

Required: Yes

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$

Update requires: Replacement

FieldMapping

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

Required: Yes

Type: PineconeFieldMapping

Update requires: Replacement

Namespace

The namespace to be used to write new data to your database.

Required: No

Type: String

Pattern: ^.*$

Maximum: 2048

Update requires: Replacement