CfnMemory

class aws_cdk.aws_bedrockagentcore.CfnMemory(scope, id, *, event_expiry_duration, name, description=None, encryption_key_arn=None, memory_execution_role_arn=None, memory_strategies=None, tags=None)

Bases: CfnResource

Memory allows AI agents to maintain both immediate and long-term knowledge, enabling context-aware and personalized interactions.

For more information about using Memory in Amazon Bedrock AgentCore, see Host agent or tools with Amazon Bedrock AgentCore Memory .

See the Properties section below for descriptions of both the required and optional properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html
CloudformationResource:: AWS::BedrockAgentCore::Memory
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

cfn_memory = bedrockagentcore.CfnMemory(self, "MyCfnMemory",
    event_expiry_duration=123,
    name="name",

    # the properties below are optional
    description="description",
    encryption_key_arn="encryptionKeyArn",
    memory_execution_role_arn="memoryExecutionRoleArn",
    memory_strategies=[bedrockagentcore.CfnMemory.MemoryStrategyProperty(
        custom_memory_strategy=bedrockagentcore.CfnMemory.CustomMemoryStrategyProperty(
            name="name",

            # the properties below are optional
            configuration=bedrockagentcore.CfnMemory.CustomConfigurationInputProperty(
                self_managed_configuration=bedrockagentcore.CfnMemory.SelfManagedConfigurationProperty(
                    historical_context_window_size=123,
                    invocation_configuration=bedrockagentcore.CfnMemory.InvocationConfigurationInputProperty(
                        payload_delivery_bucket_name="payloadDeliveryBucketName",
                        topic_arn="topicArn"
                    ),
                    trigger_conditions=[bedrockagentcore.CfnMemory.TriggerConditionInputProperty(
                        message_based_trigger=bedrockagentcore.CfnMemory.MessageBasedTriggerInputProperty(
                            message_count=123
                        ),
                        time_based_trigger=bedrockagentcore.CfnMemory.TimeBasedTriggerInputProperty(
                            idle_session_timeout=123
                        ),
                        token_based_trigger=bedrockagentcore.CfnMemory.TokenBasedTriggerInputProperty(
                            token_count=123
                        )
                    )]
                ),
                semantic_override=bedrockagentcore.CfnMemory.SemanticOverrideProperty(
                    consolidation=bedrockagentcore.CfnMemory.SemanticOverrideConsolidationConfigurationInputProperty(
                        append_to_prompt="appendToPrompt",
                        model_id="modelId"
                    ),
                    extraction=bedrockagentcore.CfnMemory.SemanticOverrideExtractionConfigurationInputProperty(
                        append_to_prompt="appendToPrompt",
                        model_id="modelId"
                    )
                ),
                summary_override=bedrockagentcore.CfnMemory.SummaryOverrideProperty(
                    consolidation=bedrockagentcore.CfnMemory.SummaryOverrideConsolidationConfigurationInputProperty(
                        append_to_prompt="appendToPrompt",
                        model_id="modelId"
                    )
                ),
                user_preference_override=bedrockagentcore.CfnMemory.UserPreferenceOverrideProperty(
                    consolidation=bedrockagentcore.CfnMemory.UserPreferenceOverrideConsolidationConfigurationInputProperty(
                        append_to_prompt="appendToPrompt",
                        model_id="modelId"
                    ),
                    extraction=bedrockagentcore.CfnMemory.UserPreferenceOverrideExtractionConfigurationInputProperty(
                        append_to_prompt="appendToPrompt",
                        model_id="modelId"
                    )
                )
            ),
            created_at="createdAt",
            description="description",
            namespaces=["namespaces"],
            status="status",
            strategy_id="strategyId",
            type="type",
            updated_at="updatedAt"
        ),
        semantic_memory_strategy=bedrockagentcore.CfnMemory.SemanticMemoryStrategyProperty(
            name="name",

            # the properties below are optional
            created_at="createdAt",
            description="description",
            namespaces=["namespaces"],
            status="status",
            strategy_id="strategyId",
            type="type",
            updated_at="updatedAt"
        ),
        summary_memory_strategy=bedrockagentcore.CfnMemory.SummaryMemoryStrategyProperty(
            name="name",

            # the properties below are optional
            created_at="createdAt",
            description="description",
            namespaces=["namespaces"],
            status="status",
            strategy_id="strategyId",
            type="type",
            updated_at="updatedAt"
        ),
        user_preference_memory_strategy=bedrockagentcore.CfnMemory.UserPreferenceMemoryStrategyProperty(
            name="name",

            # the properties below are optional
            created_at="createdAt",
            description="description",
            namespaces=["namespaces"],
            status="status",
            strategy_id="strategyId",
            type="type",
            updated_at="updatedAt"
        )
    )],
    tags={
        "tags_key": "tags"
    }
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
event_expiry_duration (Union[int, float]) – The event expiry configuration.
name (str) – The memory name.
description (Optional[str]) – Description of the Memory resource.
encryption_key_arn (Optional[str]) – The memory encryption key Amazon Resource Name (ARN).
memory_execution_role_arn (Optional[str]) – The memory role ARN.
memory_strategies (Union[IResolvable, Sequence[Union[IResolvable, MemoryStrategyProperty, Dict[str, Any]]], None]) – The memory strategies.
tags (Optional[Mapping[str, str]]) – The tags for the resources.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::BedrockAgentCore::Memory'

attr_created_at

The timestamp when the memory record was created.

CloudformationAttribute:: CreatedAt

attr_failure_reason

FailureReason

Type:: cloudformationAttribute

attr_memory_arn

ARN of the Memory resource.

CloudformationAttribute:: MemoryArn

attr_memory_id

The memory ID.

CloudformationAttribute:: MemoryId

attr_status

The memory status.

CloudformationAttribute:: Status

attr_updated_at

UpdatedAt

Type:: cloudformationAttribute

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description: Description of the Memory resource.

encryption_key_arn: The memory encryption key Amazon Resource Name (ARN).

event_expiry_duration: The event expiry configuration.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

memory_execution_role_arn: The memory role ARN.

memory_ref: A reference to a Memory resource.

memory_strategies: The memory strategies.

name: The memory name.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: The tags for the resources.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

CustomConfigurationInputProperty

class CfnMemory.CustomConfigurationInputProperty(*, self_managed_configuration=None, semantic_override=None, summary_override=None, user_preference_override=None)

Bases: object

The memory configuration input.

Parameters:

self_managed_configuration (Union[IResolvable, SelfManagedConfigurationProperty, Dict[str, Any], None]) – The custom configuration input.
semantic_override (Union[IResolvable, SemanticOverrideProperty, Dict[str, Any], None]) – The memory override configuration.
summary_override (Union[IResolvable, SummaryOverrideProperty, Dict[str, Any], None]) – The memory configuration override.
user_preference_override (Union[IResolvable, UserPreferenceOverrideProperty, Dict[str, Any], None]) – The memory user preference override.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

custom_configuration_input_property = bedrockagentcore.CfnMemory.CustomConfigurationInputProperty(
    self_managed_configuration=bedrockagentcore.CfnMemory.SelfManagedConfigurationProperty(
        historical_context_window_size=123,
        invocation_configuration=bedrockagentcore.CfnMemory.InvocationConfigurationInputProperty(
            payload_delivery_bucket_name="payloadDeliveryBucketName",
            topic_arn="topicArn"
        ),
        trigger_conditions=[bedrockagentcore.CfnMemory.TriggerConditionInputProperty(
            message_based_trigger=bedrockagentcore.CfnMemory.MessageBasedTriggerInputProperty(
                message_count=123
            ),
            time_based_trigger=bedrockagentcore.CfnMemory.TimeBasedTriggerInputProperty(
                idle_session_timeout=123
            ),
            token_based_trigger=bedrockagentcore.CfnMemory.TokenBasedTriggerInputProperty(
                token_count=123
            )
        )]
    ),
    semantic_override=bedrockagentcore.CfnMemory.SemanticOverrideProperty(
        consolidation=bedrockagentcore.CfnMemory.SemanticOverrideConsolidationConfigurationInputProperty(
            append_to_prompt="appendToPrompt",
            model_id="modelId"
        ),
        extraction=bedrockagentcore.CfnMemory.SemanticOverrideExtractionConfigurationInputProperty(
            append_to_prompt="appendToPrompt",
            model_id="modelId"
        )
    ),
    summary_override=bedrockagentcore.CfnMemory.SummaryOverrideProperty(
        consolidation=bedrockagentcore.CfnMemory.SummaryOverrideConsolidationConfigurationInputProperty(
            append_to_prompt="appendToPrompt",
            model_id="modelId"
        )
    ),
    user_preference_override=bedrockagentcore.CfnMemory.UserPreferenceOverrideProperty(
        consolidation=bedrockagentcore.CfnMemory.UserPreferenceOverrideConsolidationConfigurationInputProperty(
            append_to_prompt="appendToPrompt",
            model_id="modelId"
        ),
        extraction=bedrockagentcore.CfnMemory.UserPreferenceOverrideExtractionConfigurationInputProperty(
            append_to_prompt="appendToPrompt",
            model_id="modelId"
        )
    )
)

Attributes

self_managed_configuration

The custom configuration input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-selfmanagedconfiguration

semantic_override

The memory override configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-semanticoverride

summary_override

The memory configuration override.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-summaryoverride

user_preference_override

The memory user preference override.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-customconfigurationinput.html#cfn-bedrockagentcore-memory-customconfigurationinput-userpreferenceoverride

CustomMemoryStrategyProperty

class CfnMemory.CustomMemoryStrategyProperty(*, name, configuration=None, created_at=None, description=None, namespaces=None, status=None, strategy_id=None, type=None, updated_at=None)

Bases: object

The memory strategy.

Parameters:

name (str) – The memory strategy name.
configuration (Union[IResolvable, CustomConfigurationInputProperty, Dict[str, Any], None]) – The memory strategy configuration.
created_at (Optional[str]) – Creation timestamp of the memory strategy.
description (Optional[str]) – The memory strategy description.
namespaces (Optional[Sequence[str]]) – The memory strategy namespaces.
status (Optional[str]) – The memory strategy status.
strategy_id (Optional[str]) – The memory strategy ID.
type (Optional[str]) – The memory strategy type.
updated_at (Optional[str]) – The memory strategy update date and time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

custom_memory_strategy_property = bedrockagentcore.CfnMemory.CustomMemoryStrategyProperty(
    name="name",

    # the properties below are optional
    configuration=bedrockagentcore.CfnMemory.CustomConfigurationInputProperty(
        self_managed_configuration=bedrockagentcore.CfnMemory.SelfManagedConfigurationProperty(
            historical_context_window_size=123,
            invocation_configuration=bedrockagentcore.CfnMemory.InvocationConfigurationInputProperty(
                payload_delivery_bucket_name="payloadDeliveryBucketName",
                topic_arn="topicArn"
            ),
            trigger_conditions=[bedrockagentcore.CfnMemory.TriggerConditionInputProperty(
                message_based_trigger=bedrockagentcore.CfnMemory.MessageBasedTriggerInputProperty(
                    message_count=123
                ),
                time_based_trigger=bedrockagentcore.CfnMemory.TimeBasedTriggerInputProperty(
                    idle_session_timeout=123
                ),
                token_based_trigger=bedrockagentcore.CfnMemory.TokenBasedTriggerInputProperty(
                    token_count=123
                )
            )]
        ),
        semantic_override=bedrockagentcore.CfnMemory.SemanticOverrideProperty(
            consolidation=bedrockagentcore.CfnMemory.SemanticOverrideConsolidationConfigurationInputProperty(
                append_to_prompt="appendToPrompt",
                model_id="modelId"
            ),
            extraction=bedrockagentcore.CfnMemory.SemanticOverrideExtractionConfigurationInputProperty(
                append_to_prompt="appendToPrompt",
                model_id="modelId"
            )
        ),
        summary_override=bedrockagentcore.CfnMemory.SummaryOverrideProperty(
            consolidation=bedrockagentcore.CfnMemory.SummaryOverrideConsolidationConfigurationInputProperty(
                append_to_prompt="appendToPrompt",
                model_id="modelId"
            )
        ),
        user_preference_override=bedrockagentcore.CfnMemory.UserPreferenceOverrideProperty(
            consolidation=bedrockagentcore.CfnMemory.UserPreferenceOverrideConsolidationConfigurationInputProperty(
                append_to_prompt="appendToPrompt",
                model_id="modelId"
            ),
            extraction=bedrockagentcore.CfnMemory.UserPreferenceOverrideExtractionConfigurationInputProperty(
                append_to_prompt="appendToPrompt",
                model_id="modelId"
            )
        )
    ),
    created_at="createdAt",
    description="description",
    namespaces=["namespaces"],
    status="status",
    strategy_id="strategyId",
    type="type",
    updated_at="updatedAt"
)

Attributes

configuration

The memory strategy configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-configuration

created_at

Creation timestamp of the memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-createdat

description

The memory strategy description.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-description

name

The memory strategy name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-name

namespaces

The memory strategy namespaces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-namespaces

status

The memory strategy status.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-status

strategy_id

The memory strategy ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-strategyid

type

The memory strategy type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-type

updated_at

The memory strategy update date and time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-custommemorystrategy.html#cfn-bedrockagentcore-memory-custommemorystrategy-updatedat

InvocationConfigurationInputProperty

class CfnMemory.InvocationConfigurationInputProperty(*, payload_delivery_bucket_name=None, topic_arn=None)

Bases: object

The memory invocation configuration input.

Parameters:

payload_delivery_bucket_name (Optional[str]) – The message invocation configuration information for the bucket name.
topic_arn (Optional[str]) – The memory trigger condition topic Amazon Resource Name (ARN).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-invocationconfigurationinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

invocation_configuration_input_property = bedrockagentcore.CfnMemory.InvocationConfigurationInputProperty(
    payload_delivery_bucket_name="payloadDeliveryBucketName",
    topic_arn="topicArn"
)

Attributes

payload_delivery_bucket_name

The message invocation configuration information for the bucket name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-invocationconfigurationinput.html#cfn-bedrockagentcore-memory-invocationconfigurationinput-payloaddeliverybucketname

topic_arn

The memory trigger condition topic Amazon Resource Name (ARN).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-invocationconfigurationinput.html#cfn-bedrockagentcore-memory-invocationconfigurationinput-topicarn

MemoryStrategyProperty

class CfnMemory.MemoryStrategyProperty(*, custom_memory_strategy=None, semantic_memory_strategy=None, summary_memory_strategy=None, user_preference_memory_strategy=None)

Bases: object

The memory strategy.

Parameters:

custom_memory_strategy (Union[IResolvable, CustomMemoryStrategyProperty, Dict[str, Any], None]) – The memory strategy.
semantic_memory_strategy (Union[IResolvable, SemanticMemoryStrategyProperty, Dict[str, Any], None]) – The memory strategy.
summary_memory_strategy (Union[IResolvable, SummaryMemoryStrategyProperty, Dict[str, Any], None]) – The memory strategy summary.
user_preference_memory_strategy (Union[IResolvable, UserPreferenceMemoryStrategyProperty, Dict[str, Any], None]) – The memory strategy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

memory_strategy_property = bedrockagentcore.CfnMemory.MemoryStrategyProperty(
    custom_memory_strategy=bedrockagentcore.CfnMemory.CustomMemoryStrategyProperty(
        name="name",

        # the properties below are optional
        configuration=bedrockagentcore.CfnMemory.CustomConfigurationInputProperty(
            self_managed_configuration=bedrockagentcore.CfnMemory.SelfManagedConfigurationProperty(
                historical_context_window_size=123,
                invocation_configuration=bedrockagentcore.CfnMemory.InvocationConfigurationInputProperty(
                    payload_delivery_bucket_name="payloadDeliveryBucketName",
                    topic_arn="topicArn"
                ),
                trigger_conditions=[bedrockagentcore.CfnMemory.TriggerConditionInputProperty(
                    message_based_trigger=bedrockagentcore.CfnMemory.MessageBasedTriggerInputProperty(
                        message_count=123
                    ),
                    time_based_trigger=bedrockagentcore.CfnMemory.TimeBasedTriggerInputProperty(
                        idle_session_timeout=123
                    ),
                    token_based_trigger=bedrockagentcore.CfnMemory.TokenBasedTriggerInputProperty(
                        token_count=123
                    )
                )]
            ),
            semantic_override=bedrockagentcore.CfnMemory.SemanticOverrideProperty(
                consolidation=bedrockagentcore.CfnMemory.SemanticOverrideConsolidationConfigurationInputProperty(
                    append_to_prompt="appendToPrompt",
                    model_id="modelId"
                ),
                extraction=bedrockagentcore.CfnMemory.SemanticOverrideExtractionConfigurationInputProperty(
                    append_to_prompt="appendToPrompt",
                    model_id="modelId"
                )
            ),
            summary_override=bedrockagentcore.CfnMemory.SummaryOverrideProperty(
                consolidation=bedrockagentcore.CfnMemory.SummaryOverrideConsolidationConfigurationInputProperty(
                    append_to_prompt="appendToPrompt",
                    model_id="modelId"
                )
            ),
            user_preference_override=bedrockagentcore.CfnMemory.UserPreferenceOverrideProperty(
                consolidation=bedrockagentcore.CfnMemory.UserPreferenceOverrideConsolidationConfigurationInputProperty(
                    append_to_prompt="appendToPrompt",
                    model_id="modelId"
                ),
                extraction=bedrockagentcore.CfnMemory.UserPreferenceOverrideExtractionConfigurationInputProperty(
                    append_to_prompt="appendToPrompt",
                    model_id="modelId"
                )
            )
        ),
        created_at="createdAt",
        description="description",
        namespaces=["namespaces"],
        status="status",
        strategy_id="strategyId",
        type="type",
        updated_at="updatedAt"
    ),
    semantic_memory_strategy=bedrockagentcore.CfnMemory.SemanticMemoryStrategyProperty(
        name="name",

        # the properties below are optional
        created_at="createdAt",
        description="description",
        namespaces=["namespaces"],
        status="status",
        strategy_id="strategyId",
        type="type",
        updated_at="updatedAt"
    ),
    summary_memory_strategy=bedrockagentcore.CfnMemory.SummaryMemoryStrategyProperty(
        name="name",

        # the properties below are optional
        created_at="createdAt",
        description="description",
        namespaces=["namespaces"],
        status="status",
        strategy_id="strategyId",
        type="type",
        updated_at="updatedAt"
    ),
    user_preference_memory_strategy=bedrockagentcore.CfnMemory.UserPreferenceMemoryStrategyProperty(
        name="name",

        # the properties below are optional
        created_at="createdAt",
        description="description",
        namespaces=["namespaces"],
        status="status",
        strategy_id="strategyId",
        type="type",
        updated_at="updatedAt"
    )
)

Attributes

custom_memory_strategy

The memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-custommemorystrategy

semantic_memory_strategy

The memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-semanticmemorystrategy

summary_memory_strategy

The memory strategy summary.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-summarymemorystrategy

user_preference_memory_strategy

The memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-memorystrategy.html#cfn-bedrockagentcore-memory-memorystrategy-userpreferencememorystrategy

MessageBasedTriggerInputProperty

class CfnMemory.MessageBasedTriggerInputProperty(*, message_count=None)

Bases: object

The message based trigger input.

Parameters:: message_count (Union[int, float, None]) – The memory trigger condition input for the message based trigger message count.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-messagebasedtriggerinput.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

message_based_trigger_input_property = bedrockagentcore.CfnMemory.MessageBasedTriggerInputProperty(
    message_count=123
)

Attributes

message_count

The memory trigger condition input for the message based trigger message count.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-messagebasedtriggerinput.html#cfn-bedrockagentcore-memory-messagebasedtriggerinput-messagecount

SelfManagedConfigurationProperty

class CfnMemory.SelfManagedConfigurationProperty(*, historical_context_window_size=None, invocation_configuration=None, trigger_conditions=None)

Bases: object

The self managed configuration.

Parameters:

historical_context_window_size (Union[int, float, None]) – The memory configuration for self managed.
invocation_configuration (Union[IResolvable, InvocationConfigurationInputProperty, Dict[str, Any], None]) – The self managed configuration.
trigger_conditions (Union[IResolvable, Sequence[Union[IResolvable, TriggerConditionInputProperty, Dict[str, Any]]], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

self_managed_configuration_property = bedrockagentcore.CfnMemory.SelfManagedConfigurationProperty(
    historical_context_window_size=123,
    invocation_configuration=bedrockagentcore.CfnMemory.InvocationConfigurationInputProperty(
        payload_delivery_bucket_name="payloadDeliveryBucketName",
        topic_arn="topicArn"
    ),
    trigger_conditions=[bedrockagentcore.CfnMemory.TriggerConditionInputProperty(
        message_based_trigger=bedrockagentcore.CfnMemory.MessageBasedTriggerInputProperty(
            message_count=123
        ),
        time_based_trigger=bedrockagentcore.CfnMemory.TimeBasedTriggerInputProperty(
            idle_session_timeout=123
        ),
        token_based_trigger=bedrockagentcore.CfnMemory.TokenBasedTriggerInputProperty(
            token_count=123
        )
    )]
)

Attributes

historical_context_window_size

The memory configuration for self managed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html#cfn-bedrockagentcore-memory-selfmanagedconfiguration-historicalcontextwindowsize

invocation_configuration

The self managed configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html#cfn-bedrockagentcore-memory-selfmanagedconfiguration-invocationconfiguration

trigger_conditions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-selfmanagedconfiguration.html#cfn-bedrockagentcore-memory-selfmanagedconfiguration-triggerconditions

Type:: see

SemanticMemoryStrategyProperty

class CfnMemory.SemanticMemoryStrategyProperty(*, name, created_at=None, description=None, namespaces=None, status=None, strategy_id=None, type=None, updated_at=None)

Bases: object

The memory strategy.

Parameters:

name (str) – The memory strategy name.
created_at (Optional[str]) – Creation timestamp of the memory strategy.
description (Optional[str]) – The memory strategy description.
namespaces (Optional[Sequence[str]]) – The memory strategy namespaces.
status (Optional[str]) – Status of the memory strategy.
strategy_id (Optional[str]) – The memory strategy ID.
type (Optional[str]) – The memory strategy type.
updated_at (Optional[str]) – Last update timestamp of the memory strategy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

semantic_memory_strategy_property = bedrockagentcore.CfnMemory.SemanticMemoryStrategyProperty(
    name="name",

    # the properties below are optional
    created_at="createdAt",
    description="description",
    namespaces=["namespaces"],
    status="status",
    strategy_id="strategyId",
    type="type",
    updated_at="updatedAt"
)

Attributes

created_at

Creation timestamp of the memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-createdat

description

The memory strategy description.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-description

name

The memory strategy name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-name

namespaces

The memory strategy namespaces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-namespaces

status

Status of the memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-status

strategy_id

The memory strategy ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-strategyid

type

The memory strategy type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-type

updated_at

Last update timestamp of the memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticmemorystrategy.html#cfn-bedrockagentcore-memory-semanticmemorystrategy-updatedat

SemanticOverrideConsolidationConfigurationInputProperty

class CfnMemory.SemanticOverrideConsolidationConfigurationInputProperty(*, append_to_prompt, model_id)

Bases: object

The memory override configuration.

Parameters:

append_to_prompt (str) – The override configuration.
model_id (str) – The memory override model ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

semantic_override_consolidation_configuration_input_property = bedrockagentcore.CfnMemory.SemanticOverrideConsolidationConfigurationInputProperty(
    append_to_prompt="appendToPrompt",
    model_id="modelId"
)

Attributes

append_to_prompt

The override configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-appendtoprompt

model_id

The memory override model ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideconsolidationconfigurationinput-modelid

SemanticOverrideExtractionConfigurationInputProperty

class CfnMemory.SemanticOverrideExtractionConfigurationInputProperty(*, append_to_prompt, model_id)

Bases: object

The memory override configuration.

Parameters:

append_to_prompt (str) – The extraction configuration.
model_id (str) – The memory override configuration model ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

semantic_override_extraction_configuration_input_property = bedrockagentcore.CfnMemory.SemanticOverrideExtractionConfigurationInputProperty(
    append_to_prompt="appendToPrompt",
    model_id="modelId"
)

Attributes

append_to_prompt

The extraction configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-appendtoprompt

model_id

The memory override configuration model ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-semanticoverrideextractionconfigurationinput-modelid

SemanticOverrideProperty

class CfnMemory.SemanticOverrideProperty(*, consolidation=None, extraction=None)

Bases: object

The memory override.

Parameters:

consolidation (Union[IResolvable, SemanticOverrideConsolidationConfigurationInputProperty, Dict[str, Any], None]) – The memory override consolidation.
extraction (Union[IResolvable, SemanticOverrideExtractionConfigurationInputProperty, Dict[str, Any], None]) – The memory override extraction.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverride.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

semantic_override_property = bedrockagentcore.CfnMemory.SemanticOverrideProperty(
    consolidation=bedrockagentcore.CfnMemory.SemanticOverrideConsolidationConfigurationInputProperty(
        append_to_prompt="appendToPrompt",
        model_id="modelId"
    ),
    extraction=bedrockagentcore.CfnMemory.SemanticOverrideExtractionConfigurationInputProperty(
        append_to_prompt="appendToPrompt",
        model_id="modelId"
    )
)

Attributes

consolidation

The memory override consolidation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverride.html#cfn-bedrockagentcore-memory-semanticoverride-consolidation

extraction

The memory override extraction.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-semanticoverride.html#cfn-bedrockagentcore-memory-semanticoverride-extraction

SummaryMemoryStrategyProperty

class CfnMemory.SummaryMemoryStrategyProperty(*, name, created_at=None, description=None, namespaces=None, status=None, strategy_id=None, type=None, updated_at=None)

Bases: object

The memory strategy.

Parameters:

name (str) – The memory strategy name.
created_at (Optional[str]) – Creation timestamp of the memory strategy.
description (Optional[str]) – The memory strategy description.
namespaces (Optional[Sequence[str]]) – The summary memory strategy.
status (Optional[str]) – The memory strategy status.
strategy_id (Optional[str]) – The memory strategy ID.
type (Optional[str]) – The memory strategy type.
updated_at (Optional[str]) – The memory strategy update date and time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

summary_memory_strategy_property = bedrockagentcore.CfnMemory.SummaryMemoryStrategyProperty(
    name="name",

    # the properties below are optional
    created_at="createdAt",
    description="description",
    namespaces=["namespaces"],
    status="status",
    strategy_id="strategyId",
    type="type",
    updated_at="updatedAt"
)

Attributes

created_at

Creation timestamp of the memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-createdat

description

The memory strategy description.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-description

name

The memory strategy name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-name

namespaces

The summary memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-namespaces

status

The memory strategy status.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-status

strategy_id

The memory strategy ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-strategyid

type

The memory strategy type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-type

updated_at

The memory strategy update date and time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summarymemorystrategy.html#cfn-bedrockagentcore-memory-summarymemorystrategy-updatedat

SummaryOverrideConsolidationConfigurationInputProperty

class CfnMemory.SummaryOverrideConsolidationConfigurationInputProperty(*, append_to_prompt, model_id)

Bases: object

The consolidation configuration.

Parameters:

append_to_prompt (str) – The memory override configuration.
model_id (str) – The memory override configuration model ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

summary_override_consolidation_configuration_input_property = bedrockagentcore.CfnMemory.SummaryOverrideConsolidationConfigurationInputProperty(
    append_to_prompt="appendToPrompt",
    model_id="modelId"
)

Attributes

append_to_prompt

The memory override configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-appendtoprompt

model_id

The memory override configuration model ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-summaryoverrideconsolidationconfigurationinput-modelid

SummaryOverrideProperty

class CfnMemory.SummaryOverrideProperty(*, consolidation=None)

Bases: object

The memory summary override.

Parameters:: consolidation (Union[IResolvable, SummaryOverrideConsolidationConfigurationInputProperty, Dict[str, Any], None]) – The memory override consolidation.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverride.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

summary_override_property = bedrockagentcore.CfnMemory.SummaryOverrideProperty(
    consolidation=bedrockagentcore.CfnMemory.SummaryOverrideConsolidationConfigurationInputProperty(
        append_to_prompt="appendToPrompt",
        model_id="modelId"
    )
)

Attributes

consolidation

The memory override consolidation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-summaryoverride.html#cfn-bedrockagentcore-memory-summaryoverride-consolidation

TimeBasedTriggerInputProperty

class CfnMemory.TimeBasedTriggerInputProperty(*, idle_session_timeout=None)

Bases: object

The memory trigger condition input for the time based trigger.

Parameters:: idle_session_timeout (Union[int, float, None]) – The memory trigger condition input for the session timeout.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-timebasedtriggerinput.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

time_based_trigger_input_property = bedrockagentcore.CfnMemory.TimeBasedTriggerInputProperty(
    idle_session_timeout=123
)

Attributes

idle_session_timeout

The memory trigger condition input for the session timeout.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-timebasedtriggerinput.html#cfn-bedrockagentcore-memory-timebasedtriggerinput-idlesessiontimeout

TokenBasedTriggerInputProperty

class CfnMemory.TokenBasedTriggerInputProperty(*, token_count=None)

Bases: object

The token based trigger input.

Parameters:: token_count (Union[int, float, None]) – The token based trigger token count.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

token_based_trigger_input_property = bedrockagentcore.CfnMemory.TokenBasedTriggerInputProperty(
    token_count=123
)

Attributes

token_count

The token based trigger token count.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-tokenbasedtriggerinput.html#cfn-bedrockagentcore-memory-tokenbasedtriggerinput-tokencount

TriggerConditionInputProperty

class CfnMemory.TriggerConditionInputProperty(*, message_based_trigger=None, time_based_trigger=None, token_based_trigger=None)

Bases: object

The memory trigger condition input.

Parameters:

message_based_trigger (Union[IResolvable, MessageBasedTriggerInputProperty, Dict[str, Any], None]) – The memory trigger condition input for the message based trigger.
time_based_trigger (Union[IResolvable, TimeBasedTriggerInputProperty, Dict[str, Any], None]) – The memory trigger condition input.
token_based_trigger (Union[IResolvable, TokenBasedTriggerInputProperty, Dict[str, Any], None]) – The trigger condition information for a token based trigger.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

trigger_condition_input_property = bedrockagentcore.CfnMemory.TriggerConditionInputProperty(
    message_based_trigger=bedrockagentcore.CfnMemory.MessageBasedTriggerInputProperty(
        message_count=123
    ),
    time_based_trigger=bedrockagentcore.CfnMemory.TimeBasedTriggerInputProperty(
        idle_session_timeout=123
    ),
    token_based_trigger=bedrockagentcore.CfnMemory.TokenBasedTriggerInputProperty(
        token_count=123
    )
)

Attributes

message_based_trigger

The memory trigger condition input for the message based trigger.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html#cfn-bedrockagentcore-memory-triggerconditioninput-messagebasedtrigger

time_based_trigger

The memory trigger condition input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html#cfn-bedrockagentcore-memory-triggerconditioninput-timebasedtrigger

token_based_trigger

The trigger condition information for a token based trigger.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-triggerconditioninput.html#cfn-bedrockagentcore-memory-triggerconditioninput-tokenbasedtrigger

UserPreferenceMemoryStrategyProperty

class CfnMemory.UserPreferenceMemoryStrategyProperty(*, name, created_at=None, description=None, namespaces=None, status=None, strategy_id=None, type=None, updated_at=None)

Bases: object

The memory strategy.

Parameters:

name (str) – The memory strategy name.
created_at (Optional[str]) – Creation timestamp of the memory strategy.
description (Optional[str]) – The memory strategy description.
namespaces (Optional[Sequence[str]]) – The memory namespaces.
status (Optional[str]) – The memory strategy status.
strategy_id (Optional[str]) – The memory strategy ID.
type (Optional[str]) – The memory strategy type.
updated_at (Optional[str]) – The memory strategy update date and time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

user_preference_memory_strategy_property = bedrockagentcore.CfnMemory.UserPreferenceMemoryStrategyProperty(
    name="name",

    # the properties below are optional
    created_at="createdAt",
    description="description",
    namespaces=["namespaces"],
    status="status",
    strategy_id="strategyId",
    type="type",
    updated_at="updatedAt"
)

Attributes

created_at

Creation timestamp of the memory strategy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-createdat

description

The memory strategy description.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-description

name

The memory strategy name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-name

namespaces

The memory namespaces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-namespaces

status

The memory strategy status.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-status

strategy_id

The memory strategy ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-strategyid

type

The memory strategy type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-type

updated_at

The memory strategy update date and time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferencememorystrategy.html#cfn-bedrockagentcore-memory-userpreferencememorystrategy-updatedat

UserPreferenceOverrideConsolidationConfigurationInputProperty

class CfnMemory.UserPreferenceOverrideConsolidationConfigurationInputProperty(*, append_to_prompt, model_id)

Bases: object

The configuration input.

Parameters:

append_to_prompt (str) – The memory configuration.
model_id (str) – The memory override configuration model ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

user_preference_override_consolidation_configuration_input_property = bedrockagentcore.CfnMemory.UserPreferenceOverrideConsolidationConfigurationInputProperty(
    append_to_prompt="appendToPrompt",
    model_id="modelId"
)

Attributes

append_to_prompt

The memory configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-appendtoprompt

model_id

The memory override configuration model ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideconsolidationconfigurationinput-modelid

UserPreferenceOverrideExtractionConfigurationInputProperty

class CfnMemory.UserPreferenceOverrideExtractionConfigurationInputProperty(*, append_to_prompt, model_id)

Bases: object

The memory override configuration.

Parameters:

append_to_prompt (str) – The extraction configuration.
model_id (str) – The memory override for the model ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

user_preference_override_extraction_configuration_input_property = bedrockagentcore.CfnMemory.UserPreferenceOverrideExtractionConfigurationInputProperty(
    append_to_prompt="appendToPrompt",
    model_id="modelId"
)

Attributes

append_to_prompt

The extraction configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-appendtoprompt

model_id

The memory override for the model ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput.html#cfn-bedrockagentcore-memory-userpreferenceoverrideextractionconfigurationinput-modelid

UserPreferenceOverrideProperty

class CfnMemory.UserPreferenceOverrideProperty(*, consolidation=None, extraction=None)

Bases: object

The memory user preference override.

Parameters:

consolidation (Union[IResolvable, UserPreferenceOverrideConsolidationConfigurationInputProperty, Dict[str, Any], None]) – The memory override consolidation information.
extraction (Union[IResolvable, UserPreferenceOverrideExtractionConfigurationInputProperty, Dict[str, Any], None]) – The memory user preferences for extraction.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverride.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

user_preference_override_property = bedrockagentcore.CfnMemory.UserPreferenceOverrideProperty(
    consolidation=bedrockagentcore.CfnMemory.UserPreferenceOverrideConsolidationConfigurationInputProperty(
        append_to_prompt="appendToPrompt",
        model_id="modelId"
    ),
    extraction=bedrockagentcore.CfnMemory.UserPreferenceOverrideExtractionConfigurationInputProperty(
        append_to_prompt="appendToPrompt",
        model_id="modelId"
    )
)

Attributes

consolidation

The memory override consolidation information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverride.html#cfn-bedrockagentcore-memory-userpreferenceoverride-consolidation

extraction

The memory user preferences for extraction.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-memory-userpreferenceoverride.html#cfn-bedrockagentcore-memory-userpreferenceoverride-extraction