CfnMonitor

class aws_cdk.aws_internetmonitor.CfnMonitor(scope, id, *, 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: CfnResource

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
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 = internetmonitor.CfnMonitor(self, "MyCfnMonitor",
    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
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::InternetMonitor::Monitor'

attr_created_at

The time when the monitor was created.

CloudformationAttribute:: CreatedAt

attr_modified_at

The last time that the monitor was modified.

CloudformationAttribute:: ModifiedAt

attr_monitor_arn

The Amazon Resource Name (ARN) of the monitor.

CloudformationAttribute:: MonitorArn

attr_processing_status

The health of data processing for the monitor.

For more information, see ProcessingStatus under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .

CloudformationAttribute:: ProcessingStatus

attr_processing_status_info

Additional information about the health of the data processing for the monitor.

CloudformationAttribute:: ProcessingStatusInfo

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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.

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.

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.

linked_account_id: The account ID for an account that you’ve set up cross-account sharing for in Internet Monitor.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

monitor_name: The name of the monitor.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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

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

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

status: The status of a monitor.

tags: Tag Manager which manages the tags for this resource.

tags_raw

value* pairs.

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.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

HealthEventsConfigProperty

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

health_events_config_property = 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
)

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

internet_measurements_log_delivery_property = internetmonitor.CfnMonitor.InternetMeasurementsLogDeliveryProperty(
    s3_config=internetmonitor.CfnMonitor.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 CfnMonitor.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 import aws_internetmonitor as internetmonitor

local_health_events_config_property = internetmonitor.CfnMonitor.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 CfnMonitor.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 import aws_internetmonitor as internetmonitor

s3_config_property = internetmonitor.CfnMonitor.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