CfnMonitorProps

class aws_cdk.aws_internetmonitor.CfnMonitorProps(*, monitor_name, internet_measurements_log_delivery=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 (_).
internet_measurements_log_delivery (Union[InternetMeasurementsLogDeliveryProperty, Dict[str, Any], IResolvable, 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).
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).
resources_to_add (Optional[Sequence[str]]) – The resources to add to a monitor, which you provide as a set of Amazon Resource Names (ARNs). You can add a combination of Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add WorkSpaces directories. You can’t add all three types of resources. .. epigraph:: 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.
resources_to_remove (Optional[Sequence[str]]) – The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
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.

Link:

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.
import aws_cdk.aws_internetmonitor as internetmonitor

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

    # the properties below are optional
    internet_measurements_log_delivery=internetmonitor.CfnMonitor.InternetMeasurementsLogDeliveryProperty(
        s3_config=internetmonitor.CfnMonitor.S3ConfigProperty(
            bucket_name="bucketName",
            bucket_prefix="bucketPrefix",
            log_delivery_status="logDeliveryStatus"
        )
    ),
    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

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

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

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 .

Link:: 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 (_).

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

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

resources_to_add

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

You can add a combination of Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add WorkSpaces directories. You can’t add all three types of resources. .. epigraph:

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.

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

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

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

tags

value* pairs.

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

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