interface InsightSelectorProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CloudTrail.CfnTrail.InsightSelectorProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscloudtrail#CfnTrail_InsightSelectorProperty |
 Java | software.amazon.awscdk.services.cloudtrail.CfnTrail.InsightSelectorProperty |
 Python | aws_cdk.aws_cloudtrail.CfnTrail.InsightSelectorProperty |
 TypeScript | aws-cdk-lib » aws_cloudtrail » CfnTrail » InsightSelectorProperty |
A JSON string that contains a list of Insights types that are logged on a trail.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudtrail as cloudtrail } from 'aws-cdk-lib';
const insightSelectorProperty: cloudtrail.CfnTrail.InsightSelectorProperty = {
eventCategories: ['eventCategories'],
insightType: 'insightType',
};
Properties
| Name | Type | Description |
|---|---|---|
| event | string[] | Select the event category on which Insights should be enabled. |
| insight | string | The type of Insights events to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types. |
eventCategories?
Type:
string[]
(optional)
Select the event category on which Insights should be enabled.
- If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.
- If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.
insightType?
Type:
string
(optional)
The type of Insights events to log on a trail. 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.