io.github.cdklabs.cdkmonitoringconstructs.KinesisFirehoseMonitoring Maven / Gradle / Ivy
package io.github.cdklabs.cdkmonitoringconstructs;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-24T17:32:52.005Z")
@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.KinesisFirehoseMonitoring")
public class KinesisFirehoseMonitoring extends io.github.cdklabs.cdkmonitoringconstructs.Monitoring {
protected KinesisFirehoseMonitoring(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected KinesisFirehoseMonitoring(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 KinesisFirehoseMonitoring(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.MonitoringScope scope, final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.KinesisFirehoseMonitoringProps 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 createConversionWidget(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, "createConversionWidget", 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") });
}
/**
* @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 createIncomingRecordWidget(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, "createIncomingRecordWidget", 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") });
}
/**
* @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 createLatencyWidget(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, "createLatencyWidget", 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") });
}
/**
* @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 createLimitWidget(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, "createLimitWidget", 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));
}
/**
* (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 java.lang.Object getFailedConversionMetric() {
return software.amazon.jsii.Kernel.get(this, "failedConversionMetric", 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 getIncomingBytesMetric() {
return software.amazon.jsii.Kernel.get(this, "incomingBytesMetric", 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 getIncomingBytesToLimitRate() {
return software.amazon.jsii.Kernel.get(this, "incomingBytesToLimitRate", 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.util.List getIncomingLimitAnnotations() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "incomingLimitAnnotations", 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 getIncomingPutRequestsToLimitRate() {
return software.amazon.jsii.Kernel.get(this, "incomingPutRequestsToLimitRate", 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 getIncomingRecordsMetric() {
return software.amazon.jsii.Kernel.get(this, "incomingRecordsMetric", 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 getIncomingRecordsToLimitRate() {
return software.amazon.jsii.Kernel.get(this, "incomingRecordsToLimitRate", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.KinesisAlarmFactory getKinesisAlarmFactory() {
return software.amazon.jsii.Kernel.get(this, "kinesisAlarmFactory", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkmonitoringconstructs.KinesisAlarmFactory.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Object getPutRecordBatchLatency() {
return software.amazon.jsii.Kernel.get(this, "putRecordBatchLatency", 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 getPutRecordLatency() {
return software.amazon.jsii.Kernel.get(this, "putRecordLatency", 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.util.List getRecordCountAnnotations() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "recordCountAnnotations", 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 getSuccessfulConversionMetric() {
return software.amazon.jsii.Kernel.get(this, "successfulConversionMetric", 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 getThrottledRecordsMetric() {
return software.amazon.jsii.Kernel.get(this, "throttledRecordsMetric", 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));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.String getStreamUrl() {
return software.amazon.jsii.Kernel.get(this, "streamUrl", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.cdkmonitoringconstructs.KinesisFirehoseMonitoring}.
*/
@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.KinesisFirehoseMonitoringProps.Builder props;
private Builder(final io.github.cdklabs.cdkmonitoringconstructs.MonitoringScope scope) {
this.scope = scope;
this.props = new io.github.cdklabs.cdkmonitoringconstructs.KinesisFirehoseMonitoringProps.Builder();
}
/**
* (experimental) Account where the metrics exist.
*
* Default: The account configured by the construct holding the Monitoring construct
*
* @return {@code this}
* @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html
* @param account Account where the metrics exist. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder account(final java.lang.String account) {
this.props.account(account);
return this;
}
/**
* (experimental) Region where the metrics exist.
*
* Default: The region configured by the construct holding the Monitoring construct
*
* @return {@code this}
* @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html
* @param region Region where the metrics exist. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder region(final java.lang.String region) {
this.props.region(region);
return this;
}
/**
* @return {@code this}
* @param deliveryStreamName This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder deliveryStreamName(final java.lang.String deliveryStreamName) {
this.props.deliveryStreamName(deliveryStreamName);
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 addIncomingBytesExceedThresholdAlarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addIncomingBytesExceedThresholdAlarm(final java.util.Map addIncomingBytesExceedThresholdAlarm) {
this.props.addIncomingBytesExceedThresholdAlarm(addIncomingBytesExceedThresholdAlarm);
return this;
}
/**
* @return {@code this}
* @param addIncomingPutRequestsExceedThresholdAlarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addIncomingPutRequestsExceedThresholdAlarm(final java.util.Map addIncomingPutRequestsExceedThresholdAlarm) {
this.props.addIncomingPutRequestsExceedThresholdAlarm(addIncomingPutRequestsExceedThresholdAlarm);
return this;
}
/**
* @return {@code this}
* @param addIncomingRecordsExceedThresholdAlarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addIncomingRecordsExceedThresholdAlarm(final java.util.Map addIncomingRecordsExceedThresholdAlarm) {
this.props.addIncomingRecordsExceedThresholdAlarm(addIncomingRecordsExceedThresholdAlarm);
return this;
}
/**
* @return {@code this}
* @param addRecordsThrottledAlarm This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder addRecordsThrottledAlarm(final java.util.Map addRecordsThrottledAlarm) {
this.props.addRecordsThrottledAlarm(addRecordsThrottledAlarm);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.cdkmonitoringconstructs.KinesisFirehoseMonitoring}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.cdkmonitoringconstructs.KinesisFirehoseMonitoring build() {
return new io.github.cdklabs.cdkmonitoringconstructs.KinesisFirehoseMonitoring(
this.scope,
this.props.build()
);
}
}
}