Type Support for Amazon CloudWatch Synthetics Node.js Runtime

TypeScript type definitions for the Amazon CloudWatch Synthetics Node.js runtime library.

Installation

Please ensure the type definition package version matches your canary's runtime version.

npm install @aws/synthetics-core

Usage

import { synthetics } from '@aws/synthetics-core';

// Execute a step with custom configuration
await synthetics.executeStep('checkHomepage', async () => {
    // Your test logic here
}, {
    includeRequestHeaders: true,
    includeResponseHeaders: true,
    restrictedHeaders: ['authorization'],
    includeRequestBody: true,
    includeResponseBody: true
});

TypeScript Support

This package provides complete TypeScript type definitions for the Amazon CloudWatch Synthetics Node.js runtime, enabling full IntelliSense support and type checking in your canary scripts.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.