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 ros_cdk_esa
ros_cdk_esa.ScheduledPreloadJob(
  scope: Construct,
  id: str,
  insert_way: typing.Union[str, IResolvable],
  scheduled_preload_job_name: typing.Union[str, IResolvable],
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  oss_url: typing.Union[str, IResolvable] = None,
  url_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

insert_way^Required

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

Property insertWay: The method to submit the URLs to be prefetched.

scheduled_preload_job_name^Required

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

Property scheduledPreloadJobName: The name of the scheduled prefetch task.

site_id^Required

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

Property siteId: The site ID.

oss_url^Optional

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

Property ossUrl: Preheat OSS files regularly and fill in the OSS file address.

Note: The OSS file contains the URL that you need to warm up.

url_list^Optional

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

Property urlList: A list of URLs to be preheated, which is used when uploading a preheated file in the text box mode.

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_esa
ros_cdk_esa.ScheduledPreloadJob.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_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The time when the task was created.

attr_domains^Required

attr_domains: typing.Union[str, IResolvable]

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

Attribute Domains: The domain names to be prefetched.

attr_error_info^Required

attr_error_info: typing.Union[str, IResolvable]

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

Attribute ErrorInfo: The error message.

attr_failed_file_oss^Required

attr_failed_file_oss: typing.Union[str, IResolvable]

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

Attribute FailedFileOss: OSS address of failed file.

attr_file_id^Required

attr_file_id: typing.Union[str, IResolvable]

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

Attribute FileId: The ID of the URL list file, which can be used during downloads.

attr_insert_way^Required

attr_insert_way: typing.Union[str, IResolvable]

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

Attribute InsertWay: The method to submit the URLs to be prefetched.

attr_scheduled_preload_job_id^Required

attr_scheduled_preload_job_id: typing.Union[str, IResolvable]

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

Attribute ScheduledPreloadJobId: The ID of the prefetch task.

attr_scheduled_preload_job_name^Required

attr_scheduled_preload_job_name: typing.Union[str, IResolvable]

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

Attribute ScheduledPreloadJobName: The task name.

attr_site_id^Required

attr_site_id: typing.Union[str, IResolvable]

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

Attribute SiteId: The site ID.

attr_task_submitted^Required

attr_task_submitted: typing.Union[str, IResolvable]

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

Attribute TaskSubmitted: The number of submitted prefetch tasks.

attr_task_type^Required

attr_task_type: typing.Union[str, IResolvable]

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

Attribute TaskType: The task type.

Valid values: refresh and preload.

attr_url_count^Required

attr_url_count: typing.Union[str, IResolvable]

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

Attribute UrlCount: The total number of URLs.

attr_url_submitted^Required

attr_url_submitted: typing.Union[str, IResolvable]

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

Attribute UrlSubmitted: The number of submitted URLs.

props^Required

props: ScheduledPreloadJobProps

• Type: ScheduledPreloadJobProps