Skip to content

AggTaskGroupProps

Properties for defining a AggTaskGroup.

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

Initializer 

import { AggTaskGroupProps } from '@alicloud/ros-cdk-cms2'
const aggTaskGroupProps: AggTaskGroupProps = { ... }

Properties

Name Type Description
aggTaskGroupConfig string | @alicloud/ros-cdk-core.IResolvable Property aggTaskGroupConfig: The config of the agg task group.
aggTaskGroupName string | @alicloud/ros-cdk-core.IResolvable Property aggTaskGroupName: The name of the agg task group.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: The ID of the source Prometheus instance the agg task group reads data from.
targetPrometheusId string | @alicloud/ros-cdk-core.IResolvable Property targetPrometheusId: The ID of the target Prometheus instance of the agg task group.
aggTaskGroupConfigType string | @alicloud/ros-cdk-core.IResolvable Property aggTaskGroupConfigType: The config type of the agg task group.
cronExpr string | @alicloud/ros-cdk-core.IResolvable Property cronExpr: The cron expression used when ScheduleMode is "Cron".
delay number | @alicloud/ros-cdk-core.IResolvable Property delay: The fixed delay of the schedule, in seconds.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the agg task group.
fromTime number | @alicloud/ros-cdk-core.IResolvable Property fromTime: The second-level timestamp corresponding to the schedule start time.
maxRetries number | @alicloud/ros-cdk-core.IResolvable Property maxRetries: The maximum number of retries for executing the agg task.
maxRunTimeInSeconds number | @alicloud/ros-cdk-core.IResolvable Property maxRunTimeInSeconds: The maximum retry time for executing the agg task, in seconds.
overrideIfExists boolean | @alicloud/ros-cdk-core.IResolvable Property overrideIfExists: Whether to override and update an existing agg task group with the same name when creating.
precheckString @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property precheckString: The precheck config.
scheduleMode string | @alicloud/ros-cdk-core.IResolvable Property scheduleMode: The schedule mode, "Cron" or "FixedRate".
scheduleTimeExpr string | @alicloud/ros-cdk-core.IResolvable Property scheduleTimeExpr: The schedule time expression, "@s" or "@m" is recommended, indicating the rounding granularity of the schedule time window.
status string | @alicloud/ros-cdk-core.IResolvable Property status: The status of the agg task group, "Running" or "Stopped".
tags TagsProperty[] Property tags: The tags of the agg task group.
toTime number | @alicloud/ros-cdk-core.IResolvable Property toTime: The second-level timestamp corresponding to the schedule end time.

aggTaskGroupConfigRequired 

public readonly aggTaskGroupConfig: string | IResolvable;
  • Type: string | @alicloud/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.

aggTaskGroupNameRequired 

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

Property aggTaskGroupName: The name of the agg task group.

instanceIdRequired 

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

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

targetPrometheusIdRequired 

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

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

aggTaskGroupConfigTypeOptional 

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

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

Default: "RecordingRuleYaml".

cronExprOptional 

public readonly cronExpr: string | IResolvable;
  • Type: string | @alicloud/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.

delayOptional 

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

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

Default: 30.

descriptionOptional 

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

Property description: The description of the agg task group.

fromTimeOptional 

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

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

maxRetriesOptional 

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

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

Default: 20.

maxRunTimeInSecondsOptional 

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

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

Default: 600.

overrideIfExistsOptional 

public readonly overrideIfExists: boolean | IResolvable;
  • Type: boolean | @alicloud/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.

precheckStringOptional 

public readonly precheckString: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property precheckString: The precheck config.

Not configured by default.

scheduleModeOptional 

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

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

Default: "FixedRate".

scheduleTimeExprOptional 

public readonly scheduleTimeExpr: string | IResolvable;
  • Type: string | @alicloud/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".

statusOptional 

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

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

Default: Running.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: The tags of the agg task group.

toTimeOptional 

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

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

0 means the schedule never stops.