Package software.amazon.awscdk.services.cloudtrail

Interface CfnTrail.InsightSelectorProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrail.InsightSelectorProperty.Jsii$Proxy

Enclosing class:

CfnTrail

@Stability(Stable)
public static interface CfnTrail.InsightSelectorProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cloudtrail.*;
 InsightSelectorProperty insightSelectorProperty = InsightSelectorProperty.builder()
         .eventCategories(List.of("eventCategories"))
         .insightType("insightType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTrail.InsightSelectorProperty.Builder	builder()
default List<String>	getEventCategories()	Select the event category on which Insights should be enabled.
default String	getInsightType()	The type of Insights events to log on a trail.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventCategories

@Stability(Stable)
@Nullable
default List<String> getEventCategories()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html#cfn-cloudtrail-trail-insightselector-eventcategories

getInsightType

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html#cfn-cloudtrail-trail-insightselector-insighttype

builder

@Stability(Stable)
static CfnTrail.InsightSelectorProperty.Builder builder()

Returns:

a CfnTrail.InsightSelectorProperty.Builder of CfnTrail.InsightSelectorProperty