Package software.amazon.awscdk.services.events

Class Archive

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.events.Archive
All Implemented Interfaces:
IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:17.286Z") @Stability(Stable) public class Archive extends Resource
Define an EventBridge 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.*;
 import software.amazon.awscdk.services.events.*;
 Object detail;
 EventBus eventBus;
 Archive archive = Archive.Builder.create(this, "MyArchive")
         .eventPattern(EventPattern.builder()
                 .account(List.of("account"))
                 .detail(Map.of(
                         "detailKey", detail))
                 .detailType(List.of("detailType"))
                 .id(List.of("id"))
                 .region(List.of("region"))
                 .resources(List.of("resources"))
                 .source(List.of("source"))
                 .time(List.of("time"))
                 .version(List.of("version"))
                 .build())
         .sourceEventBus(eventBus)
         // the properties below are optional
         .archiveName("archiveName")
         .description("description")
         .retention(Duration.minutes(30))
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Archive.Builder
    A fluent builder for Archive.

    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.IResource

    IResource.Jsii$Default

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Archive(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Archive(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    Archive(software.constructs.Construct scope, String id, ArchiveProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getArchiveArn()
    The ARN of the archive created.
    String
    getArchiveName()
    The archive name.

    Methods inherited from class software.amazon.awscdk.Resource

    applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    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.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Archive

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

    • Archive

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

    • Archive

      @Stability(Stable) public Archive(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ArchiveProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • getArchiveArn

      @Stability(Stable) @NotNull public String getArchiveArn()
      The ARN of the archive created.

    • getArchiveName

      @Stability(Stable) @NotNull public String getArchiveName()
      The archive name.