SiteDeliveryTask

• Implements: ISiteDeliveryTask

This class encapsulates and extends the ROS resource type ALIYUN::ESA::SiteDeliveryTask.

Initializers

import ros_cdk_esa
ros_cdk_esa.SiteDeliveryTask(
  scope: Construct,
  id: str,
  business_type: typing.Union[str, IResolvable],
  data_center: typing.Union[str, IResolvable],
  delivery_type: typing.Union[str, IResolvable],
  field_name: typing.Union[str, IResolvable],
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  task_name: typing.Union[str, IResolvable],
  discard_rate: typing.Union[typing.Union[int, float], IResolvable] = None,
  http_delivery: typing.Union[IResolvable, HttpDeliveryProperty] = None,
  kafka_delivery: typing.Union[IResolvable, KafkaDeliveryProperty] = None,
  oss_delivery: typing.Union[IResolvable, OssDeliveryProperty] = None,
  s3_delivery: typing.Union[IResolvable, S3DeliveryProperty] = None,
  sls_delivery: typing.Union[IResolvable, SlsDeliveryProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

business_type^Required

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

Property businessType: Real-time log type.

Valid values:

• dcdn_log_access_l1 (default): access log.
• dcdn_log_er: Edge Routine logs.
• dcdn_log_waf: firewall logs.
• dcdn_log_ipa: TCP/UDP proxy logs.

data_center^Required

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

Property dataCenter: Data Center.

Values:

• cn: Mainland China.
• sg: Global (excluding Mainland China).

delivery_type^Required

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

Property deliveryType: Delivery Type: - sls: Alibaba Cloud Simple Log Service (SLS).

• http: Http service.
• aws3: Amazon s3 service.
• oss: Alibaba Cloud Object Storage Service.
• kafka: Kafka service.
• aws3cmpt: Amazon s3 Compatible Service.

field_name^Required

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

Property fieldName: The list of delivery fields to be modified, separated by commas.

site_id^Required

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

Property siteId: The site ID.

task_name^Required

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

Property taskName: The name of the delivery task.

discard_rate^Optional

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

Property discardRate: If the discard rate is not filled, the default value is 0.

http_delivery^Optional

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

Property httpDelivery: HTTP delivery configuration parameters.

kafka_delivery^Optional

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

Property kafkaDelivery: Kafka delivery configuration parameters.

oss_delivery^Optional

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

Property ossDelivery: OSS delivery configuration.

s3_delivery^Optional

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

Property s3Delivery: S3\/S3 compatible delivery configuration parameters.

sls_delivery^Optional

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

Property slsDelivery: SLS delivery configuration.

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.SiteDeliveryTask.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_business_type^Required

attr_business_type: typing.Union[str, IResolvable]

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

Attribute BusinessType: Real-time log type.

attr_data_center^Required

attr_data_center: typing.Union[str, IResolvable]

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

Attribute DataCenter: Data Center.

attr_delivery_type^Required

attr_delivery_type: typing.Union[str, IResolvable]

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

Attribute DeliveryType: Delivery Type:.

attr_discard_rate^Required

attr_discard_rate: typing.Union[str, IResolvable]

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

Attribute DiscardRate: If the discard rate is not filled, the default value is 0.

attr_field_name^Required

attr_field_name: typing.Union[str, IResolvable]

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

Attribute FieldName: The list of delivery fields to be modified, separated by commas.

attr_filter_rules^Required

attr_filter_rules: typing.Union[str, IResolvable]

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

Attribute FilterRules: The filtering rules.

attr_sink_config^Required

attr_sink_config: typing.Union[str, IResolvable]

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

Attribute SinkConfig: The delivery configuration.

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_site_name^Required

attr_site_name: typing.Union[str, IResolvable]

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

Attribute SiteName: The website name.

attr_task_name^Required

attr_task_name: typing.Union[str, IResolvable]

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

Attribute TaskName: The task name.

props^Required

props: SiteDeliveryTaskProps

• Type: SiteDeliveryTaskProps