SiteMonitor

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

Initializers

import com.aliyun.ros.cdk.cms.SiteMonitor;
SiteMonitor.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .address(java.lang.String)
    .address(IResolvable)
    .taskName(java.lang.String)
    .taskName(IResolvable)
    .taskType(java.lang.String)
    .taskType(IResolvable)
//  .alertIds(IResolvable)
//  .alertIds(java.util.List<java.lang.String)
//  .alertIds(IResolvable>)
//  .interval(java.lang.Number)
//  .interval(IResolvable)
//  .ispCities(IResolvable)
//  .ispCities(java.util.List<IResolvable)
//  .ispCities(IspCitiesProperty>)
//  .optionsJson(java.lang.String)
//  .optionsJson(IResolvable)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
address	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property address: The URL or IP address monitored by the monitoring task.
taskName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property taskName: The name of the site monitoring task.
taskType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property taskType: The protocol used by the site monitoring task.
alertIds	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property alertIds:.
interval	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property interval: The interval at which detection requests are sent.
ispCities	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListIspCitiesProperty>	Property ispCities: The information about detection points, which is specified in a JSON array.
optionsJson	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property optionsJson: The extended options of the protocol that is used by the site monitoring task.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

address^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

taskName^Required

• Type: java.lang.String OR com.aliyun.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 (_).

---

taskType^Required

• Type: java.lang.String OR com.aliyun.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.

---

alertIds^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property alertIds:.

---

interval^Optional

• Type: java.lang.Number OR com.aliyun.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.

---

ispCities^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListIspCitiesProperty>

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.

---

optionsJson^Optional

• Type: java.lang.String OR com.aliyun.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.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

import com.aliyun.ros.cdk.cms.SiteMonitor;
SiteMonitor.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrTaskId	com.aliyun.ros.cdk.core.IResolvable	Attribute TaskId: The ID of the site monitoring task.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrTaskId^Required

public IResolvable getAttrTaskId();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TaskId: The ID of the site monitoring task.

---