software.amazon.awscdk.services.events

Class CfnArchive

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.events.CfnArchive

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:26.643Z")
public class CfnArchive
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Events::Archive`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 Object eventPattern;
 CfnArchive cfnArchive = CfnArchive.Builder.create(this, "MyCfnArchive")
         .sourceArn("sourceArn")
         // the properties below are optional
         .archiveName("archiveName")
         .description("description")
         .eventPattern(eventPattern)
         .retentionDays(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnArchive.Builder A fluent builder for CfnArchive.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnArchive(Construct scope, java.lang.String id, CfnArchiveProps props) Create a new `AWS::Events::Archive`.
protected	CfnArchive(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnArchive(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArchiveName() The name for the archive to create.
java.lang.String	getAttrArchiveName()
java.lang.String	getAttrArn() The ARN of the archive created.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description for the archive.
java.lang.Object	getEventPattern() An event pattern to use to filter events sent to the archive.
java.lang.Number	getRetentionDays() The number of days to retain events for.
java.lang.String	getSourceArn() The ARN of the event bus that sends events to the archive.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setArchiveName(java.lang.String value) The name for the archive to create.
void	setDescription(java.lang.String value) A description for the archive.
void	setEventPattern(java.lang.Object value) An event pattern to use to filter events sent to the archive.
void	setRetentionDays(java.lang.Number value) The number of days to retain events for.
void	setSourceArn(java.lang.String value) The ARN of the event bus that sends events to the archive.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnArchive

protected CfnArchive(software.amazon.jsii.JsiiObjectRef objRef)

CfnArchive

protected CfnArchive(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnArchive

public CfnArchive(Construct scope,
                  java.lang.String id,
                  CfnArchiveProps props)

Create a new `AWS::Events::Archive`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArchiveName

public java.lang.String getAttrArchiveName()

getAttrArn

public java.lang.String getAttrArn()

The ARN of the archive created.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEventPattern

public java.lang.Object getEventPattern()

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

setEventPattern

public void setEventPattern(java.lang.Object value)

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

getSourceArn

public java.lang.String getSourceArn()

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

setSourceArn

public void setSourceArn(java.lang.String value)

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

getArchiveName

public java.lang.String getArchiveName()

The name for the archive to create.

setArchiveName

public void setArchiveName(java.lang.String value)

The name for the archive to create.

getDescription

public java.lang.String getDescription()

A description for the archive.

setDescription

public void setDescription(java.lang.String value)

A description for the archive.

getRetentionDays

public java.lang.Number getRetentionDays()

The number of days to retain events for.

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

setRetentionDays

public void setRetentionDays(java.lang.Number value)

The number of days to retain events for.

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