Class CfnArchive
Creates an archive of events with the specified settings.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnArchive : CfnResource, IInspectable
Syntax (vb)
Public Class CfnArchive
Inherits CfnResource
Implements IInspectable
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.
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,
RetentionDays = 123
});
Synopsis
Constructors
CfnArchive(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnArchive(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnArchive(Construct, String, ICfnArchiveProps) |
Properties
ArchiveName | The name for the archive to create. |
AttrArn | The ARN of the archive created. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description for the archive. |
EventPattern | An event pattern to use to filter events sent to the archive. |
RetentionDays | The number of days to retain events for. |
SourceArn | The ARN of the event bus that sends events to the archive. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnArchive(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnArchive(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnArchive(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnArchive(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnArchive(Construct, String, ICfnArchiveProps)
public CfnArchive(Construct scope, string id, ICfnArchiveProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnArchiveProps
Resource properties.
Properties
ArchiveName
The name for the archive to create.
public virtual string ArchiveName { get; set; }
Property Value
System.String
AttrArn
The ARN of the archive created.
public virtual string AttrArn { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description for the archive.
public virtual string Description { get; set; }
Property Value
System.String
EventPattern
An event pattern to use to filter events sent to the archive.
public virtual object EventPattern { get; set; }
Property Value
System.Object
RetentionDays
The number of days to retain events for.
public virtual Nullable<double> RetentionDays { get; set; }
Property Value
System.Nullable<System.Double>
SourceArn
The ARN of the event bus that sends events to the archive.
public virtual string SourceArn { get; set; }
Property Value
System.String
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>