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.101.0 (build b95fe5d)", date="2024-07-12T19:33:58.759Z") @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()))
         .billingMode("billingMode")
         .federationEnabled(false)
         .federationRoleArn("federationRoleArn")
         .ingestionEnabled(false)
         .insightsDestination("insightsDestination")
         .insightSelectors(List.of(InsightSelectorProperty.builder()
                 .insightType("insightType")
                 .build()))
         .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.

    • getBillingMode

      @Stability(Stable) @Nullable public String getBillingMode()
      The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

    • setBillingMode

      @Stability(Stable) public void setBillingMode(@Nullable String value)
      The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

    • getFederationEnabled

      @Stability(Stable) @Nullable public Object getFederationEnabled()
      Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.

    • setFederationEnabled

      @Stability(Stable) public void setFederationEnabled(@Nullable Boolean value)
      Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.

    • setFederationEnabled

      @Stability(Stable) public void setFederationEnabled(@Nullable IResolvable value)
      Indicates if Lake query federation is enabled. By default, Lake query federation is disabled. You cannot delete an event data store if Lake query federation is enabled.

    • getFederationRoleArn

      @Stability(Stable) @Nullable public String getFederationRoleArn()
      If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.

    • setFederationRoleArn

      @Stability(Stable) public void setFederationRoleArn(@Nullable String value)
      If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event 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.

    • getInsightsDestination

      @Stability(Stable) @Nullable public String getInsightsDestination()
      The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.

    • setInsightsDestination

      @Stability(Stable) public void setInsightsDestination(@Nullable String value)
      The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.

    • getInsightSelectors

      @Stability(Stable) @Nullable public Object getInsightSelectors()
      A JSON string that contains the Insights types you want to log on an event data store.

    • setInsightSelectors

      @Stability(Stable) public void setInsightSelectors(@Nullable IResolvable value)
      A JSON string that contains the Insights types you want to log on an event data store.

    • setInsightSelectors

      @Stability(Stable) public void setInsightSelectors(@Nullable List<Object> value)
      A JSON string that contains the Insights types you want to log on an event data store.

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