Class CfnArchive
A CloudFormation AWS::Events::Archive
.
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.AWS.Events.dll
Syntax (csharp)
public class CfnArchive : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnArchive
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates an archive of events with the specified settings. 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.
CloudformationResource: AWS::Events::Archive
Link: 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 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(Construct, String, ICfnArchiveProps) | Create a new |
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 |
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(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 System.String
- scoped id of the resource.
- props ICfnArchiveProps
- resource properties.
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
Properties
ArchiveName
The name for the archive to create.
public virtual string ArchiveName { get; set; }
Property Value
System.String
Remarks
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
Remarks
EventPattern
An event pattern to use to filter events sent to the archive.
public virtual object EventPattern { get; set; }
Property Value
System.Object
Remarks
RetentionDays
The number of days to retain events for.
public virtual Nullable<double> RetentionDays { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default value is 0. If set to 0, events are retained indefinitely
SourceArn
The ARN of the event bus that sends events to the archive.
public virtual string SourceArn { get; set; }
Property Value
System.String
Remarks
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>