Interface ICfnArchiveProps

Properties for defining a CfnArchive.

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnArchiveProps

Syntax (vb)

Public Interface ICfnArchiveProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Events;

             var eventPattern;

             var cfnArchiveProps = new CfnArchiveProps {
                 SourceArn = "sourceArn",

                 // the properties below are optional
                 ArchiveName = "archiveName",
                 Description = "description",
                 EventPattern = eventPattern,
                 KmsKeyIdentifier = "kmsKeyIdentifier",
                 RetentionDays = 123
             };

Synopsis

Properties

ArchiveName	The name for the archive to create.
Description	A description for the archive.
EventPattern	An event pattern to use to filter events sent to the archive.
KmsKeyIdentifier	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.
RetentionDays	The number of days to retain events for.
SourceArn	The ARN of the event bus that sends events to the archive.

Properties

ArchiveName

The name for the archive to create.

string? ArchiveName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename

Description

A description for the archive.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description

EventPattern

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

object? EventPattern { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern

KmsKeyIdentifier

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.

string? KmsKeyIdentifier { get; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-kmskeyidentifier

RetentionDays

The number of days to retain events for.

double? RetentionDays { get; }

Property Value

double?

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays

SourceArn

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

object SourceArn { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn

Type union: either string or IEventBusRef