Package software.amazon.awscdk.services.cloudwatch

Class CfnLogAlarmProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CfnLogAlarmProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLogAlarmProps>

Enclosing interface:

CfnLogAlarmProps

@Stability(Stable)
public static final class CfnLogAlarmProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLogAlarmProps>

A builder for CfnLogAlarmProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnLogAlarmProps.Builder	actionLogLineCount(Number actionLogLineCount)	Sets the value of CfnLogAlarmProps.getActionLogLineCount()
CfnLogAlarmProps.Builder	actionLogLineRoleArn(String actionLogLineRoleArn)	Sets the value of CfnLogAlarmProps.getActionLogLineRoleArn()
CfnLogAlarmProps.Builder	actionsEnabled(Boolean actionsEnabled)	Sets the value of CfnLogAlarmProps.getActionsEnabled()
CfnLogAlarmProps.Builder	actionsEnabled(IResolvable actionsEnabled)	Sets the value of CfnLogAlarmProps.getActionsEnabled()
CfnLogAlarmProps.Builder	alarmActions(List<String> alarmActions)	Sets the value of CfnLogAlarmProps.getAlarmActions()
CfnLogAlarmProps.Builder	alarmDescription(String alarmDescription)	Sets the value of CfnLogAlarmProps.getAlarmDescription()
CfnLogAlarmProps.Builder	alarmName(String alarmName)	Sets the value of CfnLogAlarmProps.getAlarmName()
CfnLogAlarmProps	build()	Builds the configured instance.
CfnLogAlarmProps.Builder	comparisonOperator(String comparisonOperator)	Sets the value of CfnLogAlarmProps.getComparisonOperator()
CfnLogAlarmProps.Builder	insufficientDataActions(List<String> insufficientDataActions)	Sets the value of CfnLogAlarmProps.getInsufficientDataActions()
CfnLogAlarmProps.Builder	okActions(List<String> okActions)	Sets the value of CfnLogAlarmProps.getOkActions()
CfnLogAlarmProps.Builder	queryResultsToAlarm(Number queryResultsToAlarm)	Sets the value of CfnLogAlarmProps.getQueryResultsToAlarm()
CfnLogAlarmProps.Builder	queryResultsToEvaluate(Number queryResultsToEvaluate)	Sets the value of CfnLogAlarmProps.getQueryResultsToEvaluate()
CfnLogAlarmProps.Builder	scheduledQueryConfiguration(IResolvable scheduledQueryConfiguration)	Sets the value of CfnLogAlarmProps.getScheduledQueryConfiguration()
CfnLogAlarmProps.Builder	scheduledQueryConfiguration(CfnLogAlarm.ScheduledQueryConfigurationProperty scheduledQueryConfiguration)	Sets the value of CfnLogAlarmProps.getScheduledQueryConfiguration()
CfnLogAlarmProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnLogAlarmProps.getTags()
CfnLogAlarmProps.Builder	threshold(Number threshold)	Sets the value of CfnLogAlarmProps.getThreshold()
CfnLogAlarmProps.Builder	treatMissingData(String treatMissingData)	Sets the value of CfnLogAlarmProps.getTreatMissingData()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

comparisonOperator

@Stability(Stable)
public CfnLogAlarmProps.Builder comparisonOperator(String comparisonOperator)

Sets the value of CfnLogAlarmProps.getComparisonOperator()

Parameters:

comparisonOperator - The arithmetic operation to use when comparing the specified threshold and the query results. This parameter is required. Valid values are GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.

Returns:

this

queryResultsToAlarm

@Stability(Stable)
public CfnLogAlarmProps.Builder queryResultsToAlarm(Number queryResultsToAlarm)

Sets the value of CfnLogAlarmProps.getQueryResultsToAlarm()

Parameters:

queryResultsToAlarm - The number of query results that must be breaching to trigger the alarm. This parameter is required.

Returns:

this

queryResultsToEvaluate

@Stability(Stable)
public CfnLogAlarmProps.Builder queryResultsToEvaluate(Number queryResultsToEvaluate)

Sets the value of CfnLogAlarmProps.getQueryResultsToEvaluate()

Parameters:

queryResultsToEvaluate - The number of query results over which data is compared to the specified threshold. This parameter is required.

Returns:

this

scheduledQueryConfiguration

@Stability(Stable)
public CfnLogAlarmProps.Builder scheduledQueryConfiguration(IResolvable scheduledQueryConfiguration)

Sets the value of CfnLogAlarmProps.getScheduledQueryConfiguration()

Parameters:

scheduledQueryConfiguration - The scheduled query configuration for the log alarm. This parameter is required.

Returns:

this

scheduledQueryConfiguration

@Stability(Stable)
public CfnLogAlarmProps.Builder scheduledQueryConfiguration(CfnLogAlarm.ScheduledQueryConfigurationProperty scheduledQueryConfiguration)

Sets the value of CfnLogAlarmProps.getScheduledQueryConfiguration()

Parameters:

scheduledQueryConfiguration - The scheduled query configuration for the log alarm. This parameter is required.

Returns:

this

threshold

@Stability(Stable)
public CfnLogAlarmProps.Builder threshold(Number threshold)

Sets the value of CfnLogAlarmProps.getThreshold()

Parameters:

threshold - The value to compare against the results of the scheduled query evaluation. This parameter is required.

Returns:

this

actionLogLineCount

@Stability(Stable)
public CfnLogAlarmProps.Builder actionLogLineCount(Number actionLogLineCount)

Sets the value of CfnLogAlarmProps.getActionLogLineCount()

Parameters:

actionLogLineCount - The number of log lines to include in alarm notifications. Valid values are 0 to 50.

Returns:

this

actionLogLineRoleArn

@Stability(Stable)
public CfnLogAlarmProps.Builder actionLogLineRoleArn(String actionLogLineRoleArn)

Sets the value of CfnLogAlarmProps.getActionLogLineRoleArn()

Parameters:

actionLogLineRoleArn - The ARN of the IAM role that grants CloudWatch permissions to fetch log lines for alarm notifications. Required when ActionLogLineCount is greater than 0.

Returns:

this

actionsEnabled

@Stability(Stable)
public CfnLogAlarmProps.Builder actionsEnabled(Boolean actionsEnabled)

Sets the value of CfnLogAlarmProps.getActionsEnabled()

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

Returns:

this

actionsEnabled

@Stability(Stable)
public CfnLogAlarmProps.Builder actionsEnabled(IResolvable actionsEnabled)

Sets the value of CfnLogAlarmProps.getActionsEnabled()

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

Returns:

this

alarmActions

@Stability(Stable)
public CfnLogAlarmProps.Builder alarmActions(List<String> alarmActions)

Sets the value of CfnLogAlarmProps.getAlarmActions()

Parameters:

alarmActions - The list of actions to execute when this alarm transitions into an ALARM state from any other state.

Returns:

this

alarmDescription

@Stability(Stable)
public CfnLogAlarmProps.Builder alarmDescription(String alarmDescription)

Sets the value of CfnLogAlarmProps.getAlarmDescription()

Parameters:

alarmDescription - The description of the log alarm.

Returns:

this

alarmName

@Stability(Stable)
public CfnLogAlarmProps.Builder alarmName(String alarmName)

Sets the value of CfnLogAlarmProps.getAlarmName()

Parameters:

alarmName - The name of the log alarm.

Returns:

this

insufficientDataActions

@Stability(Stable)
public CfnLogAlarmProps.Builder insufficientDataActions(List<String> insufficientDataActions)

Sets the value of CfnLogAlarmProps.getInsufficientDataActions()

Parameters:

insufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.

Returns:

this

okActions

@Stability(Stable)
public CfnLogAlarmProps.Builder okActions(List<String> okActions)

Sets the value of CfnLogAlarmProps.getOkActions()

Parameters:

okActions - The actions to execute when this alarm transitions to the OK state from any other state.

Returns:

this

tags

@Stability(Stable)
public CfnLogAlarmProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnLogAlarmProps.getTags()

Parameters:

tags - A list of key-value pairs to associate with the log alarm.

Returns:

this

treatMissingData

@Stability(Stable)
public CfnLogAlarmProps.Builder treatMissingData(String treatMissingData)

Sets the value of CfnLogAlarmProps.getTreatMissingData()

Parameters:

treatMissingData - Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.

Returns:

this

build

@Stability(Stable)
public CfnLogAlarmProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnLogAlarmProps>

Returns:

a new instance of CfnLogAlarmProps

Throws:

NullPointerException - if any required attribute was not provided