Package software.amazon.awscdk.services.cloudwatch

Class LogQueryWidgetProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.LogQueryWidgetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LogQueryWidgetProps>

Enclosing interface:

LogQueryWidgetProps

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

A builder for LogQueryWidgetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LogQueryWidgetProps.Builder	accountId(String accountId)	Sets the value of LogQueryWidgetProps.getAccountId()
LogQueryWidgetProps	build()	Builds the configured instance.
LogQueryWidgetProps.Builder	height(Number height)	Sets the value of LogQueryWidgetProps.getHeight()
LogQueryWidgetProps.Builder	logGroupNames(List<String> logGroupNames)	Sets the value of LogQueryWidgetProps.getLogGroupNames()
LogQueryWidgetProps.Builder	queryLanguage(LogQueryLanguage queryLanguage)	Sets the value of LogQueryWidgetProps.getQueryLanguage()
LogQueryWidgetProps.Builder	queryLines(List<String> queryLines)	Sets the value of LogQueryWidgetProps.getQueryLines()
LogQueryWidgetProps.Builder	queryString(String queryString)	Sets the value of LogQueryWidgetProps.getQueryString()
LogQueryWidgetProps.Builder	region(String region)	Sets the value of LogQueryWidgetProps.getRegion()
LogQueryWidgetProps.Builder	title(String title)	Sets the value of LogQueryWidgetProps.getTitle()
LogQueryWidgetProps.Builder	view(LogQueryVisualizationType view)	Sets the value of LogQueryWidgetProps.getView()
LogQueryWidgetProps.Builder	width(Number width)	Sets the value of LogQueryWidgetProps.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

logGroupNames

@Stability(Stable)
public LogQueryWidgetProps.Builder logGroupNames(List<String> logGroupNames)

Sets the value of LogQueryWidgetProps.getLogGroupNames()

Parameters:

logGroupNames - Names of log groups to query. This parameter is required.

Returns:

this

accountId

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

Sets the value of LogQueryWidgetProps.getAccountId()

Parameters:

accountId - The AWS account ID where the log groups 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 LogQueryWidgetProps.Builder height(Number height)

Sets the value of LogQueryWidgetProps.getHeight()

Parameters:

height - Height of the widget.

Returns:

this

queryLanguage

@Stability(Stable)
public LogQueryWidgetProps.Builder queryLanguage(LogQueryLanguage queryLanguage)

Sets the value of LogQueryWidgetProps.getQueryLanguage()

Parameters:

queryLanguage - The query language to use for the query.

Returns:

this

queryLines

@Stability(Stable)
public LogQueryWidgetProps.Builder queryLines(List<String> queryLines)

Sets the value of LogQueryWidgetProps.getQueryLines()

Parameters:

queryLines - A sequence of lines to use to build the query. The query will be built by joining the lines together using \n|.

Returns:

this

queryString

@Stability(Stable)
public LogQueryWidgetProps.Builder queryString(String queryString)

Sets the value of LogQueryWidgetProps.getQueryString()

Parameters:

queryString - Full query string for log insights. Be sure to prepend every new line with a newline and pipe character (\n|).

Returns:

this

region

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

Sets the value of LogQueryWidgetProps.getRegion()

Parameters:

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

Returns:

this

title

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

Sets the value of LogQueryWidgetProps.getTitle()

Parameters:

title - Title for the widget.

Returns:

this

view

@Stability(Stable)
public LogQueryWidgetProps.Builder view(LogQueryVisualizationType view)

Sets the value of LogQueryWidgetProps.getView()

Parameters:

view - The type of view to use.

Returns:

this

width

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

Sets the value of LogQueryWidgetProps.getWidth()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public LogQueryWidgetProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LogQueryWidgetProps

Throws:

NullPointerException - if any required attribute was not provided