software.amazon.awscdk.services.events

Class CfnArchive

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.events.CfnArchive

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.252Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnArchive(software.constructs.Construct scope, 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
String	getArchiveName() The name for the archive to create.
String	getAttrArchiveName() The archive name.
String	getAttrArn() The ARN of the archive created.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description for the archive.
Object	getEventPattern() An event pattern to use to filter events sent to the archive.
Number	getRetentionDays() The number of days to retain events for.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setArchiveName(String value) The name for the archive to create.
void	setDescription(String value) A description for the archive.
void	setEventPattern(Object value) An event pattern to use to filter events sent to the archive.
void	setRetentionDays(Number value) The number of days to retain events for.
void	setSourceArn(String value) The ARN of the event bus that sends events to the archive.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnArchive(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArchiveName

@Stability(value=Stable)
 @NotNull
public String getAttrArchiveName()

The archive name.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the archive created.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEventPattern

@Stability(value=Stable)
 @NotNull
public Object getEventPattern()

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

setEventPattern

@Stability(value=Stable)
public void setEventPattern(@NotNull
                                                     Object value)

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

getSourceArn

@Stability(value=Stable)
 @NotNull
public String getSourceArn()

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

setSourceArn

@Stability(value=Stable)
public void setSourceArn(@NotNull
                                                  String value)

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

getArchiveName

@Stability(value=Stable)
 @Nullable
public String getArchiveName()

The name for the archive to create.

setArchiveName

@Stability(value=Stable)
public void setArchiveName(@Nullable
                                                    String value)

The name for the archive to create.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description for the archive.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description for the archive.

getRetentionDays

@Stability(value=Stable)
 @Nullable
public Number getRetentionDays()

The number of days to retain events for.

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

setRetentionDays

@Stability(value=Stable)
public void setRetentionDays(@Nullable
                                                      Number value)

The number of days to retain events for.

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