Package software.amazon.awscdk.services.internetmonitor

Interface CfnMonitorProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnMonitorProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:08.291Z") @Stability(Stable) public interface CfnMonitorProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnMonitor.

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.*;
 CfnMonitorProps cfnMonitorProps = CfnMonitorProps.builder()
         .monitorName("monitorName")
         // the properties below are optional
         .healthEventsConfig(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())
         .includeLinkedAccounts(false)
         .internetMeasurementsLogDelivery(InternetMeasurementsLogDeliveryProperty.builder()
                 .s3Config(S3ConfigProperty.builder()
                         .bucketName("bucketName")
                         .bucketPrefix("bucketPrefix")
                         .logDeliveryStatus("logDeliveryStatus")
                         .build())
                 .build())
         .linkedAccountId("linkedAccountId")
         .maxCityNetworksToMonitor(123)
         .resources(List.of("resources"))
         .resourcesToAdd(List.of("resourcesToAdd"))
         .resourcesToRemove(List.of("resourcesToRemove"))
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trafficPercentageToMonitor(123)
         .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CfnMonitorProps.Builder
    A builder for CfnMonitorProps
    static final class 
    CfnMonitorProps.Jsii$Proxy
    An implementation for CfnMonitorProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnMonitorProps.Builder
    builder()
     
    default Object
    getHealthEventsConfig()
    A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.
    default Object
    getIncludeLinkedAccounts()
    A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor.
    default Object
    getInternetMeasurementsLogDelivery()
    Publish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket.
    default String
    getLinkedAccountId()
    The account ID for an account that you've set up cross-account sharing for in Internet Monitor.
    default Number
    getMaxCityNetworksToMonitor()
    The maximum number of city-networks to monitor for your resources.
    String
    getMonitorName()
    The name of the monitor.
    default List<String>
    getResources()
    The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).
    default List<String>
    getResourcesToAdd()
    The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
    default List<String>
    getResourcesToRemove()
    The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
    default String
    getStatus()
    The status of a monitor.
    default List<CfnTag>
    getTags()
    The tags for a monitor, listed as a set of key:value pairs.
    default Number
    getTrafficPercentageToMonitor()
    The percentage of the internet-facing traffic for your application that you want to monitor.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson