CfnArchiveProps Struct
Properties for defining a CfnArchive.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
declare const eventPattern: any;
const cfnArchiveProps: events.CfnArchiveProps = {
sourceArn: 'sourceArn',
// the properties below are optional
archiveName: 'archiveName',
description: 'description',
eventPattern: eventPattern,
kmsKeyIdentifier: 'kmsKeyIdentifier',
retentionDays: 123,
};
Properties
archiveNameoptionalstringarchive_nameoptionalstrarchiveNameoptionalStringArchiveNameoptionalstringArchiveNameoptional*string#The name for the archive to create.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description for the archive.
eventPatternoptionalanyevent_patternoptionalAnyeventPatternoptionalObjectEventPatternoptionalobjectEventPatternoptionalinterface{}#An event pattern to use to filter events sent to the archive.
kmsKeyIdentifieroptionalstringkms_key_identifieroptionalstrkmsKeyIdentifieroptionalStringKmsKeyIdentifieroptionalstringKmsKeyIdentifieroptional*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.
notes
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 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 in the Amazon EventBridge User Guide .
retentionDaysoptionalnumberretention_daysoptionalint | floatretentionDaysoptionalNumberRetentionDaysoptionaldoubleRetentionDaysoptional*float64#The number of days to retain events for.
Default value is 0. If set to 0, events are retained indefinitely
sourceArnstring | IEventBusRefsource_arntyping.Union[str, IEventBusRef]sourceArnStringSourceArnstringSourceArninterface{}required#The ARN of the event bus that sends events to the archive.