SiteMonitor

This class encapsulates and extends the ROS resource type ALIYUN::CMS::SiteMonitor, which is used to create a site monitoring task.

Initializers

import ros_cdk_cms
ros_cdk_cms.SiteMonitor(
  scope: Construct,
  id: str,
  address: typing.Union[str, IResolvable],
  task_name: typing.Union[str, IResolvable],
  task_type: typing.Union[str, IResolvable],
  alert_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  interval: typing.Union[typing.Union[int, float], IResolvable] = None,
  isp_cities: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, IspCitiesProperty]]] = None,
  options_json: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
address	typing.Union[str, ros_cdk_core.IResolvable]	Property address: The URL or IP address monitored by the monitoring task.
task_name	typing.Union[str, ros_cdk_core.IResolvable]	Property taskName: The name of the site monitoring task.
task_type	typing.Union[str, ros_cdk_core.IResolvable]	Property taskType: The protocol used by the site monitoring task.
alert_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property alertIds:.
interval	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property interval: The interval at which detection requests are sent.
isp_cities	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, IspCitiesProperty]]]	Property ispCities: The information about detection points, which is specified in a JSON array.
options_json	typing.Union[str, ros_cdk_core.IResolvable]	Property optionsJson: The extended options of the protocol that is used by the site monitoring task.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

address^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property address: The URL or IP address monitored by the monitoring task.

---

task_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property taskName: The name of the site monitoring task.

The name must be 4 to 100 characters in length. It can contain letters, digits, and underscores (_).

---

task_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property taskType: The protocol used by the site monitoring task.

Valid values: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.

---

alert_ids^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property alertIds:.

---

interval^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property interval: The interval at which detection requests are sent.

Valid values: 1, 5, and 15. Unit: minutes. Default value: 1.

---

isp_cities^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, IspCitiesProperty]]]

Property ispCities: The information about detection points, which is specified in a JSON array.

Example: [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]. The three city codes represent Beijing, Hangzhou, and Qingdao. Note You can call the DescribeSiteMonitorISPCityList API operation to query the detection points that can be used to create site monitoring tasks. For more information, see DescribeSiteMonitorISPCityList . If this parameter is not specified, the system randomly selects three detection points for site monitoring.

---

options_json^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property optionsJson: The extended options of the protocol that is used by the site monitoring task.

The options vary based on the protocol.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_cms
ros_cdk_cms.SiteMonitor.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_task_id	ros_cdk_core.IResolvable	Attribute TaskId: The ID of the site monitoring task.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_task_id^Required

attr_task_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute TaskId: The ID of the site monitoring task.

---