DeliverTask
This class encapsulates and extends the ROS resource type ALIYUN::ARMS::DeliverTask
, which is used to create a delivery task.
Initializers
import ros_cdk_arms
ros_cdk_arms.DeliverTask(
scope: Construct,
id: str,
target_list: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetListProperty]]],
task_name: typing.Union[str, IResolvable],
data_source_id: typing.Union[str, IResolvable] = None,
data_source_name: typing.Union[str, IResolvable] = None,
external_label: typing.Union[str, IResolvable] = None,
filter_list: typing.Union[str, IResolvable] = None,
filter_type: typing.Union[bool, IResolvable] = None,
task_description: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
target_list |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TargetListProperty]]] |
Property targetList: The list of the target. |
task_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property taskName: The name of the task. |
data_source_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dataSourceId: The ID of the data source. |
data_source_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dataSourceName: The name of the data source. |
external_label |
typing.Union[str, ros_cdk_core.IResolvable] |
Property externalLabel: The external label of the task. |
filter_list |
typing.Union[str, ros_cdk_core.IResolvable] |
Property filterList: Set metrics to filter, support for regular expressions, multiple line breaks, and multiple conditions to deliver. |
filter_type |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property filterType: Whether the data filtering adopts the whitelist mechanism. |
task_description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property taskDescription: The description of the task. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
target_list
Required
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TargetListProperty]]]
Property targetList: The list of the target.
task_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property taskName: The name of the task.
data_source_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dataSourceId: The ID of the data source.
data_source_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dataSourceName: The name of the data source.
external_label
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property externalLabel: The external label of the task.
filter_list
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property filterList: Set metrics to filter, support for regular expressions, multiple line breaks, and multiple conditions to deliver.
filter_type
Optional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property filterType: Whether the data filtering adopts the whitelist mechanism.
Default value: true.
task_description
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property taskDescription: The description of the task.
enable_resource_property_constraint
Optional
- Type: bool
Methods
Name | Description |
---|---|
to_string |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition |
No description. |
add_count |
No description. |
add_dependency |
No description. |
add_resource_desc |
No description. |
apply_removal_policy |
No description. |
get_att |
No description. |
set_metadata |
No description. |
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_arms
ros_cdk_arms.DeliverTask.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
Name | Type | Description |
---|---|---|
node |
ros_cdk_core.ConstructNode |
The construct tree node associated with this construct. |
ref |
str |
No description. |
stack |
ros_cdk_core.Stack |
The stack in which this resource is defined. |
resource |
ros_cdk_core.RosResource |
No description. |
attr_task_id |
ros_cdk_core.IResolvable |
Attribute TaskId: The ID of the task. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
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_task_id
Required
attr_task_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute TaskId: The ID of the task.