AggTaskGroupProps

Properties for defining a AggTaskGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cms2-aggtaskgroup

Initializer

import ros_cdk_cms2
ros_cdk_cms2.AggTaskGroupProps(
  agg_task_group_config: typing.Union[str, IResolvable],
  agg_task_group_name: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  target_prometheus_id: typing.Union[str, IResolvable],
  agg_task_group_config_type: typing.Union[str, IResolvable] = None,
  cron_expr: typing.Union[str, IResolvable] = None,
  delay: typing.Union[typing.Union[int, float], IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  from_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_retries: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_run_time_in_seconds: typing.Union[typing.Union[int, float], IResolvable] = None,
  override_if_exists: typing.Union[bool, IResolvable] = None,
  precheck_string: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  schedule_mode: typing.Union[str, IResolvable] = None,
  schedule_time_expr: typing.Union[str, IResolvable] = None,
  status: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  to_time: typing.Union[typing.Union[int, float], IResolvable] = None
)

Properties

agg_task_group_config^Required

agg_task_group_config: typing.Union[str, IResolvable]

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

Property aggTaskGroupConfig: The config of the agg task group.

Only "RecordingRuleYaml" format is supported, which must conform to the RecordingRule format of the open source Prometheus.

agg_task_group_name^Required

agg_task_group_name: typing.Union[str, IResolvable]

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

Property aggTaskGroupName: The name of the agg task group.

instance_id^Required

instance_id: typing.Union[str, IResolvable]

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

Property instanceId: The ID of the source Prometheus instance the agg task group reads data from.

target_prometheus_id^Required

target_prometheus_id: typing.Union[str, IResolvable]

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

Property targetPrometheusId: The ID of the target Prometheus instance of the agg task group.

agg_task_group_config_type^Optional

agg_task_group_config_type: typing.Union[str, IResolvable]

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

Property aggTaskGroupConfigType: The config type of the agg task group.

Default: "RecordingRuleYaml".

cron_expr^Optional

cron_expr: typing.Union[str, IResolvable]

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

Property cronExpr: The cron expression used when ScheduleMode is "Cron".

For example, "0/1 * * * *" means scheduling every 1 minute starting from minute 0.

delay^Optional

delay: typing.Union[typing.Union[int, float], IResolvable]

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

Property delay: The fixed delay of the schedule, in seconds.

Default: 30.

description^Optional

description: typing.Union[str, IResolvable]

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

Property description: The description of the agg task group.

from_time^Optional

from_time: typing.Union[typing.Union[int, float], IResolvable]

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

Property fromTime: The second-level timestamp corresponding to the schedule start time.

max_retries^Optional

max_retries: typing.Union[typing.Union[int, float], IResolvable]

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

Property maxRetries: The maximum number of retries for executing the agg task.

Default: 20.

max_run_time_in_seconds^Optional

max_run_time_in_seconds: typing.Union[typing.Union[int, float], IResolvable]

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

Property maxRunTimeInSeconds: The maximum retry time for executing the agg task, in seconds.

Default: 600.

override_if_exists^Optional

override_if_exists: typing.Union[bool, IResolvable]

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

Property overrideIfExists: Whether to override and update an existing agg task group with the same name when creating.

Create-only, cannot be updated.

precheck_string^Optional

precheck_string: typing.Union[IResolvable, typing.Mapping[typing.Any]]

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

Property precheckString: The precheck config.

Not configured by default.

schedule_mode^Optional

schedule_mode: typing.Union[str, IResolvable]

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

Property scheduleMode: The schedule mode, "Cron" or "FixedRate".

Default: "FixedRate".

schedule_time_expr^Optional

schedule_time_expr: typing.Union[str, IResolvable]

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

Property scheduleTimeExpr: The schedule time expression, "@s" or "@m" is recommended, indicating the rounding granularity of the schedule time window.

Default: "@m".

status^Optional

status: typing.Union[str, IResolvable]

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

Property status: The status of the agg task group, "Running" or "Stopped".

Default: Running.

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[TagsProperty]

Property tags: The tags of the agg task group.

to_time^Optional

to_time: typing.Union[typing.Union[int, float], IResolvable]

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

Property toTime: The second-level timestamp corresponding to the schedule end time.

0 means the schedule never stops.