Package software.amazon.awscdk.services.cloudwatch

Class CfnLogAlarm.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CfnLogAlarm.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLogAlarm>

Enclosing class:

CfnLogAlarm

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

A fluent builder for CfnLogAlarm.

Method Summary

Modifier and Type	Method	Description
CfnLogAlarm.Builder	actionLogLineCount(Number actionLogLineCount)	The number of log lines to include in alarm notifications.
CfnLogAlarm.Builder	actionLogLineRoleArn(String actionLogLineRoleArn)	The ARN of the IAM role that grants CloudWatch permissions to fetch log lines for alarm notifications.
CfnLogAlarm.Builder	actionsEnabled(Boolean actionsEnabled)	Indicates whether actions should be executed during any changes to the alarm state.
CfnLogAlarm.Builder	actionsEnabled(IResolvable actionsEnabled)	Indicates whether actions should be executed during any changes to the alarm state.
CfnLogAlarm.Builder	alarmActions(List<String> alarmActions)	The list of actions to execute when this alarm transitions into an ALARM state from any other state.
CfnLogAlarm.Builder	alarmDescription(String alarmDescription)	The description of the log alarm.
CfnLogAlarm.Builder	alarmName(String alarmName)	The name of the log alarm.
CfnLogAlarm	build()
CfnLogAlarm.Builder	comparisonOperator(String comparisonOperator)	The arithmetic operation to use when comparing the specified threshold and the query results.
static CfnLogAlarm.Builder	create(software.constructs.Construct scope, String id)
CfnLogAlarm.Builder	insufficientDataActions(List<String> insufficientDataActions)	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
CfnLogAlarm.Builder	okActions(List<String> okActions)	The actions to execute when this alarm transitions to the OK state from any other state.
CfnLogAlarm.Builder	queryResultsToAlarm(Number queryResultsToAlarm)	The number of query results that must be breaching to trigger the alarm.
CfnLogAlarm.Builder	queryResultsToEvaluate(Number queryResultsToEvaluate)	The number of query results over which data is compared to the specified threshold.
CfnLogAlarm.Builder	scheduledQueryConfiguration(IResolvable scheduledQueryConfiguration)	The scheduled query configuration for the log alarm.
CfnLogAlarm.Builder	scheduledQueryConfiguration(CfnLogAlarm.ScheduledQueryConfigurationProperty scheduledQueryConfiguration)	The scheduled query configuration for the log alarm.
CfnLogAlarm.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs to associate with the log alarm.
CfnLogAlarm.Builder	threshold(Number threshold)	The value to compare against the results of the scheduled query evaluation.
CfnLogAlarm.Builder	treatMissingData(String treatMissingData)	Sets how this alarm is to handle missing data points.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnLogAlarm.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLogAlarm.Builder.

comparisonOperator

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

The arithmetic operation to use when comparing the specified threshold and the query results.

Valid values are GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.

Parameters:

comparisonOperator - The arithmetic operation to use when comparing the specified threshold and the query results. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-comparisonoperator

queryResultsToAlarm

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

The number of query results that must be breaching to trigger the alarm.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-queryresultstoalarm

queryResultsToEvaluate

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

The number of query results over which data is compared to the specified threshold.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-queryresultstoevaluate

scheduledQueryConfiguration

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

The scheduled query configuration for the log alarm.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-scheduledqueryconfiguration

scheduledQueryConfiguration

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

The scheduled query configuration for the log alarm.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-scheduledqueryconfiguration

threshold

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

The value to compare against the results of the scheduled query evaluation.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-threshold

actionLogLineCount

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

The number of log lines to include in alarm notifications.

Valid values are 0 to 50.

Parameters:

actionLogLineCount - The number of log lines to include in alarm notifications. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-actionloglinecount

actionLogLineRoleArn

@Stability(Stable)
public CfnLogAlarm.Builder actionLogLineRoleArn(String 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.

Parameters:

actionLogLineRoleArn - The ARN of the IAM role that grants CloudWatch permissions to fetch log lines for alarm notifications. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-actionloglinerolearn

actionsEnabled

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

Indicates whether actions should be executed during any changes to the alarm state.

The default is TRUE.

Default: - true

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-actionsenabled

actionsEnabled

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

Indicates whether actions should be executed during any changes to the alarm state.

The default is TRUE.

Default: - true

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-actionsenabled

alarmActions

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-alarmactions

alarmDescription

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

The description of the log alarm.

Parameters:

alarmDescription - The description of the log alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-alarmdescription

alarmName

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

The name of the log alarm.

Parameters:

alarmName - The name of the log alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-alarmname

insufficientDataActions

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-insufficientdataactions

okActions

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-okactions

tags

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

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

Parameters:

tags - A list of key-value pairs to associate with the log alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-tags

treatMissingData

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

Sets how this alarm is to handle missing data points.

Valid values are breaching, notBreaching, ignore, and missing.

Parameters:

treatMissingData - Sets how this alarm is to handle missing data points. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-logalarm.html#cfn-cloudwatch-logalarm-treatmissingdata

build

@Stability(Stable)
public CfnLogAlarm build()

Specified by:

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

Returns:

a newly built instance of CfnLogAlarm.