feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming#531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Hweinstock merged 3 commits into from
Apr 8, 2026
Merged

feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming #531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
505cb43
feat: add streamDeliveryResources schema, CLI flags, and validation f…
Hweinstock Mar 10, 2026
8202106
fix: address review feedback on streaming support
Hweinstock Apr 6, 2026
98d1212
fix: update create-memory test for strict strategy validation
Hweinstock Apr 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions docs/memory.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -222,6 +222,66 @@ Memory events expire after a configurable duration (7-365 days, default 30):
}
```

## Memory Record Streaming

Memory record streaming delivers real-time events when memory records are created, updated, or deleted. Events are
pushed to a delivery target in your account, enabling event-driven architectures without polling.

### Enabling Streaming

Via CLI flags:

```bash
agentcore add memory \
--name MyMemory \
--strategies SEMANTIC \
--data-stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/my-stream \
--stream-content-level FULL_CONTENT
```

For advanced configurations (e.g. multiple delivery targets), pass the full JSON:

```bash
agentcore add memory \
--name MyMemory \
--strategies SEMANTIC \
--stream-delivery-resources '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/my-stream","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}'
```

### Configuration

```json
{
"type": "AgentCoreMemory",
"name": "MyMemory",
"eventExpiryDuration": 30,
"strategies": [{ "type": "SEMANTIC" }],
"streamDeliveryResources": {
"resources": [
{
"kinesis": {
"dataStreamArn": "arn:aws:kinesis:us-west-2:123456789012:stream/my-stream",
"contentConfigurations": [{ "type": "MEMORY_RECORDS", "level": "FULL_CONTENT" }]
}
}
]
}
}
```

### Content Level

| Level | Description |
| --------------- | ---------------------------------------------------------- |
| `FULL_CONTENT` | Events include memory record text and all metadata |
| `METADATA_ONLY` | Events include only metadata (IDs, timestamps, namespaces) |

The CDK construct automatically grants the memory execution role permission to publish to the configured delivery
target.

For more details, see the
[Memory Record Streaming documentation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-record-streaming.html).

## Using Memory in Code

The memory ID is available via environment variable:
Expand Down
113 changes: 113 additions & 0 deletions src/cli/commands/add/__tests__/validate.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -994,6 +994,119 @@ describe('validate', () => {
valid: true,
});
});

// Streaming validation
it('accepts valid streaming options', () => {
expect(
validateAddMemoryOptions({
...validMemoryOptions,
dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
contentLevel: 'FULL_CONTENT',
})
).toEqual({ valid: true });
});

it('accepts dataStreamArn without contentLevel (defaults to FULL_CONTENT)', () => {
expect(
validateAddMemoryOptions({
...validMemoryOptions,
dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
})
).toEqual({ valid: true });
});

it('rejects contentLevel without dataStreamArn', () => {
const result = validateAddMemoryOptions({ ...validMemoryOptions, contentLevel: 'FULL_CONTENT' });
expect(result.valid).toBe(false);
expect(result.error).toContain('--data-stream-arn is required');
});

it('rejects invalid contentLevel', () => {
const result = validateAddMemoryOptions({
...validMemoryOptions,
dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
contentLevel: 'INVALID',
});
expect(result.valid).toBe(false);
expect(result.error).toContain('Invalid content level');
});

it('rejects invalid deliveryType', () => {
const result = validateAddMemoryOptions({
...validMemoryOptions,
dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
deliveryType: 'sqs',
});
expect(result.valid).toBe(false);
expect(result.error).toContain('Invalid delivery type');
});

it('accepts valid deliveryType', () => {
expect(
validateAddMemoryOptions({
...validMemoryOptions,
dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
deliveryType: 'kinesis',
})
).toEqual({ valid: true });
});

it('rejects dataStreamArn not starting with arn:', () => {
const result = validateAddMemoryOptions({
...validMemoryOptions,
dataStreamArn: 'not-an-arn',
});
expect(result.valid).toBe(false);
expect(result.error).toContain('valid ARN');
});

it('rejects combining streamDeliveryResources with flat flags', () => {
const result = validateAddMemoryOptions({
...validMemoryOptions,
dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
streamDeliveryResources: '{"resources":[]}',
});
expect(result.valid).toBe(false);
expect(result.error).toContain('cannot be combined');
});

it('rejects combining streamDeliveryResources with deliveryType', () => {
const result = validateAddMemoryOptions({
...validMemoryOptions,
deliveryType: 'kinesis',
streamDeliveryResources:
'{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/test","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}',
});
expect(result.valid).toBe(false);
expect(result.error).toContain('cannot be combined');
});

it('rejects deliveryType without dataStreamArn', () => {
const result = validateAddMemoryOptions({
...validMemoryOptions,
deliveryType: 'kinesis',
});
expect(result.valid).toBe(false);
expect(result.error).toContain('--data-stream-arn is required');
});

it('rejects invalid streamDeliveryResources JSON', () => {
const result = validateAddMemoryOptions({
...validMemoryOptions,
streamDeliveryResources: 'not json',
});
expect(result.valid).toBe(false);
expect(result.error).toContain('Invalid JSON');
});

it('rejects streamDeliveryResources that fails schema validation', () => {
const result = validateAddMemoryOptions({
...validMemoryOptions,
streamDeliveryResources: '{"resources":[]}',
});
expect(result.valid).toBe(false);
expect(result.error).toContain('does not match the expected schema');
});
});

describe('validateAddCredentialOptions', () => {
Expand Down
4 changes: 4 additions & 0 deletions src/cli/commands/add/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,10 @@ export interface AddMemoryOptions {
name?: string;
strategies?: string;
expiry?: number;
deliveryType?: string;
dataStreamArn?: string;
contentLevel?: string;
streamDeliveryResources?: string;
json?: boolean;
}

Expand Down
55 changes: 55 additions & 0 deletions src/cli/commands/add/validate.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
ProtocolModeSchema,
RuntimeAuthorizerTypeSchema,
SDKFrameworkSchema,
StreamDeliveryResourcesSchema,
TARGET_TYPE_AUTH_CONFIG,
TargetLanguageSchema,
getSupportedFrameworksForProtocol,
Expand DownExpand Up@@ -35,6 +36,9 @@ export interface ValidationResult {
// Constants
const MEMORY_OPTIONS = ['none', 'shortTerm', 'longAndShortTerm'] as const;
const VALID_STRATEGIES = ['SEMANTIC', 'SUMMARIZATION', 'USER_PREFERENCE', 'EPISODIC'];
const VALID_STREAM_CONTENT_LEVELS = ['FULL_CONTENT', 'METADATA_ONLY'];
const VALID_DELIVERY_TYPES = ['kinesis'] as const;
export const DEFAULT_DELIVERY_TYPE = 'kinesis';

/**
* Validate that a credential name exists in the project spec.
Expand DownExpand Up@@ -677,6 +681,57 @@ export function validateAddMemoryOptions(options: AddMemoryOptions): ValidationR
}
}

if (options.streamDeliveryResources && (options.dataStreamArn || options.contentLevel || options.deliveryType)) {
return {
valid: false,
error:
'--stream-delivery-resources cannot be combined with --data-stream-arn, --stream-content-level, or --delivery-type',
};
}

if (options.contentLevel && !options.dataStreamArn) {
return { valid: false, error: '--data-stream-arn is required when --stream-content-level is set' };
}

if (options.deliveryType && !options.dataStreamArn) {
return { valid: false, error: '--data-stream-arn is required when --delivery-type is set' };
}

if (options.dataStreamArn && !options.dataStreamArn.startsWith('arn:')) {
return { valid: false, error: '--data-stream-arn must be a valid ARN (starts with arn:)' };
}

if (
options.deliveryType &&
!VALID_DELIVERY_TYPES.includes(options.deliveryType as (typeof VALID_DELIVERY_TYPES)[number])
) {
return {
valid: false,
error: `Invalid delivery type. Must be one of: ${VALID_DELIVERY_TYPES.join(', ')}`,
};
}

if (options.contentLevel && !VALID_STREAM_CONTENT_LEVELS.includes(options.contentLevel)) {
return {
valid: false,
error: `Invalid content level. Must be one of: ${VALID_STREAM_CONTENT_LEVELS.join(', ')}`,
};
}

if (options.streamDeliveryResources) {
try {
StreamDeliveryResourcesSchema.parse(JSON.parse(options.streamDeliveryResources));
} catch (e) {
return {
valid: false,
error:
e instanceof SyntaxError
? 'Invalid JSON in --stream-delivery-resources'
: 'Invalid --stream-delivery-resources: does not match the expected schema',
};
}
}

return { valid: true };
}

Expand Down
10 changes: 4 additions & 6 deletions src/cli/operations/memory/__tests__/create-memory.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,20 +76,18 @@ describe('add', () => {
expect(addedMemory.strategies[0]!.namespaces).toEqual(['/users/{actorId}/facts']);
});

it('creates memory with strategy without default namespaces', async () => {
it('rejects invalid strategy type', async () => {
const project = makeProject([]);
mockReadProjectSpec.mockResolvedValue(project);
mockWriteProjectSpec.mockResolvedValue(undefined);

await primitive.add({
const result = await primitive.add({
name: 'NewMem',
strategies: 'CUSTOM',
expiry: 30,
});

const writtenSpec = mockWriteProjectSpec.mock.calls[0]![0];
const addedMemory = writtenSpec.memories.find((m: { name: string }) => m.name === 'NewMem');
expect(addedMemory.strategies[0]!.namespaces).toBeUndefined();
expect(result).toEqual(expect.objectContaining({ success: false, error: expect.any(String) }));
expect(mockWriteProjectSpec).not.toHaveBeenCalled();
});

it('returns error on duplicate memory name', async () => {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming#531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Hweinstock
merged 3 commits into

from

Apr 8, 2026
 Merged


feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming
#531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
505cb43

feat: add streamDeliveryResources schema, CLI flags, and validation f…


Hweinstock Mar 10, 2026
8202106

fix: address review feedback on streaming support


Hweinstock Apr 6, 2026
98d1212

fix: update create-memory test for strict strategy validation


Hweinstock Apr 6, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


60 changes: 60 additions & 0 deletions
docs/memory.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,6 +222,66 @@ Memory events expire after a configurable duration (7-365 days, default 30):
}
```

## Memory Record Streaming

Memory record streaming delivers real-time events when memory records are created, updated, or deleted. Events are
pushed to a delivery target in your account, enabling event-driven architectures without polling.

### Enabling Streaming

Via CLI flags:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --data-stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/my-stream \
 --stream-content-level FULL_CONTENT
```

For advanced configurations (e.g. multiple delivery targets), pass the full JSON:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --stream-delivery-resources '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/my-stream","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}'
```

### Configuration

```json
{
 "type": "AgentCoreMemory",
 "name": "MyMemory",
 "eventExpiryDuration": 30,
 "strategies": [{ "type": "SEMANTIC" }],
 "streamDeliveryResources": {
 "resources": [
 {
 "kinesis": {
 "dataStreamArn": "arn:aws:kinesis:us-west-2:123456789012:stream/my-stream",
 "contentConfigurations": [{ "type": "MEMORY_RECORDS", "level": "FULL_CONTENT" }]
 }
 }
 ]
 }
}
```

### Content Level

| Level | Description |
| --------------- | ---------------------------------------------------------- |
| `FULL_CONTENT` | Events include memory record text and all metadata |
| `METADATA_ONLY` | Events include only metadata (IDs, timestamps, namespaces) |

The CDK construct automatically grants the memory execution role permission to publish to the configured delivery
target.

For more details, see the
[Memory Record Streaming documentation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-record-streaming.html).

## Using Memory in Code

The memory ID is available via environment variable:
Expand Down

113 changes: 113 additions & 0 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -994,6 +994,119 @@ describe('validate', () => {
 valid: true,
 });
 });

 // Streaming validation
 it('accepts valid streaming options', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'FULL_CONTENT',
 })
 ).toEqual({ valid: true });
 });

 it('accepts dataStreamArn without contentLevel (defaults to FULL_CONTENT)', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 })
 ).toEqual({ valid: true });
 });

 it('rejects contentLevel without dataStreamArn', () => {
 const result = validateAddMemoryOptions({ ...validMemoryOptions, contentLevel: 'FULL_CONTENT' });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid contentLevel', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'INVALID',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid content level');
 });

 it('rejects invalid deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'sqs',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid delivery type');
 });

 it('accepts valid deliveryType', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'kinesis',
 })
 ).toEqual({ valid: true });
 });

 it('rejects dataStreamArn not starting with arn:', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'not-an-arn',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('valid ARN');
 });

 it('rejects combining streamDeliveryResources with flat flags', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects combining streamDeliveryResources with deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 streamDeliveryResources:
 '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/test","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects deliveryType without dataStreamArn', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid streamDeliveryResources JSON', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid JSON');
 });

 it('rejects streamDeliveryResources that fails schema validation', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('does not match the expected schema');
 });
 });

 describe('validateAddCredentialOptions', () => {
Expand Down

4 changes: 4 additions & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,10 @@ export interface AddMemoryOptions {
 name?: string;
 strategies?: string;
 expiry?: number;
 deliveryType?: string;
 dataStreamArn?: string;
 contentLevel?: string;
 streamDeliveryResources?: string;
 json?: boolean;
}

Expand Down

55 changes: 55 additions & 0 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
 ProtocolModeSchema,
 RuntimeAuthorizerTypeSchema,
 SDKFrameworkSchema,
 StreamDeliveryResourcesSchema,
 TARGET_TYPE_AUTH_CONFIG,
 TargetLanguageSchema,
 getSupportedFrameworksForProtocol,
Expand DownExpand Up@@ -35,6 +36,9 @@ export interface ValidationResult {
// Constants
const MEMORY_OPTIONS = ['none', 'shortTerm', 'longAndShortTerm'] as const;
const VALID_STRATEGIES = ['SEMANTIC', 'SUMMARIZATION', 'USER_PREFERENCE', 'EPISODIC'];
const VALID_STREAM_CONTENT_LEVELS = ['FULL_CONTENT', 'METADATA_ONLY'];
const VALID_DELIVERY_TYPES = ['kinesis'] as const;
export const DEFAULT_DELIVERY_TYPE = 'kinesis';

/**
 * Validate that a credential name exists in the project spec.
Expand DownExpand Up@@ -677,6 +681,57 @@ export function validateAddMemoryOptions(options: AddMemoryOptions): ValidationR
 }
 }

 if (options.streamDeliveryResources && (options.dataStreamArn || options.contentLevel || options.deliveryType)) {
 return {
 valid: false,
 error:
 '--stream-delivery-resources cannot be combined with --data-stream-arn, --stream-content-level, or --delivery-type',
 };
 }

 if (options.contentLevel && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --stream-content-level is set' };
 }

 if (options.deliveryType && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --delivery-type is set' };
 }

 if (options.dataStreamArn && !options.dataStreamArn.startsWith('arn:')) {
 return { valid: false, error: '--data-stream-arn must be a valid ARN (starts with arn:)' };
 }

 if (
 options.deliveryType &&
 !VALID_DELIVERY_TYPES.includes(options.deliveryType as (typeof VALID_DELIVERY_TYPES)[number])
 ) {
 return {
 valid: false,
 error: `Invalid delivery type. Must be one of: ${VALID_DELIVERY_TYPES.join(', ')}`,
 };
 }

 if (options.contentLevel && !VALID_STREAM_CONTENT_LEVELS.includes(options.contentLevel)) {
 return {
 valid: false,
 error: `Invalid content level. Must be one of: ${VALID_STREAM_CONTENT_LEVELS.join(', ')}`,
 };
 }

 if (options.streamDeliveryResources) {
 try {
 StreamDeliveryResourcesSchema.parse(JSON.parse(options.streamDeliveryResources));
 } catch (e) {
 return {
 valid: false,
 error:
 e instanceof SyntaxError
 ? 'Invalid JSON in --stream-delivery-resources'
 : 'Invalid --stream-delivery-resources: does not match the expected schema',
 };
 }
 }

 return { valid: true };
}

Expand Down

10 changes: 4 additions & 6 deletions
src/cli/operations/memory/__tests__/create-memory.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,20 +76,18 @@ describe('add', () => {
 expect(addedMemory.strategies[0]!.namespaces).toEqual(['/users/{actorId}/facts']);
 });

 it('creates memory with strategy without default namespaces', async () => {
 it('rejects invalid strategy type', async () => {
 const project = makeProject([]);
 mockReadProjectSpec.mockResolvedValue(project);
 mockWriteProjectSpec.mockResolvedValue(undefined);

 await primitive.add({
const result = await primitive.add({
 name: 'NewMem',
 strategies: 'CUSTOM',
 expiry: 30,
 });

 const writtenSpec = mockWriteProjectSpec.mock.calls[0]![0];
 const addedMemory = writtenSpec.memories.find((m: { name: string }) => m.name === 'NewMem');
 expect(addedMemory.strategies[0]!.namespaces).toBeUndefined();
 expect(result).toEqual(expect.objectContaining({ success: false, error: expect.any(String) }));
 expect(mockWriteProjectSpec).not.toHaveBeenCalled();
 });

 it('returns error on duplicate memory name', async () => {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming#531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Hweinstock
merged 3 commits into

from

Apr 8, 2026
 Merged


feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming
#531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
505cb43

feat: add streamDeliveryResources schema, CLI flags, and validation f…


Hweinstock Mar 10, 2026
8202106

fix: address review feedback on streaming support


Hweinstock Apr 6, 2026
98d1212

fix: update create-memory test for strict strategy validation


Hweinstock Apr 6, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


60 changes: 60 additions & 0 deletions
docs/memory.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,6 +222,66 @@ Memory events expire after a configurable duration (7-365 days, default 30):
}
```

## Memory Record Streaming

Memory record streaming delivers real-time events when memory records are created, updated, or deleted. Events are
pushed to a delivery target in your account, enabling event-driven architectures without polling.

### Enabling Streaming

Via CLI flags:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --data-stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/my-stream \
 --stream-content-level FULL_CONTENT
```

For advanced configurations (e.g. multiple delivery targets), pass the full JSON:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --stream-delivery-resources '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/my-stream","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}'
```

### Configuration

```json
{
 "type": "AgentCoreMemory",
 "name": "MyMemory",
 "eventExpiryDuration": 30,
 "strategies": [{ "type": "SEMANTIC" }],
 "streamDeliveryResources": {
 "resources": [
 {
 "kinesis": {
 "dataStreamArn": "arn:aws:kinesis:us-west-2:123456789012:stream/my-stream",
 "contentConfigurations": [{ "type": "MEMORY_RECORDS", "level": "FULL_CONTENT" }]
 }
 }
 ]
 }
}
```

### Content Level

| Level | Description |
| --------------- | ---------------------------------------------------------- |
| `FULL_CONTENT` | Events include memory record text and all metadata |
| `METADATA_ONLY` | Events include only metadata (IDs, timestamps, namespaces) |

The CDK construct automatically grants the memory execution role permission to publish to the configured delivery
target.

For more details, see the
[Memory Record Streaming documentation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-record-streaming.html).

## Using Memory in Code

The memory ID is available via environment variable:
Expand Down

113 changes: 113 additions & 0 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -994,6 +994,119 @@ describe('validate', () => {
 valid: true,
 });
 });

 // Streaming validation
 it('accepts valid streaming options', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'FULL_CONTENT',
 })
 ).toEqual({ valid: true });
 });

 it('accepts dataStreamArn without contentLevel (defaults to FULL_CONTENT)', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 })
 ).toEqual({ valid: true });
 });

 it('rejects contentLevel without dataStreamArn', () => {
 const result = validateAddMemoryOptions({ ...validMemoryOptions, contentLevel: 'FULL_CONTENT' });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid contentLevel', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'INVALID',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid content level');
 });

 it('rejects invalid deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'sqs',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid delivery type');
 });

 it('accepts valid deliveryType', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'kinesis',
 })
 ).toEqual({ valid: true });
 });

 it('rejects dataStreamArn not starting with arn:', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'not-an-arn',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('valid ARN');
 });

 it('rejects combining streamDeliveryResources with flat flags', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects combining streamDeliveryResources with deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 streamDeliveryResources:
 '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/test","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects deliveryType without dataStreamArn', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid streamDeliveryResources JSON', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid JSON');
 });

 it('rejects streamDeliveryResources that fails schema validation', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('does not match the expected schema');
 });
 });

 describe('validateAddCredentialOptions', () => {
Expand Down

4 changes: 4 additions & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,10 @@ export interface AddMemoryOptions {
 name?: string;
 strategies?: string;
 expiry?: number;
 deliveryType?: string;
 dataStreamArn?: string;
 contentLevel?: string;
 streamDeliveryResources?: string;
 json?: boolean;
}

Expand Down

55 changes: 55 additions & 0 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
 ProtocolModeSchema,
 RuntimeAuthorizerTypeSchema,
 SDKFrameworkSchema,
 StreamDeliveryResourcesSchema,
 TARGET_TYPE_AUTH_CONFIG,
 TargetLanguageSchema,
 getSupportedFrameworksForProtocol,
Expand DownExpand Up@@ -35,6 +36,9 @@ export interface ValidationResult {
// Constants
const MEMORY_OPTIONS = ['none', 'shortTerm', 'longAndShortTerm'] as const;
const VALID_STRATEGIES = ['SEMANTIC', 'SUMMARIZATION', 'USER_PREFERENCE', 'EPISODIC'];
const VALID_STREAM_CONTENT_LEVELS = ['FULL_CONTENT', 'METADATA_ONLY'];
const VALID_DELIVERY_TYPES = ['kinesis'] as const;
export const DEFAULT_DELIVERY_TYPE = 'kinesis';

/**
 * Validate that a credential name exists in the project spec.
Expand DownExpand Up@@ -677,6 +681,57 @@ export function validateAddMemoryOptions(options: AddMemoryOptions): ValidationR
 }
 }

 if (options.streamDeliveryResources && (options.dataStreamArn || options.contentLevel || options.deliveryType)) {
 return {
 valid: false,
 error:
 '--stream-delivery-resources cannot be combined with --data-stream-arn, --stream-content-level, or --delivery-type',
 };
 }

 if (options.contentLevel && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --stream-content-level is set' };
 }

 if (options.deliveryType && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --delivery-type is set' };
 }

 if (options.dataStreamArn && !options.dataStreamArn.startsWith('arn:')) {
 return { valid: false, error: '--data-stream-arn must be a valid ARN (starts with arn:)' };
 }

 if (
 options.deliveryType &&
 !VALID_DELIVERY_TYPES.includes(options.deliveryType as (typeof VALID_DELIVERY_TYPES)[number])
 ) {
 return {
 valid: false,
 error: `Invalid delivery type. Must be one of: ${VALID_DELIVERY_TYPES.join(', ')}`,
 };
 }

 if (options.contentLevel && !VALID_STREAM_CONTENT_LEVELS.includes(options.contentLevel)) {
 return {
 valid: false,
 error: `Invalid content level. Must be one of: ${VALID_STREAM_CONTENT_LEVELS.join(', ')}`,
 };
 }

 if (options.streamDeliveryResources) {
 try {
 StreamDeliveryResourcesSchema.parse(JSON.parse(options.streamDeliveryResources));
 } catch (e) {
 return {
 valid: false,
 error:
 e instanceof SyntaxError
 ? 'Invalid JSON in --stream-delivery-resources'
 : 'Invalid --stream-delivery-resources: does not match the expected schema',
 };
 }
 }

 return { valid: true };
}

Expand Down

10 changes: 4 additions & 6 deletions
src/cli/operations/memory/__tests__/create-memory.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,20 +76,18 @@ describe('add', () => {
 expect(addedMemory.strategies[0]!.namespaces).toEqual(['/users/{actorId}/facts']);
 });

 it('creates memory with strategy without default namespaces', async () => {
 it('rejects invalid strategy type', async () => {
 const project = makeProject([]);
 mockReadProjectSpec.mockResolvedValue(project);
 mockWriteProjectSpec.mockResolvedValue(undefined);

 await primitive.add({
const result = await primitive.add({
 name: 'NewMem',
 strategies: 'CUSTOM',
 expiry: 30,
 });

 const writtenSpec = mockWriteProjectSpec.mock.calls[0]![0];
 const addedMemory = writtenSpec.memories.find((m: { name: string }) => m.name === 'NewMem');
 expect(addedMemory.strategies[0]!.namespaces).toBeUndefined();
 expect(result).toEqual(expect.objectContaining({ success: false, error: expect.any(String) }));
 expect(mockWriteProjectSpec).not.toHaveBeenCalled();
 });

 it('returns error on duplicate memory name', async () => {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming#531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Hweinstock
merged 3 commits into

from

Apr 8, 2026
 Merged


feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming
#531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
505cb43

feat: add streamDeliveryResources schema, CLI flags, and validation f…


Hweinstock Mar 10, 2026
8202106

fix: address review feedback on streaming support


Hweinstock Apr 6, 2026
98d1212

fix: update create-memory test for strict strategy validation


Hweinstock Apr 6, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


60 changes: 60 additions & 0 deletions
docs/memory.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,6 +222,66 @@ Memory events expire after a configurable duration (7-365 days, default 30):
}
```

## Memory Record Streaming

Memory record streaming delivers real-time events when memory records are created, updated, or deleted. Events are
pushed to a delivery target in your account, enabling event-driven architectures without polling.

### Enabling Streaming

Via CLI flags:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --data-stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/my-stream \
 --stream-content-level FULL_CONTENT
```

For advanced configurations (e.g. multiple delivery targets), pass the full JSON:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --stream-delivery-resources '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/my-stream","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}'
```

### Configuration

```json
{
 "type": "AgentCoreMemory",
 "name": "MyMemory",
 "eventExpiryDuration": 30,
 "strategies": [{ "type": "SEMANTIC" }],
 "streamDeliveryResources": {
 "resources": [
 {
 "kinesis": {
 "dataStreamArn": "arn:aws:kinesis:us-west-2:123456789012:stream/my-stream",
 "contentConfigurations": [{ "type": "MEMORY_RECORDS", "level": "FULL_CONTENT" }]
 }
 }
 ]
 }
}
```

### Content Level

| Level | Description |
| --------------- | ---------------------------------------------------------- |
| `FULL_CONTENT` | Events include memory record text and all metadata |
| `METADATA_ONLY` | Events include only metadata (IDs, timestamps, namespaces) |

The CDK construct automatically grants the memory execution role permission to publish to the configured delivery
target.

For more details, see the
[Memory Record Streaming documentation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-record-streaming.html).

## Using Memory in Code

The memory ID is available via environment variable:
Expand Down

113 changes: 113 additions & 0 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -994,6 +994,119 @@ describe('validate', () => {
 valid: true,
 });
 });

 // Streaming validation
 it('accepts valid streaming options', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'FULL_CONTENT',
 })
 ).toEqual({ valid: true });
 });

 it('accepts dataStreamArn without contentLevel (defaults to FULL_CONTENT)', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 })
 ).toEqual({ valid: true });
 });

 it('rejects contentLevel without dataStreamArn', () => {
 const result = validateAddMemoryOptions({ ...validMemoryOptions, contentLevel: 'FULL_CONTENT' });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid contentLevel', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'INVALID',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid content level');
 });

 it('rejects invalid deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'sqs',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid delivery type');
 });

 it('accepts valid deliveryType', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'kinesis',
 })
 ).toEqual({ valid: true });
 });

 it('rejects dataStreamArn not starting with arn:', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'not-an-arn',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('valid ARN');
 });

 it('rejects combining streamDeliveryResources with flat flags', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects combining streamDeliveryResources with deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 streamDeliveryResources:
 '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/test","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects deliveryType without dataStreamArn', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid streamDeliveryResources JSON', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid JSON');
 });

 it('rejects streamDeliveryResources that fails schema validation', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('does not match the expected schema');
 });
 });

 describe('validateAddCredentialOptions', () => {
Expand Down

4 changes: 4 additions & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,10 @@ export interface AddMemoryOptions {
 name?: string;
 strategies?: string;
 expiry?: number;
 deliveryType?: string;
 dataStreamArn?: string;
 contentLevel?: string;
 streamDeliveryResources?: string;
 json?: boolean;
}

Expand Down

55 changes: 55 additions & 0 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
 ProtocolModeSchema,
 RuntimeAuthorizerTypeSchema,
 SDKFrameworkSchema,
 StreamDeliveryResourcesSchema,
 TARGET_TYPE_AUTH_CONFIG,
 TargetLanguageSchema,
 getSupportedFrameworksForProtocol,
Expand DownExpand Up@@ -35,6 +36,9 @@ export interface ValidationResult {
// Constants
const MEMORY_OPTIONS = ['none', 'shortTerm', 'longAndShortTerm'] as const;
const VALID_STRATEGIES = ['SEMANTIC', 'SUMMARIZATION', 'USER_PREFERENCE', 'EPISODIC'];
const VALID_STREAM_CONTENT_LEVELS = ['FULL_CONTENT', 'METADATA_ONLY'];
const VALID_DELIVERY_TYPES = ['kinesis'] as const;
export const DEFAULT_DELIVERY_TYPE = 'kinesis';

/**
 * Validate that a credential name exists in the project spec.
Expand DownExpand Up@@ -677,6 +681,57 @@ export function validateAddMemoryOptions(options: AddMemoryOptions): ValidationR
 }
 }

 if (options.streamDeliveryResources && (options.dataStreamArn || options.contentLevel || options.deliveryType)) {
 return {
 valid: false,
 error:
 '--stream-delivery-resources cannot be combined with --data-stream-arn, --stream-content-level, or --delivery-type',
 };
 }

 if (options.contentLevel && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --stream-content-level is set' };
 }

 if (options.deliveryType && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --delivery-type is set' };
 }

 if (options.dataStreamArn && !options.dataStreamArn.startsWith('arn:')) {
 return { valid: false, error: '--data-stream-arn must be a valid ARN (starts with arn:)' };
 }

 if (
 options.deliveryType &&
 !VALID_DELIVERY_TYPES.includes(options.deliveryType as (typeof VALID_DELIVERY_TYPES)[number])
 ) {
 return {
 valid: false,
 error: `Invalid delivery type. Must be one of: ${VALID_DELIVERY_TYPES.join(', ')}`,
 };
 }

 if (options.contentLevel && !VALID_STREAM_CONTENT_LEVELS.includes(options.contentLevel)) {
 return {
 valid: false,
 error: `Invalid content level. Must be one of: ${VALID_STREAM_CONTENT_LEVELS.join(', ')}`,
 };
 }

 if (options.streamDeliveryResources) {
 try {
 StreamDeliveryResourcesSchema.parse(JSON.parse(options.streamDeliveryResources));
 } catch (e) {
 return {
 valid: false,
 error:
 e instanceof SyntaxError
 ? 'Invalid JSON in --stream-delivery-resources'
 : 'Invalid --stream-delivery-resources: does not match the expected schema',
 };
 }
 }

 return { valid: true };
}

Expand Down

10 changes: 4 additions & 6 deletions
src/cli/operations/memory/__tests__/create-memory.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,20 +76,18 @@ describe('add', () => {
 expect(addedMemory.strategies[0]!.namespaces).toEqual(['/users/{actorId}/facts']);
 });

 it('creates memory with strategy without default namespaces', async () => {
 it('rejects invalid strategy type', async () => {
 const project = makeProject([]);
 mockReadProjectSpec.mockResolvedValue(project);
 mockWriteProjectSpec.mockResolvedValue(undefined);

 await primitive.add({
const result = await primitive.add({
 name: 'NewMem',
 strategies: 'CUSTOM',
 expiry: 30,
 });

 const writtenSpec = mockWriteProjectSpec.mock.calls[0]![0];
 const addedMemory = writtenSpec.memories.find((m: { name: string }) => m.name === 'NewMem');
 expect(addedMemory.strategies[0]!.namespaces).toBeUndefined();
 expect(result).toEqual(expect.objectContaining({ success: false, error: expect.any(String) }));
 expect(mockWriteProjectSpec).not.toHaveBeenCalled();
 });

 it('returns error on duplicate memory name', async () => {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming#531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Hweinstock
merged 3 commits into

from

Apr 8, 2026
 Merged


feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming
#531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
505cb43

feat: add streamDeliveryResources schema, CLI flags, and validation f…


Hweinstock Mar 10, 2026
8202106

fix: address review feedback on streaming support


Hweinstock Apr 6, 2026
98d1212

fix: update create-memory test for strict strategy validation


Hweinstock Apr 6, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


60 changes: 60 additions & 0 deletions
docs/memory.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,6 +222,66 @@ Memory events expire after a configurable duration (7-365 days, default 30):
}
```

## Memory Record Streaming

Memory record streaming delivers real-time events when memory records are created, updated, or deleted. Events are
pushed to a delivery target in your account, enabling event-driven architectures without polling.

### Enabling Streaming

Via CLI flags:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --data-stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/my-stream \
 --stream-content-level FULL_CONTENT
```

For advanced configurations (e.g. multiple delivery targets), pass the full JSON:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --stream-delivery-resources '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/my-stream","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}'
```

### Configuration

```json
{
 "type": "AgentCoreMemory",
 "name": "MyMemory",
 "eventExpiryDuration": 30,
 "strategies": [{ "type": "SEMANTIC" }],
 "streamDeliveryResources": {
 "resources": [
 {
 "kinesis": {
 "dataStreamArn": "arn:aws:kinesis:us-west-2:123456789012:stream/my-stream",
 "contentConfigurations": [{ "type": "MEMORY_RECORDS", "level": "FULL_CONTENT" }]
 }
 }
 ]
 }
}
```

### Content Level

| Level | Description |
| --------------- | ---------------------------------------------------------- |
| `FULL_CONTENT` | Events include memory record text and all metadata |
| `METADATA_ONLY` | Events include only metadata (IDs, timestamps, namespaces) |

The CDK construct automatically grants the memory execution role permission to publish to the configured delivery
target.

For more details, see the
[Memory Record Streaming documentation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-record-streaming.html).

## Using Memory in Code

The memory ID is available via environment variable:
Expand Down

113 changes: 113 additions & 0 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -994,6 +994,119 @@ describe('validate', () => {
 valid: true,
 });
 });

 // Streaming validation
 it('accepts valid streaming options', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'FULL_CONTENT',
 })
 ).toEqual({ valid: true });
 });

 it('accepts dataStreamArn without contentLevel (defaults to FULL_CONTENT)', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 })
 ).toEqual({ valid: true });
 });

 it('rejects contentLevel without dataStreamArn', () => {
 const result = validateAddMemoryOptions({ ...validMemoryOptions, contentLevel: 'FULL_CONTENT' });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid contentLevel', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'INVALID',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid content level');
 });

 it('rejects invalid deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'sqs',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid delivery type');
 });

 it('accepts valid deliveryType', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'kinesis',
 })
 ).toEqual({ valid: true });
 });

 it('rejects dataStreamArn not starting with arn:', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'not-an-arn',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('valid ARN');
 });

 it('rejects combining streamDeliveryResources with flat flags', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects combining streamDeliveryResources with deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 streamDeliveryResources:
 '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/test","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects deliveryType without dataStreamArn', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid streamDeliveryResources JSON', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid JSON');
 });

 it('rejects streamDeliveryResources that fails schema validation', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('does not match the expected schema');
 });
 });

 describe('validateAddCredentialOptions', () => {
Expand Down

4 changes: 4 additions & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,10 @@ export interface AddMemoryOptions {
 name?: string;
 strategies?: string;
 expiry?: number;
 deliveryType?: string;
 dataStreamArn?: string;
 contentLevel?: string;
 streamDeliveryResources?: string;
 json?: boolean;
}

Expand Down

55 changes: 55 additions & 0 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
 ProtocolModeSchema,
 RuntimeAuthorizerTypeSchema,
 SDKFrameworkSchema,
 StreamDeliveryResourcesSchema,
 TARGET_TYPE_AUTH_CONFIG,
 TargetLanguageSchema,
 getSupportedFrameworksForProtocol,
Expand DownExpand Up@@ -35,6 +36,9 @@ export interface ValidationResult {
// Constants
const MEMORY_OPTIONS = ['none', 'shortTerm', 'longAndShortTerm'] as const;
const VALID_STRATEGIES = ['SEMANTIC', 'SUMMARIZATION', 'USER_PREFERENCE', 'EPISODIC'];
const VALID_STREAM_CONTENT_LEVELS = ['FULL_CONTENT', 'METADATA_ONLY'];
const VALID_DELIVERY_TYPES = ['kinesis'] as const;
export const DEFAULT_DELIVERY_TYPE = 'kinesis';

/**
 * Validate that a credential name exists in the project spec.
Expand DownExpand Up@@ -677,6 +681,57 @@ export function validateAddMemoryOptions(options: AddMemoryOptions): ValidationR
 }
 }

 if (options.streamDeliveryResources && (options.dataStreamArn || options.contentLevel || options.deliveryType)) {
 return {
 valid: false,
 error:
 '--stream-delivery-resources cannot be combined with --data-stream-arn, --stream-content-level, or --delivery-type',
 };
 }

 if (options.contentLevel && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --stream-content-level is set' };
 }

 if (options.deliveryType && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --delivery-type is set' };
 }

 if (options.dataStreamArn && !options.dataStreamArn.startsWith('arn:')) {
 return { valid: false, error: '--data-stream-arn must be a valid ARN (starts with arn:)' };
 }

 if (
 options.deliveryType &&
 !VALID_DELIVERY_TYPES.includes(options.deliveryType as (typeof VALID_DELIVERY_TYPES)[number])
 ) {
 return {
 valid: false,
 error: `Invalid delivery type. Must be one of: ${VALID_DELIVERY_TYPES.join(', ')}`,
 };
 }

 if (options.contentLevel && !VALID_STREAM_CONTENT_LEVELS.includes(options.contentLevel)) {
 return {
 valid: false,
 error: `Invalid content level. Must be one of: ${VALID_STREAM_CONTENT_LEVELS.join(', ')}`,
 };
 }

 if (options.streamDeliveryResources) {
 try {
 StreamDeliveryResourcesSchema.parse(JSON.parse(options.streamDeliveryResources));
 } catch (e) {
 return {
 valid: false,
 error:
 e instanceof SyntaxError
 ? 'Invalid JSON in --stream-delivery-resources'
 : 'Invalid --stream-delivery-resources: does not match the expected schema',
 };
 }
 }

 return { valid: true };
}

Expand Down

10 changes: 4 additions & 6 deletions
src/cli/operations/memory/__tests__/create-memory.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,20 +76,18 @@ describe('add', () => {
 expect(addedMemory.strategies[0]!.namespaces).toEqual(['/users/{actorId}/facts']);
 });

 it('creates memory with strategy without default namespaces', async () => {
 it('rejects invalid strategy type', async () => {
 const project = makeProject([]);
 mockReadProjectSpec.mockResolvedValue(project);
 mockWriteProjectSpec.mockResolvedValue(undefined);

 await primitive.add({
const result = await primitive.add({
 name: 'NewMem',
 strategies: 'CUSTOM',
 expiry: 30,
 });

 const writtenSpec = mockWriteProjectSpec.mock.calls[0]![0];
 const addedMemory = writtenSpec.memories.find((m: { name: string }) => m.name === 'NewMem');
 expect(addedMemory.strategies[0]!.namespaces).toBeUndefined();
 expect(result).toEqual(expect.objectContaining({ success: false, error: expect.any(String) }));
 expect(mockWriteProjectSpec).not.toHaveBeenCalled();
 });

 it('returns error on duplicate memory name', async () => {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming#531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Hweinstock
merged 3 commits into

from

Apr 8, 2026
 Merged


feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming
#531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
505cb43

feat: add streamDeliveryResources schema, CLI flags, and validation f…


Hweinstock Mar 10, 2026
8202106

fix: address review feedback on streaming support


Hweinstock Apr 6, 2026
98d1212

fix: update create-memory test for strict strategy validation


Hweinstock Apr 6, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


60 changes: 60 additions & 0 deletions
docs/memory.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,6 +222,66 @@ Memory events expire after a configurable duration (7-365 days, default 30):
}
```

## Memory Record Streaming

Memory record streaming delivers real-time events when memory records are created, updated, or deleted. Events are
pushed to a delivery target in your account, enabling event-driven architectures without polling.

### Enabling Streaming

Via CLI flags:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --data-stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/my-stream \
 --stream-content-level FULL_CONTENT
```

For advanced configurations (e.g. multiple delivery targets), pass the full JSON:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --stream-delivery-resources '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/my-stream","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}'
```

### Configuration

```json
{
 "type": "AgentCoreMemory",
 "name": "MyMemory",
 "eventExpiryDuration": 30,
 "strategies": [{ "type": "SEMANTIC" }],
 "streamDeliveryResources": {
 "resources": [
 {
 "kinesis": {
 "dataStreamArn": "arn:aws:kinesis:us-west-2:123456789012:stream/my-stream",
 "contentConfigurations": [{ "type": "MEMORY_RECORDS", "level": "FULL_CONTENT" }]
 }
 }
 ]
 }
}
```

### Content Level

| Level | Description |
| --------------- | ---------------------------------------------------------- |
| `FULL_CONTENT` | Events include memory record text and all metadata |
| `METADATA_ONLY` | Events include only metadata (IDs, timestamps, namespaces) |

The CDK construct automatically grants the memory execution role permission to publish to the configured delivery
target.

For more details, see the
[Memory Record Streaming documentation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-record-streaming.html).

## Using Memory in Code

The memory ID is available via environment variable:
Expand Down

113 changes: 113 additions & 0 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -994,6 +994,119 @@ describe('validate', () => {
 valid: true,
 });
 });

 // Streaming validation
 it('accepts valid streaming options', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'FULL_CONTENT',
 })
 ).toEqual({ valid: true });
 });

 it('accepts dataStreamArn without contentLevel (defaults to FULL_CONTENT)', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 })
 ).toEqual({ valid: true });
 });

 it('rejects contentLevel without dataStreamArn', () => {
 const result = validateAddMemoryOptions({ ...validMemoryOptions, contentLevel: 'FULL_CONTENT' });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid contentLevel', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'INVALID',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid content level');
 });

 it('rejects invalid deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'sqs',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid delivery type');
 });

 it('accepts valid deliveryType', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'kinesis',
 })
 ).toEqual({ valid: true });
 });

 it('rejects dataStreamArn not starting with arn:', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'not-an-arn',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('valid ARN');
 });

 it('rejects combining streamDeliveryResources with flat flags', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects combining streamDeliveryResources with deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 streamDeliveryResources:
 '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/test","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects deliveryType without dataStreamArn', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid streamDeliveryResources JSON', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid JSON');
 });

 it('rejects streamDeliveryResources that fails schema validation', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('does not match the expected schema');
 });
 });

 describe('validateAddCredentialOptions', () => {
Expand Down

4 changes: 4 additions & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,10 @@ export interface AddMemoryOptions {
 name?: string;
 strategies?: string;
 expiry?: number;
 deliveryType?: string;
 dataStreamArn?: string;
 contentLevel?: string;
 streamDeliveryResources?: string;
 json?: boolean;
}

Expand Down

55 changes: 55 additions & 0 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
 ProtocolModeSchema,
 RuntimeAuthorizerTypeSchema,
 SDKFrameworkSchema,
 StreamDeliveryResourcesSchema,
 TARGET_TYPE_AUTH_CONFIG,
 TargetLanguageSchema,
 getSupportedFrameworksForProtocol,
Expand DownExpand Up@@ -35,6 +36,9 @@ export interface ValidationResult {
// Constants
const MEMORY_OPTIONS = ['none', 'shortTerm', 'longAndShortTerm'] as const;
const VALID_STRATEGIES = ['SEMANTIC', 'SUMMARIZATION', 'USER_PREFERENCE', 'EPISODIC'];
const VALID_STREAM_CONTENT_LEVELS = ['FULL_CONTENT', 'METADATA_ONLY'];
const VALID_DELIVERY_TYPES = ['kinesis'] as const;
export const DEFAULT_DELIVERY_TYPE = 'kinesis';

/**
 * Validate that a credential name exists in the project spec.
Expand DownExpand Up@@ -677,6 +681,57 @@ export function validateAddMemoryOptions(options: AddMemoryOptions): ValidationR
 }
 }

 if (options.streamDeliveryResources && (options.dataStreamArn || options.contentLevel || options.deliveryType)) {
 return {
 valid: false,
 error:
 '--stream-delivery-resources cannot be combined with --data-stream-arn, --stream-content-level, or --delivery-type',
 };
 }

 if (options.contentLevel && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --stream-content-level is set' };
 }

 if (options.deliveryType && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --delivery-type is set' };
 }

 if (options.dataStreamArn && !options.dataStreamArn.startsWith('arn:')) {
 return { valid: false, error: '--data-stream-arn must be a valid ARN (starts with arn:)' };
 }

 if (
 options.deliveryType &&
 !VALID_DELIVERY_TYPES.includes(options.deliveryType as (typeof VALID_DELIVERY_TYPES)[number])
 ) {
 return {
 valid: false,
 error: `Invalid delivery type. Must be one of: ${VALID_DELIVERY_TYPES.join(', ')}`,
 };
 }

 if (options.contentLevel && !VALID_STREAM_CONTENT_LEVELS.includes(options.contentLevel)) {
 return {
 valid: false,
 error: `Invalid content level. Must be one of: ${VALID_STREAM_CONTENT_LEVELS.join(', ')}`,
 };
 }

 if (options.streamDeliveryResources) {
 try {
 StreamDeliveryResourcesSchema.parse(JSON.parse(options.streamDeliveryResources));
 } catch (e) {
 return {
 valid: false,
 error:
 e instanceof SyntaxError
 ? 'Invalid JSON in --stream-delivery-resources'
 : 'Invalid --stream-delivery-resources: does not match the expected schema',
 };
 }
 }

 return { valid: true };
}

Expand Down

10 changes: 4 additions & 6 deletions
src/cli/operations/memory/__tests__/create-memory.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,20 +76,18 @@ describe('add', () => {
 expect(addedMemory.strategies[0]!.namespaces).toEqual(['/users/{actorId}/facts']);
 });

 it('creates memory with strategy without default namespaces', async () => {
 it('rejects invalid strategy type', async () => {
 const project = makeProject([]);
 mockReadProjectSpec.mockResolvedValue(project);
 mockWriteProjectSpec.mockResolvedValue(undefined);

 await primitive.add({
const result = await primitive.add({
 name: 'NewMem',
 strategies: 'CUSTOM',
 expiry: 30,
 });

 const writtenSpec = mockWriteProjectSpec.mock.calls[0]![0];
 const addedMemory = writtenSpec.memories.find((m: { name: string }) => m.name === 'NewMem');
 expect(addedMemory.strategies[0]!.namespaces).toBeUndefined();
 expect(result).toEqual(expect.objectContaining({ success: false, error: expect.any(String) }));
 expect(mockWriteProjectSpec).not.toHaveBeenCalled();
 });

 it('returns error on duplicate memory name', async () => {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming#531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Hweinstock
merged 3 commits into

from

Apr 8, 2026
 Merged


feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming
#531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
505cb43

feat: add streamDeliveryResources schema, CLI flags, and validation f…


Hweinstock Mar 10, 2026
8202106

fix: address review feedback on streaming support


Hweinstock Apr 6, 2026
98d1212

fix: update create-memory test for strict strategy validation


Hweinstock Apr 6, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


60 changes: 60 additions & 0 deletions
docs/memory.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,6 +222,66 @@ Memory events expire after a configurable duration (7-365 days, default 30):
}
```

## Memory Record Streaming

Memory record streaming delivers real-time events when memory records are created, updated, or deleted. Events are
pushed to a delivery target in your account, enabling event-driven architectures without polling.

### Enabling Streaming

Via CLI flags:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --data-stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/my-stream \
 --stream-content-level FULL_CONTENT
```

For advanced configurations (e.g. multiple delivery targets), pass the full JSON:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --stream-delivery-resources '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/my-stream","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}'
```

### Configuration

```json
{
 "type": "AgentCoreMemory",
 "name": "MyMemory",
 "eventExpiryDuration": 30,
 "strategies": [{ "type": "SEMANTIC" }],
 "streamDeliveryResources": {
 "resources": [
 {
 "kinesis": {
 "dataStreamArn": "arn:aws:kinesis:us-west-2:123456789012:stream/my-stream",
 "contentConfigurations": [{ "type": "MEMORY_RECORDS", "level": "FULL_CONTENT" }]
 }
 }
 ]
 }
}
```

### Content Level

| Level | Description |
| --------------- | ---------------------------------------------------------- |
| `FULL_CONTENT` | Events include memory record text and all metadata |
| `METADATA_ONLY` | Events include only metadata (IDs, timestamps, namespaces) |

The CDK construct automatically grants the memory execution role permission to publish to the configured delivery
target.

For more details, see the
[Memory Record Streaming documentation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-record-streaming.html).

## Using Memory in Code

The memory ID is available via environment variable:
Expand Down

113 changes: 113 additions & 0 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -994,6 +994,119 @@ describe('validate', () => {
 valid: true,
 });
 });

 // Streaming validation
 it('accepts valid streaming options', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'FULL_CONTENT',
 })
 ).toEqual({ valid: true });
 });

 it('accepts dataStreamArn without contentLevel (defaults to FULL_CONTENT)', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 })
 ).toEqual({ valid: true });
 });

 it('rejects contentLevel without dataStreamArn', () => {
 const result = validateAddMemoryOptions({ ...validMemoryOptions, contentLevel: 'FULL_CONTENT' });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid contentLevel', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'INVALID',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid content level');
 });

 it('rejects invalid deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'sqs',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid delivery type');
 });

 it('accepts valid deliveryType', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'kinesis',
 })
 ).toEqual({ valid: true });
 });

 it('rejects dataStreamArn not starting with arn:', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'not-an-arn',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('valid ARN');
 });

 it('rejects combining streamDeliveryResources with flat flags', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects combining streamDeliveryResources with deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 streamDeliveryResources:
 '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/test","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects deliveryType without dataStreamArn', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid streamDeliveryResources JSON', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid JSON');
 });

 it('rejects streamDeliveryResources that fails schema validation', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('does not match the expected schema');
 });
 });

 describe('validateAddCredentialOptions', () => {
Expand Down

4 changes: 4 additions & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,10 @@ export interface AddMemoryOptions {
 name?: string;
 strategies?: string;
 expiry?: number;
 deliveryType?: string;
 dataStreamArn?: string;
 contentLevel?: string;
 streamDeliveryResources?: string;
 json?: boolean;
}

Expand Down

55 changes: 55 additions & 0 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
 ProtocolModeSchema,
 RuntimeAuthorizerTypeSchema,
 SDKFrameworkSchema,
 StreamDeliveryResourcesSchema,
 TARGET_TYPE_AUTH_CONFIG,
 TargetLanguageSchema,
 getSupportedFrameworksForProtocol,
Expand DownExpand Up@@ -35,6 +36,9 @@ export interface ValidationResult {
// Constants
const MEMORY_OPTIONS = ['none', 'shortTerm', 'longAndShortTerm'] as const;
const VALID_STRATEGIES = ['SEMANTIC', 'SUMMARIZATION', 'USER_PREFERENCE', 'EPISODIC'];
const VALID_STREAM_CONTENT_LEVELS = ['FULL_CONTENT', 'METADATA_ONLY'];
const VALID_DELIVERY_TYPES = ['kinesis'] as const;
export const DEFAULT_DELIVERY_TYPE = 'kinesis';

/**
 * Validate that a credential name exists in the project spec.
Expand DownExpand Up@@ -677,6 +681,57 @@ export function validateAddMemoryOptions(options: AddMemoryOptions): ValidationR
 }
 }

 if (options.streamDeliveryResources && (options.dataStreamArn || options.contentLevel || options.deliveryType)) {
 return {
 valid: false,
 error:
 '--stream-delivery-resources cannot be combined with --data-stream-arn, --stream-content-level, or --delivery-type',
 };
 }

 if (options.contentLevel && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --stream-content-level is set' };
 }

 if (options.deliveryType && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --delivery-type is set' };
 }

 if (options.dataStreamArn && !options.dataStreamArn.startsWith('arn:')) {
 return { valid: false, error: '--data-stream-arn must be a valid ARN (starts with arn:)' };
 }

 if (
 options.deliveryType &&
 !VALID_DELIVERY_TYPES.includes(options.deliveryType as (typeof VALID_DELIVERY_TYPES)[number])
 ) {
 return {
 valid: false,
 error: `Invalid delivery type. Must be one of: ${VALID_DELIVERY_TYPES.join(', ')}`,
 };
 }

 if (options.contentLevel && !VALID_STREAM_CONTENT_LEVELS.includes(options.contentLevel)) {
 return {
 valid: false,
 error: `Invalid content level. Must be one of: ${VALID_STREAM_CONTENT_LEVELS.join(', ')}`,
 };
 }

 if (options.streamDeliveryResources) {
 try {
 StreamDeliveryResourcesSchema.parse(JSON.parse(options.streamDeliveryResources));
 } catch (e) {
 return {
 valid: false,
 error:
 e instanceof SyntaxError
 ? 'Invalid JSON in --stream-delivery-resources'
 : 'Invalid --stream-delivery-resources: does not match the expected schema',
 };
 }
 }

 return { valid: true };
}

Expand Down

10 changes: 4 additions & 6 deletions
src/cli/operations/memory/__tests__/create-memory.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,20 +76,18 @@ describe('add', () => {
 expect(addedMemory.strategies[0]!.namespaces).toEqual(['/users/{actorId}/facts']);
 });

 it('creates memory with strategy without default namespaces', async () => {
 it('rejects invalid strategy type', async () => {
 const project = makeProject([]);
 mockReadProjectSpec.mockResolvedValue(project);
 mockWriteProjectSpec.mockResolvedValue(undefined);

 await primitive.add({
const result = await primitive.add({
 name: 'NewMem',
 strategies: 'CUSTOM',
 expiry: 30,
 });

 const writtenSpec = mockWriteProjectSpec.mock.calls[0]![0];
 const addedMemory = writtenSpec.memories.find((m: { name: string }) => m.name === 'NewMem');
 expect(addedMemory.strategies[0]!.namespaces).toBeUndefined();
 expect(result).toEqual(expect.objectContaining({ success: false, error: expect.any(String) }));
 expect(mockWriteProjectSpec).not.toHaveBeenCalled();
 });

 it('returns error on duplicate memory name', async () => {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming#531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Hweinstock
merged 3 commits into

from

Apr 8, 2026
 Merged


feat: add streamDeliveryResources schema, CLI flags, and validation for memory record streaming
#531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
505cb43

feat: add streamDeliveryResources schema, CLI flags, and validation f…


Hweinstock Mar 10, 2026
8202106

fix: address review feedback on streaming support


Hweinstock Apr 6, 2026
98d1212

fix: update create-memory test for strict strategy validation


Hweinstock Apr 6, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


60 changes: 60 additions & 0 deletions
docs/memory.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,6 +222,66 @@ Memory events expire after a configurable duration (7-365 days, default 30):
}
```

## Memory Record Streaming

Memory record streaming delivers real-time events when memory records are created, updated, or deleted. Events are
pushed to a delivery target in your account, enabling event-driven architectures without polling.

### Enabling Streaming

Via CLI flags:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --data-stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/my-stream \
 --stream-content-level FULL_CONTENT
```

For advanced configurations (e.g. multiple delivery targets), pass the full JSON:

```bash
agentcore add memory \
 --name MyMemory \
 --strategies SEMANTIC \
 --stream-delivery-resources '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/my-stream","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}'
```

### Configuration

```json
{
 "type": "AgentCoreMemory",
 "name": "MyMemory",
 "eventExpiryDuration": 30,
 "strategies": [{ "type": "SEMANTIC" }],
 "streamDeliveryResources": {
 "resources": [
 {
 "kinesis": {
 "dataStreamArn": "arn:aws:kinesis:us-west-2:123456789012:stream/my-stream",
 "contentConfigurations": [{ "type": "MEMORY_RECORDS", "level": "FULL_CONTENT" }]
 }
 }
 ]
 }
}
```

### Content Level

| Level | Description |
| --------------- | ---------------------------------------------------------- |
| `FULL_CONTENT` | Events include memory record text and all metadata |
| `METADATA_ONLY` | Events include only metadata (IDs, timestamps, namespaces) |

The CDK construct automatically grants the memory execution role permission to publish to the configured delivery
target.

For more details, see the
[Memory Record Streaming documentation](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/memory-record-streaming.html).

## Using Memory in Code

The memory ID is available via environment variable:
Expand Down

113 changes: 113 additions & 0 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -994,6 +994,119 @@ describe('validate', () => {
 valid: true,
 });
 });

 // Streaming validation
 it('accepts valid streaming options', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'FULL_CONTENT',
 })
 ).toEqual({ valid: true });
 });

 it('accepts dataStreamArn without contentLevel (defaults to FULL_CONTENT)', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 })
 ).toEqual({ valid: true });
 });

 it('rejects contentLevel without dataStreamArn', () => {
 const result = validateAddMemoryOptions({ ...validMemoryOptions, contentLevel: 'FULL_CONTENT' });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid contentLevel', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 contentLevel: 'INVALID',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid content level');
 });

 it('rejects invalid deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'sqs',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid delivery type');
 });

 it('accepts valid deliveryType', () => {
 expect(
 validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 deliveryType: 'kinesis',
 })
 ).toEqual({ valid: true });
 });

 it('rejects dataStreamArn not starting with arn:', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'not-an-arn',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('valid ARN');
 });

 it('rejects combining streamDeliveryResources with flat flags', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 dataStreamArn: 'arn:aws:kinesis:us-west-2:123456789012:stream/test',
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects combining streamDeliveryResources with deliveryType', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 streamDeliveryResources:
 '{"resources":[{"kinesis":{"dataStreamArn":"arn:aws:kinesis:us-west-2:123456789012:stream/test","contentConfigurations":[{"type":"MEMORY_RECORDS","level":"FULL_CONTENT"}]}}]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('cannot be combined');
 });

 it('rejects deliveryType without dataStreamArn', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 deliveryType: 'kinesis',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('--data-stream-arn is required');
 });

 it('rejects invalid streamDeliveryResources JSON', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid JSON');
 });

 it('rejects streamDeliveryResources that fails schema validation', () => {
 const result = validateAddMemoryOptions({
 ...validMemoryOptions,
 streamDeliveryResources: '{"resources":[]}',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('does not match the expected schema');
 });
 });

 describe('validateAddCredentialOptions', () => {
Expand Down

4 changes: 4 additions & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -109,6 +109,10 @@ export interface AddMemoryOptions {
 name?: string;
 strategies?: string;
 expiry?: number;
 deliveryType?: string;
 dataStreamArn?: string;
 contentLevel?: string;
 streamDeliveryResources?: string;
 json?: boolean;
}

Expand Down

55 changes: 55 additions & 0 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import {
 ProtocolModeSchema,
 RuntimeAuthorizerTypeSchema,
 SDKFrameworkSchema,
 StreamDeliveryResourcesSchema,
 TARGET_TYPE_AUTH_CONFIG,
 TargetLanguageSchema,
 getSupportedFrameworksForProtocol,
Expand DownExpand Up@@ -35,6 +36,9 @@ export interface ValidationResult {
// Constants
const MEMORY_OPTIONS = ['none', 'shortTerm', 'longAndShortTerm'] as const;
const VALID_STRATEGIES = ['SEMANTIC', 'SUMMARIZATION', 'USER_PREFERENCE', 'EPISODIC'];
const VALID_STREAM_CONTENT_LEVELS = ['FULL_CONTENT', 'METADATA_ONLY'];
const VALID_DELIVERY_TYPES = ['kinesis'] as const;
export const DEFAULT_DELIVERY_TYPE = 'kinesis';

/**
 * Validate that a credential name exists in the project spec.
Expand DownExpand Up@@ -677,6 +681,57 @@ export function validateAddMemoryOptions(options: AddMemoryOptions): ValidationR
 }
 }

 if (options.streamDeliveryResources && (options.dataStreamArn || options.contentLevel || options.deliveryType)) {
 return {
 valid: false,
 error:
 '--stream-delivery-resources cannot be combined with --data-stream-arn, --stream-content-level, or --delivery-type',
 };
 }

 if (options.contentLevel && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --stream-content-level is set' };
 }

 if (options.deliveryType && !options.dataStreamArn) {
 return { valid: false, error: '--data-stream-arn is required when --delivery-type is set' };
 }

 if (options.dataStreamArn && !options.dataStreamArn.startsWith('arn:')) {
 return { valid: false, error: '--data-stream-arn must be a valid ARN (starts with arn:)' };
 }

 if (
 options.deliveryType &&
 !VALID_DELIVERY_TYPES.includes(options.deliveryType as (typeof VALID_DELIVERY_TYPES)[number])
 ) {
 return {
 valid: false,
 error: `Invalid delivery type. Must be one of: ${VALID_DELIVERY_TYPES.join(', ')}`,
 };
 }

 if (options.contentLevel && !VALID_STREAM_CONTENT_LEVELS.includes(options.contentLevel)) {
 return {
 valid: false,
 error: `Invalid content level. Must be one of: ${VALID_STREAM_CONTENT_LEVELS.join(', ')}`,
 };
 }

 if (options.streamDeliveryResources) {
 try {
 StreamDeliveryResourcesSchema.parse(JSON.parse(options.streamDeliveryResources));
 } catch (e) {
 return {
 valid: false,
 error:
 e instanceof SyntaxError
 ? 'Invalid JSON in --stream-delivery-resources'
 : 'Invalid --stream-delivery-resources: does not match the expected schema',
 };
 }
 }

 return { valid: true };
}

Expand Down

10 changes: 4 additions & 6 deletions
src/cli/operations/memory/__tests__/create-memory.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,20 +76,18 @@ describe('add', () => {
 expect(addedMemory.strategies[0]!.namespaces).toEqual(['/users/{actorId}/facts']);
 });

 it('creates memory with strategy without default namespaces', async () => {
 it('rejects invalid strategy type', async () => {
 const project = makeProject([]);
 mockReadProjectSpec.mockResolvedValue(project);
 mockWriteProjectSpec.mockResolvedValue(undefined);

 await primitive.add({
const result = await primitive.add({
 name: 'NewMem',
 strategies: 'CUSTOM',
 expiry: 30,
 });

 const writtenSpec = mockWriteProjectSpec.mock.calls[0]![0];
 const addedMemory = writtenSpec.memories.find((m: { name: string }) => m.name === 'NewMem');
 expect(addedMemory.strategies[0]!.namespaces).toBeUndefined();
 expect(result).toEqual(expect.objectContaining({ success: false, error: expect.any(String) }));
 expect(mockWriteProjectSpec).not.toHaveBeenCalled();
 });

 it('returns error on duplicate memory name', async () => {
Expand Down
Loading
Loading