Package software.amazon.awscdk.services.internetmonitor

Interface CfnMonitor.HealthEventsConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMonitor.HealthEventsConfigProperty.Jsii$Proxy

Enclosing class:

CfnMonitor

@Stability(Stable)
public static interface CfnMonitor.HealthEventsConfigProperty
extends software.amazon.jsii.JsiiSerializable

Define the health event threshold percentages for the performance score and availability score for your application's monitor.

Amazon CloudWatch Internet Monitor creates a health event when there's an internet issue that affects your application end users where a health score percentage is at or below a set threshold.

If you don't set a health event threshold, the default value is 95%.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.internetmonitor.*;
 HealthEventsConfigProperty healthEventsConfigProperty = HealthEventsConfigProperty.builder()
         .availabilityLocalHealthEventsConfig(LocalHealthEventsConfigProperty.builder()
                 .healthScoreThreshold(123)
                 .minTrafficImpact(123)
                 .status("status")
                 .build())
         .availabilityScoreThreshold(123)
         .performanceLocalHealthEventsConfig(LocalHealthEventsConfigProperty.builder()
                 .healthScoreThreshold(123)
                 .minTrafficImpact(123)
                 .status("status")
                 .build())
         .performanceScoreThreshold(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMonitor.HealthEventsConfigProperty.Builder	A builder for CfnMonitor.HealthEventsConfigProperty
static final class	CfnMonitor.HealthEventsConfigProperty.Jsii$Proxy	An implementation for CfnMonitor.HealthEventsConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnMonitor.HealthEventsConfigProperty.Builder	builder()
default Object	getAvailabilityLocalHealthEventsConfig()	The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
default Number	getAvailabilityScoreThreshold()	The health event threshold percentage set for availability scores.
default Object	getPerformanceLocalHealthEventsConfig()	The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
default Number	getPerformanceScoreThreshold()	The health event threshold percentage set for performance scores.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityLocalHealthEventsConfig

@Stability(Stable)
@Nullable
default Object getAvailabilityLocalHealthEventsConfig()

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.

Returns union: either IResolvable or CfnMonitor.LocalHealthEventsConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-availabilitylocalhealtheventsconfig

getAvailabilityScoreThreshold

@Stability(Stable)
@Nullable
default Number getAvailabilityScoreThreshold()

The health event threshold percentage set for availability scores.

When the overall availability score is at or below this percentage, Internet Monitor creates a health event.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-availabilityscorethreshold

getPerformanceLocalHealthEventsConfig

@Stability(Stable)
@Nullable
default Object getPerformanceLocalHealthEventsConfig()

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.

Returns union: either IResolvable or CfnMonitor.LocalHealthEventsConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-performancelocalhealtheventsconfig

getPerformanceScoreThreshold

@Stability(Stable)
@Nullable
default Number getPerformanceScoreThreshold()

The health event threshold percentage set for performance scores.

When the overall performance score is at or below this percentage, Internet Monitor creates a health event.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.html#cfn-internetmonitor-monitor-healtheventsconfig-performancescorethreshold

builder

@Stability(Stable)
static CfnMonitor.HealthEventsConfigProperty.Builder builder()

Returns:

a CfnMonitor.HealthEventsConfigProperty.Builder of CfnMonitor.HealthEventsConfigProperty