Class CfnMonitorProps
Properties for defining a CfnMonitor.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.InternetMonitor
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMonitorProps : ICfnMonitorPropsSyntax (vb)
Public Class CfnMonitorProps Implements ICfnMonitorPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.InternetMonitor;
var cfnMonitorProps = new CfnMonitorProps {
MonitorName = "monitorName",
// the properties below are optional
HealthEventsConfig = new HealthEventsConfigProperty {
AvailabilityLocalHealthEventsConfig = new LocalHealthEventsConfigProperty {
HealthScoreThreshold = 123,
MinTrafficImpact = 123,
Status = "status"
},
AvailabilityScoreThreshold = 123,
PerformanceLocalHealthEventsConfig = new LocalHealthEventsConfigProperty {
HealthScoreThreshold = 123,
MinTrafficImpact = 123,
Status = "status"
},
PerformanceScoreThreshold = 123
},
IncludeLinkedAccounts = false,
InternetMeasurementsLogDelivery = new InternetMeasurementsLogDeliveryProperty {
S3Config = new S3ConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
LogDeliveryStatus = "logDeliveryStatus"
}
},
LinkedAccountId = "linkedAccountId",
MaxCityNetworksToMonitor = 123,
Resources = new [] { "resources" },
ResourcesToAdd = new [] { "resourcesToAdd" },
ResourcesToRemove = new [] { "resourcesToRemove" },
Status = "status",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TrafficPercentageToMonitor = 123
};Synopsis
Constructors
| CfnMonitorProps() | Properties for defining a |
Properties
| HealthEventsConfig | 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. |
| IncludeLinkedAccounts | A boolean option that you can set to |
| InternetMeasurementsLogDelivery | 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. |
| LinkedAccountId | The account ID for an account that you've set up cross-account sharing for in Internet Monitor. |
| MaxCityNetworksToMonitor | The maximum number of city-networks to monitor for your resources. |
| MonitorName | The name of the monitor. |
| Resources | The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). |
| ResourcesToAdd | The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). |
| ResourcesToRemove | The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs). |
| Status | The status of a monitor. |
| Tags | The tags for a monitor, listed as a set of key:value pairs. |
| TrafficPercentageToMonitor | The percentage of the internet-facing traffic for your application that you want to monitor. |
Constructors
CfnMonitorProps()
Properties for defining a CfnMonitor.
public CfnMonitorProps()Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.InternetMonitor;
var cfnMonitorProps = new CfnMonitorProps {
MonitorName = "monitorName",
// the properties below are optional
HealthEventsConfig = new HealthEventsConfigProperty {
AvailabilityLocalHealthEventsConfig = new LocalHealthEventsConfigProperty {
HealthScoreThreshold = 123,
MinTrafficImpact = 123,
Status = "status"
},
AvailabilityScoreThreshold = 123,
PerformanceLocalHealthEventsConfig = new LocalHealthEventsConfigProperty {
HealthScoreThreshold = 123,
MinTrafficImpact = 123,
Status = "status"
},
PerformanceScoreThreshold = 123
},
IncludeLinkedAccounts = false,
InternetMeasurementsLogDelivery = new InternetMeasurementsLogDeliveryProperty {
S3Config = new S3ConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
LogDeliveryStatus = "logDeliveryStatus"
}
},
LinkedAccountId = "linkedAccountId",
MaxCityNetworksToMonitor = 123,
Resources = new [] { "resources" },
ResourcesToAdd = new [] { "resourcesToAdd" },
ResourcesToRemove = new [] { "resourcesToRemove" },
Status = "status",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TrafficPercentageToMonitor = 123
};Properties
HealthEventsConfig
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.
public object? HealthEventsConfig { get; set; }Property Value
Remarks
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 .
IncludeLinkedAccounts
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.
public object? IncludeLinkedAccounts { get; set; }Property Value
Remarks
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.
InternetMeasurementsLogDelivery
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.
public object? InternetMeasurementsLogDelivery { get; set; }Property Value
Remarks
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).
LinkedAccountId
The account ID for an account that you've set up cross-account sharing for in Internet Monitor.
public string? LinkedAccountId { get; set; }Property Value
Remarks
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.
MaxCityNetworksToMonitor
The maximum number of city-networks to monitor for your resources.
public double? MaxCityNetworksToMonitor { get; set; }Property Value
Remarks
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 .
MonitorName
The name of the monitor.
public string MonitorName { get; set; }Property Value
Remarks
A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
Resources
The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).
public string[]? Resources { get; set; }Property Value
string[]
Remarks
Use this option to add or remove resources when making an update.
Be aware that if you include content in the <code>Resources</code> field when you update a monitor, the <code>ResourcesToAdd</code> and <code>ResourcesToRemove</code> fields must be empty.
ResourcesToAdd
The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
public string[]? ResourcesToAdd { get; set; }Property Value
string[]
Remarks
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.
You can specify this field for a monitor update only if the <code>Resources</code> field is empty.
ResourcesToRemove
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
public string[]? ResourcesToRemove { get; set; }Property Value
string[]
Remarks
You can specify this field for a monitor update only if the <code>Resources</code> field is empty.
Status
The status of a monitor.
public string? Status { get; set; }Property Value
Remarks
The accepted values that you can specify for Status are ACTIVE and INACTIVE .
Tags
The tags for a monitor, listed as a set of key:value pairs.
public ICfnTag[]? Tags { get; set; }Property Value
ICfnTag[]
Remarks
TrafficPercentageToMonitor
The percentage of the internet-facing traffic for your application that you want to monitor.
public double? TrafficPercentageToMonitor { get; set; }Property Value
Remarks
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.