io.github.cdklabs.cdkmonitoringconstructs.LogMonitoring Maven / Gradle / Ivy
package io.github.cdklabs.cdkmonitoringconstructs;
/**
* (experimental) Monitors a CloudWatch log group for various patterns.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.93.0 (build 1706ca5)", date = "2024-01-08T00:34:46.690Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdkmonitoringconstructs.$Module.class, fqn = "cdk-monitoring-constructs.LogMonitoring")
public class LogMonitoring extends io.github.cdklabs.cdkmonitoringconstructs.Monitoring {
protected LogMonitoring(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected LogMonitoring(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public LogMonitoring(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.MonitoringScope scope, final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.LogMonitoringProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* @param width This parameter is required.
* @param height This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.cloudwatch.GraphWidget createIncomingLogsWidget(final @org.jetbrains.annotations.NotNull java.lang.Number width, final @org.jetbrains.annotations.NotNull java.lang.Number height) {
return software.amazon.jsii.Kernel.call(this, "createIncomingLogsWidget", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.cloudwatch.GraphWidget.class), new Object[] { java.util.Objects.requireNonNull(width, "width is required"), java.util.Objects.requireNonNull(height, "height is required") });
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.MonitoringHeaderWidget createTitleWidget() {
return software.amazon.jsii.Kernel.call(this, "createTitleWidget", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkmonitoringconstructs.MonitoringHeaderWidget.class));
}
/**
* @param numRows This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
protected @org.jetbrains.annotations.NotNull java.lang.Number resolveRecommendedHeight(final @org.jetbrains.annotations.NotNull java.lang.Number numRows) {
return software.amazon.jsii.Kernel.call(this, "resolveRecommendedHeight", software.amazon.jsii.NativeType.forClass(java.lang.Number.class), new Object[] { java.util.Objects.requireNonNull(numRows, "numRows is required") });
}
/**
* (experimental) Returns widgets to be placed on the summary dashboard.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public @org.jetbrains.annotations.NotNull java.util.List summaryWidgets() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "summaryWidgets", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.cloudwatch.IWidget.class))));
}
/**
* (experimental) Returns widgets to be placed on the main dashboard.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public @org.jetbrains.annotations.NotNull java.util.List widgets() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "widgets", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.cloudwatch.IWidget.class))));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.AlarmFactory getAlarmFactory() {
return software.amazon.jsii.Kernel.get(this, "alarmFactory", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkmonitoringconstructs.AlarmFactory.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Object getIncomingLogEventsMetric() {
return software.amazon.jsii.Kernel.get(this, "incomingLogEventsMetric", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Number getLimit() {
return software.amazon.jsii.Kernel.get(this, "limit", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getLogGroupName() {
return software.amazon.jsii.Kernel.get(this, "logGroupName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.UsageAlarmFactory getUsageAlarmFactory() {
return software.amazon.jsii.Kernel.get(this, "usageAlarmFactory", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkmonitoringconstructs.UsageAlarmFactory.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getUsageAnnotations() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "usageAnnotations", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.cloudwatch.HorizontalAnnotation.class))));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getLogGroupUrl() {
return software.amazon.jsii.Kernel.get(this, "logGroupUrl", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getPattern() {
return software.amazon.jsii.Kernel.get(this, "pattern", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getTitle() {
return software.amazon.jsii.Kernel.get(this, "title", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.cdkmonitoringconstructs.LogMonitoring}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final io.github.cdklabs.cdkmonitoringconstructs.MonitoringScope scope) {
return new Builder(scope);
}
private final io.github.cdklabs.cdkmonitoringconstructs.MonitoringScope scope;
private final io.github.cdklabs.cdkmonitoringconstructs.LogMonitoringProps.Builder props;
private Builder(final io.github.cdklabs.cdkmonitoringconstructs.MonitoringScope scope) {
this.scope = scope;
this.props = new io.github.cdklabs.cdkmonitoringconstructs.LogMonitoringProps.Builder();
}
/**
* (experimental) Plain name, used in naming alarms.
*
* This unique among other resources, and respect the AWS CDK restriction posed on alarm names.
* The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens.
*
* Default: - derives name from the construct itself
*
* @return {@code this}
* @param alarmFriendlyName Plain name, used in naming alarms. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder alarmFriendlyName(final java.lang.String alarmFriendlyName) {
this.props.alarmFriendlyName(alarmFriendlyName);
return this;
}
/**
* (experimental) Human-readable name is a freeform string, used as a caption or description.
*
* There are no limitations on what it can be.
*
* Default: - use alarmFriendlyName
*
* @return {@code this}
* @param humanReadableName Human-readable name is a freeform string, used as a caption or description. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder humanReadableName(final java.lang.String humanReadableName) {
this.props.humanReadableName(humanReadableName);
return this;
}
/**
* (experimental) If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value.
*
* The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens.
*
* @return {@code this}
* @see AlarmNamingStrategy for more details on alarm name prefixes
* @param localAlarmNamePrefixOverride If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder localAlarmNamePrefixOverride(final java.lang.String localAlarmNamePrefixOverride) {
this.props.localAlarmNamePrefixOverride(localAlarmNamePrefixOverride);
return this;
}
/**
* (experimental) Flag indicating if the widgets should be added to alarm dashboard.
*
* Default: - true
*
* @return {@code this}
* @param addToAlarmDashboard Flag indicating if the widgets should be added to alarm dashboard. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addToAlarmDashboard(final java.lang.Boolean addToAlarmDashboard) {
this.props.addToAlarmDashboard(addToAlarmDashboard);
return this;
}
/**
* (experimental) Flag indicating if the widgets should be added to detailed dashboard.
*
* Default: - true
*
* @return {@code this}
* @param addToDetailDashboard Flag indicating if the widgets should be added to detailed dashboard. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addToDetailDashboard(final java.lang.Boolean addToDetailDashboard) {
this.props.addToDetailDashboard(addToDetailDashboard);
return this;
}
/**
* (experimental) Flag indicating if the widgets should be added to summary dashboard.
*
* Default: - true
*
* @return {@code this}
* @param addToSummaryDashboard Flag indicating if the widgets should be added to summary dashboard. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addToSummaryDashboard(final java.lang.Boolean addToSummaryDashboard) {
this.props.addToSummaryDashboard(addToSummaryDashboard);
return this;
}
/**
* (experimental) Calls provided function to process all alarms created.
*
* @return {@code this}
* @param useCreatedAlarms Calls provided function to process all alarms created. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder useCreatedAlarms(final io.github.cdklabs.cdkmonitoringconstructs.IAlarmConsumer useCreatedAlarms) {
this.props.useCreatedAlarms(useCreatedAlarms);
return this;
}
/**
* (experimental) Name of the log group to monitor.
*
* @return {@code this}
* @param logGroupName Name of the log group to monitor. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder logGroupName(final java.lang.String logGroupName) {
this.props.logGroupName(logGroupName);
return this;
}
/**
* @return {@code this}
* @param addMinIncomingLogsAlarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addMinIncomingLogsAlarm(final java.util.Map addMinIncomingLogsAlarm) {
this.props.addMinIncomingLogsAlarm(addMinIncomingLogsAlarm);
return this;
}
/**
* (experimental) Maximum number of log messages to search for.
*
* Default: - 10
*
* @return {@code this}
* @param limit Maximum number of log messages to search for. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder limit(final java.lang.Number limit) {
this.props.limit(limit);
return this;
}
/**
* (experimental) Pattern to search for, e.g. "ERROR".
*
* @return {@code this}
* @param pattern Pattern to search for, e.g. "ERROR". This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder pattern(final java.lang.String pattern) {
this.props.pattern(pattern);
return this;
}
/**
* (experimental) Widget title.
*
* Default: - auto-generated title based on the pattern and limit
*
* @return {@code this}
* @param title Widget title. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder title(final java.lang.String title) {
this.props.title(title);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.cdkmonitoringconstructs.LogMonitoring}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.cdkmonitoringconstructs.LogMonitoring build() {
return new io.github.cdklabs.cdkmonitoringconstructs.LogMonitoring(
this.scope,
this.props.build()
);
}
}
}