Class CreateLogAnomalyDetectorRequest

    • Method Detail

      • hasLogGroupArnList

        public final boolean hasLogGroupArnList()
        For responses, this returns true if the service returned a value for the LogGroupArnList 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.
      • logGroupArnList

        public final List<String> logGroupArnList()

        An array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN.

        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 hasLogGroupArnList() method.

        Returns:
        An array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN.
      • detectorName

        public final String detectorName()

        A name for this anomaly detector.

        Returns:
        A name for this anomaly detector.
      • evaluationFrequency

        public final EvaluationFrequency evaluationFrequency()

        Specifies how often the anomaly detector is to run and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for evaluationFrequency .

        If the service returns an enum value that is not available in the current SDK version, evaluationFrequency will return EvaluationFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evaluationFrequencyAsString().

        Returns:
        Specifies how often the anomaly detector is to run and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for evaluationFrequency .
        See Also:
        EvaluationFrequency
      • evaluationFrequencyAsString

        public final String evaluationFrequencyAsString()

        Specifies how often the anomaly detector is to run and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for evaluationFrequency .

        If the service returns an enum value that is not available in the current SDK version, evaluationFrequency will return EvaluationFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evaluationFrequencyAsString().

        Returns:
        Specifies how often the anomaly detector is to run and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for evaluationFrequency .
        See Also:
        EvaluationFrequency
      • filterPattern

        public final String filterPattern()

        You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here. For more information, see Filter and Pattern Syntax.

        Returns:
        You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here. For more information, see Filter and Pattern Syntax.
      • kmsKeyId

        public final String kmsKeyId()

        Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If a key is assigned to an anomaly detector, a user must have permissions for both this key and for the anomaly detector to retrieve information about the anomalies that it finds.

        For more information about using a KMS key and to see the required IAM policy, see Use a KMS key with an anomaly detector.

        Returns:
        Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If a key is assigned to an anomaly detector, a user must have permissions for both this key and for the anomaly detector to retrieve information about the anomalies that it finds.

        For more information about using a KMS key and to see the required IAM policy, see Use a KMS key with an anomaly detector.

      • anomalyVisibilityTime

        public final Long anomalyVisibilityTime()

        The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in anomalyVisibilityTime, it will be considered normal going forward and will not be detected as an anomaly.

        Returns:
        The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in anomalyVisibilityTime, it will be considered normal going forward and will not be detected as an anomaly.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.
      • tags

        public final Map<String,​String> tags()

        An optional list of key-value pairs to associate with the resource.

        For more information about tagging, see Tagging Amazon Web Services resources

        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 hasTags() method.

        Returns:
        An optional list of key-value pairs to associate with the resource.

        For more information about tagging, see Tagging Amazon Web Services resources

      • 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