interface CfnArchiveProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Events.CfnArchiveProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnArchiveProps |
Java | software.amazon.awscdk.services.events.CfnArchiveProps |
Python | aws_cdk.aws_events.CfnArchiveProps |
TypeScript | aws-cdk-lib » aws_events » CfnArchiveProps |
Properties for defining a CfnArchive
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html
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
Name | Type | Description |
---|---|---|
source | string | The ARN of the event bus that sends events to the archive. |
archive | string | The name for the archive to create. |
description? | string | A description for the archive. |
event | any | An event pattern to use to filter events sent to the archive. |
retention | number | The 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