io.github.cdklabs.cdkmonitoringconstructs.CloudFrontDistributionMetricFactory Maven / Gradle / Ivy
package io.github.cdklabs.cdkmonitoringconstructs;
/**
* (experimental) To get the CloudFront metrics from the CloudWatch API, you must use the US East (N.
*
* Virginia) Region (us-east-1).
* https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/programming-cloudwatch-metrics.html
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-24T17:32:51.844Z")
@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.CloudFrontDistributionMetricFactory")
public class CloudFrontDistributionMetricFactory extends io.github.cdklabs.cdkmonitoringconstructs.BaseMetricFactory {
protected CloudFrontDistributionMetricFactory(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected CloudFrontDistributionMetricFactory(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param metricFactory This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public CloudFrontDistributionMetricFactory(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.MetricFactory metricFactory, final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkmonitoringconstructs.CloudFrontDistributionMetricFactoryProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(metricFactory, "metricFactory is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Object metric4xxErrorRateAverage() {
return software.amazon.jsii.Kernel.call(this, "metric4xxErrorRateAverage", 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 metric5xxErrorRateAverage() {
return software.amazon.jsii.Kernel.call(this, "metric5xxErrorRateAverage", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* (experimental) Cache hit rate metric.
*
* This is an additional metric that needs to be explicitly enabled for an additional cost.
*
* @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Object metricCacheHitRateAverageInPercent() {
return software.amazon.jsii.Kernel.call(this, "metricCacheHitRateAverageInPercent", 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 metricRequestCount() {
return software.amazon.jsii.Kernel.call(this, "metricRequestCount", 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 metricRequestRate() {
return software.amazon.jsii.Kernel.call(this, "metricRequestRate", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* @deprecated use metricRequestRate
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Deprecated)
@Deprecated
public @org.jetbrains.annotations.NotNull java.lang.Object metricRequestTps() {
return software.amazon.jsii.Kernel.call(this, "metricRequestTps", 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 metricTotalBytesDownloaded() {
return software.amazon.jsii.Kernel.call(this, "metricTotalBytesDownloaded", 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 metricTotalBytesUploaded() {
return software.amazon.jsii.Kernel.call(this, "metricTotalBytesUploaded", 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 metricTotalErrorRateAverage() {
return software.amazon.jsii.Kernel.call(this, "metricTotalErrorRateAverage", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.cdkmonitoringconstructs.CloudFrontDistributionMetricFactory}.
*/
@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 metricFactory This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final io.github.cdklabs.cdkmonitoringconstructs.MetricFactory metricFactory) {
return new Builder(metricFactory);
}
private final io.github.cdklabs.cdkmonitoringconstructs.MetricFactory metricFactory;
private final io.github.cdklabs.cdkmonitoringconstructs.CloudFrontDistributionMetricFactoryProps.Builder props;
private Builder(final io.github.cdklabs.cdkmonitoringconstructs.MetricFactory metricFactory) {
this.metricFactory = metricFactory;
this.props = new io.github.cdklabs.cdkmonitoringconstructs.CloudFrontDistributionMetricFactoryProps.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 distribution This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder distribution(final software.amazon.awscdk.services.cloudfront.IDistribution distribution) {
this.props.distribution(distribution);
return this;
}
/**
* (experimental) Generate dashboard charts for additional CloudFront distribution metrics.
*
* To enable additional metrics on your CloudFront distribution, see
* https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional
*
* Default: - true
*
* @return {@code this}
* @param additionalMetricsEnabled Generate dashboard charts for additional CloudFront distribution metrics. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder additionalMetricsEnabled(final java.lang.Boolean additionalMetricsEnabled) {
this.props.additionalMetricsEnabled(additionalMetricsEnabled);
return this;
}
/**
* Default: - true
*
* @return {@code this}
* @param fillTpsWithZeroes This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder fillTpsWithZeroes(final java.lang.Boolean fillTpsWithZeroes) {
this.props.fillTpsWithZeroes(fillTpsWithZeroes);
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;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.cdkmonitoringconstructs.CloudFrontDistributionMetricFactory}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.cdkmonitoringconstructs.CloudFrontDistributionMetricFactory build() {
return new io.github.cdklabs.cdkmonitoringconstructs.CloudFrontDistributionMetricFactory(
this.metricFactory,
this.props.build()
);
}
}
}