MonitorConfig
- Implements: IMonitorConfig
This class encapsulates and extends the ROS resource type ALIYUN::DNS::MonitorConfig.
Initializers
import com.aliyun.ros.cdk.dns.MonitorConfig;
MonitorConfig.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.addrPoolId(java.lang.String)
.addrPoolId(IResolvable)
.evaluationCount(java.lang.Number)
.evaluationCount(IResolvable)
.interval(java.lang.Number)
.interval(IResolvable)
.ispCityNode(IResolvable)
.ispCityNode(java.util.List<IResolvable)
.ispCityNode(IspCityNodeProperty>)
.monitorExtendInfo(IResolvable)
.monitorExtendInfo(java.util.Map<java.lang.String, java.lang.Object>)
.protocolType(java.lang.String)
.protocolType(IResolvable)
.timeout(java.lang.Number)
.timeout(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. |
addrPoolId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property addrPoolId: The ID of the address pool. |
evaluationCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property evaluationCount: The evaluation count of the monitor. |
interval | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property interval: The health check interval. |
ispCityNode | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property ispCityNode: The ISP city node list. |
monitorExtendInfo | com.aliyun.ros.cdk.core.IResolvable OR java.util.Map | Property monitorExtendInfo: The extended information. |
protocolType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property protocolType: The health check protocol. |
timeout | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property timeout: The timeout period. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
addrPoolIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property addrPoolId: The ID of the address pool.
evaluationCountRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property evaluationCount: The evaluation count of the monitor.
intervalRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property interval: The health check interval.
Unit: seconds.
ispCityNodeRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
IspCityNodeProperty>
Property ispCityNode: The ISP city node list.
monitorExtendInfoRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property monitorExtendInfo: The extended information.
The parameters vary based on the protocol type.
- HTTP or HTTPS
- port: The health check port.
- host: The Host header.
- path: The URL path.
- code: The health check is considered abnormal if the returned HTTP status code is greater than this value.
- failureRate: The failure rate.
- sni: Specifies whether to enable Server Name Indication (SNI). This parameter is used only when the health check protocol is HTTPS. Valid values:
- true
- false
- nodeType: The type of the monitoring node. This parameter is used when the address pool type is DOMAIN. Valid values:
- IPV4
- IPV6
- PING
- failureRate: The failure rate.
- packetNum: The number of ping packets.
- packetLossRate: The packet loss rate.
- nodeType: The type of the monitoring node. This parameter is used when the address pool type is DOMAIN. Valid values:
- IPV4
- IPV6
- TCP
- port: The health check port.
- failureRate: The failure rate.
- nodeType: The type of the monitoring node. This parameter is used when the address pool type is DOMAIN. Valid values:
- IPV4
- IPV6
This parameter must be a JSON string.
protocolTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property protocolType: The health check protocol.
Valid values:
- HTTP
- HTTPS
- PING
- TCP
timeoutRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property timeout: The timeout period.
Unit: milliseconds.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.dns.MonitorConfig;
MonitorConfig.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrMonitorConfigId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MonitorConfigId: The ID of the monitor config. |
props | MonitorConfigProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
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
attrMonitorConfigIdRequired
public java.lang.Object getAttrMonitorConfigId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute MonitorConfigId: The ID of the monitor config.
propsRequired
public MonitorConfigProps getProps();
- Type: MonitorConfigProps