class CfnMonitor (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.InternetMonitor.CfnMonitor |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsinternetmonitor#CfnMonitor |
Java | software.amazon.awscdk.services.internetmonitor.CfnMonitor |
Python | aws_cdk.aws_internetmonitor.CfnMonitor |
TypeScript | aws-cdk-lib » aws_internetmonitor » CfnMonitor |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
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 .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_internetmonitor as internetmonitor } from 'aws-cdk-lib';
const cfnMonitor = new internetmonitor.CfnMonitor(this, 'MyCfnMonitor', {
monitorName: 'monitorName',
// the properties below are optional
healthEventsConfig: {
availabilityLocalHealthEventsConfig: {
healthScoreThreshold: 123,
minTrafficImpact: 123,
status: 'status',
},
availabilityScoreThreshold: 123,
performanceLocalHealthEventsConfig: {
healthScoreThreshold: 123,
minTrafficImpact: 123,
status: 'status',
},
performanceScoreThreshold: 123,
},
includeLinkedAccounts: false,
internetMeasurementsLogDelivery: {
s3Config: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
logDeliveryStatus: 'logDeliveryStatus',
},
},
linkedAccountId: 'linkedAccountId',
maxCityNetworksToMonitor: 123,
resources: ['resources'],
resourcesToAdd: ['resourcesToAdd'],
resourcesToRemove: ['resourcesToRemove'],
status: 'status',
tags: [{
key: 'key',
value: 'value',
}],
trafficPercentageToMonitor: 123,
});
Initializer
new CfnMonitor(scope: Construct, id: string, props: CfnMonitorProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Monitor Props
Construct Props
Name | Type | Description |
---|---|---|
monitor | string | The name of the monitor. |
health | IResolvable | Health | 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 | boolean | IResolvable | 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 | IResolvable | Internet | 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 | string | The account ID for an account that you've set up cross-account sharing for in Internet Monitor. |
max | number | The maximum number of city-networks to monitor for your resources. |
resources? | string[] | The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). |
resources | string[] | The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). |
resources | string[] | The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs). |
status? | string | The status of a monitor. |
tags? | Cfn [] | The tags for a monitor, listed as a set of key:value pairs. |
traffic | number | The percentage of the internet-facing traffic for your application that you want to monitor. |
monitorName
Type:
string
The name of the monitor.
A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
healthEventsConfig?
Type:
IResolvable
|
Health
(optional)
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 Amazon CloudWatch 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?
Type:
boolean |
IResolvable
(optional)
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.
internetMeasurementsLogDelivery?
Type:
IResolvable
|
Internet
(optional)
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).
linkedAccountId?
Type:
string
(optional)
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.
maxCityNetworksToMonitor?
Type:
number
(optional)
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?
Type:
string[]
(optional)
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.
Be aware that if you include content in the
Resources
field when you update a monitor, theResourcesToAdd
andResourcesToRemove
fields must be empty.
resourcesToAdd?
Type:
string[]
(optional)
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.
You can specify this field for a monitor update only if the
Resources
field is empty.
resourcesToRemove?
Type:
string[]
(optional)
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
You can specify this field for a monitor update only if the
Resources
field is empty.
status?
Type:
string
(optional)
The status of a monitor.
The accepted values that you can specify for Status
are ACTIVE
and INACTIVE
.
tags?
Type:
Cfn
[]
(optional)
The tags for a monitor, listed as a set of key:value pairs.
trafficPercentageToMonitor?
Type:
number
(optional)
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.
Properties
Name | Type | Description |
---|---|---|
attr | string | The time when the monitor was created. |
attr | string | The last time that the monitor was modified. |
attr | string | The Amazon Resource Name (ARN) of the monitor. |
attr | string | The health of data processing for the monitor. |
attr | string | Additional information about the health of the data processing for the monitor. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
monitor | string | The name of the monitor. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
health | IResolvable | Health | 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 | boolean | IResolvable | 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 | IResolvable | Internet | 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 | string | The account ID for an account that you've set up cross-account sharing for in Internet Monitor. |
max | number | The maximum number of city-networks to monitor for your resources. |
resources? | string[] | The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). |
resources | string[] | The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). |
resources | string[] | The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs). |
status? | string | The status of a monitor. |
tags | Cfn [] | The tags for a monitor, listed as a set of key:value pairs. |
traffic | number | The percentage of the internet-facing traffic for your application that you want to monitor. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrCreatedAt
Type:
string
The time when the monitor was created.
attrModifiedAt
Type:
string
The last time that the monitor was modified.
attrMonitorArn
Type:
string
The Amazon Resource Name (ARN) of the monitor.
attrProcessingStatus
Type:
string
The health of data processing for the monitor.
For more information, see ProcessingStatus
under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .
attrProcessingStatusInfo
Type:
string
Additional information about the health of the data processing for the monitor.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
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)
.
monitorName
Type:
string
The name of the monitor.
node
Type:
Node
The tree node.
ref
Type:
string
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 })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
healthEventsConfig?
Type:
IResolvable
|
Health
(optional)
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?
Type:
boolean |
IResolvable
(optional)
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.
internetMeasurementsLogDelivery?
Type:
IResolvable
|
Internet
(optional)
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?
Type:
string
(optional)
The account ID for an account that you've set up cross-account sharing for in Internet Monitor.
maxCityNetworksToMonitor?
Type:
number
(optional)
The maximum number of city-networks to monitor for your resources.
resources?
Type:
string[]
(optional)
The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs).
resourcesToAdd?
Type:
string[]
(optional)
The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
resourcesToRemove?
Type:
string[]
(optional)
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
status?
Type:
string
(optional)
The status of a monitor.
tagsRaw?
Type:
Cfn
[]
(optional)
The tags for a monitor, listed as a set of key:value pairs.
trafficPercentageToMonitor?
Type:
number
(optional)
The percentage of the internet-facing traffic for your application that you want to monitor.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
DeletionOverride(path)
addpublic addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
Dependency(target)
addpublic addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
DependsOn(target)
addpublic addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
Metadata(key, value)
addpublic addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
See also: [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.](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.)
Override(path, value)
addpublic addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The 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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"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.
PropertyDeletionOverride(propertyPath)
addpublic addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
PropertyOverride(propertyPath, value)
addpublic addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
RemovalPolicy(policy?, options?)
applypublic applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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:
Att(attributeName, typeHint?)
getpublic getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
Metadata(key)
getpublic getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
See also: [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.](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)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
Dependencies()
obtainpublic obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
ResourceDependencies()
obtainpublic obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
LogicalId(newLogicalId)
overridepublic overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
Dependency(target)
removepublic removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
Dependency(target, newTarget)
replacepublic replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
Properties(props)
protected renderprotected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }