Skip to content

SyntheticTask

  • Implements: @alicloud/ros-cdk-arms.datasource.ISyntheticTask

This class encapsulates and extends the ROS resource type DATASOURCE::ARMS::SyntheticTask, which is used to query the information about a scheduled synthetic monitoring task.

Initializers

import { datasource } from '@alicloud/ros-cdk-arms'
new datasource.SyntheticTask(scope: Construct, id: string, props: SyntheticTaskProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props SyntheticTaskProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { datasource } from '@alicloud/ros-cdk-arms'
datasource.SyntheticTask.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAvailableAssertions string | @alicloud/ros-cdk-core.IResolvable Attribute AvailableAssertions: The list of assertions.
attrCommonSetting string | @alicloud/ros-cdk-core.IResolvable Attribute CommonSetting: The general settings.
attrCustomPeriod string | @alicloud/ros-cdk-core.IResolvable Attribute CustomPeriod: The custom cycle.
attrFrequency string | @alicloud/ros-cdk-core.IResolvable Attribute Frequency: The detection frequency.
attrMonitorCategory string | @alicloud/ros-cdk-core.IResolvable Attribute MonitorCategory: The detection point type.
attrMonitorConf string | @alicloud/ros-cdk-core.IResolvable Attribute MonitorConf: The monitoring configurations.
attrMonitors string | @alicloud/ros-cdk-core.IResolvable Attribute Monitors: The list of monitoring points.
attrResourceGroupId string | @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrSyntheticTaskName string | @alicloud/ros-cdk-core.IResolvable Attribute SyntheticTaskName: The name of synthetic task.
attrTags string | @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tags of the instance.
attrTaskId string | @alicloud/ros-cdk-core.IResolvable Attribute TaskId: The ID of the synthetic monitoring task.
attrTaskType string | @alicloud/ros-cdk-core.IResolvable Attribute TaskType: The type of the task.
props SyntheticTaskProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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 readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAvailableAssertionsRequired

public readonly attrAvailableAssertions: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AvailableAssertions: The list of assertions.


attrCommonSettingRequired

public readonly attrCommonSetting: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CommonSetting: The general settings.


attrCustomPeriodRequired

public readonly attrCustomPeriod: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CustomPeriod: The custom cycle.


attrFrequencyRequired

public readonly attrFrequency: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Frequency: The detection frequency.


attrMonitorCategoryRequired

public readonly attrMonitorCategory: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MonitorCategory: The detection point type.

1: PC. 2: mobile device.


attrMonitorConfRequired

public readonly attrMonitorConf: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MonitorConf: The monitoring configurations.


attrMonitorsRequired

public readonly attrMonitors: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Monitors: The list of monitoring points.


attrResourceGroupIdRequired

public readonly attrResourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attrSyntheticTaskNameRequired

public readonly attrSyntheticTaskName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute SyntheticTaskName: The name of synthetic task.


attrTagsRequired

public readonly attrTags: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tags of the instance.


attrTaskIdRequired

public readonly attrTaskId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TaskId: The ID of the synthetic monitoring task.


attrTaskTypeRequired

public readonly attrTaskType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TaskType: The type of the task.


propsRequired

public readonly props: SyntheticTaskProps;