Schedule

• Implements: com.aliyun.ros.cdk.fnf.datasource.ISchedule

This class encapsulates and extends the ROS resource type DATASOURCE::FNF::Schedule, which is used to query the information about a time-based schedule.

Initializers

import com.aliyun.ros.cdk.fnf.datasource.Schedule;
Schedule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .flowName(java.lang.String)
    .flowName(IResolvable)
    .scheduleName(java.lang.String)
    .scheduleName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

flowName^Required

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

Property flowName: The name of the flow that is associated with the time-based schedule.

The name must be unique within the region and cannot be modified after the time-based schedule is created. The name must meet the following conventions: The name can contain letters, digits, underscores (), and hyphens (-). The name must start with a letter or an underscore (). The name is case-sensitive. The name must be 1 to 128 characters in length.

scheduleName^Required

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

Property scheduleName: The name of the time-based schedule.

The name must meet the following conventions: The name can contain letters, digits, underscores (), and hyphens (-). The name must start with a letter or an underscore (). The name is case-sensitive. The name must be 1 to 128 characters in length.

refreshOptions^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.fnf.datasource.Schedule;
Schedule.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

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

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

Attribute CreateTime: The time when the time-based schedule was created.

attrCronExpression^Required

public java.lang.Object getAttrCronExpression();

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

Attribute CronExpression: The CRON expression of the time-based schedule to be created.

attrDescription^Required

public java.lang.Object getAttrDescription();

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

Attribute Description: The description of the time-based schedule to be created.

attrLastModifiedTime^Required

public java.lang.Object getAttrLastModifiedTime();

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

Attribute LastModifiedTime: The time when the time-based schedule was last updated.

attrPayload^Required

public java.lang.Object getAttrPayload();

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

Attribute Payload: The trigger message of the time-based schedule to be created.

attrScheduleId^Required

public java.lang.Object getAttrScheduleId();

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

Attribute ScheduleId: The ID of the time-based schedule.

attrScheduleName^Required

public java.lang.Object getAttrScheduleName();

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

Attribute ScheduleName: The name of the time-based schedule to be created.

props^Required

public ScheduleProps getProps();

• Type: ScheduleProps