Skip to content

AggTaskGroupProps

Properties for defining a AggTaskGroup.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkcms2"
&alicloudroscdkcms2.AggTaskGroupProps {
    AggTaskGroupConfig: interface{},
    AggTaskGroupName: interface{},
    InstanceId: interface{},
    TargetPrometheusId: interface{},
    AggTaskGroupConfigType: interface{},
    CronExpr: interface{},
    Delay: interface{},
    Description: interface{},
    FromTime: interface{},
    MaxRetries: interface{},
    MaxRunTimeInSeconds: interface{},
    OverrideIfExists: interface{},
    PrecheckString: interface{},
    ScheduleMode: interface{},
    ScheduleTimeExpr: interface{},
    Status: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkcms2.RosAggTaskGroup.TagsProperty,
    ToTime: interface{},
}

Properties

Name Type Description
AggTaskGroupConfig interface{} Property aggTaskGroupConfig: The config of the agg task group.
AggTaskGroupName interface{} Property aggTaskGroupName: The name of the agg task group.
InstanceId interface{} Property instanceId: The ID of the source Prometheus instance the agg task group reads data from.
TargetPrometheusId interface{} Property targetPrometheusId: The ID of the target Prometheus instance of the agg task group.
AggTaskGroupConfigType interface{} Property aggTaskGroupConfigType: The config type of the agg task group.
CronExpr interface{} Property cronExpr: The cron expression used when ScheduleMode is "Cron".
Delay interface{} Property delay: The fixed delay of the schedule, in seconds.
Description interface{} Property description: The description of the agg task group.
FromTime interface{} Property fromTime: The second-level timestamp corresponding to the schedule start time.
MaxRetries interface{} Property maxRetries: The maximum number of retries for executing the agg task.
MaxRunTimeInSeconds interface{} Property maxRunTimeInSeconds: The maximum retry time for executing the agg task, in seconds.
OverrideIfExists interface{} Property overrideIfExists: Whether to override and update an existing agg task group with the same name when creating.
PrecheckString interface{} Property precheckString: The precheck config.
ScheduleMode interface{} Property scheduleMode: The schedule mode, "Cron" or "FixedRate".
ScheduleTimeExpr interface{} Property scheduleTimeExpr: The schedule time expression, "@s" or "@m" is recommended, indicating the rounding granularity of the schedule time window.
Status interface{} Property status: The status of the agg task group, "Running" or "Stopped".
Tags *[]TagsProperty Property tags: The tags of the agg task group.
ToTime interface{} Property toTime: The second-level timestamp corresponding to the schedule end time.

AggTaskGroupConfigRequired

AggTaskGroupConfig interface{}
  • Type: interface{}

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

AggTaskGroupName interface{}
  • Type: interface{}

Property aggTaskGroupName: The name of the agg task group.


InstanceIdRequired

InstanceId interface{}
  • Type: interface{}

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


TargetPrometheusIdRequired

TargetPrometheusId interface{}
  • Type: interface{}

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


AggTaskGroupConfigTypeOptional

AggTaskGroupConfigType interface{}
  • Type: interface{}

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

Default: "RecordingRuleYaml".


CronExprOptional

CronExpr interface{}
  • Type: interface{}

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

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


DelayOptional

Delay interface{}
  • Type: interface{}

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

Default: 30.


DescriptionOptional

Description interface{}
  • Type: interface{}

Property description: The description of the agg task group.


FromTimeOptional

FromTime interface{}
  • Type: interface{}

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


MaxRetriesOptional

MaxRetries interface{}
  • Type: interface{}

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

Default: 20.


MaxRunTimeInSecondsOptional

MaxRunTimeInSeconds interface{}
  • Type: interface{}

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

Default: 600.


OverrideIfExistsOptional

OverrideIfExists interface{}
  • Type: interface{}

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

Create-only, cannot be updated.


PrecheckStringOptional

PrecheckString interface{}
  • Type: interface{}

Property precheckString: The precheck config.

Not configured by default.


ScheduleModeOptional

ScheduleMode interface{}
  • Type: interface{}

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

Default: "FixedRate".


ScheduleTimeExprOptional

ScheduleTimeExpr interface{}
  • Type: interface{}

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

Default: "@m".


StatusOptional

Status interface{}
  • Type: interface{}

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

Default: Running.


TagsOptional

Tags *[]TagsProperty

Property tags: The tags of the agg task group.


ToTimeOptional

ToTime interface{}
  • Type: interface{}

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

0 means the schedule never stops.