Skip to content

CycleTask

This class encapsulates and extends the ROS resource type ALIYUN::ThreatDetection::CycleTask.

Initializers

import ros_cdk_threatdetection
ros_cdk_threatdetection.CycleTask(
  scope: Construct,
  id: str,
  enable: typing.Union[typing.Union[int, float], IResolvable],
  first_date_str: typing.Union[typing.Union[int, float], IResolvable],
  interval_period: typing.Union[typing.Union[int, float], IResolvable],
  period_unit: typing.Union[str, IResolvable],
  target_end_time: typing.Union[typing.Union[int, float], IResolvable],
  target_start_time: typing.Union[typing.Union[int, float], IResolvable],
  task_name: typing.Union[str, IResolvable],
  task_type: typing.Union[str, IResolvable],
  param: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  source: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
enable typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property enable: Specifies whether to enable the task.
first_date_str typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property firstDateStr: The first time when the task is performed.
interval_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property intervalPeriod: The interval at which the task is run.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The unit of the scan interval.
target_end_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property targetEndTime: The time when the task ends.
target_start_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property targetStartTime: The time when the task is started.
task_name typing.Union[str, ros_cdk_core.IResolvable] Property taskName: The task name.
task_type typing.Union[str, ros_cdk_core.IResolvable] Property taskType: The type of the task.
param typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property param: The additional information.
source typing.Union[str, ros_cdk_core.IResolvable] Property source: The additional source for the task.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

enableRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property enable: Specifies whether to enable the task.

Valid values:

  • 1: yes
  • 0: no.

first_date_strRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property firstDateStr: The first time when the task is performed.


interval_periodRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property intervalPeriod: The interval at which the task is run.


period_unitRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property periodUnit: The unit of the scan interval.

Valid values:

  • day
  • hour.

target_end_timeRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property targetEndTime: The time when the task ends.

Unit: hours.


target_start_timeRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property targetStartTime: The time when the task is started.

Unit: hours.


task_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property taskName: The task name.


task_typeRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property taskType: The type of the task.

Valid values:

  • VIRUS_VUL_SCHEDULE_SCAN: virus scan task
  • IMAGE_SCAN: image scan task
  • EMG_VUL_SCHEDULE_SCAN: urgent vulnerability scan task.

paramOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property param: The additional information.


sourceOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property source: The additional source for the task.


enable_resource_property_constraintOptional

  • 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.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc 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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct

import ros_cdk_threatdetection
ros_cdk_threatdetection.CycleTask.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
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_config_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ConfigId: Configuration ID.
attr_enable typing.Union[str, ros_cdk_core.IResolvable] Attribute Enable: Specifies whether to enable the task.
attr_first_date_str typing.Union[str, ros_cdk_core.IResolvable] Attribute FirstDateStr: The first time when the task is performed.
attr_interval_period typing.Union[str, ros_cdk_core.IResolvable] Attribute IntervalPeriod: The interval at which the task is run.
attr_param typing.Union[str, ros_cdk_core.IResolvable] Attribute Param: The additional information.
attr_period_unit typing.Union[str, ros_cdk_core.IResolvable] Attribute PeriodUnit: The unit of the scan interval.
attr_target_end_time typing.Union[str, ros_cdk_core.IResolvable] Attribute TargetEndTime: The time when the task ends.
attr_target_start_time typing.Union[str, ros_cdk_core.IResolvable] Attribute TargetStartTime: The time when the task is started.
attr_task_name typing.Union[str, ros_cdk_core.IResolvable] Attribute TaskName: The task name.
attr_task_type typing.Union[str, ros_cdk_core.IResolvable] Attribute TaskType: The type of the task.
props CycleTaskProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

env: IResourceEnvironment
  • Type: 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

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_config_idRequired

attr_config_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ConfigId: Configuration ID.


attr_enableRequired

attr_enable: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Enable: Specifies whether to enable the task.


attr_first_date_strRequired

attr_first_date_str: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute FirstDateStr: The first time when the task is performed.


attr_interval_periodRequired

attr_interval_period: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute IntervalPeriod: The interval at which the task is run.


attr_paramRequired

attr_param: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Param: The additional information.


attr_period_unitRequired

attr_period_unit: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute PeriodUnit: The unit of the scan interval.


attr_target_end_timeRequired

attr_target_end_time: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TargetEndTime: The time when the task ends.

Unit: hours.


attr_target_start_timeRequired

attr_target_start_time: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TargetStartTime: The time when the task is started.

Unit: hours.


attr_task_nameRequired

attr_task_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TaskName: The task name.


attr_task_typeRequired

attr_task_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TaskType: The type of the task.


propsRequired

props: CycleTaskProps