AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Events::Archive

CfnArchive

Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive. > If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well. > > For more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide* .

Import

import { CfnArchive } from 'aws-cdk-lib/aws-events';

Or use the module namespace:

import * as events from 'aws-cdk-lib/aws-events';
// events.CfnArchive

Properties

Configuration passed to the constructor as CfnArchiveProps.

sourceArnRequired
string | IEventBusRef

The ARN of the event bus that sends events to the archive.

archiveNameOptional
string

The name for the archive to create.

descriptionOptional
string

A description for the archive.

eventPatternOptional
any

An event pattern to use to filter events sent to the archive.

kmsKeyIdentifierOptional
string

The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the archive. For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the *AWS Key Management Service Developer Guide* . > If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well. > > For more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide* .

retentionDaysOptional
number

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Events::ArchiveView in CloudFormation Explorer

Get the Amazon EventBridge Cheat Sheet

Everything you need to know about Amazon EventBridge on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-events
CFN TypeAWS::Events::Archive
Properties6

Related Constructs

Explore This Service

External Links