ApplicationMonitor
This class encapsulates and extends the ROS resource type ALIYUN::GA::ApplicationMonitor
, which is used to create an origin probing task.
Initializers
import ros_cdk_ga
ros_cdk_ga.ApplicationMonitor(
scope: Construct,
id: str,
accelerator_id: typing.Union[str, IResolvable],
address: typing.Union[str, IResolvable],
listener_id: typing.Union[str, IResolvable],
task_name: typing.Union[str, IResolvable],
detect_enable: typing.Union[bool, IResolvable] = None,
detect_threshold: typing.Union[typing.Union[int, float], IResolvable] = None,
detect_times: typing.Union[typing.Union[int, float], IResolvable] = None,
options_json: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
silence_time: typing.Union[typing.Union[int, float], IResolvable] = None,
enable_resource_property_constraint: bool = None
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
accelerator_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property acceleratorId: The ID of the GA instance on which you want to perform the origin probing task. |
address |
typing.Union[str, ros_cdk_core.IResolvable] |
Property address: The URL or IP address that you want to probe. |
listener_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property listenerId: The ID of the listener on which you want to perform the origin probing task. |
task_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property taskName: The name of the origin probing task. |
detect_enable |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property detectEnable: Specifies whether to enable the automatic diagnostics feature. |
detect_threshold |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property detectThreshold: The threshold that is used to trigger the automatic diagnostics feature. |
detect_times |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property detectTimes: The number of times that the threshold must be reached before the automatic diagnostics feature is triggered. |
options_json |
typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] |
Property optionsJson: The extended options of the listener protocol that is used by the origin probing task. |
silence_time |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property silenceTime: The silence period of the automatic diagnostics feature. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
accelerator_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property acceleratorId: The ID of the GA instance on which you want to perform the origin probing task.
address
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property address: The URL or IP address that you want to probe.
listener_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property listenerId: The ID of the listener on which you want to perform the origin probing task.
task_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property taskName: The name of the origin probing task.
The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
detect_enable
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property detectEnable: Specifies whether to enable the automatic diagnostics feature.
detect_threshold
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property detectThreshold: The threshold that is used to trigger the automatic diagnostics feature.
Unit: percentage.Valid values: 0 to 100.The default value is 0, which indicates that the automatic diagnostics feature is not triggered.
detect_times
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property detectTimes: The number of times that the threshold must be reached before the automatic diagnostics feature is triggered.
Valid values: 1 to 20. Default value: 1.
options_json
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
Property optionsJson: The extended options of the listener protocol that is used by the origin probing task.
The options vary based on the listener protocol.
silence_time
Optional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property silenceTime: The silence period of the automatic diagnostics feature.
This parameter specifies the interval at which the automatic diagnostics feature is triggered. If the availability rate does not return to normal after GA triggers an automatic diagnostic task, GA must wait until the silence period ends before GA can trigger another automatic diagnostic task.If the number of consecutive times that the availability rate drops below the threshold of automatic diagnostics reaches the value of DetectTimes, the automatic diagnostics feature is triggered. The automatic diagnostics feature is not triggered again within the silence period even if the availability rate remains below the threshold. If the availability rate does not return to normal after the silence period ends, the automatic diagnostics feature is triggered again.Unit: seconds. Valid values: 300 to 86400. Default value: 300.
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_ga
ros_cdk_ga.ApplicationMonitor.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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 origin probing 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 origin probing task.