AggTaskGroup

• Implements: IAggTaskGroup

This class encapsulates and extends the ROS resource type ALIYUN::CMS2::AggTaskGroup.

Initializers

import ros_cdk_cms2
ros_cdk_cms2.AggTaskGroup(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

agg_task_group_config^Required

• 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

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

Property aggTaskGroupName: The name of the agg task group.

instance_id^Required

• 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

• 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

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

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

Default: "RecordingRuleYaml".

cron_expr^Optional

• 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

• 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

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

Property description: The description of the agg task group.

from_time^Optional

• 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

• 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

• 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

• 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

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

Property precheckString: The precheck config.

Not configured by default.

schedule_mode^Optional

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

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

Default: "FixedRate".

schedule_time_expr^Optional

• 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

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

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

Default: Running.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: The tags of the agg task group.

to_time^Optional

• 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• 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

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_cms2
ros_cdk_cms2.AggTaskGroup.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_agg_task_group_config_hash^Required

attr_agg_task_group_config_hash: typing.Union[str, IResolvable]

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

Attribute AggTaskGroupConfigHash: The config hash of the agg task group.

attr_agg_task_group_id^Required

attr_agg_task_group_id: typing.Union[str, IResolvable]

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

Attribute AggTaskGroupId: The ID of the agg task group.

attr_agg_task_group_name^Required

attr_agg_task_group_name: typing.Union[str, IResolvable]

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

Attribute AggTaskGroupName: The name of the agg task group.

attr_source_prometheus_id^Required

attr_source_prometheus_id: typing.Union[str, IResolvable]

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

Attribute SourcePrometheusId: The ID of the source Prometheus instance of the agg task group.

attr_status^Required

attr_status: typing.Union[str, IResolvable]

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

Attribute Status: The current status of the agg task group.

props^Required

props: AggTaskGroupProps

• Type: AggTaskGroupProps