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.103.1 (build bef2dea)",
date="2024-10-05T03:43:43.620Z")
@Stability(Stable)
public class CfnArchive
extends CfnResource
implements IInspectable
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.
Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:
- You call
[CreateArchive](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html)
on an event bus set to use a customer managed key for encryption.- You call
[CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer)
on an event bus set to use a customer managed key for encryption.- You call
[UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html)
to set a customer managed key on an event bus with an archives or schema discovery enabled.To enable archives or schema discovery on an event bus, choose to use an AWS owned key . For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide .
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();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnArchive
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnArchive
(software.amazon.jsii.JsiiObjectRef objRef) CfnArchive
(software.constructs.Construct scope, String id, CfnArchiveProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe name for the archive to create.The ARN of the archive created.A description for the archive.An event pattern to use to filter events sent to the archive.The number of days to retain events for.The ARN of the event bus that sends events to the archive.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnArchive
protected CfnArchive(software.amazon.jsii.JsiiObjectRef objRef) -
CfnArchive
protected CfnArchive(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnArchive
@Stability(Stable) public CfnArchive(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnArchiveProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the archive created. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getSourceArn
The ARN of the event bus that sends events to the archive. -
setSourceArn
The ARN of the event bus that sends events to the archive. -
getArchiveName
The name for the archive to create. -
setArchiveName
The name for the archive to create. -
getDescription
A description for the archive. -
setDescription
A description for the archive. -
getEventPattern
An event pattern to use to filter events sent to the archive. -
setEventPattern
An event pattern to use to filter events sent to the archive. -
getRetentionDays
The number of days to retain events for. -
setRetentionDays
The number of days to retain events for.
-