io.github.cdklabs.cdkmonitoringconstructs.StepFunctionActivityMonitoring Maven / Gradle / Ivy
package io.github.cdklabs.cdkmonitoringconstructs;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.93.0 (build 1706ca5)", date = "2024-01-08T00:34:46.806Z")
@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.StepFunctionActivityMonitoring")
public class StepFunctionActivityMonitoring extends io.github.cdklabs.cdkmonitoringconstructs.Monitoring {
protected StepFunctionActivityMonitoring(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected StepFunctionActivityMonitoring(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 StepFunctionActivityMonitoring(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.MonitoringScope scope, final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.StepFunctionActivityMonitoringProps 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") });
}
/**
* (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.LatencyAlarmFactory getDurationAlarmFactory() {
return software.amazon.jsii.Kernel.get(this, "durationAlarmFactory", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkmonitoringconstructs.LatencyAlarmFactory.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getDurationAnnotations() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "durationAnnotations", 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.NotNull io.github.cdklabs.cdkmonitoringconstructs.ErrorAlarmFactory getErrorAlarmFactory() {
return software.amazon.jsii.Kernel.get(this, "errorAlarmFactory", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkmonitoringconstructs.ErrorAlarmFactory.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getErrorCountAnnotations() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "errorCountAnnotations", 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.NotNull java.util.List getErrorRateAnnotations() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "errorRateAnnotations", 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.NotNull java.lang.Object getFailedActivitiesMetric() {
return software.amazon.jsii.Kernel.get(this, "failedActivitiesMetric", 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.Object getFailedActivitiesRateMetric() {
return software.amazon.jsii.Kernel.get(this, "failedActivitiesRateMetric", 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.Object getHeartbeatTimedOutActivitiesMetrics() {
return software.amazon.jsii.Kernel.get(this, "heartbeatTimedOutActivitiesMetrics", 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.Object getP50DurationMetric() {
return software.amazon.jsii.Kernel.get(this, "p50DurationMetric", 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.Object getP90DurationMetric() {
return software.amazon.jsii.Kernel.get(this, "p90DurationMetric", 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.Object getP99DurationMetric() {
return software.amazon.jsii.Kernel.get(this, "p99DurationMetric", 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.Object getScheduledActivitiesMetric() {
return software.amazon.jsii.Kernel.get(this, "scheduledActivitiesMetric", 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.Object getStartedActivitiesMetric() {
return software.amazon.jsii.Kernel.get(this, "startedActivitiesMetric", 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.Object getSucceededActivitiesMetric() {
return software.amazon.jsii.Kernel.get(this, "succeededActivitiesMetric", 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.Object getTimedOutActivitiesMetrics() {
return software.amazon.jsii.Kernel.get(this, "timedOutActivitiesMetrics", 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.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.StepFunctionActivityMonitoring}.
*/
@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.StepFunctionActivityMonitoringProps.Builder props;
private Builder(final io.github.cdklabs.cdkmonitoringconstructs.MonitoringScope scope) {
this.scope = scope;
this.props = new io.github.cdklabs.cdkmonitoringconstructs.StepFunctionActivityMonitoringProps.Builder();
}
/**
* @return {@code this}
* @param activity This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder activity(final software.amazon.awscdk.services.stepfunctions.IActivity activity) {
this.props.activity(activity);
return this;
}
/**
* Default: - average
*
* @return {@code this}
* @param rateComputationMethod This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder rateComputationMethod(final io.github.cdklabs.cdkmonitoringconstructs.RateComputationMethod rateComputationMethod) {
this.props.rateComputationMethod(rateComputationMethod);
return this;
}
/**
* (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;
}
/**
* @return {@code this}
* @param addDurationP50Alarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addDurationP50Alarm(final java.util.Map addDurationP50Alarm) {
this.props.addDurationP50Alarm(addDurationP50Alarm);
return this;
}
/**
* @return {@code this}
* @param addDurationP90Alarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addDurationP90Alarm(final java.util.Map addDurationP90Alarm) {
this.props.addDurationP90Alarm(addDurationP90Alarm);
return this;
}
/**
* @return {@code this}
* @param addDurationP99Alarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addDurationP99Alarm(final java.util.Map addDurationP99Alarm) {
this.props.addDurationP99Alarm(addDurationP99Alarm);
return this;
}
/**
* @return {@code this}
* @param addFailedActivitiesCountAlarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addFailedActivitiesCountAlarm(final java.util.Map addFailedActivitiesCountAlarm) {
this.props.addFailedActivitiesCountAlarm(addFailedActivitiesCountAlarm);
return this;
}
/**
* @return {@code this}
* @param addFailedActivitiesRateAlarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addFailedActivitiesRateAlarm(final java.util.Map addFailedActivitiesRateAlarm) {
this.props.addFailedActivitiesRateAlarm(addFailedActivitiesRateAlarm);
return this;
}
/**
* @return {@code this}
* @param addTimedOutActivitiesCountAlarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addTimedOutActivitiesCountAlarm(final java.util.Map addTimedOutActivitiesCountAlarm) {
this.props.addTimedOutActivitiesCountAlarm(addTimedOutActivitiesCountAlarm);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.cdkmonitoringconstructs.StepFunctionActivityMonitoring}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.cdkmonitoringconstructs.StepFunctionActivityMonitoring build() {
return new io.github.cdklabs.cdkmonitoringconstructs.StepFunctionActivityMonitoring(
this.scope,
this.props.build()
);
}
}
}