Package software.amazon.awscdk.services.cloudwatch

Class AlarmWidgetProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.AlarmWidgetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AlarmWidgetProps>

Enclosing interface:

AlarmWidgetProps

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

A builder for AlarmWidgetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AlarmWidgetProps.Builder	accountId(String accountId)	Sets the value of MetricWidgetProps.getAccountId()
AlarmWidgetProps.Builder	alarm(IAlarm alarm)	Sets the value of AlarmWidgetProps.getAlarm()
AlarmWidgetProps	build()	Builds the configured instance.
AlarmWidgetProps.Builder	height(Number height)	Sets the value of MetricWidgetProps.getHeight()
AlarmWidgetProps.Builder	leftYAxis(YAxisProps leftYAxis)	Sets the value of AlarmWidgetProps.getLeftYAxis()
AlarmWidgetProps.Builder	region(String region)	Sets the value of MetricWidgetProps.getRegion()
AlarmWidgetProps.Builder	title(String title)	Sets the value of MetricWidgetProps.getTitle()
AlarmWidgetProps.Builder	width(Number width)	Sets the value of MetricWidgetProps.getWidth()

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

alarm

@Stability(Stable)
public AlarmWidgetProps.Builder alarm(IAlarm alarm)

Sets the value of AlarmWidgetProps.getAlarm()

Parameters:

alarm - The alarm to show. This parameter is required.

Returns:

this

leftYAxis

@Stability(Stable)
public AlarmWidgetProps.Builder leftYAxis(YAxisProps leftYAxis)

Sets the value of AlarmWidgetProps.getLeftYAxis()

Parameters:

leftYAxis - Left Y axis.

Returns:

this

accountId

@Stability(Stable)
public AlarmWidgetProps.Builder accountId(String accountId)

Sets the value of MetricWidgetProps.getAccountId()

Parameters:

accountId - The AWS account ID where the metrics are located. This enables cross-account functionality for CloudWatch dashboards. Before using this feature, ensure that proper cross-account sharing is configured between the monitoring account and source account.

For more information, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html

Returns:

this

height

@Stability(Stable)
public AlarmWidgetProps.Builder height(Number height)

Sets the value of MetricWidgetProps.getHeight()

Parameters:

height - Height of the widget.

Returns:

this

region

@Stability(Stable)
public AlarmWidgetProps.Builder region(String region)

Sets the value of MetricWidgetProps.getRegion()

Parameters:

region - The region the metrics of this graph should be taken from.

Returns:

this

title

@Stability(Stable)
public AlarmWidgetProps.Builder title(String title)

Sets the value of MetricWidgetProps.getTitle()

Parameters:

title - Title for the graph.

Returns:

this

width

@Stability(Stable)
public AlarmWidgetProps.Builder width(Number width)

Sets the value of MetricWidgetProps.getWidth()

Parameters:

width - Width of the widget, in a grid of 24 units wide.

Returns:

this

build

@Stability(Stable)
public AlarmWidgetProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AlarmWidgetProps

Throws:

NullPointerException - if any required attribute was not provided