Create an event data store for Insights events with the console

Sign in to the Amazon Web Services Management Console and open the CloudTrail console at https://console.amazonaws.cn/cloudtrail/.

From the navigation pane, open the Lake submenu, then choose Event data stores.

Choose Create event data store.

On the Configure event data store page, in General details, enter a name for the event data store. A name is required.

Choose the Pricing option that you want to use for your event data store. The pricing option determines the cost for ingesting and storing events, and the default and maximum retention periods for your event data store. For more information, see Amazon CloudTrail Pricing and Managing CloudTrail Lake costs.

The following are the available options:

Specify a retention period for the event data store in days. Retention periods can be between 7 days and 3,653 days (about 10 years) for the One-year extendable retention pricing option, or between 7 days and 2,557 days (about seven years) for the Seven-year retention pricing option. The event data store retains event data for the specified number of days.

(Optional) To enable encryption using Amazon Key Management Service, choose Use my own Amazon KMS key. Choose New to have an Amazon KMS key created for you, or choose Existing to use an existing KMS key. In Enter KMS alias, specify an alias, in the format alias/MyAliasName. Using your own KMS key requires that you edit your KMS key policy to allow your event data store to be encrypted and decrypted. For more information, see Configure Amazon KMS key policies for CloudTrail. CloudTrail also supports Amazon KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Amazon Key Management Service Developer Guide.

Using your own KMS key incurs Amazon KMS costs for encryption and decryption. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed.

(Optional) If you want to query against your event data using Amazon Athena, choose Enable in Lake query federation. Federation lets you view the metadata associated with the event data store in the Amazon Glue Data Catalog and run SQL queries against the event data in Athena. The table metadata stored in the Amazon Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query. For more information, see Federate an event data store.

To enable Lake query federation, choose Enable and then do the following:

1. Choose whether you want to create a new role or use an existing IAM role. Amazon Lake Formation uses this role to manage permissions for the federated event data store. When you create a new role using the CloudTrail console, CloudTrail automatically creates a role with the required permissions. If you choose an existing role, be sure the policy for the role provides the required minimum permissions.

2. If you are creating a new role, enter a name to identify the role.

3. If you are using an existing role, choose the role you want to use. The role must exist in your account.

(Optional) Choose Enable resource policy to add a resource-based policy to your event data store. Resource-based policies allow you to control which principals can perform actions on your event data store. For example, you can add a resource based policy that allows the root users in other accounts to query this event data store and view the query results. For example policies, see Resource-based policy examples for event data stores.

A resource-based policy includes one or more statements. Each statement in the policy defines the principals that are allowed or denied access to the event data store and the actions the principals can perform on the event data store resource.

The following actions are supported in resource-based policies for event data stores:

For organization event data stores, CloudTrail creates a default resource-based policy that lists the actions that the delegated administrator accounts are allowed to perform on organization event data stores. The permissions in this policy are derived from the delegated administrator permissions in Amazon Organizations. This policy is updated automatically following changes to the organization event data store or to the organization (for example, a CloudTrail delegated administrator account is registered or removed).

(Optional) In the Tags section, you can add up to 50 tag key pairs to help you identify, sort, and control access to your event data store. For more information about how to use IAM policies to authorize access to an event data store based on tags, see Examples: Denying access to create or delete event data stores based on tags. For more information about how you can use tags in Amazon, see Tagging your Amazon resources in the Tagging Amazon Resources User Guide.

Choose Next to configure the event data store.

On the Choose events page, choose Amazon events, and then choose CloudTrail Insights events.

In CloudTrail Insights events, do the following.

1. Choose Allow delegated administrator access if you want to give your organization's delegated administrator access to this event data store. This option is only available if you are signed in with the management account for an Amazon Organizations organization.

2. (Optional) Choose an existing source event data store that logs management events and specify the Insights types you want to receive.

   To add a source event data store, do the following.

   1. Choose Add source event data store.

   2. Choose the source event data store.

   3. Choose the Insights type that you want to receive.

      • ApiCallRateInsight – The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. To receives Insights on ApiCallRateInsight, the source event data store must log Write management events.

      • ApiErrorRateInsight – The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful. To receive Insights on ApiErrorRateInsight, the source event data store must log Write or Read management events.

   4. Repeat the previous two steps (ii and iii) to add any additional Insights types you want to receive.

Choose Next to review your choices.

On the Review and create page, review your choices. Choose Edit to make changes to a section. When you're ready to create the event data store, choose Create event data store.

The new event data store is visible in the Event data stores table on the Event data stores page.

If you did not choose a source event data store in step 10, follow the steps in To create a source event data store that enables Insights events to create a source event data store.

Sign in to the Amazon Web Services Management Console and open the CloudTrail console at https://console.amazonaws.cn/cloudtrail/.

From the navigation pane, open the Lake submenu, then choose Event data stores.

Choose Create event data store.

On the Configure event data store page, in General details, enter a name for the event data store. A name is required.

Choose the Pricing option that you want to use for your event data store. The pricing option determines the cost for ingesting and storing events, and the default and maximum retention periods for your event data store. For more information, see Amazon CloudTrail Pricing and Managing CloudTrail Lake costs.

The following are the available options:

Specify a retention period for the event data store. Retention periods can be between 7 days and 3,653 days (about 10 years) for the One-year extendable retention pricing option, or between 7 days and 2,557 days (about seven years) for the Seven-year retention pricing option.

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 specify a retention period of 90 days, CloudTrail will remove events when their eventTime is older than 90 days.

(Optional) To enable encryption using Amazon Key Management Service, choose Use my own Amazon KMS key. Choose New to have an Amazon KMS key created for you, or choose Existing to use an existing KMS key. In Enter KMS alias, specify an alias, in the format alias/MyAliasName. Using your own KMS key requires that you edit your KMS key policy to allow your event data store to be encrypted and decrypted. For more information, see Configure Amazon KMS key policies for CloudTrail. CloudTrail also supports Amazon KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Amazon Key Management Service Developer Guide.

Using your own KMS key incurs Amazon KMS costs for encryption and decryption. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed.

(Optional) If you want to query against your event data using Amazon Athena, choose Enable in Lake query federation. Federation lets you view the metadata associated with the event data store in the Amazon Glue Data Catalog and run SQL queries against the event data in Athena. The table metadata stored in the Amazon Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query. For more information, see Federate an event data store.

To enable Lake query federation, choose Enable and then do the following:

1. Choose whether you want to create a new role or use an existing IAM role. Amazon Lake Formation uses this role to manage permissions for the federated event data store. When you create a new role using the CloudTrail console, CloudTrail automatically creates a role with the required permissions. If you choose an existing role, be sure the policy for the role provides the required minimum permissions.

2. If you are creating a new role, enter a name to identify the role.

3. If you are using an existing role, choose the role you want to use. The role must exist in your account.

(Optional) Choose Enable resource policy to add a resource-based policy to your event data store. Resource-based policies allow you to control which principals can perform actions on your event data store. For example, you can add a resource based policy that allows the root users in other accounts to query this event data store and view the query results. For example policies, see Resource-based policy examples for event data stores.

A resource-based policy includes one or more statements. Each statement in the policy defines the principals that are allowed or denied access to the event data store and the actions the principals can perform on the event data store resource.

The following actions are supported in resource-based policies for event data stores:

For organization event data stores, CloudTrail creates a default resource-based policy that lists the actions that the delegated administrator accounts are allowed to perform on organization event data stores. The permissions in this policy are derived from the delegated administrator permissions in Amazon Organizations. This policy is updated automatically following changes to the organization event data store or to the organization (for example, a CloudTrail delegated administrator account is registered or removed).

(Optional) In the Tags section, you can add up to 50 tag key pairs to help you identify, sort, and control access to your event data store. For more information about how to use IAM policies to authorize access to an event data store based on tags, see Examples: Denying access to create or delete event data stores based on tags. For more information about how you can use tags in Amazon, see Tagging your Amazon resources in the Tagging Amazon Resources User Guide.

Choose Next to configure the event data store.

On the Choose events page, choose Amazon events, and then choose CloudTrail events.

In CloudTrail events, leave Management events selected.

To have your event data store collect events from all accounts in an Amazon Organizations organization, select Enable for all accounts in my organization. You must be signed in to the management account for the organization to create an event data store that enables Insights.

Expand Additional settings to choose whether you want your event data store to collect events for all Amazon Web Services Regions, or only the current Amazon Web Services Region, and choose whether the event data store ingests events. By default, your event data store collects events from all Regions in your account and starts ingesting events when it's created.

1. Choose Include only the current region in my event data store if you want to include only events that are logged in the current Region. If you do not choose this option, your event data store includes events from all Regions.

2. Leave Ingest events selected.

Choose between Simple event collection or Advanced event collection:

If you selected Simple event collection, choose whether you want to log all events, log only read events, or log only write events. You can also choose to exclude Amazon KMS and Amazon RDS Data API events.

If you selected Advanced event collection, make the following selections:

1. In Log selector template, choose a template, or Custom to build a custom configuration based on advanced event selector field values.

2. (Optional) In Selector name, enter a name to identify your selector. The selector name is a descriptive name for an advanced event selector, such as "Log management events from Amazon Web Services Management Console sessions". The selector name is listed as Name in the advanced event selector and is viewable if you expand the JSON view.

3. If you chose Custom, in Advanced event selectors build an expression based on advanced event selector field values.

   1. Choose from the following fields.

      • readOnly – readOnly can be set to equals a value of true or false. When it is set to false, the event data store logs Write-only management events. Read-only management events are events that do not change the state of a resource, such as Get* or Describe* events. Write events add, change, or delete resources, attributes, or artifacts, such as Put*, Delete*, or Write* events. To log both Read and Write events, don't add a readOnly selector.

      • eventName – eventName can use any operator. You can use it to include or exclude any management event, such as CreateAccessPoint or GetAccessPoint.

      • userIdentity.arn – Include or exclude events for actions taken by specific IAM identities. For more information, see CloudTrail userIdentity element.

      • sessionCredentialFromConsole – Include or exclude events originating from an Amazon Web Services Management Console session. This field can be set to equals or not equals with a value of true.

      • eventSource – You can use it to include or exclude specific event sources. The eventSource is typically a short form of the service name without spaces plus .amazonaws.com. For example, you could set eventSource equals to ec2.amazonaws.com to log only Amazon EC2 management events.

      • eventType – The eventType to include or exclude. For example, you can set this field to not equals AwsServiceEvent to exclude Amazon Web Services service events.

   2. For each field, choose + Condition to add as many conditions as you need, up to a maximum of 500 specified values for all conditions.

      For information about how CloudTrail evaluates multiple conditions, see How CloudTrail evaluates multiple conditions for a field.

      Note

      You can have a maximum of 500 values for all selectors on an event data store. This includes arrays of multiple values for a selector such as eventName. If you have single values for all selectors, you can have a maximum of 500 conditions added to a selector.

   3. Choose + Field to add additional fields as required. To avoid errors, do not set conflicting or duplicate values for fields.

4. Optionally, expand JSON view to see your advanced event selectors as a JSON block.

Choose Enable Insights events capture.

Choose the destination event store that will log Insights events. The destination event data store will collect Insights events based upon the management event activity in this event data store. For information about how to create the destination event data store, see To create a destination event data store that logs Insights events.

Choose the Insights types. You can choose API call rate, API error rate, or both. You must be logging Write management events to log Insights events for API call rate. You must be logging Read or Write management events to log Insights events for API error rate.

Choose Next to review your choices.

On the Review and create page, review your choices. Choose Edit to make changes to a section. When you're ready to create the event data store, choose Create event data store.

The new event data store is visible in the Event data stores table on the Event data stores page.

From this point forward, the event data store captures events that match its advanced event selectors. After you enable CloudTrail Insights for the first time on your source event data store, it can take up to 7 days for CloudTrail to deliver the first Insights event to your destination event data store, if unusual activity is detected.

You can view the CloudTrail Lake dashboard to visualize the Insights events in your destination event data store. For more information about Lake dashboards, see CloudTrail Lake dashboards.