AggTaskGroup

• Implements: IAggTaskGroup

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

Initializers

import com.aliyun.ros.cdk.cms2.AggTaskGroup;
AggTaskGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .aggTaskGroupConfig(java.lang.String)
    .aggTaskGroupConfig(IResolvable)
    .aggTaskGroupName(java.lang.String)
    .aggTaskGroupName(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .targetPrometheusId(java.lang.String)
    .targetPrometheusId(IResolvable)
//  .aggTaskGroupConfigType(java.lang.String)
//  .aggTaskGroupConfigType(IResolvable)
//  .cronExpr(java.lang.String)
//  .cronExpr(IResolvable)
//  .delay(java.lang.Number)
//  .delay(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .fromTime(java.lang.Number)
//  .fromTime(IResolvable)
//  .maxRetries(java.lang.Number)
//  .maxRetries(IResolvable)
//  .maxRunTimeInSeconds(java.lang.Number)
//  .maxRunTimeInSeconds(IResolvable)
//  .overrideIfExists(java.lang.Boolean)
//  .overrideIfExists(IResolvable)
//  .precheckString(IResolvable)
//  .precheckString(java.util.Map<java.lang.String, java.lang.Object>)
//  .scheduleMode(java.lang.String)
//  .scheduleMode(IResolvable)
//  .scheduleTimeExpr(java.lang.String)
//  .scheduleTimeExpr(IResolvable)
//  .status(java.lang.String)
//  .status(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .toTime(java.lang.Number)
//  .toTime(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

aggTaskGroupConfig^Required

• Type: java.lang.String OR com.aliyun.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.

aggTaskGroupName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property aggTaskGroupName: The name of the agg task group.

instanceId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

targetPrometheusId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

aggTaskGroupConfigType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Default: "RecordingRuleYaml".

cronExpr^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Default: 30.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the agg task group.

fromTime^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

maxRetries^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Default: 20.

maxRunTimeInSeconds^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Default: 600.

overrideIfExists^Optional

• Type: java.lang.Boolean OR com.aliyun.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.

precheckString^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property precheckString: The precheck config.

Not configured by default.

scheduleMode^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Default: "FixedRate".

scheduleTimeExpr^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Default: Running.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: The tags of the agg task group.

toTime^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

0 means the schedule never stops.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.cms2.AggTaskGroup;
AggTaskGroup.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAggTaskGroupConfigHash^Required

public java.lang.Object getAttrAggTaskGroupConfigHash();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrAggTaskGroupId^Required

public java.lang.Object getAttrAggTaskGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AggTaskGroupId: The ID of the agg task group.

attrAggTaskGroupName^Required

public java.lang.Object getAttrAggTaskGroupName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AggTaskGroupName: The name of the agg task group.

attrSourcePrometheusId^Required

public java.lang.Object getAttrSourcePrometheusId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrStatus^Required

public java.lang.Object getAttrStatus();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public AggTaskGroupProps getProps();

• Type: AggTaskGroupProps