AWS::InternetMonitor::Monitor
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::InternetMonitor::Monitor", "Properties" : { "MaxCityNetworksToMonitor" :
Integer
, "MonitorName" :String
, "Resources" :[ String, ... ]
, "ResourcesToAdd" :[ String, ... ]
, "ResourcesToRemove" :[ String, ... ]
, "Status" :String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::InternetMonitor::Monitor Properties: MaxCityNetworksToMonitor:
Integer
MonitorName:String
Resources:- String
ResourcesToAdd:- String
ResourcesToRemove:- String
Status:String
Tags:- Tag
Properties
MaxCityNetworksToMonitor
-
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.
Required: No
Type: Integer
Update requires: No interruption
MonitorName
-
The name of the monitor. A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
Required: No
Type: String
Update requires: Replacement
Resources
-
The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).
Required: No
Type: List of String
Update requires: No interruption
ResourcesToAdd
-
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.
Note 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.
Required: No
Type: List of String
Update requires: No interruption
ResourcesToRemove
-
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
Required: No
Type: List of String
Update requires: No interruption
Status
-
The status of a monitor. The accepted values that you can specify for
Status
areACTIVE
andINACTIVE
.Required: No
Type: String
Update requires: No interruption
Tags
-
The tags for a monitor, listed as a set of key:value pairs.
Required: No
Type: List of Tag
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the ARN of the monitor, such as
arn:aws:internetmonitor:us-east-1:111122223333:monitor/TestMonitor
.
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.
CreatedAt
-
The time when the monitor was created.
ModifiedAt
-
The last time that the monitor was modified.
MonitorArn
-
The Amazon Resource Name (ARN) of the monitor.
ProcessingStatus
-
The health of data processing for the monitor. For more information, see
ProcessingStatus
under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference. ProcessingStatusInfo
-
Additional information about the health of the data processing for the monitor.