Package software.amazon.awscdk.services.cloudtrail

Interface CfnEventDataStoreProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventDataStoreProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:12.588Z")
@Stability(Stable)
public interface CfnEventDataStoreProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEventDataStore.

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.*;
 CfnEventDataStoreProps cfnEventDataStoreProps = CfnEventDataStoreProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventDataStoreProps.Builder	A builder for CfnEventDataStoreProps
static final class	CfnEventDataStoreProps.Jsii$Proxy	An implementation for CfnEventDataStoreProps

Method Summary

Modifier and Type	Method	Description
static CfnEventDataStoreProps.Builder	builder()
default Object	getAdvancedEventSelectors()	The advanced event selectors to use to select the events for the data store.
default 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.
default Object	getFederationEnabled()	Indicates if Lake query federation is enabled.
default 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.
default Object	getIngestionEnabled()	Specifies whether the event data store should start ingesting live events.
default String	getInsightsDestination()	The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.
default Object	getInsightSelectors()	A JSON string that contains the Insights types you want to log on an event data store.
default String	getKmsKeyId()	Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.
default 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.
default String	getName()	The name of the event data store.
default Object	getOrganizationEnabled()	Specifies whether an event data store collects events logged for an organization in AWS Organizations .
default Number	getRetentionPeriod()	The retention period of the event data store, in days.
default List<CfnTag>	getTags()	A list of tags.
default Object	getTerminationProtectionEnabled()	Specifies whether termination protection is enabled for the event data store.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdvancedEventSelectors

@Stability(Stable)
@Nullable
default Object getAdvancedEventSelectors()

The advanced event selectors to use to select the events for the data store.

You can configure up to five advanced event selectors for each event data store.

For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see Create an event data store for AWS Config configuration items in the CloudTrail User Guide.

For more information about how to use advanced event selectors to include events outside of AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-advancedeventselectors

getBillingMode

@Stability(Stable)
@Nullable
default 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.

The following are the possible values:

• EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.
• FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.

The default value is EXTENDABLE_RETENTION_PRICING .

For more information about CloudTrail pricing, see AWS CloudTrail Pricing and Managing CloudTrail Lake costs .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-billingmode

getFederationEnabled

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationenabled

getFederationRoleArn

@Stability(Stable)
@Nullable
default 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.

The federation role must exist in your account and provide the required minimum permissions .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-federationrolearn

getIngestionEnabled

@Stability(Stable)
@Nullable
default Object getIngestionEnabled()

Specifies whether the event data store should start ingesting live events.

The default is true.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-ingestionenabled

getInsightsDestination

@Stability(Stable)
@Nullable
default String getInsightsDestination()

The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events.

For more information, see Create an event data store for CloudTrail Insights events .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightsdestination

getInsightSelectors

@Stability(Stable)
@Nullable
default Object getInsightSelectors()

A JSON string that contains the Insights types you want to log on an event data store.

ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.

The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-insightselectors

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail.

The value can be an alias name prefixed by alias/ , a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.

CloudTrail also supports AWS KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide .

Examples:

• alias/MyAliasName
• arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
• arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
• 12345678-1234-1234-1234-123456789012

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-kmskeyid

getMultiRegionEnabled

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-multiregionenabled

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the event data store.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-name

getOrganizationEnabled

@Stability(Stable)
@Nullable
default Object getOrganizationEnabled()

Specifies whether an event data store collects events logged for an organization in AWS Organizations .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-organizationenabled

getRetentionPeriod

@Stability(Stable)
@Nullable
default Number getRetentionPeriod()

The retention period of the event data store, in days.

If BillingMode is set to EXTENDABLE_RETENTION_PRICING , you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING , you can set a retention period of up to 2557 days, the equivalent of seven years.

CloudTrail Lake determines whether to retain an event by checking if the eventTime of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the eventTime is older than 90 days.

If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-retentionperiod

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of tags.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-tags

getTerminationProtectionEnabled

@Stability(Stable)
@Nullable
default Object getTerminationProtectionEnabled()

Specifies whether termination protection is enabled for the event data store.

If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-eventdatastore.html#cfn-cloudtrail-eventdatastore-terminationprotectionenabled

builder

@Stability(Stable)
static CfnEventDataStoreProps.Builder builder()

Returns:

a CfnEventDataStoreProps.Builder of CfnEventDataStoreProps