Skip to content

Pipeline

This class encapsulates and extends the ROS resource type ALIYUN::MPS::Pipeline, which is used to create an ApsaraVideo Media Processing (MPS) queue.

Initializers

import ros_cdk_mps
ros_cdk_mps.Pipeline(
  scope: Construct,
  id: str,
  name: typing.Union[str, IResolvable],
  notify_config: typing.Union[IResolvable, NotifyConfigProperty] = None,
  role: typing.Union[str, IResolvable] = None,
  speed: typing.Union[str, IResolvable] = None,
  speed_level: typing.Union[typing.Union[int, float], IResolvable] = None,
  state: 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 new name of the MPS queue.
notify_config typing.Union[ros_cdk_core.IResolvable, NotifyConfigProperty] Property notifyConfig: The Message Service (MNS) configuration, such as the information about the MNS queue or topic.
role typing.Union[str, ros_cdk_core.IResolvable] Property role: The role that is assigned to the current RAM user.
speed typing.Union[str, ros_cdk_core.IResolvable] Property speed: Pipe type.
speed_level typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property speedLevel: Speed level.
state typing.Union[str, ros_cdk_core.IResolvable] Property state: The new state of the MPS queue.
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 new name of the MPS queue.

The value can contain letters, digits, and special characters such as hyphens (-) and can be up to 128 bytes in size. The value cannot start with a special character.


notify_configOptional

Property notifyConfig: The Message Service (MNS) configuration, such as the information about the MNS queue or topic.

For more information, see NotifyConfig.


roleOptional

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

Property role: The role that is assigned to the current RAM user.

To obtain the role, you can log on to the RAM console and choose Identities > Roles in the left-side navigation pane.


speedOptional

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

Property speed: Pipe type.

Value: Boost: Double-speed transcoding Standard: ordinary pipe NarrowBandHDV2: Narrowband HD 2.0 AIVideoCover: Smart Screenshots AIVideoTag: video tag (supports regions Shanghai, Beijing, Hangzhou). Default: Standard.


speed_levelOptional

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

Property speedLevel: Speed level.


stateOptional

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

Property state: The new state of the MPS queue.

Active: The MPS queue is active. Jobs in the MPS queue can be scheduled and run by MPS. Paused: The MPS queue is paused. Jobs in the MPS queue cannot be scheduled or run by MPS, and all jobs remain in the Submitted state. Jobs that are running will not be affected.


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.
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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • 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.Pipeline.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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_pipeline_id ros_cdk_core.IResolvable Attribute PipelineId: The ID of the MPS queue.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


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_pipeline_idRequired

attr_pipeline_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PipelineId: The ID of the MPS queue.