MediaWorkflow
- Implements: IMediaWorkflow
This class encapsulates and extends the ROS resource type ALIYUN::MPS::MediaWorkflow.
Initializers
import ros_cdk_mps
ros_cdk_mps.MediaWorkflow(
scope: Construct,
id: str,
name: typing.Union[str, IResolvable],
topology: typing.Union[IResolvable, typing.Mapping[typing.Any]],
trigger_mode: 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. |
name | typing.Union[str, ros_cdk_core.IResolvable] | Property name: The topology of the media workflow. |
topology | typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] | Property topology: The topology of the media workflow. |
trigger_mode | typing.Union[str, ros_cdk_core.IResolvable] | Property triggerMode: The triggering mode of the media workflow. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property name: The topology of the media workflow.
The value cannot be empty. The name cannot be the same as that of an existing media workflow within the current Alibaba Cloud account. The name can be up to 64 characters in length. The value must be encoded in the UTF-8 format.
topologyRequired
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
Property topology: The topology of the media workflow.
The value must be a JSON object that contains the activities and activity dependencies. For more information, see the Sample topology section of this topic.Note The Object Storage Service (OSS) bucket must reside in the same region as your MPS service.
trigger_modeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property triggerMode: The triggering mode of the media workflow.
Valid values: OssAutoTrigger: The media workflow is automatically triggered. NotInAuto: The media workflow is not automatically triggered.
enable_resource_property_constraintOptional
- 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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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
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
- 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_mps
ros_cdk_mps.MediaWorkflow.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. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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_creation_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreationTime: The time when the media workflow was created. |
attr_media_workflow_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute MediaWorkflowId: The ID of the media workflow. |
attr_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Name: The name of the media workflow. |
attr_state | typing.Union[str, ros_cdk_core.IResolvable] | Attribute State: The state of the media workflow. |
attr_topology | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Topology: The topology of the media workflow. |
attr_trigger_mode | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TriggerMode: The trigger mode of the media workflow. |
props | MediaWorkflowProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_creation_timeRequired
attr_creation_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreationTime: The time when the media workflow was created.
attr_media_workflow_idRequired
attr_media_workflow_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute MediaWorkflowId: The ID of the media workflow.
attr_nameRequired
attr_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Name: The name of the media workflow.
attr_stateRequired
attr_state: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute State: The state of the media workflow.
attr_topologyRequired
attr_topology: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Topology: The topology of the media workflow.
attr_trigger_modeRequired
attr_trigger_mode: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TriggerMode: The trigger mode of the media workflow.
propsRequired
props: MediaWorkflowProps
- Type: MediaWorkflowProps