CfnMonitorProps Struct
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
healthEventsConfigIResolvable | CfnMonitor.HealthEventsConfigPropertyhealth_events_configtyping.Union[IResolvable, HealthEventsConfigProperty]healthEventsConfigIResolvableHealthEventsConfigIResolvableHealthEventsConfiginterface{}#notes
Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when 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 .
includeLinkedAccountsboolean | IResolvableinclude_linked_accountstyping.Union[bool, IResolvable]includeLinkedAccountsBooleanIncludeLinkedAccountsboolIncludeLinkedAccountsinterface{}#notes
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.
internetMeasurementsLogDeliveryIResolvable | CfnMonitor.InternetMeasurementsLogDeliveryPropertyinternet_measurements_log_deliverytyping.Union[IResolvable, InternetMeasurementsLogDeliveryProperty]internetMeasurementsLogDeliveryIResolvableInternetMeasurementsLogDeliveryIResolvableInternetMeasurementsLogDeliveryinterface{}#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).
linkedAccountIdstringlinked_account_idstrlinkedAccountIdStringLinkedAccountIdstringLinkedAccountId*string#notes
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.
maxCityNetworksToMonitornumbermax_city_networks_to_monitorint | floatmaxCityNetworksToMonitorNumberMaxCityNetworksToMonitordoubleMaxCityNetworksToMonitor*float64#notes
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 .
A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
resourcesstring[]resourcestyping.List[str]resourcesList<String>Resourcesstring[]Resources*[]*string#Use this option to add or remove resources when making an update.
Be aware that if you include content in the
Resourcesfield when you update a monitor, theResourcesToAddandResourcesToRemovefields must be empty.
resourcesToAddstring[]resources_to_addtyping.List[str]resourcesToAddList<String>ResourcesToAddstring[]ResourcesToAdd*[]*string#notes
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
Resourcesfield is empty.
resourcesToRemovestring[]resources_to_removetyping.List[str]resourcesToRemoveList<String>ResourcesToRemovestring[]ResourcesToRemove*[]*string#You can specify this field for a monitor update only if the
Resourcesfield is empty.
The accepted values that you can specify for Status are ACTIVE and INACTIVE .
trafficPercentageToMonitornumbertraffic_percentage_to_monitorint | floattrafficPercentageToMonitorNumberTrafficPercentageToMonitordoubleTrafficPercentageToMonitor*float64#notes
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.