Skip to content

SiteMonitor

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

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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

addressRequired

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

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

taskNameRequired

  • 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 (_).

taskTypeRequired

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

alertIdsOptional

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

Property alertIds:.

intervalOptional

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

ispCitiesOptional

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

optionsJsonOptional

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

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

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

xRequired

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

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrTaskIdRequired 

public IResolvable getAttrTaskId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TaskId: The ID of the site monitoring task.