AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

BedrockFoundationModelProps Struct ​

Properties for configuring a Bedrock Foundation Model.

These properties define the model's capabilities and supported features.

Stability
Experimental
Source
bedrock/models.ts
Type last changed
v2.274.0-alpha.0 · 21 Oct 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_alpha from '@aws-cdk/aws-bedrock-alpha';
const bedrockFoundationModelProps: bedrock_alpha.BedrockFoundationModelProps = {
  legacy: false,
  optimizedForAgents: false,
  supportedVectorType: [bedrock_alpha.VectorType.FLOATING_POINT],
  supportsAgents: false,
  supportsConfigurableDimensions: false,
  supportsCrossRegion: false,
  supportsKnowledgeBase: false,
  vectorDimensions: 123,
};

Properties ​

legacyoptionalbooleanlegacyoptionalboollegacyoptionalBooleanLegacyoptionalboolLegacyoptional*bool= false#
https://docs.aws.amazon.com/bedrock/latest/userguide/model-lifecycle.html A version is marked Legacy when there is a more recent version which provides superior performance. Amazon Bedrock sets an EOL date for Legacy versions.
optimizedForAgentsoptionalbooleanoptimized_for_agentsoptionalbooloptimizedForAgentsoptionalBooleanOptimizedForAgentsoptionalboolOptimizedForAgentsoptional*bool= false#
Currently, some of the offered models are optimized with prompts/parsers fine-tuned for integrating with the agents architecture.

When true, the model has been specifically optimized for agent interactions.

supportedVectorTypeoptionalVectorType[]supported_vector_typeoptionaltyping.List[VectorType]supportedVectorTypeoptionalList<VectorType>SupportedVectorTypeoptionalVectorType[]SupportedVectorTypeoptional*[]VectorType= undefined#
Embeddings models have different supported vector types.

Defines whether the model supports floating-point or binary vectors.

supportsAgentsoptionalbooleansupports_agentsoptionalboolsupportsAgentsoptionalBooleanSupportsAgentsoptionalboolSupportsAgentsoptional*bool= false#
Bedrock Agents can use this model.

When true, the model can be used with Bedrock Agents for automated task execution.

supportsConfigurableDimensionsoptionalbooleansupports_configurable_dimensionsoptionalboolsupportsConfigurableDimensionsoptionalBooleanSupportsConfigurableDimensionsoptionalboolSupportsConfigurableDimensionsoptional*bool= false#
Whether the number of vector dimensions can be chosen when the model is used by a knowledge base.

Only applicable for embedding models. When true, vectorDimensions is passed to the knowledge base; when false, the model's dimension is fixed and vectorDimensions is informational only.

supportsCrossRegionoptionalbooleansupports_cross_regionoptionalboolsupportsCrossRegionoptionalBooleanSupportsCrossRegionoptionalboolSupportsCrossRegionoptional*bool= false#
Can be used with a Cross-Region Inference Profile.

When true, the model supports inference across different AWS regions.

supportsKnowledgeBaseoptionalbooleansupports_knowledge_baseoptionalboolsupportsKnowledgeBaseoptionalBooleanSupportsKnowledgeBaseoptionalboolSupportsKnowledgeBaseoptional*bool= false#
Bedrock Knowledge Base can use this model.

When true, the model can be used for knowledge base operations.

vectorDimensionsoptionalnumbervector_dimensionsoptionalint | floatvectorDimensionsoptionalNumberVectorDimensionsoptionaldoubleVectorDimensionsoptional*float64= undefined#
Embedding models have different vector dimensions.

Only applicable for embedding models. Defines the dimensionality of the vector embeddings.