ScheduledPreloadJob
- Implements: IScheduledPreloadJob
This class encapsulates and extends the ROS resource type ALIYUN::ESA::ScheduledPreloadJobThe , which type is used to create a scheduled preload job.
Initializers
import { ScheduledPreloadJob } from '@alicloud/ros-cdk-esa'
new ScheduledPreloadJob(scope: Construct, id: string, props: ScheduledPreloadJobProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | ScheduledPreloadJobProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: ScheduledPreloadJobProps
enableResourcePropertyConstraintOptional
- Type: boolean
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { ScheduledPreloadJob } from '@alicloud/ros-cdk-esa'
ScheduledPreloadJob.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The time when the task was created. |
attrDomains | string | @alicloud/ros-cdk-core.IResolvable | Attribute Domains: The domain names to be prefetched. |
attrErrorInfo | string | @alicloud/ros-cdk-core.IResolvable | Attribute ErrorInfo: The error message. |
attrFailedFileOss | string | @alicloud/ros-cdk-core.IResolvable | Attribute FailedFileOss: OSS address of failed file. |
attrFileId | string | @alicloud/ros-cdk-core.IResolvable | Attribute FileId: The ID of the URL list file, which can be used during downloads. |
attrInsertWay | string | @alicloud/ros-cdk-core.IResolvable | Attribute InsertWay: The method to submit the URLs to be prefetched. |
attrScheduledPreloadJobId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ScheduledPreloadJobId: The ID of the prefetch task. |
attrScheduledPreloadJobName | string | @alicloud/ros-cdk-core.IResolvable | Attribute ScheduledPreloadJobName: The task name. |
attrSiteId | string | @alicloud/ros-cdk-core.IResolvable | Attribute SiteId: The site ID. |
attrTaskSubmitted | string | @alicloud/ros-cdk-core.IResolvable | Attribute TaskSubmitted: The number of submitted prefetch tasks. |
attrTaskType | string | @alicloud/ros-cdk-core.IResolvable | Attribute TaskType: The task type. |
attrUrlCount | string | @alicloud/ros-cdk-core.IResolvable | Attribute UrlCount: The total number of URLs. |
attrUrlSubmitted | string | @alicloud/ros-cdk-core.IResolvable | Attribute UrlSubmitted: The number of submitted URLs. |
props | ScheduledPreloadJobProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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.
refRequired
public readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The time when the task was created.
attrDomainsRequired
public readonly attrDomains: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Domains: The domain names to be prefetched.
attrErrorInfoRequired
public readonly attrErrorInfo: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ErrorInfo: The error message.
attrFailedFileOssRequired
public readonly attrFailedFileOss: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute FailedFileOss: OSS address of failed file.
attrFileIdRequired
public readonly attrFileId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute FileId: The ID of the URL list file, which can be used during downloads.
attrInsertWayRequired
public readonly attrInsertWay: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute InsertWay: The method to submit the URLs to be prefetched.
attrScheduledPreloadJobIdRequired
public readonly attrScheduledPreloadJobId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ScheduledPreloadJobId: The ID of the prefetch task.
attrScheduledPreloadJobNameRequired
public readonly attrScheduledPreloadJobName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ScheduledPreloadJobName: The task name.
attrSiteIdRequired
public readonly attrSiteId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SiteId: The site ID.
attrTaskSubmittedRequired
public readonly attrTaskSubmitted: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute TaskSubmitted: The number of submitted prefetch tasks.
attrTaskTypeRequired
public readonly attrTaskType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute TaskType: The task type.
Valid values: refresh and preload.
attrUrlCountRequired
public readonly attrUrlCount: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UrlCount: The total number of URLs.
attrUrlSubmittedRequired
public readonly attrUrlSubmitted: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UrlSubmitted: The number of submitted URLs.
propsRequired
public readonly props: ScheduledPreloadJobProps;
- Type: ScheduledPreloadJobProps