Class PutInsightSelectorsRequest

    • Method Detail

      • trailName

        public final String trailName()

        The name of the CloudTrail trail for which you want to change or add Insights selectors.

        You cannot use this parameter with the EventDataStore and InsightsDestination parameters.

        Returns:
        The name of the CloudTrail trail for which you want to change or add Insights selectors.

        You cannot use this parameter with the EventDataStore and InsightsDestination parameters.

      • hasInsightSelectors

        public final boolean hasInsightSelectors()
        For responses, this returns true if the service returned a value for the InsightSelectors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • insightSelectors

        public final List<InsightSelector> insightSelectors()

        A JSON string that contains the Insights types you want to log on a trail or 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInsightSelectors() method.

        Returns:
        A JSON string that contains the Insights types you want to log on a trail or 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.

      • eventDataStore

        public final String eventDataStore()

        The ARN (or ID suffix of the ARN) of the source event data store for which you want to change or add Insights selectors. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

        You cannot use this parameter with the TrailName parameter.

        Returns:
        The ARN (or ID suffix of the ARN) of the source event data store for which you want to change or add Insights selectors. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

        You cannot use this parameter with the TrailName parameter.

      • insightsDestination

        public final String insightsDestination()

        The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

        You cannot use this parameter with the TrailName parameter.

        Returns:
        The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

        You cannot use this parameter with the TrailName parameter.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object