Package software.amazon.awscdk.services.cloudtrail

Class CfnEventDataStore

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.cloudtrail.CfnEventDataStore
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)", date="2023-10-26T00:56:05.283Z") @Stability(Stable) public class CfnEventDataStore extends CfnResource implements IInspectable, ITaggable
Creates a new event data store.

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.cloudtrail.*;
 CfnEventDataStore cfnEventDataStore = CfnEventDataStore.Builder.create(this, "MyCfnEventDataStore")
         .advancedEventSelectors(List.of(AdvancedEventSelectorProperty.builder()
                 .fieldSelectors(List.of(AdvancedFieldSelectorProperty.builder()
                         .field("field")
                         // the properties below are optional
                         .endsWith(List.of("endsWith"))
                         .equalTo(List.of("equalTo"))
                         .notEndsWith(List.of("notEndsWith"))
                         .notEquals(List.of("notEquals"))
                         .notStartsWith(List.of("notStartsWith"))
                         .startsWith(List.of("startsWith"))
                         .build()))
                 // the properties below are optional
                 .name("name")
                 .build()))
         .ingestionEnabled(false)
         .kmsKeyId("kmsKeyId")
         .multiRegionEnabled(false)
         .name("name")
         .organizationEnabled(false)
         .retentionPeriod(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .terminationProtectionEnabled(false)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEventDataStore

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

    • CfnEventDataStore

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

    • CfnEventDataStore

      @Stability(Stable) public CfnEventDataStore(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnEventDataStoreProps 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.

    • CfnEventDataStore

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

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedTimestamp

      @Stability(Stable) @NotNull public String getAttrCreatedTimestamp()
      Ref returns the time stamp of the creation of the event data store, such as 1248496624 .

    • getAttrEventDataStoreArn

      @Stability(Stable) @NotNull public String getAttrEventDataStoreArn()
      Ref returns the ARN of the CloudTrail event data store, such as arn:aws:cloudtrail:us-east-1:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE .

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Ref returns the status of the event data store, such as ENABLED .

    • getAttrUpdatedTimestamp

      @Stability(Stable) @NotNull public String getAttrUpdatedTimestamp()
      Ref returns the time stamp that updates were made to an event data store, such as 1598296624 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAdvancedEventSelectors

      @Stability(Stable) @Nullable public Object getAdvancedEventSelectors()
      The advanced event selectors to use to select the events for the data store.

    • setAdvancedEventSelectors

      @Stability(Stable) public void setAdvancedEventSelectors(@Nullable IResolvable value)
      The advanced event selectors to use to select the events for the data store.

    • setAdvancedEventSelectors

      @Stability(Stable) public void setAdvancedEventSelectors(@Nullable List<Object> value)
      The advanced event selectors to use to select the events for the data store.

    • getIngestionEnabled

      @Stability(Stable) @Nullable public Object getIngestionEnabled()
      Specifies whether the event data store should start ingesting live events.

    • setIngestionEnabled

      @Stability(Stable) public void setIngestionEnabled(@Nullable Boolean value)
      Specifies whether the event data store should start ingesting live events.

    • setIngestionEnabled

      @Stability(Stable) public void setIngestionEnabled(@Nullable IResolvable value)
      Specifies whether the event data store should start ingesting live events.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.

    • getMultiRegionEnabled

      @Stability(Stable) @Nullable public Object getMultiRegionEnabled()
      Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

    • setMultiRegionEnabled

      @Stability(Stable) public void setMultiRegionEnabled(@Nullable Boolean value)
      Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

    • setMultiRegionEnabled

      @Stability(Stable) public void setMultiRegionEnabled(@Nullable IResolvable value)
      Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the event data store.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the event data store.

    • getOrganizationEnabled

      @Stability(Stable) @Nullable public Object getOrganizationEnabled()
      Specifies whether an event data store collects events logged for an organization in AWS Organizations .

    • setOrganizationEnabled

      @Stability(Stable) public void setOrganizationEnabled(@Nullable Boolean value)
      Specifies whether an event data store collects events logged for an organization in AWS Organizations .

    • setOrganizationEnabled

      @Stability(Stable) public void setOrganizationEnabled(@Nullable IResolvable value)
      Specifies whether an event data store collects events logged for an organization in AWS Organizations .

    • getRetentionPeriod

      @Stability(Stable) @Nullable public Number getRetentionPeriod()
      The retention period of the event data store, in days.

    • setRetentionPeriod

      @Stability(Stable) public void setRetentionPeriod(@Nullable Number value)
      The retention period of the event data store, in days.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of tags.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of tags.

    • getTerminationProtectionEnabled

      @Stability(Stable) @Nullable public Object getTerminationProtectionEnabled()
      Specifies whether termination protection is enabled for the event data store.

    • setTerminationProtectionEnabled

      @Stability(Stable) public void setTerminationProtectionEnabled(@Nullable Boolean value)
      Specifies whether termination protection is enabled for the event data store.

    • setTerminationProtectionEnabled

      @Stability(Stable) public void setTerminationProtectionEnabled(@Nullable IResolvable value)
      Specifies whether termination protection is enabled for the event data store.