com.amazonaws.services.logs.model

Class CreateLogAnomalyDetectorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.CreateLogAnomalyDetectorRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateLogAnomalyDetectorRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateLogAnomalyDetectorRequest()

Method Summary

Modifier and Type	Method and Description
CreateLogAnomalyDetectorRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateLogAnomalyDetectorRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateLogAnomalyDetectorRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getAnomalyVisibilityTime() The number of days to have visibility on an anomaly.
String	getDetectorName() A name for this anomaly detector.
String	getEvaluationFrequency() Specifies how often the anomaly detector is to run and look for anomalies.
String	getFilterPattern() You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here.
String	getKmsKeyId() Optionally assigns a KMS key to secure this anomaly detector and its findings.
List<String>	getLogGroupArnList() An array containing the ARN of the log group that this anomaly detector will watch.
Map<String,String>	getTags() An optional list of key-value pairs to associate with the resource.
int	hashCode()
void	setAnomalyVisibilityTime(Long anomalyVisibilityTime) The number of days to have visibility on an anomaly.
void	setDetectorName(String detectorName) A name for this anomaly detector.
void	setEvaluationFrequency(String evaluationFrequency) Specifies how often the anomaly detector is to run and look for anomalies.
void	setFilterPattern(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.
void	setKmsKeyId(String kmsKeyId) Optionally assigns a KMS key to secure this anomaly detector and its findings.
void	setLogGroupArnList(Collection<String> logGroupArnList) An array containing the ARN of the log group that this anomaly detector will watch.
void	setTags(Map<String,String> tags) An optional list of key-value pairs to associate with the resource.
String	toString() Returns a string representation of this object.
CreateLogAnomalyDetectorRequest	withAnomalyVisibilityTime(Long anomalyVisibilityTime) The number of days to have visibility on an anomaly.
CreateLogAnomalyDetectorRequest	withDetectorName(String detectorName) A name for this anomaly detector.
CreateLogAnomalyDetectorRequest	withEvaluationFrequency(EvaluationFrequency evaluationFrequency) Specifies how often the anomaly detector is to run and look for anomalies.
CreateLogAnomalyDetectorRequest	withEvaluationFrequency(String evaluationFrequency) Specifies how often the anomaly detector is to run and look for anomalies.
CreateLogAnomalyDetectorRequest	withFilterPattern(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.
CreateLogAnomalyDetectorRequest	withKmsKeyId(String kmsKeyId) Optionally assigns a KMS key to secure this anomaly detector and its findings.
CreateLogAnomalyDetectorRequest	withLogGroupArnList(Collection<String> logGroupArnList) An array containing the ARN of the log group that this anomaly detector will watch.
CreateLogAnomalyDetectorRequest	withLogGroupArnList(String... logGroupArnList) An array containing the ARN of the log group that this anomaly detector will watch.
CreateLogAnomalyDetectorRequest	withTags(Map<String,String> tags) An optional list of key-value pairs to associate with the resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateLogAnomalyDetectorRequest

public CreateLogAnomalyDetectorRequest()

Method Detail

getLogGroupArnList

public List<String> getLogGroupArnList()

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

Returns:

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

setLogGroupArnList

public void setLogGroupArnList(Collection<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.

Parameters:

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

withLogGroupArnList

public CreateLogAnomalyDetectorRequest withLogGroupArnList(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.

NOTE: This method appends the values to the existing list (if any). Use setLogGroupArnList(java.util.Collection) or withLogGroupArnList(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withLogGroupArnList

public CreateLogAnomalyDetectorRequest withLogGroupArnList(Collection<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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDetectorName

public void setDetectorName(String detectorName)

A name for this anomaly detector.

Parameters:

detectorName - A name for this anomaly detector.

getDetectorName

public String getDetectorName()

A name for this anomaly detector.

Returns:

A name for this anomaly detector.

withDetectorName

public CreateLogAnomalyDetectorRequest withDetectorName(String detectorName)

A name for this anomaly detector.

Parameters:

detectorName - A name for this anomaly detector.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEvaluationFrequency

public void setEvaluationFrequency(String 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 .

Parameters:

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 .

See Also:

EvaluationFrequency

getEvaluationFrequency

public String getEvaluationFrequency()

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 .

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

withEvaluationFrequency

public CreateLogAnomalyDetectorRequest withEvaluationFrequency(String 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 .

Parameters:

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 .

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EvaluationFrequency

withEvaluationFrequency

public CreateLogAnomalyDetectorRequest withEvaluationFrequency(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 .

Parameters:

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 .

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EvaluationFrequency

setFilterPattern

public void setFilterPattern(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.

Parameters:

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.

getFilterPattern

public String getFilterPattern()

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.

withFilterPattern

public CreateLogAnomalyDetectorRequest withFilterPattern(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(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.

Parameters:

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.

getKmsKeyId

public String getKmsKeyId()

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.

withKmsKeyId

public CreateLogAnomalyDetectorRequest withKmsKeyId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setAnomalyVisibilityTime

public void setAnomalyVisibilityTime(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.

Parameters:

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.

getAnomalyVisibilityTime

public Long getAnomalyVisibilityTime()

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.

withAnomalyVisibilityTime

public CreateLogAnomalyDetectorRequest withAnomalyVisibilityTime(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

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

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

Returns:

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

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

setTags

public void setTags(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

Parameters:

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

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

withTags

public CreateLogAnomalyDetectorRequest withTags(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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateLogAnomalyDetectorRequest addTagsEntry(String key,
                                                    String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateLogAnomalyDetectorRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateLogAnomalyDetectorRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()