Package software.amazon.awscdk.services.internetmonitor

Class CfnMonitor

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.internetmonitor.CfnMonitor
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IMonitorRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:07.368Z") @Stability(Stable) public class CfnMonitor extends CfnResource implements IInspectable, IMonitorRef, ITaggable
The AWS::InternetMonitor::Monitor resource is an Internet Monitor resource type that contains information about how you create a monitor in Amazon CloudWatch Internet Monitor.

A monitor in Internet Monitor provides visibility into performance and availability between your applications hosted on AWS and your end users, using a traffic profile that it creates based on the application resources that you add: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces directories.

Internet Monitor also alerts you to internet issues that impact your application in the city-networks (geographies and networks) where your end users use it. With Internet Monitor, you can quickly pinpoint the locations and providers that are affected, so that you can address the issue.

For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide .

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.*;
 CfnMonitor cfnMonitor = CfnMonitor.Builder.create(this, "MyCfnMonitor")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMonitor

      protected CfnMonitor(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMonitor

      protected CfnMonitor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMonitor

      @Stability(Stable) public CfnMonitor(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMonitorProps props)
      Create a new AWS::InternetMonitor::Monitor.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromMonitorArn

      @Stability(Stable) @NotNull public static IMonitorRef fromMonitorArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IMonitorRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromMonitorName

      @Stability(Stable) @NotNull public static IMonitorRef fromMonitorName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String monitorName)
      Creates a new IMonitorRef from a monitorName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      monitorName - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time when the monitor was created.

    • getAttrModifiedAt

      @Stability(Stable) @NotNull public String getAttrModifiedAt()
      The last time that the monitor was modified.

    • getAttrMonitorArn

      @Stability(Stable) @NotNull public String getAttrMonitorArn()
      The Amazon Resource Name (ARN) of the monitor.

    • getAttrProcessingStatus

      @Stability(Stable) @NotNull public String getAttrProcessingStatus()
      The health of data processing for the monitor.

      For more information, see ProcessingStatus under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .

    • getAttrProcessingStatusInfo

      @Stability(Stable) @NotNull public String getAttrProcessingStatusInfo()
      Additional information about the health of the data processing for the monitor.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMonitorRef

      @Stability(Stable) @NotNull public MonitorReference getMonitorRef()
      A reference to a Monitor resource.
      Specified by:
      getMonitorRef in interface IMonitorRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getMonitorName

      @Stability(Stable) @NotNull public String getMonitorName()
      The name of the monitor.

    • setMonitorName

      @Stability(Stable) public void setMonitorName(@NotNull String value)
      The name of the monitor.

    • getHealthEventsConfig

      @Stability(Stable) @Nullable public 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.

      Returns union: either IResolvable or CfnMonitor.HealthEventsConfigProperty

    • setHealthEventsConfig

      @Stability(Stable) public void setHealthEventsConfig(@Nullable IResolvable value)
      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.

    • setHealthEventsConfig

      @Stability(Stable) public void setHealthEventsConfig(@Nullable CfnMonitor.HealthEventsConfigProperty value)
      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.

    • getIncludeLinkedAccounts

      @Stability(Stable) @Nullable public 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.

      Returns union: either Boolean or IResolvable

    • setIncludeLinkedAccounts

      @Stability(Stable) public void setIncludeLinkedAccounts(@Nullable Boolean value)
      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.

    • setIncludeLinkedAccounts

      @Stability(Stable) public void setIncludeLinkedAccounts(@Nullable IResolvable value)
      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.

    • getInternetMeasurementsLogDelivery

      @Stability(Stable) @Nullable public 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.

      Returns union: either IResolvable or CfnMonitor.InternetMeasurementsLogDeliveryProperty

    • setInternetMeasurementsLogDelivery

      @Stability(Stable) public void setInternetMeasurementsLogDelivery(@Nullable IResolvable value)
      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.

    • setInternetMeasurementsLogDelivery

      @Stability(Stable) public void setInternetMeasurementsLogDelivery(@Nullable CfnMonitor.InternetMeasurementsLogDeliveryProperty value)
      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.

    • getLinkedAccountId

      @Stability(Stable) @Nullable public String getLinkedAccountId()
      The account ID for an account that you've set up cross-account sharing for in Internet Monitor.

    • setLinkedAccountId

      @Stability(Stable) public void setLinkedAccountId(@Nullable String value)
      The account ID for an account that you've set up cross-account sharing for in Internet Monitor.

    • getMaxCityNetworksToMonitor

      @Stability(Stable) @Nullable public Number getMaxCityNetworksToMonitor()
      The maximum number of city-networks to monitor for your resources.

    • setMaxCityNetworksToMonitor

      @Stability(Stable) public void setMaxCityNetworksToMonitor(@Nullable Number value)
      The maximum number of city-networks to monitor for your resources.

    • getResources

      @Stability(Stable) @Nullable public List<String> getResources()
      The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).

    • setResources

      @Stability(Stable) public void setResources(@Nullable List<String> value)
      The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).

    • getResourcesToAdd

      @Stability(Stable) @Nullable public List<String> getResourcesToAdd()
      The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).

    • setResourcesToAdd

      @Stability(Stable) public void setResourcesToAdd(@Nullable List<String> value)
      The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).

    • getResourcesToRemove

      @Stability(Stable) @Nullable public List<String> getResourcesToRemove()
      The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

    • setResourcesToRemove

      @Stability(Stable) public void setResourcesToRemove(@Nullable List<String> value)
      The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The status of a monitor.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The status of a monitor.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags for a monitor, listed as a set of key:value pairs.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags for a monitor, listed as a set of key:value pairs.

    • getTrafficPercentageToMonitor

      @Stability(Stable) @Nullable public Number getTrafficPercentageToMonitor()
      The percentage of the internet-facing traffic for your application that you want to monitor.

    • setTrafficPercentageToMonitor

      @Stability(Stable) public void setTrafficPercentageToMonitor(@Nullable Number value)
      The percentage of the internet-facing traffic for your application that you want to monitor.