Class CfnArchive

Creates an archive of events with the specified settings.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnArchive

Implements

IInspectable

IArchiveRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnArchive : CfnResource, IInspectable, IArchiveRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnArchive Inherits CfnResource Implements IInspectable, IArchiveRef, IConstruct, IDependable, IEnvironmentAware

Remarks

When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

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

CloudformationResource: AWS::Events::Archive

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 cfnArchive = new CfnArchive(this, "MyCfnArchive", new CfnArchiveProps {
                 SourceArn = "sourceArn",

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

Synopsis

Constructors

CfnArchive(Construct, string, ICfnArchiveProps)

Create a new AWS::Events::Archive.

Properties

ArchiveName	The name for the archive to create.
ArchiveRef	A reference to a Archive resource.
AttrArn	The ARN of the archive created.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates an archive of events with the specified settings.
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.

Methods

ArnForArchive(IArchiveRef)	Creates an archive of events with the specified settings.
FromArchiveArn(Construct, string, string)	Creates a new IArchiveRef from an ARN.
FromArchiveName(Construct, string, string)	Creates a new IArchiveRef from a archiveName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnArchive(object)	Checks whether the given object is a CfnArchive.
RenderProperties(IDictionary<string, object>)	Creates an archive of events with the specified settings.

Constructors

CfnArchive(Construct, string, ICfnArchiveProps)

Create a new AWS::Events::Archive.

public CfnArchive(Construct scope, string id, ICfnArchiveProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnArchiveProps: Resource properties.

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

Properties

ArchiveName

The name for the archive to create.

public virtual string? ArchiveName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

ArchiveRef

A reference to a Archive resource.

public virtual IArchiveReference ArchiveRef { get; }

Property Value

IArchiveReference

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

AttrArn

The ARN of the archive created.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

CfnProperties

Creates an archive of events with the specified settings.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

Description

A description for the archive.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

EventPattern

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

public virtual object? EventPattern { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

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.

public virtual string? KmsKeyIdentifier { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

RetentionDays

The number of days to retain events for.

public virtual double? RetentionDays { get; set; }

Property Value

double?

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

SourceArn

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

public virtual string SourceArn { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

Methods

ArnForArchive(IArchiveRef)

Creates an archive of events with the specified settings.

public static string ArnForArchive(IArchiveRef resource)

Parameters

resource IArchiveRef

Returns

string

Remarks

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

CloudformationResource: AWS::Events::Archive

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 cfnArchive = new CfnArchive(this, "MyCfnArchive", new CfnArchiveProps {
                 SourceArn = "sourceArn",

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

FromArchiveArn(Construct, string, string)

Creates a new IArchiveRef from an ARN.

public static IArchiveRef FromArchiveArn(Construct scope, string id, string arn)

Parameters

scope Construct
id string
arn string

Returns

IArchiveRef

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

FromArchiveName(Construct, string, string)

Creates a new IArchiveRef from a archiveName.

public static IArchiveRef FromArchiveName(Construct scope, string id, string archiveName)

Parameters

scope Construct
id string
archiveName string

Returns

IArchiveRef

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

IsCfnArchive(object)

Checks whether the given object is a CfnArchive.

public static bool IsCfnArchive(object x)

Parameters

x object

Returns

bool

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates an archive of events with the specified settings.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

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

CloudformationResource: AWS::Events::Archive

ExampleMetadata: fixture=_generated

Implements

IInspectable

IArchiveRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware