Memory

bedrockagentcorecontrol.services.k8s.aws/v1alpha1

TypeLink
GoDocbedrockagentcorecontrol-controller/apis/v1alpha1#Memory

Metadata

PropertyValue
ScopeNamespaced
KindMemory
ListKindMemoryList
Pluralmemories
Singularmemory

Contains information about a memory resource.

Spec

description: string
encryptionKeyARN: string
encryptionKeyRef: 
  from: 
    name: string
    namespace: string
eventExpiryDuration: integer
memoryExecutionRoleARN: string
memoryExecutionRoleRef: 
  from: 
    name: string
    namespace: string
memoryStrategies:
  customMemoryStrategy: 
    configuration: 
      episodicOverride: 
        consolidation: 
          appendToPrompt: string
          modelID: string
        extraction: 
          appendToPrompt: string
          modelID: string
        reflection: 
          appendToPrompt: string
          modelID: string
          namespaceTemplates:
          - string
          namespaces:
          - string
      selfManagedConfiguration: 
        historicalContextWindowSize: integer
        invocationConfiguration: 
          payloadDeliveryBucketName: string
          topicARN: string
          topicRef: 
            from: 
              name: string
              namespace: string
        triggerConditions:
          messageBasedTrigger: 
            messageCount: integer
          timeBasedTrigger: 
            idleSessionTimeout: integer
          tokenBasedTrigger: 
            tokenCount: integer
      semanticOverride: 
        consolidation: 
          appendToPrompt: string
          modelID: string
        extraction: 
          appendToPrompt: string
          modelID: string
      summaryOverride: 
        consolidation: 
          appendToPrompt: string
          modelID: string
      userPreferenceOverride: 
        consolidation: 
          appendToPrompt: string
          modelID: string
        extraction: 
          appendToPrompt: string
          modelID: string
    description: string
    name: string
    namespaceTemplates:
    - string
    namespaces:
    - string
  episodicMemoryStrategy: 
    description: string
    name: string
    namespaceTemplates:
    - string
    namespaces:
    - string
    reflectionConfiguration: 
      namespaceTemplates:
      - string
      namespaces:
      - string
  semanticMemoryStrategy: 
    description: string
    name: string
    namespaceTemplates:
    - string
    namespaces:
    - string
  summaryMemoryStrategy: 
    description: string
    name: string
    namespaceTemplates:
    - string
    namespaces:
    - string
  userPreferenceMemoryStrategy: 
    description: string
    name: string
    namespaceTemplates:
    - string
    namespaces:
    - string
name: string
streamDeliveryResources: 
  resources:
    kinesis: 
      contentConfigurations:
      - level: string
        type_: string
      dataStreamARN: string
tags: {}
FieldDescription
description
Optional		string
The description of the memory.
encryptionKeyARN
Optional		string
The Amazon Resource Name (ARN) of the KMS key used to encrypt the memory
data.

Regex Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
encryptionKeyRef
Optional		object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
name: my-api
encryptionKeyRef.from
Optional		object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
encryptionKeyRef.from.name
Optional		string
encryptionKeyRef.from.namespace
Optional		string
eventExpiryDuration
Required		integer
The duration after which memory events expire. Specified as an ISO 8601 duration.
memoryExecutionRoleARN
Optional		string
The Amazon Resource Name (ARN) of the IAM role that provides permissions
for the memory to access Amazon Web Services services.

Regex Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
memoryExecutionRoleRef
Optional		object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
name: my-api
memoryExecutionRoleRef.from
Optional		object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
memoryExecutionRoleRef.from.name
Optional		string
memoryExecutionRoleRef.from.namespace
Optional		string
memoryStrategies
Optional		array
The memory strategies to use for this memory. Strategies define how information
is extracted, processed, and consolidated.
memoryStrategies.[]
Required		object
Contains input information for creating a memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration
Optional		object
Input for custom configuration of a memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride
Optional		object
Input for the configuration to override the episodic memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.consolidation
Optional		object
Configurations for overriding the consolidation step of the episodic memory
strategy.
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.consolidation.appendToPrompt
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.consolidation.modelID
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.extraction
Optional		object
Configurations for overriding the extraction step of the episodic memory
strategy.
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.extraction.appendToPrompt
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.extraction.modelID
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.reflection
Optional		object
Configurations for overriding the reflection step of the episodic memory
strategy.
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.reflection.appendToPrompt
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.reflection.modelID
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.reflection.namespaceTemplates
Optional		array
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.reflection.namespaceTemplates.[]
Required		string
memoryStrategies.[].customMemoryStrategy.configuration.episodicOverride.reflection.namespaces.[]
Required		string
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.historicalContextWindowSize
Optional		integer
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.invocationConfiguration
Optional		object
The configuration to invoke a self-managed memory processing pipeline with.
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.invocationConfiguration.payloadDeliveryBucketName
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.invocationConfiguration.topicARN
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.invocationConfiguration.topicRef
Optional		object
Reference field for TopicARN
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.invocationConfiguration.topicRef.from
Optional		object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.invocationConfiguration.topicRef.from.name
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.invocationConfiguration.topicRef.from.namespace
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.triggerConditions
Optional		array
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.triggerConditions.[]
Required		object
Condition that triggers memory processing.
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.triggerConditions.[].messageBasedTrigger.messageCount
Optional		integer
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.triggerConditions.[].timeBasedTrigger
Optional		object
Trigger configuration based on time.
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.triggerConditions.[].timeBasedTrigger.idleSessionTimeout
Optional		integer
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.triggerConditions.[].tokenBasedTrigger
Optional		object
Trigger configuration based on tokens.
memoryStrategies.[].customMemoryStrategy.configuration.selfManagedConfiguration.triggerConditions.[].tokenBasedTrigger.tokenCount
Optional		integer
memoryStrategies.[].customMemoryStrategy.configuration.semanticOverride
Optional		object
Input for semantic override configuration in a memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration.semanticOverride.consolidation
Optional		object
Input for semantic override consolidation configuration in a memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration.semanticOverride.consolidation.appendToPrompt
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.semanticOverride.consolidation.modelID
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.semanticOverride.extraction
Optional		object
Input for semantic override extraction configuration in a memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration.semanticOverride.extraction.appendToPrompt
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.semanticOverride.extraction.modelID
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.summaryOverride
Optional		object
Input for summary override configuration in a memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration.summaryOverride.consolidation
Optional		object
Input for summary override consolidation configuration in a memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration.summaryOverride.consolidation.appendToPrompt
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.summaryOverride.consolidation.modelID
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.userPreferenceOverride
Optional		object
Input for user preference override configuration in a memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration.userPreferenceOverride.consolidation
Optional		object
Input for user preference override consolidation configuration in a memory
strategy.
memoryStrategies.[].customMemoryStrategy.configuration.userPreferenceOverride.consolidation.appendToPrompt
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.userPreferenceOverride.consolidation.modelID
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.userPreferenceOverride.extraction
Optional		object
Input for user preference override extraction configuration in a memory strategy.
memoryStrategies.[].customMemoryStrategy.configuration.userPreferenceOverride.extraction.appendToPrompt
Optional		string
memoryStrategies.[].customMemoryStrategy.configuration.userPreferenceOverride.extraction.modelID
Optional		string
memoryStrategies.[].customMemoryStrategy.description
Optional		string
memoryStrategies.[].customMemoryStrategy.name
Optional		string
memoryStrategies.[].customMemoryStrategy.namespaceTemplates
Optional		array
memoryStrategies.[].customMemoryStrategy.namespaceTemplates.[]
Required		string
memoryStrategies.[].customMemoryStrategy.namespaces.[]
Required		string
memoryStrategies.[].episodicMemoryStrategy.description
Optional		string
memoryStrategies.[].episodicMemoryStrategy.name
Optional		string
memoryStrategies.[].episodicMemoryStrategy.namespaceTemplates
Optional		array
memoryStrategies.[].episodicMemoryStrategy.namespaceTemplates.[]
Required		string
memoryStrategies.[].episodicMemoryStrategy.namespaces.[]
Required		string
memoryStrategies.[].episodicMemoryStrategy.reflectionConfiguration.namespaceTemplates
Optional		array
memoryStrategies.[].episodicMemoryStrategy.reflectionConfiguration.namespaceTemplates.[]
Required		string
memoryStrategies.[].episodicMemoryStrategy.reflectionConfiguration.namespaces.[]
Required		string
memoryStrategies.[].semanticMemoryStrategy.description
Optional		string
memoryStrategies.[].semanticMemoryStrategy.name
Optional		string
memoryStrategies.[].semanticMemoryStrategy.namespaceTemplates
Optional		array
memoryStrategies.[].semanticMemoryStrategy.namespaceTemplates.[]
Required		string
memoryStrategies.[].semanticMemoryStrategy.namespaces.[]
Required		string
memoryStrategies.[].summaryMemoryStrategy.description
Optional		string
memoryStrategies.[].summaryMemoryStrategy.name
Optional		string
memoryStrategies.[].summaryMemoryStrategy.namespaceTemplates
Optional		array
memoryStrategies.[].summaryMemoryStrategy.namespaceTemplates.[]
Required		string
memoryStrategies.[].summaryMemoryStrategy.namespaces.[]
Required		string
memoryStrategies.[].userPreferenceMemoryStrategy.description
Optional		string
memoryStrategies.[].userPreferenceMemoryStrategy.name
Optional		string
memoryStrategies.[].userPreferenceMemoryStrategy.namespaceTemplates
Optional		array
memoryStrategies.[].userPreferenceMemoryStrategy.namespaceTemplates.[]
Required		string
memoryStrategies.[].userPreferenceMemoryStrategy.namespaces.[]
Required		string
streamDeliveryResources
Optional		object
Configuration for streaming memory record data to external resources.
streamDeliveryResources.resources
Optional		array
streamDeliveryResources.resources.[]
Required		object
Supported stream delivery resource types.
streamDeliveryResources.resources.[].kinesis.contentConfigurations
Optional		array
streamDeliveryResources.resources.[].kinesis.contentConfigurations.[]
Required		object
Defines what content to stream and at what level of detail.
**streamDeliveryResources.resources.[].kinesis.contentConfigurations.[].type_**
Optional		string
streamDeliveryResources.resources.[].kinesis.dataStreamARN
Optional		string
tags
Optional		object
A map of tag keys and values to assign to an AgentCore Memory. Tags enable
you to categorize your resources in different ways, for example, by purpose,
owner, or environment.

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  partition: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdAt: string
failureReason: string
id: string
status: string
strategies:
- createdAt: string
  name: string
  status: string
  strategyID: string
  type_: string
  updatedAt: string
updatedAt: string
FieldDescription
ackResourceMetadata
Optional		object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource
ackResourceMetadata.arn
Optional		string
ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an “adopted” resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR’s Spec field values.
https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required		string
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
ackResourceMetadata.partition
Optional		string
Partition is the AWS partition in which the resource exists or will exist
ackResourceMetadata.region
Required		string
Region is the AWS region in which the resource exists or will exist.
conditions
Optional		array
All CRs managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource
conditions.[]
Required		object
Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message
Optional		string
A human readable message indicating details about the transition.
conditions.[].reason
Optional		string
The reason for the condition’s last transition.
conditions.[].status
Optional		string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional		string
Type is the type of the Condition
createdAt
Optional		string
The timestamp when the memory was created.
failureReason
Optional		string
The reason for failure if the memory is in a failed state.
id
Optional		string
The unique identifier of the memory.

Regex Pattern: ^[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$
status
Optional		string
The current status of the memory.
strategies
Optional		array
The list of memory strategies associated with this memory.
strategies.[]
Required		object
Contains information about a memory strategy.
strategies.[].name
Optional		string
strategies.[].status
Optional		string
strategies.[].strategyID
Optional		string
**strategies.[].type_**
Optional		string
strategies.[].updatedAt
Optional		string
updatedAt
Optional		string
The timestamp when the memory was last updated.