interface CfnMonitorProps

Language	Type name
.NET	`Amazon.CDK.AWS.InternetMonitor.CfnMonitorProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsinternetmonitor#CfnMonitorProps`
Java	`software.amazon.awscdk.services.internetmonitor.CfnMonitorProps`
Python	`aws_cdk.aws_internetmonitor.CfnMonitorProps`
TypeScript	`aws-cdk-lib` » `aws_internetmonitor` » `CfnMonitorProps`

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 { aws_internetmonitor as internetmonitor } from 'aws-cdk-lib';
const cfnMonitorProps: internetmonitor.CfnMonitorProps = {
  monitorName: 'monitorName',

  // the properties below are optional
  healthEventsConfig: {
    availabilityLocalHealthEventsConfig: {
      healthScoreThreshold: 123,
      minTrafficImpact: 123,
      status: 'status',
    },
    availabilityScoreThreshold: 123,
    performanceLocalHealthEventsConfig: {
      healthScoreThreshold: 123,
      minTrafficImpact: 123,
      status: 'status',
    },
    performanceScoreThreshold: 123,
  },
  includeLinkedAccounts: false,
  internetMeasurementsLogDelivery: {
    s3Config: {
      bucketName: 'bucketName',
      bucketPrefix: 'bucketPrefix',
      logDeliveryStatus: 'logDeliveryStatus',
    },
  },
  linkedAccountId: 'linkedAccountId',
  maxCityNetworksToMonitor: 123,
  resources: ['resources'],
  resourcesToAdd: ['resourcesToAdd'],
  resourcesToRemove: ['resourcesToRemove'],
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  trafficPercentageToMonitor: 123,
};

Properties

Name	Type	Description
monitorName	`string`	The name of the monitor.
healthEventsConfig?	`IResolvable` `\|` `HealthEventsConfigProperty`	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.
includeLinkedAccounts?	`boolean \|` `IResolvable`	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.
internetMeasurementsLogDelivery?	`IResolvable` `\|` `InternetMeasurementsLogDeliveryProperty`	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.
linkedAccountId?	`string`	The account ID for an account that you've set up cross-account sharing for in Internet Monitor.
maxCityNetworksToMonitor?	`number`	The maximum number of city-networks to monitor for your resources.
resources?	`string[]`	The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).
resourcesToAdd?	`string[]`	The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
resourcesToRemove?	`string[]`	The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
status?	`string`	The status of a monitor.
tags?	`CfnTag[]`	The tags for a monitor, listed as a set of key:value pairs.
trafficPercentageToMonitor?	`number`	The percentage of the internet-facing traffic for your application that you want to monitor.

monitorName

Type: string

The name of the monitor.

A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).

healthEventsConfig?

Type: IResolvable | HealthEventsConfigProperty (optional)

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.

Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.

You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.

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

For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.

For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide .

includeLinkedAccounts?

Type: boolean | IResolvable (optional)

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.

You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.

internetMeasurementsLogDelivery?

Type: IResolvable | InternetMeasurementsLogDeliveryProperty (optional)

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.

Measurements are also published to Amazon CloudWatch Logs for the first 500 (by traffic volume) city-networks (client locations and ASNs, typically internet service providers or ISPs).

linkedAccountId?

Type: string (optional)

The account ID for an account that you've set up cross-account sharing for in Internet Monitor.

maxCityNetworksToMonitor?

Type: number (optional)

The maximum number of city-networks to monitor for your resources.

A city-network is the location (city) where clients access your application resources from and the network, such as an internet service provider, that clients access the resources through.

For more information, see Choosing a city-network maximum value in Using Amazon CloudWatch Internet Monitor .

resources?

Type: string[] (optional)

The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).

Use this option to add or remove resources when making an update.

Be aware that if you include content in the Resources field when you update a monitor, the ResourcesToAdd and ResourcesToRemove fields must be empty.

resourcesToAdd?

Type: string[] (optional)

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).

Resources can be Amazon Virtual Private Cloud VPCs, Network Load Balancers (NLBs), Amazon CloudFront distributions, or Amazon WorkSpaces directories.

You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.

If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

You can specify this field for a monitor update only if the Resources field is empty.

resourcesToRemove?

Type: string[] (optional)

The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

You can specify this field for a monitor update only if the Resources field is empty.

status?

Type: string (optional)

The status of a monitor.

The accepted values that you can specify for Status are ACTIVE and INACTIVE .

tags?

Type: CfnTag[] (optional)

The tags for a monitor, listed as a set of key:value pairs.

trafficPercentageToMonitor?

Type: number (optional)

The percentage of the internet-facing traffic for your application that you want to monitor.

You can also, optionally, set a limit for the number of city-networks (client locations and ASNs, typically internet service providers) that Internet Monitor will monitor traffic for. The city-networks maximum limit caps the number of city-networks that Internet Monitor monitors for your application, regardless of the percentage of traffic that you choose to monitor.