Package software.amazon.awscdk.cfnpropertymixins.services.cloudwatch

Class CfnLogAlarmPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudwatch.CfnLogAlarmPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLogAlarmPropsMixin>

Enclosing class:

CfnLogAlarmPropsMixin

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

A fluent builder for CfnLogAlarmPropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnLogAlarmPropsMixin.Builder.

create

@Stability(Stable)
public static CfnLogAlarmPropsMixin.Builder create()

Returns:

a new instance of CfnLogAlarmPropsMixin.Builder.

actionLogLineCount

@Stability(Stable)
public CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.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

comparisonOperator

@Stability(Stable)
public CfnLogAlarmPropsMixin.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

insufficientDataActions

@Stability(Stable)
public CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.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

queryResultsToAlarm

@Stability(Stable)
public CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin.Builder scheduledQueryConfiguration(CfnLogAlarmPropsMixin.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

tags

@Stability(Stable)
public CfnLogAlarmPropsMixin.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

threshold

@Stability(Stable)
public CfnLogAlarmPropsMixin.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

treatMissingData

@Stability(Stable)
public CfnLogAlarmPropsMixin.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 CfnLogAlarmPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnLogAlarmPropsMixin.