class Archive (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Events.Archive
Java	software.amazon.awscdk.services.events.Archive
Python	aws_cdk.aws_events.Archive
TypeScript (source)	@aws-cdk/aws-events » Archive

Implements IConstruct, IConstruct, IDependable, IResource

Define an EventBridge Archive.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as events from '@aws-cdk/aws-events';
import * as cdk from '@aws-cdk/core';

declare const detail: any;
declare const eventBus: events.EventBus;
const archive = new events.Archive(this, 'MyArchive', {
  eventPattern: {
    account: ['account'],
    detail: {
      detailKey: detail,
    },
    detailType: ['detailType'],
    id: ['id'],
    region: ['region'],
    resources: ['resources'],
    source: ['source'],
    time: ['time'],
    version: ['version'],
  },
  sourceEventBus: eventBus,

  // the properties below are optional
  archiveName: 'archiveName',
  description: 'description',
  retention: cdk.Duration.minutes(30),
});

Initializer

new Archive(scope: Construct, id: string, props: ArchiveProps)

Parameters

• scope Construct
• id string
• props ArchiveProps

Construct Props

Name	Type	Description
eventPattern	EventPattern	An event pattern to use to filter events sent to the archive.
sourceEventBus	IEventBus	The event source associated with the archive.
archiveName?	string	The name of the archive.
description?	string	A description for the archive.
retention?	Duration	The number of days to retain events for.

---

eventPattern

Type: EventPattern

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

---

sourceEventBus

Type: IEventBus

The event source associated with the archive.

---

archiveName?

Type: string (optional, default: Automatically generated)

The name of the archive.

---

description?

Type: string (optional, default: none)

A description for the archive.

---

retention?

Type: Duration (optional, default: Infinite)

The number of days to retain events for.

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

Properties

Name	Type	Description
archiveArn	string	The ARN of the archive created.
archiveName	string	The archive name.
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The stack in which this resource is defined.

---

archiveArn

Type: string

The ARN of the archive created.

---

archiveName

Type: string

The archive name.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.