aws-cdk-lib.aws_events.CfnArchiveProps

interface CfnArchiveProps

LanguageType name
.NETAmazon.CDK.AWS.Events.CfnArchiveProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnArchiveProps
Javasoftware.amazon.awscdk.services.events.CfnArchiveProps
Pythonaws_cdk.aws_events.CfnArchiveProps
TypeScript aws-cdk-lib » aws_events » CfnArchiveProps

Properties for defining a CfnArchive.

Example

// 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,
  retentionDays: 123,
};

Properties

NameTypeDescription
sourceArnstringThe ARN of the event bus that sends events to the archive.
archiveName?stringThe name for the archive to create.
description?stringA description for the archive.
eventPattern?anyAn event pattern to use to filter events sent to the archive.
retentionDays?numberThe number of days to retain events for.

sourceArn

Type: string

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


archiveName?

Type: string (optional)

The name for the archive to create.


description?

Type: string (optional)

A description for the archive.


eventPattern?

Type: any (optional)

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


retentionDays?

Type: number (optional)

The number of days to retain events for.

Default value is 0. If set to 0, events are retained indefinitely