class CfnMonitor (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.InternetMonitor.CfnMonitor`
Java	`software.amazon.awscdk.services.internetmonitor.CfnMonitor`
Python	`aws_cdk.aws_internetmonitor.CfnMonitor`
TypeScript	`@aws-cdk/aws-internetmonitor` » `CfnMonitor`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation 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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as internetmonitor from '@aws-cdk/aws-internetmonitor';
const cfnMonitor = new internetmonitor.CfnMonitor(this, 'MyCfnMonitor', {
  monitorName: 'monitorName',

  // the properties below are optional
  internetMeasurementsLogDelivery: {
    s3Config: {
      bucketName: 'bucketName',
      bucketPrefix: 'bucketPrefix',
      logDeliveryStatus: 'logDeliveryStatus',
    },
  },
  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 — - scoped id of the resource.
props CfnMonitorProps — - resource properties.

Create a new AWS::InternetMonitor::Monitor.

Construct Props

Name	Type	Description
monitorName	`string`	The name of the monitor.
internetMeasurementsLogDelivery?	`InternetMeasurementsLogDeliveryProperty` `\|` `IResolvable`	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.
maxCityNetworksToMonitor?	`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).
resourcesToAdd?	`string[]`	The resources to add to a monitor, which you provide as a set of Amazon Resource Names (ARNs).
resourcesToRemove?	`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?	`CfnTag[]`	The tags for a monitor, listed as a set of key:value pairs.
trafficPercentageToMonitor?	`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 (_).

internetMeasurementsLogDelivery?

Type: InternetMeasurementsLogDeliveryProperty | IResolvable (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).

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).

resourcesToAdd?

Type: string[] (optional)

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.

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.

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.

The accepted values that you can specify for Status are ACTIVE and INACTIVE .

tags?

Type: CfnTag[] (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
attrCreatedAt	`string`	The time when the monitor was created.
attrModifiedAt	`string`	The last time that the monitor was modified.
attrMonitorArn	`string`	The Amazon Resource Name (ARN) of the monitor.
attrProcessingStatus	`string`	The health of data processing for the monitor.
attrProcessingStatusInfo	`string`	Additional information about the health of the data processing for the monitor.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
monitorName	`string`	The name of the monitor.
node	`ConstructNode`	The construct tree node associated with this construct.
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	`TagManager`	The tags for a monitor, listed as a set of key:value pairs.
internetMeasurementsLogDelivery?	`InternetMeasurementsLogDeliveryProperty` `\|` `IResolvable`	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.
maxCityNetworksToMonitor?	`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).
resourcesToAdd?	`string[]`	The resources to add to a monitor, which you provide as a set of Amazon Resource Names (ARNs).
resourcesToRemove?	`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.
trafficPercentageToMonitor?	`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: ICfnResourceOptions

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.

A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).

node

Type: ConstructNode

The construct tree node associated with this construct.

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).

internetMeasurementsLogDelivery?

Type: InternetMeasurementsLogDeliveryProperty | IResolvable (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).

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).

resourcesToAdd?

Type: string[] (optional)

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.

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.

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.

The accepted values that you can specify for Status are ACTIVE and INACTIVE .

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
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

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.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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.)

addOverride(path, value)

public 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.

addPropertyDeletionOverride(propertyPath)

public 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.

addPropertyOverride(propertyPath, value)

public 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).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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 TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public 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.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }