CfnMonitorPropsMixin

class aws_cdk.mixins_preview.aws_internetmonitor.mixins.CfnMonitorPropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-internetmonitor-monitor.html
CloudformationResource:: AWS::InternetMonitor::Monitor
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_internetmonitor import mixins as internetmonitor_mixins

cfn_monitor_props_mixin = internetmonitor_mixins.CfnMonitorPropsMixin(internetmonitor_mixins.CfnMonitorMixinProps(
    health_events_config=internetmonitor_mixins.CfnMonitorPropsMixin.HealthEventsConfigProperty(
        availability_local_health_events_config=internetmonitor_mixins.CfnMonitorPropsMixin.LocalHealthEventsConfigProperty(
            health_score_threshold=123,
            min_traffic_impact=123,
            status="status"
        ),
        availability_score_threshold=123,
        performance_local_health_events_config=internetmonitor_mixins.CfnMonitorPropsMixin.LocalHealthEventsConfigProperty(
            health_score_threshold=123,
            min_traffic_impact=123,
            status="status"
        ),
        performance_score_threshold=123
    ),
    include_linked_accounts=False,
    internet_measurements_log_delivery=internetmonitor_mixins.CfnMonitorPropsMixin.InternetMeasurementsLogDeliveryProperty(
        s3_config=internetmonitor_mixins.CfnMonitorPropsMixin.S3ConfigProperty(
            bucket_name="bucketName",
            bucket_prefix="bucketPrefix",
            log_delivery_status="logDeliveryStatus"
        )
    ),
    linked_account_id="linkedAccountId",
    max_city_networks_to_monitor=123,
    monitor_name="monitorName",
    resources=["resources"],
    resources_to_add=["resourcesToAdd"],
    resources_to_remove=["resourcesToRemove"],
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    traffic_percentage_to_monitor=123
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::InternetMonitor::Monitor.

Parameters:

props (Union[CfnMonitorMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['healthEventsConfig', 'includeLinkedAccounts', 'internetMeasurementsLogDelivery', 'linkedAccountId', 'maxCityNetworksToMonitor', 'monitorName', 'resources', 'resourcesToAdd', 'resourcesToRemove', 'status', 'tags', 'trafficPercentageToMonitor']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

HealthEventsConfigProperty

class CfnMonitorPropsMixin.HealthEventsConfigProperty(*, availability_local_health_events_config=None, availability_score_threshold=None, performance_local_health_events_config=None, performance_score_threshold=None)

Bases: object

Define the health event threshold percentages for the performance score and availability score for your application’s monitor.

Amazon CloudWatch Internet Monitor creates a health event when there’s an internet issue that affects your application end users where a health score percentage is at or below a set threshold.

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

Parameters:

availability_local_health_events_config (Union[IResolvable, LocalHealthEventsConfigProperty, Dict[str, Any], None]) – The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
availability_score_threshold (Union[int, float, None]) – The health event threshold percentage set for availability scores. When the overall availability score is at or below this percentage, Internet Monitor creates a health event.
performance_local_health_events_config (Union[IResolvable, LocalHealthEventsConfigProperty, Dict[str, Any], None]) – The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
performance_score_threshold (Union[int, float, None]) – The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-healtheventsconfig.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.mixins_preview.aws_internetmonitor import mixins as internetmonitor_mixins

health_events_config_property = internetmonitor_mixins.CfnMonitorPropsMixin.HealthEventsConfigProperty(
    availability_local_health_events_config=internetmonitor_mixins.CfnMonitorPropsMixin.LocalHealthEventsConfigProperty(
        health_score_threshold=123,
        min_traffic_impact=123,
        status="status"
    ),
    availability_score_threshold=123,
    performance_local_health_events_config=internetmonitor_mixins.CfnMonitorPropsMixin.LocalHealthEventsConfigProperty(
        health_score_threshold=123,
        min_traffic_impact=123,
        status="status"
    ),
    performance_score_threshold=123
)

Attributes

availability_local_health_events_config

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.

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

availability_score_threshold

The health event threshold percentage set for availability scores.

When the overall availability score is at or below this percentage, Internet Monitor creates a health event.

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

performance_local_health_events_config

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.

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

performance_score_threshold

The health event threshold percentage set for performance scores.

When the overall performance score is at or below this percentage, Internet Monitor creates a health event.

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

InternetMeasurementsLogDeliveryProperty

class CfnMonitorPropsMixin.InternetMeasurementsLogDeliveryProperty(*, s3_config=None)

Bases: object

Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.

Parameters:: s3_config (Union[IResolvable, S3ConfigProperty, Dict[str, Any], None]) – The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-internetmeasurementslogdelivery.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.mixins_preview.aws_internetmonitor import mixins as internetmonitor_mixins

internet_measurements_log_delivery_property = internetmonitor_mixins.CfnMonitorPropsMixin.InternetMeasurementsLogDeliveryProperty(
    s3_config=internetmonitor_mixins.CfnMonitorPropsMixin.S3ConfigProperty(
        bucket_name="bucketName",
        bucket_prefix="bucketPrefix",
        log_delivery_status="logDeliveryStatus"
    )
)

Attributes

s3_config

The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.

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

LocalHealthEventsConfigProperty

class CfnMonitorPropsMixin.LocalHealthEventsConfigProperty(*, health_score_threshold=None, min_traffic_impact=None, status=None)

Bases: object

Configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance or availability issue, when scores cross a threshold for one or more city-networks.

Defines the percentages, for performance scores or availability scores, that are the local thresholds for when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage of overall traffic that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

If you don’t set a local health event threshold, the default value is 60%.

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

Parameters:

health_score_threshold (Union[int, float, None]) – The health event threshold percentage set for a local health score.
min_traffic_impact (Union[int, float, None]) – The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score. If you don’t set a minimum traffic impact threshold, the default value is 0.01%.
status (Optional[str]) – The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.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.mixins_preview.aws_internetmonitor import mixins as internetmonitor_mixins

local_health_events_config_property = internetmonitor_mixins.CfnMonitorPropsMixin.LocalHealthEventsConfigProperty(
    health_score_threshold=123,
    min_traffic_impact=123,
    status="status"
)

Attributes

health_score_threshold

The health event threshold percentage set for a local health score.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html#cfn-internetmonitor-monitor-localhealtheventsconfig-healthscorethreshold

min_traffic_impact

The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

If you don’t set a minimum traffic impact threshold, the default value is 0.01%.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-localhealtheventsconfig.html#cfn-internetmonitor-monitor-localhealtheventsconfig-mintrafficimpact

status

The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score.

The status can be ENABLED or DISABLED .

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

S3ConfigProperty

class CfnMonitorPropsMixin.S3ConfigProperty(*, bucket_name=None, bucket_prefix=None, log_delivery_status=None)

Bases: object

The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.

The configuration includes the bucket name and (optionally) bucket prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED if you choose to deliver internet measurements to S3 logs, and DISABLED otherwise.

The measurements are also published to Amazon CloudWatch Logs.

Parameters:

bucket_name (Optional[str]) – The Amazon S3 bucket name for internet measurements publishing.
bucket_prefix (Optional[str]) – An optional Amazon S3 bucket prefix for internet measurements publishing.
log_delivery_status (Optional[str]) – The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is ENABLED if you choose to deliver internet measurements to an S3 bucket, and DISABLED otherwise.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.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.mixins_preview.aws_internetmonitor import mixins as internetmonitor_mixins

s3_config_property = internetmonitor_mixins.CfnMonitorPropsMixin.S3ConfigProperty(
    bucket_name="bucketName",
    bucket_prefix="bucketPrefix",
    log_delivery_status="logDeliveryStatus"
)

Attributes

bucket_name

The Amazon S3 bucket name for internet measurements publishing.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html#cfn-internetmonitor-monitor-s3config-bucketname

bucket_prefix

An optional Amazon S3 bucket prefix for internet measurements publishing.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html#cfn-internetmonitor-monitor-s3config-bucketprefix

log_delivery_status

The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.

The delivery status is ENABLED if you choose to deliver internet measurements to an S3 bucket, and DISABLED otherwise.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-internetmonitor-monitor-s3config.html#cfn-internetmonitor-monitor-s3config-logdeliverystatus