Class CfnMonitor
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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 .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.internetmonitor.*; CfnMonitor cfnMonitor = CfnMonitor.Builder.create(this, "MyCfnMonitor") .monitorName("monitorName") // the properties below are optional .healthEventsConfig(HealthEventsConfigProperty.builder() .availabilityLocalHealthEventsConfig(LocalHealthEventsConfigProperty.builder() .healthScoreThreshold(123) .minTrafficImpact(123) .status("status") .build()) .availabilityScoreThreshold(123) .performanceLocalHealthEventsConfig(LocalHealthEventsConfigProperty.builder() .healthScoreThreshold(123) .minTrafficImpact(123) .status("status") .build()) .performanceScoreThreshold(123) .build()) .includeLinkedAccounts(false) .internetMeasurementsLogDelivery(InternetMeasurementsLogDeliveryProperty.builder() .s3Config(S3ConfigProperty.builder() .bucketName("bucketName") .bucketPrefix("bucketPrefix") .logDeliveryStatus("logDeliveryStatus") .build()) .build()) .linkedAccountId("linkedAccountId") .maxCityNetworksToMonitor(123) .resources(List.of("resources")) .resourcesToAdd(List.of("resourcesToAdd")) .resourcesToRemove(List.of("resourcesToRemove")) .status("status") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .trafficPercentageToMonitor(123) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnMonitor
.static interface
Define the health event threshold percentages for the performance score and availability score for your application's monitor.static interface
Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.static interface
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.static interface
The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnMonitor
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnMonitor
(software.amazon.jsii.JsiiObjectRef objRef) CfnMonitor
(software.constructs.Construct scope, String id, CfnMonitorProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe time when the monitor was created.The last time that the monitor was modified.The Amazon Resource Name (ARN) of the monitor.The health of data processing for the monitor.Additional information about the health of the data processing for the monitor.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.A boolean option that you can set toTRUE
to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor.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.The account ID for an account that you've set up cross-account sharing for in Internet Monitor.The maximum number of city-networks to monitor for your resources.The name of the monitor.The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).The status of a monitor.getTags()
Tag Manager which manages the tags for this resource.The tags for a monitor, listed as a set of key:value pairs.The percentage of the internet-facing traffic for your application that you want to monitor.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setHealthEventsConfig
(IResolvable value) 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.void
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.void
setIncludeLinkedAccounts
(Boolean value) A boolean option that you can set toTRUE
to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor.void
A boolean option that you can set toTRUE
to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor.void
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.void
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.void
setLinkedAccountId
(String value) The account ID for an account that you've set up cross-account sharing for in Internet Monitor.void
The maximum number of city-networks to monitor for your resources.void
setMonitorName
(String value) The name of the monitor.void
setResources
(List<String> value) The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).void
setResourcesToAdd
(List<String> value) The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).void
setResourcesToRemove
(List<String> value) The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).void
The status of a monitor.void
setTagsRaw
(List<CfnTag> value) The tags for a monitor, listed as a set of key:value pairs.void
The percentage of the internet-facing traffic for your application that you want to monitor.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnMonitor
protected CfnMonitor(software.amazon.jsii.JsiiObjectRef objRef) -
CfnMonitor
protected CfnMonitor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnMonitor
@Stability(Stable) public CfnMonitor(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMonitorProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCreatedAt
The time when the monitor was created. -
getAttrModifiedAt
The last time that the monitor was modified. -
getAttrMonitorArn
The Amazon Resource Name (ARN) of the monitor. -
getAttrProcessingStatus
The health of data processing for the monitor.For more information, see
ProcessingStatus
under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference . -
getAttrProcessingStatusInfo
Additional information about the health of the data processing for the monitor. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getMonitorName
The name of the monitor. -
setMonitorName
The name of the monitor. -
getHealthEventsConfig
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. -
setHealthEventsConfig
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. -
setHealthEventsConfig
@Stability(Stable) public void setHealthEventsConfig(@Nullable CfnMonitor.HealthEventsConfigProperty value) 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. -
getIncludeLinkedAccounts
A boolean option that you can set toTRUE
to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. -
setIncludeLinkedAccounts
A boolean option that you can set toTRUE
to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. -
setIncludeLinkedAccounts
A boolean option that you can set toTRUE
to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. -
getInternetMeasurementsLogDelivery
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. -
setInternetMeasurementsLogDelivery
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. -
setInternetMeasurementsLogDelivery
@Stability(Stable) public void setInternetMeasurementsLogDelivery(@Nullable CfnMonitor.InternetMeasurementsLogDeliveryProperty value) 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. -
getLinkedAccountId
The account ID for an account that you've set up cross-account sharing for in Internet Monitor. -
setLinkedAccountId
The account ID for an account that you've set up cross-account sharing for in Internet Monitor. -
getMaxCityNetworksToMonitor
The maximum number of city-networks to monitor for your resources. -
setMaxCityNetworksToMonitor
The maximum number of city-networks to monitor for your resources. -
getResources
The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). -
setResources
The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). -
getResourcesToAdd
The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). -
setResourcesToAdd
The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). -
getResourcesToRemove
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs). -
setResourcesToRemove
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs). -
getStatus
The status of a monitor. -
setStatus
The status of a monitor. -
getTagsRaw
The tags for a monitor, listed as a set of key:value pairs. -
setTagsRaw
The tags for a monitor, listed as a set of key:value pairs. -
getTrafficPercentageToMonitor
The percentage of the internet-facing traffic for your application that you want to monitor. -
setTrafficPercentageToMonitor
The percentage of the internet-facing traffic for your application that you want to monitor.
-