CfnMonitorProps

class aws_cdk.aws_internetmonitor.CfnMonitorProps(*, monitor_name, health_events_config=None, include_linked_accounts=None, internet_measurements_log_delivery=None, linked_account_id=None, max_city_networks_to_monitor=None, resources=None, resources_to_add=None, resources_to_remove=None, status=None, tags=None, traffic_percentage_to_monitor=None)

Bases: object

Properties for defining a CfnMonitor.

Parameters:

monitor_name (str) – The name of the monitor. A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
health_events_config (Union[IResolvable, HealthEventsConfigProperty, Dict[str, Any], None]) – 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 .
include_linked_accounts (Union[bool, IResolvable, None]) – 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.
internet_measurements_log_delivery (Union[IResolvable, InternetMeasurementsLogDeliveryProperty, Dict[str, Any], None]) – 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).
linked_account_id (Optional[str]) –
The account ID for an account that you’ve set up cross-account sharing for 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.
max_city_networks_to_monitor (Union[int, float, None]) – 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 (Optional[Sequence[str]]) – 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. .. epigraph:: Be aware that if you include content in the Resources field when you update a monitor, the ResourcesToAdd and ResourcesToRemove fields must be empty.
resources_to_add (Optional[Sequence[str]]) – 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. .. epigraph:: You can specify this field for a monitor update only if the Resources field is empty.
resources_to_remove (Optional[Sequence[str]]) – The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs). .. epigraph:: You can specify this field for a monitor update only if the Resources field is empty.
status (Optional[str]) – The status of a monitor. The accepted values that you can specify for Status are ACTIVE and INACTIVE .
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags for a monitor, listed as a set of key:value pairs.
traffic_percentage_to_monitor (Union[int, float, None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_internetmonitor as internetmonitor

cfn_monitor_props = internetmonitor.CfnMonitorProps(
    monitor_name="monitorName",

    # the properties below are optional
    health_events_config=internetmonitor.CfnMonitor.HealthEventsConfigProperty(
        availability_local_health_events_config=internetmonitor.CfnMonitor.LocalHealthEventsConfigProperty(
            health_score_threshold=123,
            min_traffic_impact=123,
            status="status"
        ),
        availability_score_threshold=123,
        performance_local_health_events_config=internetmonitor.CfnMonitor.LocalHealthEventsConfigProperty(
            health_score_threshold=123,
            min_traffic_impact=123,
            status="status"
        ),
        performance_score_threshold=123
    ),
    include_linked_accounts=False,
    internet_measurements_log_delivery=internetmonitor.CfnMonitor.InternetMeasurementsLogDeliveryProperty(
        s3_config=internetmonitor.CfnMonitor.S3ConfigProperty(
            bucket_name="bucketName",
            bucket_prefix="bucketPrefix",
            log_delivery_status="logDeliveryStatus"
        )
    ),
    linked_account_id="linkedAccountId",
    max_city_networks_to_monitor=123,
    resources=["resources"],
    resources_to_add=["resourcesToAdd"],
    resources_to_remove=["resourcesToRemove"],
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    traffic_percentage_to_monitor=123
)

Attributes

health_events_config

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-healtheventsconfig

include_linked_accounts

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-includelinkedaccounts

internet_measurements_log_delivery

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).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-internetmeasurementslogdelivery

linked_account_id

The account ID for an account that you’ve set up cross-account sharing for 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-linkedaccountid

max_city_networks_to_monitor

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-maxcitynetworkstomonitor

monitor_name

The name of the monitor.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-monitorname

resources

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. .. epigraph:

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-resources

resources_to_add

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. .. epigraph:

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-resourcestoadd

resources_to_remove

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-resourcestoremove

status

The status of a monitor.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-status

tags

value* pairs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-tags
Type:: The tags for a monitor, listed as a set of *key

traffic_percentage_to_monitor

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html#cfn-internetmonitor-monitor-trafficpercentagetomonitor